startify.txt 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999
  1. *startify.txt* The fancy start screen.
  2. *startify*
  3. __ __ ___
  4. /\ \__ /\ \__ __ /'___\
  5. ____\ \ ,_\ __ _ __\ \ ,_\/\_\/\ \__/ __ __
  6. /',__\\ \ \/ /'__`\ /\`'__\ \ \/\/\ \ \ ,__\/\ \/\ \
  7. /\__, `\\ \ \_/\ \L\.\_\ \ \/ \ \ \_\ \ \ \ \_/\ \ \_\ \
  8. \/\____/ \ \__\ \__/.\_\\ \_\ \ \__\\ \_\ \_\ \/`____ \
  9. \/___/ \/__/\/__/\/_/ \/_/ \/__/ \/_/\/_/ `/___/> \
  10. /\___/
  11. \/__/
  12. by Marco Hinz~
  13. >
  14. If you use any of my plugins, please star them on github. It's a great way
  15. of getting feedback and gives me the kick to put more time into their
  16. development.
  17. If you encounter any bugs or have feature requests, just open an issue
  18. report on Github.
  19. Thank you for flying mhi^ airlines. Get the Vim on!
  20. <
  21. ==============================================================================
  22. CONTENTS *startify-contents*
  23. INTRO .......................................... |startify-intro|
  24. USAGE .......................................... |startify-usage|
  25. OPTIONS ........................................ |startify-options|
  26. AUTOCMD ........................................ |startify-autocmd|
  27. COMMANDS ....................................... |startify-commands|
  28. MAPPINGS ....................................... |startify-mappings|
  29. COLORS ......................................... |startify-colors|
  30. FAQ ............................................ |startify-faq|
  31. EXAMPLE ........................................ |startify-example|
  32. ==============================================================================
  33. INTRO *startify-intro*
  34. Startify is a plugin that shows recently used files, bookmarks, commands and
  35. sessions that were saved to a certain directory.
  36. ==============================================================================
  37. USAGE *startify-usage*
  38. Startify basically provides two things:
  39. 1) If you start Vim without giving any filenames to it (or pipe stuff to it so
  40. it reads from STDIN), startify will show a small but pretty start screen
  41. that shows recently used files (using viminfo) and sessions by default.
  42. Additionally, you can define bookmarks (thus entries for files) and
  43. commands that always should be available on the start screen.
  44. You can either navigate to a certain menu entry and hit enter or you just
  45. key in whatever is written between the square brackets on that line. You
  46. can even double-click anywhere on the line now.
  47. In addition, 'e' creates an empty buffer, 'i' creates an empty buffer and
  48. jumps into insert mode, 'q' quits.
  49. Moreover, you can open several files at one go. Navigate to an entry and
  50. hit either 'b' (open in same window), 's' (open in split), 'v' (open in
  51. vertical split) or 't' (open in tab). You can do that for multiple entries.
  52. You can also mix them. The order of the selections will be remembered.
  53. Afterwards execute these actions via <cr>.
  54. When the selection is finished, Startify will close automatically. You can
  55. reopen the screen via :Startify.
  56. And you can define your own custom ascii art header now!
  57. 2) It eases handling of loading and saving sessions by only working with a
  58. certain directory. These commands are used for convenience:
  59. :SLoad load a session
  60. :SSave save a session
  61. :SDelete[!] delete a session
  62. :SClose close a session
  63. If ! is given, you won't get prompted.
  64. ==============================================================================
  65. OPTIONS *startify-options*
  66. Put these variables into your vimrc. The shown assignments are also the
  67. default values.
  68. Most used options:~
  69. |g:startify_bookmarks|
  70. |g:startify_change_to_dir|
  71. |g:startify_change_to_vcs_root|
  72. |g:startify_custom_header|
  73. |g:startify_enable_special|
  74. |g:startify_list_order|
  75. |g:startify_skiplist|
  76. |g:startify_update_oldfiles|
  77. Misc options:~
  78. |g:startify_commands|
  79. |g:startify_custom_footer|
  80. |g:startify_custom_header_quotes|
  81. |g:startify_custom_indices|
  82. |g:startify_disable_at_vimenter|
  83. |g:startify_enable_unsafe|
  84. |g:startify_files_number|
  85. |g:startify_fortune_use_unicode|
  86. |g:startify_padding_left|
  87. |g:startify_relative_path|
  88. |g:startify_skiplist_server|
  89. |g:startify_use_env|
  90. Sessions:~
  91. |g:startify_session_autoload|
  92. |g:startify_session_before_save|
  93. |g:startify_session_delete_buffers|
  94. |g:startify_session_dir|
  95. |g:startify_session_number|
  96. |g:startify_session_persistence|
  97. |g:startify_session_remove_lines|
  98. |g:startify_session_savecmds|
  99. |g:startify_session_savevars|
  100. |g:startify_session_sort|
  101. ------------------------------------------------------------------------------
  102. *g:startify_session_dir*
  103. >
  104. let g:startify_session_dir = '~/.vim/session'
  105. <
  106. The directory to save/load sessions to/from.
  107. The default for Windows systems is '$HOME\vimfiles\session'.
  108. ------------------------------------------------------------------------------
  109. *g:startify_list_order*
  110. >
  111. let g:startify_list_order = ['files', 'dir', 'bookmarks', 'sessions',
  112. \ 'commands']
  113. <
  114. At the moment startify supports these lists:~
  115. 1) "files"
  116. This lists the most recently used files using viminfo. The number of files
  117. is limited by |g:startify_files_number|.
  118. 2) "dir"
  119. This lists the files from the current directory sorted by modification
  120. time. The number of files is limited by |g:startify_files_number|.
  121. 3) "bookmarks"
  122. This lists bookmarks, thus hardcoded files or directories that will always
  123. be shown. Have a look at |g:startify_bookmarks|.
  124. 4) "sessions"
  125. This lists all the sessions saved in the directory |g:startify_session_dir|.
  126. 5) "commands"
  127. This lists commands defined in |g:startify_commands|.
  128. Section headers:~
  129. Additionally you can add lists of strings to that list. These will be shown
  130. above the following item in |g:startify_list_order|.
  131. NOTE: Section headers are context-senstive. This means that if the following
  132. item is a startify list ("dir", "bookmarks", ...) and empty (no files in the
  133. current directory, no bookmarks defined, ...), the section header won't be
  134. shown as well.
  135. NOTE: The section header use the StartifySection highlight group.
  136. Section headers example:~
  137. >
  138. let g:startify_list_order = [
  139. \ [' My most recently', ' used files'],
  140. \ 'files',
  141. \ [' My most recently used files in the current directory:'],
  142. \ 'dir',
  143. \ [' These are my sessions:'],
  144. \ 'sessions',
  145. \ [' These are my bookmarks:'],
  146. \ 'bookmarks',
  147. \ [' These are my commands:'],
  148. \ 'commands',
  149. \ ]
  150. <
  151. Feel free to add some cool ASCII action!
  152. ------------------------------------------------------------------------------
  153. *g:startify_bookmarks*
  154. >
  155. let g:startify_bookmarks = []
  156. <
  157. A list of files or directories to bookmark. The list can contain two kinds of
  158. types. Either a path or a dictionary whereas the key is the custom index and
  159. the value the path.
  160. Example:
  161. >
  162. let g:startify_bookmarks = [ {'c': '~/.vimrc'}, '~/.zshrc' ]
  163. <
  164. NOTE: Avoid using keys from |startify-mappings| if providing custom indices.
  165. ------------------------------------------------------------------------------
  166. *g:startify_commands*
  167. >
  168. let g:startify_commands = []
  169. <
  170. A list of commands to execute on selection. Leading colons are optional. It
  171. supports optional custom indices and/or command descriptions.
  172. Example:
  173. >
  174. let g:startify_commands = [
  175. \ ':help reference',
  176. \ ['Vim Reference', 'h ref'],
  177. \ {'h': 'h ref'},
  178. \ {'m': ['My magical function', 'call Magic()']},
  179. \ ]
  180. <
  181. NOTE: Avoid using keys from |startify-mappings| if providing custom indices.
  182. ------------------------------------------------------------------------------
  183. *g:startify_files_number*
  184. >
  185. let g:startify_files_number = 10
  186. <
  187. The number of files to list.
  188. ------------------------------------------------------------------------------
  189. *g:startify_update_oldfiles*
  190. >
  191. let g:startify_update_oldfiles = 0
  192. <
  193. Usually |v:oldfiles| only gets updated when Vim exits. Using this option updates
  194. it on-the-fly, so that :Startify is always up-to-date.
  195. ------------------------------------------------------------------------------
  196. *g:startify_session_autoload*
  197. >
  198. let g:startify_session_autoload = 0
  199. <
  200. If this option is enabled and you start Vim in a directory that contains a
  201. `Session.vim`, that session will be loaded automatically. Otherwise it will be
  202. shown as the top entry in the Startify buffer.
  203. The same happens when you |:cd| to a directory that contains a `Session.vim`
  204. and execute |:Startify|.
  205. It also works if you open a bookmarked directory. See |g:startify_bookmarks|.
  206. This is great way to create a portable project folder!
  207. NOTE: This option is affected by |g:startify_session_delete_buffers|.
  208. ------------------------------------------------------------------------------
  209. *g:startify_session_before_save*
  210. >
  211. let g:startify_session_before_save = []
  212. <
  213. This is a list of commands to be executed before saving a session.
  214. Example:
  215. >
  216. let g:startify_session_before_save = [
  217. \ 'echo "Cleaning up before saving.."',
  218. \ 'silent! NERDTreeTabsClose'
  219. \ ]
  220. <
  221. ------------------------------------------------------------------------------
  222. *g:startify_session_persistence*
  223. >
  224. let g:startify_session_persistence = 0
  225. <
  226. Automatically update sessions in two cases:
  227. 1) Before leaving Vim
  228. 2) Before loading a new session via :SLoad
  229. This also works for sessions started with:
  230. >
  231. vim -S mysession.vim
  232. <
  233. ------------------------------------------------------------------------------
  234. *g:startify_session_delete_buffers*
  235. >
  236. let g:startify_session_delete_buffers = 1
  237. <
  238. Delete all listed buffers when loading or closing a session.
  239. 1. When using |startify-:SLoad|.
  240. 2. When using |startify-:SClose|.
  241. 3. When using |g:startify_session_autoload|.
  242. 4. When choosing a session from the Startify buffer.
  243. ------------------------------------------------------------------------------
  244. *g:startify_change_to_dir*
  245. >
  246. let g:startify_change_to_dir = 1
  247. <
  248. When opening a file or bookmark, change to its directory.
  249. ------------------------------------------------------------------------------
  250. *g:startify_change_to_vcs_root*
  251. >
  252. let g:startify_change_to_vcs_root = 0
  253. <
  254. When opening a file or bookmark, seek and change to the root directory of the
  255. VCS (if there is one).
  256. At the moment only git, hg, bzr and svn are supported.
  257. ------------------------------------------------------------------------------
  258. *g:startify_skiplist*
  259. >
  260. let g:startify_skiplist = [
  261. \ 'COMMIT_EDITMSG',
  262. \ escape(fnamemodify(resolve($VIMRUNTIME), ':p'), '\') .'doc',
  263. \ 'bundle/.*/doc',
  264. \ ]
  265. <
  266. A list of Vim regular expressions that is used to filter recently used files.
  267. See |pattern.txt| for what patterns can be used.
  268. NOTE: Due to the nature of patterns, you can't just use "~/mysecret" but have
  269. to use "$HOME .'/mysecret.txt'". The former would do something entirely
  270. different: |/\~|. When using backslashes as path separators, escape them.
  271. Otherwise using "C:\this\vim\path\is\problematic" would not match what you
  272. expect, since |/\v| is a pattern, too.
  273. Example:
  274. >
  275. let g:startify_skiplist = [
  276. \ '\.vimgolf',
  277. \ '^/tmp',
  278. \ '/project/.*/documentation',
  279. \ escape(fnamemodify($HOME, ':p'), '\') .'mysecret.txt',
  280. \ ]
  281. <
  282. ------------------------------------------------------------------------------
  283. *g:startify_fortune_use_unicode*
  284. >
  285. let g:startify_fortune_use_unicode = 0
  286. <
  287. By default, the fortune header uses ASCII characters, because they work for
  288. everyone. If you set this option to 1 and your 'encoding' is "utf-8", Unicode
  289. box-drawing characters will be used instead.
  290. This is not the default, because users of East Asian languages often set
  291. 'ambiwidth' to "double" or make their terminal emulator treat characters of
  292. ambiguous width as double width. Both would make the drawed box look funny.
  293. For more information: http://unicode.org/reports/tr11
  294. ------------------------------------------------------------------------------
  295. *g:startify_padding_left*
  296. >
  297. let g:startify_padding_left = 3
  298. <
  299. The number of spaces used for left padding.
  300. ------------------------------------------------------------------------------
  301. *g:startify_skiplist_server*
  302. >
  303. let g:startify_skiplist_server = []
  304. <
  305. Do not create the startify buffer, if this is a Vim server instance with a
  306. name contained in this list.
  307. Example:
  308. >
  309. let g:startify_skiplist_server = [ 'GVIM' ]
  310. <
  311. ------------------------------------------------------------------------------
  312. *g:startify_enable_special*
  313. >
  314. let g:startify_enable_special = 1
  315. <
  316. Show <empty buffer> and <quit>.
  317. ------------------------------------------------------------------------------
  318. *g:startify_enable_unsafe*
  319. >
  320. let g:startify_enable_unsafe = 0
  321. <
  322. Enable the option only in case you think Vim starts too slowly (because of
  323. :Startify) or if you often edit files on remote filesystems.
  324. It's called unsafe because it improves the time :Startify needs to execute by
  325. reducing the amount of syscalls to the underlying operating system, but
  326. sacrifices the precision of shown entries.
  327. This could lead to inconsistences in the shown :Startify entries (e.g. the
  328. same file could be shown twice, because one time file was opened via absolute
  329. path and another time via symlink).
  330. Currently this option does this:
  331. - don't resolves symlinks (readlink(2))
  332. - don't check every file if it's readable (stat(2))
  333. - don't filter through the bookmark list
  334. ------------------------------------------------------------------------------
  335. *g:startify_session_remove_lines*
  336. >
  337. let g:startify_session_remove_lines = []
  338. <
  339. Lines matching any of the patterns in this list, will be removed from the
  340. session file.
  341. Example:
  342. >
  343. let g:startify_session_remove_lines = ['setlocal', 'winheight']
  344. <
  345. Internally this simply does:
  346. >
  347. :global/setlocal/delete
  348. :global/winheight/delete
  349. <
  350. So you can use any |pattern|.
  351. NOTE: Take care not to mess up any expressions within the session file,
  352. otherwise you'll probably get problems when trying to load it.
  353. ------------------------------------------------------------------------------
  354. *g:startify_session_savevars*
  355. >
  356. let g:startify_session_savevars = []
  357. <
  358. Include a list of variables in here which you would like Startify to save into
  359. the session file in addition to what Vim normally saves into the session file.
  360. For example, Vim will not normally save all-lowercase global variables, which
  361. are common for plugin settings. It may be advisable to include
  362. |g:startify_session_savevars| and |g:startify_session_savecmds| into this list
  363. so they are saved every time the session saves.
  364. Example:
  365. >
  366. let g:startify_session_savevars = [
  367. \ 'g:startify_session_savevars',
  368. \ 'g:startify_session_savecmds',
  369. \ 'g:random_plugin_use_feature'
  370. \ ]
  371. <
  372. ------------------------------------------------------------------------------
  373. *g:startify_session_savecmds*
  374. >
  375. let g:startify_session_savecmds = []
  376. <
  377. Include a list of cmdline commands which Vim will run upon loading the
  378. session. This can be useful to set various things (other than variables,
  379. |g:startify_session_savevars| above) which Vim may not normally save into the
  380. session file, as well as run external commands upon loading a session.
  381. Example:
  382. >
  383. let g:startify_session_savecmds = [
  384. \ 'silent !pdfreader ~/latexproject/main.pdf &'
  385. \ ]
  386. <
  387. ------------------------------------------------------------------------------
  388. *g:startify_session_number*
  389. >
  390. let g:startify_session_number = 999
  391. <
  392. The maximum number of sessions to display. Makes the most sense together with
  393. |g:startify_session_sort|.
  394. ------------------------------------------------------------------------------
  395. *g:startify_session_sort*
  396. >
  397. let g:startify_session_sort = 0
  398. <
  399. Sort sessions by modification time (when the session files were written)
  400. rather than alphabetically.
  401. ------------------------------------------------------------------------------
  402. *g:startify_custom_indices*
  403. >
  404. let g:startify_custom_indices = []
  405. <
  406. Use any list of strings as indices instead of increasing numbers. If there are
  407. more startify entries than actual items in the custom list, the remaining
  408. entries will be filled using the default numbering scheme starting from 0.
  409. Thus you can create your own indexing scheme that fits your keyboard layout.
  410. You don't want to leave the home row, do you?!
  411. Example:
  412. >
  413. let g:startify_custom_indices = ['f', 'g', 'h']
  414. <
  415. This would result in:
  416. [f] /most/recently/used/file1
  417. [g] /most/recently/used/file2
  418. [h] /most/recently/used/file3
  419. [0] /most/recently/used/file4
  420. [1] /most/recently/used/file5
  421. [2] /most/recently/used/file6
  422. etc.
  423. If you want numbers to start at 1 instead of 0, you could use this:
  424. >
  425. let g:startify_custom_indices = map(range(1,100), 'string(v:val)')
  426. <
  427. NOTE: There is no sanitizing going on, so you should know what you're doing!
  428. Avoid using keys from |startify-mappings|.
  429. ------------------------------------------------------------------------------
  430. *g:startify_custom_header*
  431. >
  432. let g:startify_custom_header = startify#fortune#get_random_quote()
  433. <
  434. This is a list of strings to be shown before everything else. Every string
  435. will be written on its own line, hence you can use empty strings for blank
  436. lines.
  437. Static example:~
  438. >
  439. let g:startify_custom_header = ['line 1', '', 'line 3']
  440. <
  441. Static example #2:~
  442. >
  443. let g:startify_custom_header = [
  444. \ ' ________ __ __ ',
  445. \ ' __ /\_____ \/\ \\ \ ',
  446. \ ' __ __ /\_\ ___ ___ \/___//''/''\ \ \\ \ ',
  447. \ ' /\ \/\ \\/\ \ /'' __` __`\ /'' /'' \ \ \\ \_ ',
  448. \ ' \ \ \_/ |\ \ \/\ \/\ \/\ \ /'' /''__ \ \__ ,__\',
  449. \ ' \ \___/ \ \_\ \_\ \_\ \_\ /\_/ /\_\ \/_/\_\_/ ',
  450. \ ' \/__/ \/_/\/_/\/_/\/_/ \// \/_/ \/_/ ',
  451. \ ]
  452. <
  453. Dynamic example:~
  454. >
  455. let g:startify_custom_header =
  456. \ map(split(system('fortune | cowsay'), '\n'), '" ". v:val')
  457. <
  458. If you go for a dynamic header, you might find the following functions useful:
  459. startify#fortune#quote() raw random quote
  460. startify#fortune#boxed(...) opt list or formatted random quote in a box
  461. startify#fortune#cowsay() formatted random quote in a box + cow
  462. Try them like this:
  463. >
  464. :echo join(startify#fortune#cowsay(), "\n")
  465. <
  466. Let's assume you like the default boxed random quote, but not the ASCII art
  467. cow. You'd rather have another small ASCII art come before the quote. No
  468. problem!
  469. >
  470. let g:ascii = [
  471. \ ' __',
  472. \ '.--.--.|__|.--------.',
  473. \ '| | || || |',
  474. \ ' \___/ |__||__|__|__|',
  475. \ ''
  476. \]
  477. let g:startify_custom_header = g:ascii + startify#fortune#boxed()
  478. <
  479. Looks great! But it's not on the same column as the indices below which makes
  480. it look awkward. Let's indent the header by 3 spaces:
  481. >
  482. let g:startify_custom_header =
  483. \ map(g:ascii + startify#fortune#boxed(), '" ".v:val')
  484. <
  485. Ah, much better! There's only one issue left. If you set
  486. g:startify_custom_header this way, it will only be done once. Hence spamming
  487. :Startify will always show the same quote.
  488. If you provide a string to it instead, Startify will evaluate it every time
  489. :Startify is run:
  490. >
  491. let g:startify_custom_header =
  492. \ 'map(g:ascii + startify#fortune#boxed(), "\" \".v:val")'
  493. <
  494. Happy customizing!
  495. Also have a look at |startify-faq-08|.
  496. ------------------------------------------------------------------------------
  497. *g:startify_custom_header_quotes*
  498. If you don't set |g:startify_custom_header|, the internal cowsay implementation
  499. with shipped random quotes will be used.
  500. If you want to use your own quotes, add a list of lists, like this:
  501. >
  502. let g:startify_custom_header_quotes = [
  503. \ ['line 1', '', 'line 3'],
  504. \ ['quote #2']
  505. \ ]
  506. <
  507. ------------------------------------------------------------------------------
  508. *g:startify_custom_footer*
  509. >
  510. let g:startify_custom_footer = ''
  511. <
  512. Same as the custom header, but shown at the bottom of the startify buffer.
  513. ------------------------------------------------------------------------------
  514. *g:startify_disable_at_vimenter*
  515. >
  516. let g:startify_disable_at_vimenter = 0
  517. <
  518. Don't run Startify at Vim startup. You can still call it anytime via
  519. :Startify.
  520. -----------------------------------------------------------------------------
  521. *g:startify_relative_path*
  522. >
  523. let g:startify_relative_path = 0
  524. <
  525. If the file is in or below the current working directory, use a relative path.
  526. Otherwise an absolute path is used. The latter prevents hard to grasp entries
  527. like `../../../../../foo`.
  528. NOTE: This only applies to the "files" list, since the "dir" list is
  529. relative by nature.
  530. -----------------------------------------------------------------------------
  531. *g:startify_use_env*
  532. >
  533. let g:startify_use_env = 0
  534. <
  535. Show environment variables in path, if their name is shorter than their value.
  536. See |startify-colors| for highlighting them.
  537. $PWD and $OLDPWD are ignored.
  538. ==============================================================================
  539. AUTOCMD *startify-autocmd*
  540. In case you want to alter the startify buffer to cause all kinds of mayhem, an
  541. user autocmd is issued. You can hook into it like this:
  542. >
  543. autocmd User Startified let &l:stl = ' This statusline rocks!'
  544. <
  545. NOTE: Autocmds don't nest by default. If you use any command that triggers new
  546. events, be sure to add "nested": |autocmd-nested|.
  547. ==============================================================================
  548. COMMANDS *startify-commands*
  549. *startify-:Startify*
  550. >
  551. :Startify
  552. <
  553. Open the startify buffer.
  554. *startify-:SSave*
  555. *startify-:SDelete*
  556. >
  557. :SSave [session]
  558. :SDelete [session]
  559. <
  560. Save or delete a session. If you don't specify a session name, it will prompt
  561. you for one.
  562. *startify-:SLoad*
  563. >
  564. :SLoad [session]
  565. <
  566. Load a session. If you don't specify a session name, it will either prompt you
  567. for one (Windows) or load the last used session (Unix).
  568. Providing only a part of the session name works too, if you complete the
  569. argument with either <c-d> or <tab> afterwards.
  570. NOTE: This command is affected by |g:startify_session_delete_buffers|.
  571. *startify-:SClose*
  572. >
  573. :SClose
  574. <
  575. Save and close the current session, close all listed buffers, and open the
  576. Startify buffer.
  577. NOTE: This command is affected by |g:startify_session_delete_buffers|.
  578. ==============================================================================
  579. MAPPINGS *startify-mappings*
  580. Some things are remapped in the startify buffer..
  581. >
  582. q
  583. <
  584. Close startify. Also quit Vim if it is the only buffer.
  585. >
  586. e
  587. <
  588. Close startify and create a blank buffer.
  589. >
  590. i
  591. <insert>
  592. <
  593. Close startify, create a blank buffer and jump into insert mode right away.
  594. >
  595. <2-LeftMouse>
  596. <
  597. Use a simple mouse click to open the targeted entry.
  598. >
  599. [any number that is shown between square brackets]
  600. <
  601. Open the entry with the given number.
  602. >
  603. b
  604. s
  605. v
  606. t
  607. <
  608. Mark current entry to be opened in either the same window, in a split window,
  609. in a vertical split window or in a new tab.
  610. >
  611. <cr>
  612. <
  613. Open all marked entries. If nothing was marked beforehand, just open the
  614. current entry.
  615. If you want to use another key instead of <cr>, put this in your vimrc:
  616. >
  617. autocmd User Startified nmap <buffer> o <plug>(startify-open-buffers)
  618. <
  619. ==============================================================================
  620. COLORS *startify-colors*
  621. You can overwrite the highlight groups used by startify. The plugin defines
  622. these groups:
  623. Highlight group | Description | Default
  624. ------------------------------------------------------------------
  625. | |
  626. StartifyBracket | [,] | linked to Delimiter
  627. StartifyFile | the actual file | <none>
  628. StartifyFooter | the custom footer | linked to Normal
  629. StartifyHeader | the custom header | linked to Normal
  630. StartifyNumber | the numbers between [] | linked to Number
  631. StartifyPath | the path to a file | <none>
  632. StartifySection | section headers | linked to Special
  633. StartifySelect | selected entries | linked to Title
  634. StartifySlash | slashes in paths | <none>
  635. StartifySpecial | <empty buffer>,<quit> | <none>
  636. StartifyVar | environment variables | linked to StartifyPath
  637. Example: (my terminal emulator supports 256 colors)
  638. >
  639. highlight StartifyBracket ctermfg=240
  640. highlight StartifyFooter ctermfg=240
  641. highlight StartifyHeader ctermfg=114
  642. highlight StartifyNumber ctermfg=215
  643. highlight StartifyPath ctermfg=245
  644. highlight StartifySlash ctermfg=240
  645. highlight StartifySpecial ctermfg=240
  646. <
  647. ==============================================================================
  648. FAQ *startify-faq*
  649. |startify-faq-01| I don't want the start screen to use cursorline!
  650. |startify-faq-02| Recent files aren't shown!
  651. |startify-faq-03| I have broken colors when using sessions!
  652. |startify-faq-04| How to disable common but unimportant files?
  653. |startify-faq-05| Why is the Startify buffer not using buftype=nofile?
  654. |startify-faq-06| How do I get both NERDTree and Startify working at
  655. startup?
  656. |startify-faq-07| The session autoload feature is not working!
  657. |startify-faq-08| How do I center my header/footer?
  658. |startify-faq-09| tmux-resurrect?
  659. |startify-faq-10| Temporarily skip Startify at start?
  660. |startify-faq-11| How to use the output of a command as header?
  661. |startify-faq-12| There is an empty window with vim-plug!
  662. |startify-faq-13| How to disable random quotes header?
  663. ------------------------------------------------------------------------------
  664. *startify-faq-01*
  665. I want to use cursorline!~
  666. Startify issues a User event when it's finished. It can be used to set
  667. buffer-local options etc.
  668. >
  669. autocmd User Startified setlocal cursorline
  670. <
  671. ------------------------------------------------------------------------------
  672. *startify-faq-02*
  673. Recent files aren't shown!~
  674. Perhaps the problem is that the viminfo file..
  675. - doesn't exist
  676. - is invalid
  677. - is empty
  678. - can't be read (check permissions)
  679. I suggest the following steps:
  680. 1) Create a new directory:
  681. >
  682. $ mkdir -p ~/.vim/files/info
  683. <
  684. 2) Put this into your vimrc:
  685. >
  686. set viminfo='100,n$HOME/.vim/files/info/viminfo
  687. <
  688. See |'viminfo'| for information about the second step and what it does
  689. exactly.
  690. ------------------------------------------------------------------------------
  691. *startify-faq-03*
  692. I have broken colors when using sessions!~
  693. Nothing this plugin could do about. Try playing around with 'sessionoptions'.
  694. NOTE: Startify removes 'options' from the session options automatically,
  695. because it's the source of many problems.
  696. Some people swear it works for them with these settings:
  697. >
  698. set sessionoptions=blank,curdir,folds,help,tabpages,winpos
  699. <
  700. ------------------------------------------------------------------------------
  701. *startify-faq-04*
  702. How to disable common but unimportant files?~
  703. Use |g:startify_skiplist|.
  704. ------------------------------------------------------------------------------
  705. *startify-faq-05*
  706. Why is the Startify buffer not using buftype=nofile?~
  707. Did you accidentally use |:write| in the Startify buffer and it was saved to
  708. an actual file on disk? It's because buftype=nofile is not used.
  709. This is done to improve compatibility with other plugins. When buftype=nofile
  710. was set, plugins like CtrlP or NERDTree would open splits instead of reusing
  711. the window showing the Startify buffer.
  712. If you understand this but want it anyway, put this in your vimrc:
  713. >
  714. autocmd User Startified setlocal buftype=nofile
  715. <
  716. ------------------------------------------------------------------------------
  717. *startify-faq-06*
  718. How do I get both NERDTree and Startify working at startup?~
  719. Put this in your vimrc:
  720. >
  721. autocmd VimEnter *
  722. \ if !argc()
  723. \ | Startify
  724. \ | NERDTree
  725. \ | wincmd w
  726. \ | endif
  727. <
  728. ------------------------------------------------------------------------------
  729. *startify-faq-07*
  730. The session autoload feature is not working!~
  731. Do you have NERDTree installed by any chance? If so, try this:
  732. >
  733. let NERDTreeHijackNetrw = 0
  734. <
  735. ------------------------------------------------------------------------------
  736. *startify-faq-08*
  737. How do I center my header/footer?~
  738. Try something along these lines:
  739. >
  740. function! s:filter_header(lines) abort
  741. let longest_line = max(map(copy(a:lines), 'strwidth(v:val)'))
  742. let centered_lines = map(copy(a:lines),
  743. \ 'repeat(" ", (&columns / 2) - (longest_line / 2)) . v:val')
  744. return centered_lines
  745. endfunction
  746. let g:startify_custom_header = s:filter_header(startify#fortune#cowsay())
  747. <
  748. ------------------------------------------------------------------------------
  749. *startify-faq-09*
  750. tmux-resurrect?~
  751. If you use tmux-resurrect to restore your tmux environment, you can use :SLoad
  752. to load your last used session right away:
  753. >
  754. set -g @resurrect-processes '"vim->vim +SLoad"'
  755. <
  756. ------------------------------------------------------------------------------
  757. *startify-faq-10*
  758. Temporarily skip Startify at start?~
  759. In some cases you might need to skip Startify at start. E.g.
  760. >
  761. vim +VimwikiMakeDiaryNote
  762. <
  763. Startify would interfere in this case. A simple way to avoid that would be:
  764. >
  765. vim --cmd 'let g:startify_disable_at_vimenter = 1' +VimwikiMakeDiaryNote
  766. <
  767. ------------------------------------------------------------------------------
  768. *startify-faq-11*
  769. How to use the output of a command as header?~
  770. >
  771. redir => test
  772. silent echo 'one'
  773. silent echo 'two'
  774. silent echo 'three'
  775. redir END
  776. let g:startify_custom_header =
  777. \ map(split(test), 'repeat(" ", 10) . v:val')
  778. <
  779. |:redir| puts a string into 'test'. Then we turn it into a list of strings.
  780. Then we shift each string to the right by 10 spaces. Afterwards we add an
  781. empty string to the list, which results in an empty line in the header.
  782. ------------------------------------------------------------------------------
  783. *startify-faq-12*
  784. There is an empty window with vim-plug!~
  785. After start there might be only the Startify buffer which is marked as
  786. |unlisted-buffer|. The problem arises if you use :PlugUpdate followed by 'D'
  787. to see the changes. An empty window!
  788. The actual problem is that Vim won't close the last listed buffer. Try this:
  789. >
  790. $ vim -u NONE -N
  791. :set nobuflisted
  792. :new
  793. :bd
  794. <
  795. It won't close the buffer and therefore the window. This also happens in
  796. vim-plug. Note that this is no bug in neither plugin, it's a Vim weirdness.
  797. Workaround #1:~
  798. >
  799. autocmd User Startified setlocal buflisted
  800. <
  801. In some cases this could break other plugins at start (I look at you
  802. NERDTree), but works well most of the time.
  803. Workaround #2:~
  804. >
  805. let g:plug_window = 'enew' " or maybe 'tabnew'
  806. <
  807. This will open the plug buffer in the current window instead of creating a new
  808. window on the left side. Mind that this will also close the Startify buffer
  809. since it will be hidden.
  810. ------------------------------------------------------------------------------
  811. *startify-faq-13*
  812. How to disable random quotes header?~
  813. >
  814. let g:startify_custom_header = []
  815. <
  816. See |g:startify_custom_header|.
  817. ==============================================================================
  818. EXAMPLE *startify-example*
  819. This is my configuration..
  820. >
  821. autocmd User Startified setlocal cursorline
  822. let g:startify_enable_special = 0
  823. let g:startify_files_number = 8
  824. let g:startify_relative_path = 1
  825. let g:startify_change_to_dir = 1
  826. let g:startify_update_oldfiles = 1
  827. let g:startify_session_autoload = 1
  828. let g:startify_session_persistence = 1
  829. let g:startify_skiplist = [
  830. \ 'COMMIT_EDITMSG',
  831. \ 'bundle/.*/doc',
  832. \ '/data/repo/neovim/runtime/doc',
  833. \ '/Users/mhi/local/vim/share/vim/vim74/doc',
  834. \ ]
  835. let g:startify_bookmarks = [
  836. \ { 'c': '~/.vim/vimrc' },
  837. \ '~/golfing',
  838. \ ]
  839. let g:startify_custom_header =
  840. \ startify#fortune#cowsay('═','║','╔','╗','╝','╚')
  841. let g:startify_custom_footer =
  842. \ ['', " Vim is charityware. Please read ':help uganda'.", '']
  843. hi StartifyBracket ctermfg=240
  844. hi StartifyFile ctermfg=147
  845. hi StartifyFooter ctermfg=240
  846. hi StartifyHeader ctermfg=114
  847. hi StartifyNumber ctermfg=215
  848. hi StartifyPath ctermfg=245
  849. hi StartifySlash ctermfg=240
  850. hi StartifySpecial ctermfg=240
  851. <
  852. ==============================================================================
  853. vim: tw=78