startify.txt 34 KB

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