help.txt 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. *help.txt* For Vim version 9.0. Last change: 2022 Dec 03
  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: ":set mouse=a" to enable the mouse (in xterm or GUI).
  10. Double-click the left mouse button on a tag, e.g. |bars|.
  11. Jump back: Type CTRL-O. Repeat to go further back.
  12. Get specific help: It is possible to go directly to whatever you want help
  13. on, by giving an argument to the |:help| command.
  14. Prepend something to specify the context: *help-context*
  15. WHAT PREPEND EXAMPLE ~
  16. Normal mode command :help x
  17. Visual mode command v_ :help v_u
  18. Insert mode command i_ :help i_<Esc>
  19. Command-line command : :help :quit
  20. Command-line editing c_ :help c_<Del>
  21. Vim command argument - :help -r
  22. Option ' :help 'textwidth'
  23. Regular expression / :help /[
  24. See |help-summary| for more contexts and an explanation.
  25. See |notation| for an explanation of the help syntax.
  26. Search for help: Type ":help word", then hit CTRL-D to see matching
  27. help entries for "word".
  28. Or use ":helpgrep word". |:helpgrep|
  29. Getting started: Do the Vim tutor, a 30-minute interactive course for the
  30. basic commands, see |vimtutor|.
  31. Read the user manual from start to end: |usr_01.txt|
  32. Vim stands for Vi IMproved. Most of Vim was made by Bram Moolenaar, but only
  33. through the help of many others. See |credits|.
  34. ------------------------------------------------------------------------------
  35. *doc-file-list* *Q_ct*
  36. BASIC:
  37. |quickref| Overview of the most common commands you will use
  38. |tutor| 30-minute interactive course for beginners
  39. |copying| About copyrights
  40. |iccf| Helping poor children in Uganda
  41. |sponsor| Sponsor Vim development, become a registered Vim user
  42. |www| Vim on the World Wide Web
  43. |bugs| Where to send bug reports
  44. USER MANUAL: These files explain how to accomplish an editing task.
  45. |usr_toc.txt| Table Of Contents
  46. Getting Started ~
  47. |usr_01.txt| About the manuals
  48. |usr_02.txt| The first steps in Vim
  49. |usr_03.txt| Moving around
  50. |usr_04.txt| Making small changes
  51. |usr_05.txt| Set your settings
  52. |usr_06.txt| Using syntax highlighting
  53. |usr_07.txt| Editing more than one file
  54. |usr_08.txt| Splitting windows
  55. |usr_09.txt| Using the GUI
  56. |usr_10.txt| Making big changes
  57. |usr_11.txt| Recovering from a crash
  58. |usr_12.txt| Clever tricks
  59. Editing Effectively ~
  60. |usr_20.txt| Typing command-line commands quickly
  61. |usr_21.txt| Go away and come back
  62. |usr_22.txt| Finding the file to edit
  63. |usr_23.txt| Editing other files
  64. |usr_24.txt| Inserting quickly
  65. |usr_25.txt| Editing formatted text
  66. |usr_26.txt| Repeating
  67. |usr_27.txt| Search commands and patterns
  68. |usr_28.txt| Folding
  69. |usr_29.txt| Moving through programs
  70. |usr_30.txt| Editing programs
  71. |usr_31.txt| Exploiting the GUI
  72. |usr_32.txt| The undo tree
  73. Tuning Vim ~
  74. |usr_40.txt| Make new commands
  75. |usr_41.txt| Write a Vim script
  76. |usr_42.txt| Add new menus
  77. |usr_43.txt| Using filetypes
  78. |usr_44.txt| Your own syntax highlighted
  79. |usr_45.txt| Select your language
  80. Writing Vim scripts ~
  81. |usr_50.txt| Advanced Vim script writing
  82. |usr_51.txt| Create a plugin
  83. |usr_52.txt| Write plugins using Vim9 script
  84. Making Vim Run ~
  85. |usr_90.txt| Installing Vim
  86. REFERENCE MANUAL: These files explain every detail of Vim. *reference_toc*
  87. General subjects ~
  88. |intro.txt| general introduction to Vim; notation used in help files
  89. |help.txt| overview and quick reference (this file)
  90. |helphelp.txt| about using the help files
  91. |index.txt| alphabetical index of all commands
  92. |help-tags| all the tags you can jump to (index of tags)
  93. |howto.txt| how to do the most common editing tasks
  94. |tips.txt| various tips on using Vim
  95. |message.txt| (error) messages and explanations
  96. |quotes.txt| remarks from users of Vim
  97. |todo.txt| known problems and desired extensions
  98. |develop.txt| development of Vim
  99. |debug.txt| debugging Vim itself
  100. |uganda.txt| Vim distribution conditions and what to do with your money
  101. Basic editing ~
  102. |starting.txt| starting Vim, Vim command arguments, initialisation
  103. |editing.txt| editing and writing files
  104. |motion.txt| commands for moving around
  105. |scroll.txt| scrolling the text in the window
  106. |insert.txt| Insert and Replace mode
  107. |change.txt| deleting and replacing text
  108. |undo.txt| Undo and Redo
  109. |repeat.txt| repeating commands, Vim scripts and debugging
  110. |visual.txt| using the Visual mode (selecting a text area)
  111. |various.txt| various remaining commands
  112. |recover.txt| recovering from a crash
  113. Advanced editing ~
  114. |cmdline.txt| Command-line editing
  115. |options.txt| description of all options
  116. |pattern.txt| regexp patterns and search commands
  117. |map.txt| key mapping and abbreviations
  118. |tagsrch.txt| tags and special searches
  119. |windows.txt| commands for using multiple windows and buffers
  120. |tabpage.txt| commands for using multiple tab pages
  121. |spell.txt| spell checking
  122. |diff.txt| working with two to eight versions of the same file
  123. |autocmd.txt| automatically executing commands on an event
  124. |eval.txt| expression evaluation, conditional commands
  125. |builtin.txt| builtin functions
  126. |userfunc.txt| defining user functions
  127. |channel.txt| Jobs, Channels, inter-process communication
  128. |fold.txt| hide (fold) ranges of lines
  129. Special issues ~
  130. |testing.txt| testing Vim and Vim scripts
  131. |print.txt| printing
  132. |remote.txt| using Vim as a server or client
  133. |term.txt| using different terminals and mice
  134. |terminal.txt| Terminal window support
  135. |popup.txt| popup window support
  136. |vim9.txt| using Vim9 script
  137. |vim9class.txt| using Vim9 script classes
  138. Programming language support ~
  139. |indent.txt| automatic indenting for C and other languages
  140. |syntax.txt| syntax highlighting
  141. |textprop.txt| Attaching properties to text for highlighting or other
  142. |filetype.txt| settings done specifically for a type of file
  143. |quickfix.txt| commands for a quick edit-compile-fix cycle
  144. |ft_ada.txt| Ada (the programming language) support
  145. |ft_context.txt| Filetype plugin for ConTeXt
  146. |ft_mp.txt| Filetype plugin for METAFONT and MetaPost
  147. |ft_ps1.txt| Filetype plugin for Windows PowerShell
  148. |ft_raku.txt| Filetype plugin for Raku
  149. |ft_rust.txt| Filetype plugin for Rust
  150. |ft_sql.txt| about the SQL filetype plugin
  151. Language support ~
  152. |digraph.txt| list of available digraphs
  153. |mbyte.txt| multibyte text support
  154. |mlang.txt| non-English language support
  155. |rileft.txt| right-to-left editing mode
  156. |arabic.txt| Arabic language support and editing
  157. |farsi.txt| Farsi (Persian) editing
  158. |hebrew.txt| Hebrew language support and editing
  159. |russian.txt| Russian language support and editing
  160. |hangulin.txt| Hangul (Korean) input mode
  161. GUI ~
  162. |gui.txt| Graphical User Interface (GUI)
  163. |gui_w32.txt| Win32 GUI
  164. |gui_x11.txt| X11 GUI
  165. Interfaces ~
  166. |if_cscop.txt| using Cscope with Vim
  167. |if_lua.txt| Lua interface
  168. |if_mzsch.txt| MzScheme interface
  169. |if_perl.txt| Perl interface
  170. |if_pyth.txt| Python interface
  171. |if_tcl.txt| Tcl interface
  172. |if_ole.txt| OLE automation interface for Win32
  173. |if_ruby.txt| Ruby interface
  174. |debugger.txt| Interface with a debugger
  175. |netbeans.txt| NetBeans External Editor interface
  176. |sign.txt| debugging signs
  177. Versions ~
  178. |vi_diff.txt| Main differences between Vim and Vi
  179. |version4.txt| Differences between Vim version 3.0 and 4.x
  180. |version5.txt| Differences between Vim version 4.6 and 5.x
  181. |version6.txt| Differences between Vim version 5.7 and 6.x
  182. |version7.txt| Differences between Vim version 6.4 and 7.x
  183. |version8.txt| Differences between Vim version 7.4 and 8.x
  184. |version9.txt| Differences between Vim version 8.2 and 9.0
  185. *sys-file-list*
  186. Remarks about specific systems ~
  187. |os_390.txt| OS/390 Unix
  188. |os_amiga.txt| Amiga
  189. |os_beos.txt| BeOS and BeBox
  190. |os_dos.txt| MS-DOS and MS-Windows common items
  191. |os_haiku.txt| Haiku
  192. |os_mac.txt| Macintosh
  193. |os_mint.txt| Atari MiNT
  194. |os_msdos.txt| MS-DOS (plain DOS and DOS box under Windows)
  195. |os_os2.txt| OS/2
  196. |os_qnx.txt| QNX
  197. |os_risc.txt| RISC-OS
  198. |os_unix.txt| Unix
  199. |os_vms.txt| VMS
  200. |os_win32.txt| MS-Windows
  201. *standard-plugin-list*
  202. Standard plugins ~
  203. |pi_getscript.txt| Downloading latest version of Vim scripts
  204. |pi_gzip.txt| Reading and writing compressed files
  205. |pi_logipat.txt| Logical operators on patterns
  206. |pi_netrw.txt| Reading and writing files over a network
  207. |pi_paren.txt| Highlight matching parens
  208. |pi_spec.txt| Filetype plugin to work with rpm spec files
  209. |pi_tar.txt| Tar file explorer
  210. |pi_vimball.txt| Create a self-installing Vim script
  211. |pi_zip.txt| Zip archive explorer
  212. LOCAL ADDITIONS: *local-additions*
  213. ------------------------------------------------------------------------------
  214. *bars* Bars example
  215. Now that you've jumped here with CTRL-] or a double mouse click, you can use
  216. CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were.
  217. Note that tags are within | characters, but when highlighting is enabled these
  218. characters are hidden. That makes it easier to read a command.
  219. Anyway, you can use CTRL-] on any word, also when it is not within |, and Vim
  220. will try to find help for it. Especially for options in single quotes, e.g.
  221. 'compatible'.
  222. ------------------------------------------------------------------------------
  223. vim:tw=78:isk=!-~,^*,^\|,^\":ts=8:noet:ft=help:norl: