help.txt 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  1. *help.txt* Nvim
  2. NVIM - help
  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. NVIM DOCUMENTATION
  35. ------------------------------------------------------------------------------
  36. ABOUT NVIM *reference_toc* *doc-file-list* *Q_ct*
  37. |news| News since the previous release
  38. |nvim| Transitioning from Vim
  39. |vim-differences| Nvim compared to Vim
  40. |faq| Frequently Asked Questions
  41. |user-manual| User manual: How to accomplish editing tasks.
  42. |quickref| Overview of common commands
  43. |tutor| 30-minute interactive course for beginners
  44. |copying| About copyrights
  45. |iccf| Helping poor children in Uganda
  46. |sponsor| Sponsor Vim development, become a registered Vim user
  47. |www| Vim on the World Wide Web
  48. |bugs| Where to send bug reports
  49. |support| Supported platforms
  50. ------------------------------------------------------------------------------
  51. GENERAL
  52. |intro| Introduction to Vim; notation used in help files
  53. |helphelp| Using the :help files
  54. |index| Index of all commands
  55. |tips| Various tips on using Vim
  56. |message.txt| (Error) messages and explanations
  57. |uganda.txt| Vim distribution and what to do with your money
  58. ------------------------------------------------------------------------------
  59. BASIC EDITING
  60. |starting| Starting Vim, Vim command arguments, initialisation
  61. |edit-files| Editing and writing files
  62. |motion.txt| Commands for moving around
  63. |scrolling| Scrolling the text in the window
  64. |insert.txt| Insert and Replace mode
  65. |change.txt| Deleting and replacing text
  66. |undo-redo| Undo and Redo
  67. |repeat.txt| Repeating commands, Vim scripts and debugging
  68. |visual-mode| Using Visual mode (selecting text)
  69. |various| Various other commands
  70. |crash-recovery| Recovering from a crash
  71. ------------------------------------------------------------------------------
  72. ADVANCED EDITING
  73. |cmdline| Command-line editing
  74. |options| Description of all options
  75. |pattern-searches| Vim regexp patterns and search commands
  76. |key-mapping| Key mapping (shortcuts), abbreviations
  77. |tags| Tags and special searches
  78. |windows| Commands for using windows and buffers
  79. |tabpage| Commands for using tabpages
  80. |spell| Spell checking
  81. |diff| Comparing files
  82. |folding| Hide (fold) ranges of lines
  83. |terminal| Embedded terminal emulator
  84. ------------------------------------------------------------------------------
  85. API (EXTENSIBILITY/SCRIPTING/PLUGINS)
  86. |api| Nvim API via RPC, Lua and Vimscript
  87. |ui| Nvim UI protocol
  88. |lua-guide| Nvim Lua guide
  89. |lua| Lua API
  90. |luaref| Lua reference manual
  91. |luvref| Luv (|vim.uv|) reference manual
  92. |autocmd| Event handlers
  93. |job-control| Spawn and control multiple processes
  94. |channel| Nvim asynchronous IO
  95. |vimscript| Vimscript reference
  96. |vimscript-functions| Vimscript functions
  97. |testing.txt| Vimscript testing functions
  98. |remote-plugin| Nvim remote plugins
  99. |health| Health checking
  100. ------------------------------------------------------------------------------
  101. PROGRAMMING LANGUAGE SUPPORT
  102. |lsp| Language Server Protocol (LSP)
  103. |diagnostic-api| Diagnostic framework
  104. |treesitter| Incremental syntax parsing
  105. |indent.txt| automatic indenting for C and other languages
  106. |syntax| syntax highlighting
  107. |filetype| Settings for specific types of files
  108. |quickfix| Commands for a quick edit-compile-fix cycle
  109. |ft_ada.txt| Ada filetype plugin
  110. |ft_hare.txt| Filetype plugin for Hare
  111. |ft_ps1.txt| PowerShell filetype plugin
  112. |ft_raku.txt| Raku filetype plugin
  113. |ft_rust.txt| Rust filetype plugin
  114. |ft_sql.txt| SQL filetype plugin
  115. ------------------------------------------------------------------------------
  116. UI
  117. |tui| Builtin UI
  118. |gui| External (graphical) UIs
  119. |signs| Signs displayed as window decorations (the "gutter")
  120. ------------------------------------------------------------------------------
  121. LANGUAGE SUPPORT
  122. |digraph| List of available digraphs
  123. |mbyte.txt| Multibyte text support
  124. |mlang.txt| Non-English language support
  125. |rileft.txt| Right-to-left editing mode
  126. |arabic.txt| Arabic language support and editing
  127. |hebrew.txt| Hebrew language support and editing
  128. |russian.txt| Russian language support and editing
  129. |vietnamese.txt| Vietnamese language support and editing
  130. ------------------------------------------------------------------------------
  131. INTEROP
  132. |provider| Builtin remote plugin hosts
  133. |if_perl| Perl interface
  134. |if_pyth| Python interface
  135. |if_ruby| Ruby interface
  136. ------------------------------------------------------------------------------
  137. VERSIONS
  138. |deprecated| Deprecated features that will be removed
  139. |vi-differences| Differences between Vim and Vi
  140. ------------------------------------------------------------------------------
  141. DEVELOPING NVIM
  142. |dev| Development of Nvim
  143. |dev-arch| Internal architecture, modules, data structures
  144. |dev-style| Development style guidelines
  145. |dev-theme| Design guidelines (colorschemes etc.)
  146. |dev-tools| Tools and techniques for developing Nvim
  147. |dev-vimpatch| Merging patches from Vim
  148. Standard plugins ~
  149. *standard-plugin-list*
  150. |pi_gzip.txt| Reading and writing compressed files
  151. |pi_msgpack.txt| msgpack utilities
  152. |pi_netrw.txt| Reading and writing files over a network
  153. |pi_paren.txt| Highlight matching parens
  154. |pi_spec.txt| Filetype plugin to work with rpm spec files
  155. |pi_tar.txt| Tar file explorer
  156. |pi_zip.txt| Zip archive explorer
  157. Local additions ~
  158. *local-additions*
  159. ------------------------------------------------------------------------------
  160. Bars example *bars*
  161. Now that you've jumped here with CTRL-] or a double mouse click, you can use
  162. CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were.
  163. Note that tags are within | characters, but when highlighting is enabled these
  164. characters are hidden. That makes it easier to read a command.
  165. You can use CTRL-] on any word (even if it is not within "|") and Nvim will
  166. try to find help for it. Especially for options in single quotes, e.g.
  167. 'hlsearch'.
  168. vim:tw=78:isk=!-~,^*,^\|,^\":ts=8:noet:ft=help:norl: