VIM::Packager::Command::Init - create vim package skelton


VIM-Packager documentation  | view source Contained in the VIM-Packager distribution.

Index


NAME

Top

VIM::Packager::Command::Init - create vim package skelton

init

Top

SYNOPSIS

    $ vim-packager init \
            --name=ohai \
            --type=plugin \
            --author=Cornelius \
            --email=cornelius.howl@gmail.com

or just skip author name and email option if you have Autho Info File

    $ vim-packager init \
            --name=ohai \
            --type=plugin \

            # optional 
            --no-dirs
            --dirs=basic
            --dirs=full 
            --dirs=auto  # default

even skip plugin name

    $ cd your-plugin.vim
    $ vim-packager init --type plugin

the plugin name will be your-plugin.vim

OPTIONS

--name=[name] | -n
--type=[type] | -t
--author=[author] | -a
--email=[email] | -e
--no-migration | -nm

Author Info File

it locates at ~/.vim-author.

the format is:

    author: Your Name
    email:  cornelius.howl @ delete-me.gmail.com



DESCRIPTION *$name-description*

*$name* is a plugin to provide way to ...

USAGE *$name-usage*

KEY MAPPINGS *$name-key-mappings*

xx_key *xx_key* key description here

VARIABLES *$name-variables*

g:xxx_variable Your variable here

CHANGELOG *$name-changelog*

CONTACT *$name-contact*

Document skeleton generated by VIM::Packager.

vim:tw=78:ts=8:ft=help:norl:fen:fdl=0:fdm=marker: END close DOC; }

create_dir_skeleton


VIM-Packager documentation  | view source Contained in the VIM-Packager distribution.