VIM: help

## HELP

    *help.txt*	For Vim version 9.1.  Last change: 2025 Jun 27

    			VIM - main help file
    									 k
          Move around:  Use the cursor keys, or "h" to go left,	       h   l
    		    "j" to go down, "k" to go up, "l" to go right.	 j
    Close this window:  Use ":q<Enter>".
       Get out of Vim:  Use ":qa!<Enter>" (careful, all changes are lost!).

    Jump to a subject:  Position the cursor on a tag (e.g. |bars|) and hit CTRL-].
       With the mouse:  ":set mouse=a" to enable the mouse (in xterm or GUI).
    		    Double-click the left mouse button on a tag, e.g. |bars|.
    	Jump back:  Type CTRL-O.  Repeat to go further back.

    Get specific help:  It is possible to go directly to whatever you want help
    		    on, by giving an argument to the |:help| command.
    		    Prepend something to specify the context:  *help-context*

    			  WHAT			PREPEND    EXAMPLE
    		      Normal mode command		   :help x
    		      Visual mode command	  v_	   :help v_u
    		      Insert mode command	  i_	   :help i_<Esc>
    		      Command-line command	  :	   :help :quit
    		      Command-line editing	  c_	   :help c_<Del>
    		      Vim command argument	  -	   :help -r
    		      Option			  '	   :help 'textwidth'
    		      Regular expression	  /	   :help /[
    		    See |help-summary| for more contexts and an explanation.
    		    See |notation| for an explanation of the help syntax.

      Search for help:  Type ":help word", then hit CTRL-D to see matching
    		    help entries for "word".
    		    Or use ":helpgrep word". |:helpgrep|

      Getting started:  Do the Vim tutor, a 30-minute interactive course for the
    		    basic commands, see |vimtutor|.
    		    Read the user manual from start to end: |usr_01|

    Vim stands for Vi IMproved.  Most of Vim was made by Bram Moolenaar, but only
    through the help of many others.  See |credits|.

    						*doc-file-list* *Q_ct*
    BASIC:
    |quickref|	Overview of the most common commands you will use
    |tutor|		30-minute interactive course for beginners
    |copying|	About copyrights
    |iccf|		Helping poor children in Uganda
    |sponsor|	Sponsor Vim development, become a registered Vim user
    |www|		Vim on the World Wide Web
    |bugs|		Where to send bug reports

    USER MANUAL: These files explain how to accomplish an editing task.

    |usr_toc|	Table Of Contents

    Getting Started
    |usr_01|  About the manuals
    |usr_02|  The first steps in Vim
    |usr_03|  Moving around
    |usr_04|  Making small changes
    |usr_05|  Set your settings
    |usr_06|  Using syntax highlighting
    |usr_07|  Editing more than one file
    |usr_08|  Splitting windows
    |usr_09|  Using the GUI
    |usr_10|  Making big changes
    |usr_11|  Recovering from a crash
    |usr_12|  Clever tricks

    Editing Effectively
    |usr_20|  Typing command-line commands quickly
    |usr_21|  Go away and come back
    |usr_22|  Finding the file to edit
    |usr_23|  Editing other files
    |usr_24|  Inserting quickly
    |usr_25|  Editing formatted text
    |usr_26|  Repeating
    |usr_27|  Search commands and patterns
    |usr_28|  Folding
    |usr_29|  Moving through programs
    |usr_30|  Editing programs
    |usr_31|  Exploiting the GUI
    |usr_32|  The undo tree

    Tuning Vim
    |usr_40|  Make new commands
    |usr_41|  Write a Vim script
    |usr_42|  Add new menus
    |usr_43|  Using filetypes
    |usr_44|  Your own syntax highlighted
    |usr_45|  Select your language

    Writing Vim scripts
    |usr_50|  Advanced Vim script writing
    |usr_51|  Create a plugin
    |usr_52|  Write plugins using Vim9 script

    Making Vim Run
    |usr_90|  Installing Vim

    REFERENCE MANUAL: These files explain every detail of Vim.	*reference_toc*

    General subjects
    |intro|	general introduction to Vim; notation used in help files
    |help|	overview and quick reference (this file)
    |helphelp|	about using the help files
    |index|	alphabetical index of all commands
    |help-tags|	all the tags you can jump to (index of tags)
    |howto|	how to do the most common editing tasks
    |tips|	various tips on using Vim
    |message|	(error) messages and explanations
    |quotes|	remarks from users of Vim
    |todo|	known problems and desired extensions
    |develop|	development of Vim
    |debug|	debugging Vim itself
    |uganda|	Vim distribution conditions and what to do with your money

    Basic editing
    |starting|	starting Vim, Vim command arguments, initialisation
    |editing|	editing and writing files
    |motion|	commands for moving around
    |scroll|	scrolling the text in the window
    |insert|	Insert and Replace mode
    |change|	deleting and replacing text
    |undo|	Undo and Redo
    |repeat|	repeating commands, Vim scripts and debugging
    |visual|	using the Visual mode (selecting a text area)
    |various|	various remaining commands
    |recover|	recovering from a crash

    Advanced editing
    |cmdline|	Command-line editing
    |options|	description of all options
    |pattern|	regexp patterns and search commands
    |map|	key mapping and abbreviations
    |tagsrch|	tags and special searches
    |windows|	commands for using multiple windows and buffers
    |tabpage|	commands for using multiple tab pages
    |spell|	spell checking
    |diff|	working with two to eight versions of the same file
    |autocmd|	automatically executing commands on an event
    |eval|	expression evaluation, conditional commands
    |builtin|	builtin functions
    |userfunc|	defining user functions
    |channel|	Jobs, Channels, inter-process communication
    |fold|	hide (fold) ranges of lines

    Special issues
    |testing|	testing Vim and Vim scripts
    |print|	printing
    |remote|	using Vim as a server or client
    |term|	using different terminals and mice
    |terminal|	Terminal window support
    |popup|	popup window support
    |vim9|	using Vim9 script
    |vim9class|	using Vim9 script classes

    Programming language support
    |indent|	automatic indenting for C and other languages
    |syntax|	syntax highlighting
    |textprop|	Attaching properties to text for highlighting or other
    |filetype|	settings done specifically for a type of file
    |quickfix|	commands for a quick edit-compile-fix cycle
    |ft_ada|	Ada (the programming language) support
    |ft_context|  Filetype plugin for ConTeXt
    |ft_hare|	Filetype plugin for Hare
    |ft_mp|	Filetype plugin for METAFONT and MetaPost
    |ft_ps1|	Filetype plugin for Windows PowerShell
    |ft_raku|	Filetype plugin for Raku
    |ft_rust|	Filetype plugin for Rust
    |ft_sql|	about the SQL filetype plugin

    Language support
    |digraph|	list of available digraphs
    |mbyte|	multibyte text support
    |mlang|	non-English language support
    |rileft|	right-to-left editing mode
    |arabic|	Arabic language support and editing
    |farsi|	Farsi (Persian) editing
    |hebrew|	Hebrew language support and editing
    |russian|	Russian language support and editing
    |hangulin|	Hangul (Korean) input mode
    |vietnamese|  Vietnamese language support and editing

    GUI
    |gui|	Graphical User Interface (GUI)
    |gui_w32|	Win32 GUI
    |gui_x11|	X11 GUI

    System Integration
    |wayland|	Wayland protocol support

    Interfaces
    |if_cscop|	using Cscope with Vim
    |if_lua|	Lua interface
    |if_mzsch|	MzScheme interface
    |if_perl|	Perl interface
    |if_pyth|	Python interface
    |if_tcl|	Tcl interface
    |if_ole|	OLE automation interface for Win32
    |if_ruby|	Ruby interface
    |debugger|	Interface with a debugger
    |netbeans|	NetBeans External Editor interface
    |sign|	debugging signs

    Versions
    |vi_diff|	Main differences between Vim and Vi
    |version4|	Differences between Vim version 3.0 and 4.x
    |version5|	Differences between Vim version 4.6 and 5.x
    |version6|	Differences between Vim version 5.7 and 6.x
    |version7|	Differences between Vim version 6.4 and 7.x
    |version8|	Differences between Vim version 7.4 and 8.x
    |version9|	Differences between Vim version 8.2 and 9.0
    						*sys-file-list*
    Remarks about specific systems
    |os_390|	OS/390 Unix
    |os_amiga|	Amiga
    |os_beos|	BeOS and BeBox
    |os_dos|	MS-DOS and MS-Windows common items
    |os_haiku|	Haiku
    |os_mac|	Macintosh
    |os_mint|	Atari MiNT
    |os_msdos|	MS-DOS (plain DOS and DOS box under Windows)
    |os_os2|	OS/2
    |os_qnx|	QNX
    |os_risc|	RISC-OS
    |os_unix|	Unix
    |os_vms|	VMS
    |os_win32|	MS-Windows
    						*standard-plugin-list*
    Standard plugins
    |pi_getscript| Downloading latest version of Vim scripts
    |pi_gzip|      Reading and writing compressed files
    |pi_logipat|   Logical operators on patterns
    |pi_netrw|     Reading and writing files over a network
    |pi_paren|     Highlight matching parens
    |pi_spec|      Filetype plugin to work with rpm spec files
    |pi_tar|       Tar file explorer
    |pi_tutor|     Interactive tutorial for Vim
    |pi_vimball|   Create a self-installing Vim script
    |pi_zip|       Zip archive explorer

    LOCAL ADDITIONS:				*local-additions*

    *bars*		Bars example

    Now that you've jumped here with CTRL-] or a double mouse click, you can use
    CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were.

    Note that tags are within | characters, but when highlighting is enabled these
    characters are hidden.  That makes it easier to read a command.

    Anyway, you can use CTRL-] on any word, also when it is not within |, and Vim
    will try to find help for it.  Especially for options in single quotes, e.g.
    'compatible'.

     vim:tw=78:isk=!-~,^*,^\|,^\":ts=8:noet:ft=help:norl:

Generated by vim2html on 16.10.2025