Docs: ex command list
This commit is contained in:
parent
9a833c5bc6
commit
e551be9cb0
|
@ -36,8 +36,8 @@ CONTENTS *startify-contents*
|
||||||
==============================================================================
|
==============================================================================
|
||||||
INTRO *startify-intro*
|
INTRO *startify-intro*
|
||||||
|
|
||||||
Startify is a plugin that shows recently used files, bookmarks and
|
Startify is a plugin that shows recently used files, bookmarks, ex commands
|
||||||
sessions that were saved to a certain directory.
|
and sessions that were saved to a certain directory.
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
USAGE *startify-usage*
|
USAGE *startify-usage*
|
||||||
|
@ -48,8 +48,8 @@ Startify basically provides two things:
|
||||||
it reads from STDIN), startify will show a small but pretty start screen
|
it reads from STDIN), startify will show a small but pretty start screen
|
||||||
that shows recently used files (using viminfo) and sessions by default.
|
that shows recently used files (using viminfo) and sessions by default.
|
||||||
|
|
||||||
Additionally, you can define bookmarks, thus entries for files that always
|
Additionally, you can define bookmarks (thus entries for files) and ex
|
||||||
should be available on the start screen.
|
commands that always should be available on the start screen.
|
||||||
|
|
||||||
You can either navigate to a certain menu entry and hit enter or you just
|
You can either navigate to a certain menu entry and hit enter or you just
|
||||||
key in whatever is written between the square brackets on that line. You
|
key in whatever is written between the square brackets on that line. You
|
||||||
|
@ -87,6 +87,7 @@ default values.
|
||||||
|
|
||||||
Most used options:~
|
Most used options:~
|
||||||
|g:startify_bookmarks|
|
|g:startify_bookmarks|
|
||||||
|
|g:startify_ex_commands|
|
||||||
|g:startify_change_to_dir|
|
|g:startify_change_to_dir|
|
||||||
|g:startify_change_to_vcs_root|
|
|g:startify_change_to_vcs_root|
|
||||||
|g:startify_custom_header|
|
|g:startify_custom_header|
|
||||||
|
@ -128,7 +129,8 @@ The default for Windows systems is '$HOME\vimfiles\session'.
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
*g:startify_list_order*
|
*g:startify_list_order*
|
||||||
>
|
>
|
||||||
let g:startify_list_order = ['files', 'dir', 'bookmarks', 'sessions']
|
let g:startify_list_order = ['files', 'dir', 'bookmarks', 'sessions',
|
||||||
|
\ 'ex_commands']
|
||||||
<
|
<
|
||||||
At the moment startify supports these lists:~
|
At the moment startify supports these lists:~
|
||||||
|
|
||||||
|
@ -151,6 +153,10 @@ At the moment startify supports these lists:~
|
||||||
|
|
||||||
This lists all the sessions saved in the directory |g:startify_session_dir|.
|
This lists all the sessions saved in the directory |g:startify_session_dir|.
|
||||||
|
|
||||||
|
5) "ex_commands"
|
||||||
|
|
||||||
|
This lists ex commands defined in |g:startify_ex_commands|.
|
||||||
|
|
||||||
Section headers:~
|
Section headers:~
|
||||||
|
|
||||||
Additionally you can add lists of strings to that list. These will be shown
|
Additionally you can add lists of strings to that list. These will be shown
|
||||||
|
@ -174,6 +180,8 @@ Section headers example:~
|
||||||
\ 'sessions',
|
\ 'sessions',
|
||||||
\ [' These are my bookmarks:'],
|
\ [' These are my bookmarks:'],
|
||||||
\ 'bookmarks',
|
\ 'bookmarks',
|
||||||
|
\ [' These are my ex commands:'],
|
||||||
|
\ 'ex_commands',
|
||||||
\ ]
|
\ ]
|
||||||
<
|
<
|
||||||
Feel free to add some cool ASCII action!
|
Feel free to add some cool ASCII action!
|
||||||
|
@ -193,6 +201,22 @@ Example:
|
||||||
<
|
<
|
||||||
NOTE: Avoid using keys from |startify-mappings| if providing custom indices.
|
NOTE: Avoid using keys from |startify-mappings| if providing custom indices.
|
||||||
|
|
||||||
|
------------------------------------------------------------------------------
|
||||||
|
*g:startify_ex_commands*
|
||||||
|
>
|
||||||
|
let g:startify_ex_commands = []
|
||||||
|
<
|
||||||
|
A list of ex commands (without the colon) to display on the start screen. The
|
||||||
|
list can contain two kinds of types. Either an ex command or a dictionary
|
||||||
|
whereas the key is the custom index and the value the ex command.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
>
|
||||||
|
let g:startify_ex_commands = [ {'s': 'enew | set ft=sql'},
|
||||||
|
\ 'colorscheme bclear' ]
|
||||||
|
<
|
||||||
|
NOTE: Avoid using keys from |startify-mappings| if providing custom indices.
|
||||||
|
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
*g:startify_files_number*
|
*g:startify_files_number*
|
||||||
>
|
>
|
||||||
|
@ -889,6 +913,8 @@ This is my configuration..
|
||||||
\ 'sessions',
|
\ 'sessions',
|
||||||
\ [' Bookmarks:'],
|
\ [' Bookmarks:'],
|
||||||
\ 'bookmarks',
|
\ 'bookmarks',
|
||||||
|
\ [' Ex commands:'],
|
||||||
|
\ 'ex_commands',
|
||||||
\ ]
|
\ ]
|
||||||
|
|
||||||
let g:startify_skiplist = [
|
let g:startify_skiplist = [
|
||||||
|
@ -903,6 +929,11 @@ This is my configuration..
|
||||||
\ '~/golfing',
|
\ '~/golfing',
|
||||||
\ ]
|
\ ]
|
||||||
|
|
||||||
|
let g:startify_ex_commands = [
|
||||||
|
\ { 's': 'enew | set ft=sql' },
|
||||||
|
\ 'colorscheme bclear',
|
||||||
|
\ ]
|
||||||
|
|
||||||
let g:startify_custom_footer =
|
let g:startify_custom_footer =
|
||||||
\ ['', " Vim is charityware. Please read ':help uganda'.", '']
|
\ ['', " Vim is charityware. Please read ':help uganda'.", '']
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue