help.txt 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. *help.txt* Nvim
  2. VIM - main help file
  3. k
  4. Move around: Use the cursor keys, or "h" to go left, h l
  5. "j" to go down, "k" to go up, "l" to go right. j
  6. Close this window: Use ":q<Enter>".
  7. Get out of Vim: Use ":qa!<Enter>" (careful, all changes are lost!).
  8. Jump to a subject: Position the cursor on a tag (e.g. |bars|) and hit CTRL-].
  9. With the mouse: Double-click the left mouse button on a tag, e.g. |bars|.
  10. Jump back: Type CTRL-O. Repeat to go further back.
  11. Get specific help: It is possible to go directly to whatever you want help
  12. on, by giving an argument to the |:help| command.
  13. Prepend something to specify the context: *help-context*
  14. WHAT PREPEND EXAMPLE ~
  15. Normal mode command :help x
  16. Visual mode command v_ :help v_u
  17. Insert mode command i_ :help i_<Esc>
  18. Command-line command : :help :quit
  19. Command-line editing c_ :help c_<Del>
  20. Vim command argument - :help -r
  21. Option ' :help 'textwidth'
  22. Regular expression / :help /[
  23. See |help-summary| for more contexts and an explanation.
  24. See |notation| for an explanation of the help syntax.
  25. Search for help: Type ":help word", then hit CTRL-D to see matching
  26. help entries for "word".
  27. Or use ":helpgrep word". |:helpgrep|
  28. Getting started: Do the Vim tutor, a 30-minute interactive course for the
  29. basic commands, see |vimtutor|.
  30. Read the user manual from start to end: |usr_01.txt|
  31. Vim stands for Vi IMproved. Most of Vim was made by Bram Moolenaar, but only
  32. through the help of many others. See |credits|.
  33. ------------------------------------------------------------------------------
  34. *doc-file-list* *Q_ct*
  35. BASIC:
  36. |quickref| Overview of the most common commands you will use
  37. |tutor| 30-minute interactive course for beginners
  38. |copying| About copyrights
  39. |iccf| Helping poor children in Uganda
  40. |sponsor| Sponsor Vim development, become a registered Vim user
  41. |www| Vim on the World Wide Web
  42. |bugs| Where to send bug reports
  43. USER MANUAL: These files explain how to accomplish an editing task.
  44. |usr_toc.txt| Table Of Contents
  45. Getting Started ~
  46. |usr_01.txt| About the manuals
  47. |usr_02.txt| The first steps in Vim
  48. |usr_03.txt| Moving around
  49. |usr_04.txt| Making small changes
  50. |usr_05.txt| Set your settings
  51. |usr_06.txt| Using syntax highlighting
  52. |usr_07.txt| Editing more than one file
  53. |usr_08.txt| Splitting windows
  54. |usr_09.txt| Using the GUI
  55. |usr_10.txt| Making big changes
  56. |usr_11.txt| Recovering from a crash
  57. |usr_12.txt| Clever tricks
  58. Editing Effectively ~
  59. |usr_20.txt| Typing command-line commands quickly
  60. |usr_21.txt| Go away and come back
  61. |usr_22.txt| Finding the file to edit
  62. |usr_23.txt| Editing other files
  63. |usr_24.txt| Inserting quickly
  64. |usr_25.txt| Editing formatted text
  65. |usr_26.txt| Repeating
  66. |usr_27.txt| Search commands and patterns
  67. |usr_28.txt| Folding
  68. |usr_29.txt| Moving through programs
  69. |usr_30.txt| Editing programs
  70. |usr_31.txt| Exploiting the GUI
  71. |usr_32.txt| The undo tree
  72. Tuning Vim ~
  73. |usr_40.txt| Make new commands
  74. |usr_41.txt| Write a Vim script
  75. |usr_42.txt| Add new menus
  76. |usr_43.txt| Using filetypes
  77. |usr_44.txt| Your own syntax highlighted
  78. |usr_45.txt| Select your language
  79. REFERENCE MANUAL: These files explain every detail of Vim. *reference_toc*
  80. General subjects ~
  81. |intro.txt| general introduction to Vim; notation used in help files
  82. |nvim.txt| Transitioning from Vim
  83. |help.txt| overview and quick reference (this file)
  84. |helphelp.txt| about using the help files
  85. |lua-guide| Nvim Lua guide
  86. |index.txt| alphabetical index of all commands
  87. |tips.txt| various tips on using Vim
  88. |message.txt| (error) messages and explanations
  89. |develop.txt| development of Nvim
  90. |debug.txt| debugging Vim itself
  91. |uganda.txt| Vim distribution conditions and what to do with your money
  92. Basic editing ~
  93. |starting.txt| starting Vim, Vim command arguments, initialisation
  94. |editing.txt| editing and writing files
  95. |motion.txt| commands for moving around
  96. |scroll.txt| scrolling the text in the window
  97. |insert.txt| Insert and Replace mode
  98. |change.txt| deleting and replacing text
  99. |undo.txt| Undo and Redo
  100. |repeat.txt| repeating commands, Vim scripts and debugging
  101. |visual.txt| using the Visual mode (selecting a text area)
  102. |various.txt| various remaining commands
  103. |recover.txt| recovering from a crash
  104. Advanced editing ~
  105. |cmdline.txt| Command-line editing
  106. |options.txt| description of all options
  107. |pattern.txt| regexp patterns and search commands
  108. |map.txt| key mapping and abbreviations
  109. |tagsrch.txt| tags and special searches
  110. |windows.txt| commands for using multiple windows and buffers
  111. |tabpage.txt| commands for using multiple tab pages
  112. |spell.txt| spell checking
  113. |diff.txt| working with two to eight versions of the same file
  114. |autocmd.txt| automatically executing commands on an event
  115. |eval.txt| expression evaluation, conditional commands
  116. |builtin.txt| builtin functions
  117. |userfunc.txt| defining user functions
  118. |fold.txt| hide (fold) ranges of lines
  119. |lua.txt| Lua API
  120. |api.txt| Nvim API via RPC, Lua and VimL
  121. Special issues ~
  122. |testing.txt| testing Vim and Vim scripts
  123. |print.txt| printing
  124. |remote_plugin.txt| Nvim support for remote plugins
  125. Programming language support ~
  126. |indent.txt| automatic indenting for C and other languages
  127. |lsp.txt| Language Server Protocol (LSP)
  128. |treesitter.txt| tree-sitter library for incremental parsing of buffers
  129. |diagnostic.txt| Diagnostic framework
  130. |syntax.txt| syntax highlighting
  131. |filetype.txt| settings done specifically for a type of file
  132. |quickfix.txt| commands for a quick edit-compile-fix cycle
  133. |provider.txt| Built-in remote plugin hosts
  134. |ft_ada.txt| Ada (the programming language) support
  135. |ft_ps1.txt| Filetype plugin for Windows PowerShell
  136. |ft_raku.txt| Filetype plugin for Raku
  137. |ft_rust.txt| Filetype plugin for Rust
  138. |ft_sql.txt| about the SQL filetype plugin
  139. Language support ~
  140. |digraph.txt| list of available digraphs
  141. |mbyte.txt| multibyte text support
  142. |mlang.txt| non-English language support
  143. |rileft.txt| right-to-left editing mode
  144. |arabic.txt| Arabic language support and editing
  145. |hebrew.txt| Hebrew language support and editing
  146. |russian.txt| Russian language support and editing
  147. GUI ~
  148. |gui.txt| Graphical User Interface (GUI)
  149. Interfaces ~
  150. |if_cscop.txt| using Cscope with Vim
  151. |if_perl.txt| Perl interface
  152. |if_pyth.txt| Python interface
  153. |if_ruby.txt| Ruby interface
  154. |sign.txt| debugging signs
  155. Versions ~
  156. |vim_diff.txt| Main differences between Nvim and Vim
  157. |vi_diff.txt| Main differences between Vim and Vi
  158. |deprecated.txt| Deprecated items that have been or will be removed
  159. Other ~
  160. |terminal_emulator.txt| Terminal buffers
  161. |term.txt| Terminal UI
  162. |ui.txt| Nvim UI protocol
  163. |channel.txt| Nvim asynchronous IO
  164. |dev_style.txt| Nvim style guide
  165. |job_control.txt| Spawn and control multiple processes
  166. |luaref.txt| Lua reference manual
  167. |luvref.txt| Luv (|vim.loop|) reference manual
  168. *standard-plugin-list*
  169. Standard plugins ~
  170. |matchit.txt| Extended |%| matching
  171. |pi_gzip.txt| Reading and writing compressed files
  172. |pi_health.txt| Healthcheck framework
  173. |pi_msgpack.txt| msgpack utilities
  174. |pi_netrw.txt| Reading and writing files over a network
  175. |pi_paren.txt| Highlight matching parens
  176. |pi_spec.txt| Filetype plugin to work with rpm spec files
  177. |pi_tar.txt| Tar file explorer
  178. |pi_zip.txt| Zip archive explorer
  179. LOCAL ADDITIONS: *local-additions*
  180. ------------------------------------------------------------------------------
  181. *bars* Bars example
  182. Now that you've jumped here with CTRL-] or a double mouse click, you can use
  183. CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were.
  184. Note that tags are within | characters, but when highlighting is enabled these
  185. characters are hidden. That makes it easier to read a command.
  186. Anyway, you can use CTRL-] on any word, also when it is not within |, and Vim
  187. will try to find help for it. Especially for options in single quotes, e.g.
  188. 'hlsearch'.
  189. ------------------------------------------------------------------------------
  190. vim:tw=78:isk=!-~,^*,^\|,^\":ts=8:noet:ft=help:norl: