vim

Fork of vim, an acceptable text editor
git clone git://git.laack.co/vim.git
Log | Files | Refs | README | LICENSE

help.txt (9700B)


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