vim

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

usr_toc.txt (9949B)


      1 *usr_toc.txt*	For Vim version 9.2.  Last change: 2026 Feb 14
      2 
      3 
      4 		     VIM USER MANUAL	by Bram Moolenaar
      5 
      6 
      7 			      Table Of Contents		*user-manual* *usr*
      8 
      9 ==============================================================================
     10 Overview ~
     11 
     12 Getting Started ~
     13 |usr_01.txt|  About the manuals
     14 |usr_02.txt|  The first steps in Vim
     15 |usr_03.txt|  Moving around
     16 |usr_04.txt|  Making small changes
     17 |usr_05.txt|  Set your settings
     18 |usr_06.txt|  Using syntax highlighting
     19 |usr_07.txt|  Editing more than one file
     20 |usr_08.txt|  Splitting windows
     21 |usr_09.txt|  Using the GUI
     22 |usr_10.txt|  Making big changes
     23 |usr_11.txt|  Recovering from a crash
     24 |usr_12.txt|  Clever tricks
     25 
     26 Editing Effectively ~
     27 |usr_20.txt|  Typing command-line commands quickly
     28 |usr_21.txt|  Go away and come back
     29 |usr_22.txt|  Finding the file to edit
     30 |usr_23.txt|  Editing other files
     31 |usr_24.txt|  Inserting quickly
     32 |usr_25.txt|  Editing formatted text
     33 |usr_26.txt|  Repeating
     34 |usr_27.txt|  Search commands and patterns
     35 |usr_28.txt|  Folding
     36 |usr_29.txt|  Moving through programs
     37 |usr_30.txt|  Editing programs
     38 |usr_31.txt|  Exploiting the GUI
     39 |usr_32.txt|  The undo tree
     40 
     41 Tuning Vim ~
     42 |usr_40.txt|  Make new commands
     43 |usr_41.txt|  Write a Vim script
     44 |usr_42.txt|  Add new menus
     45 |usr_43.txt|  Using filetypes
     46 |usr_44.txt|  Your own syntax highlighted
     47 |usr_45.txt|  Select your language (locale)
     48 
     49 Writing Vim script ~
     50 |usr_50.txt|  Advanced Vim script writing
     51 |usr_51.txt|  Write plugins
     52 |usr_52.txt|  Write larger plugins
     53 
     54 Making Vim Run ~
     55 |usr_90.txt|  Installing Vim
     56 
     57 
     58 Reference manual ~
     59 |reference_toc|     More detailed information for all commands
     60 
     61 The user manual (an older version) is available as a single, ready to print
     62 HTML and PDF file here:
     63 	http://vimdoc.sf.net
     64 
     65 ==============================================================================
     66 Getting Started ~
     67 
     68 Read this from start to end to learn the essential commands.
     69 
     70 |usr_01.txt|  About the manuals
     71 		|01.1|	Two manuals
     72 		|01.2|	Vim installed
     73 		|01.3|	Using the Vim tutor
     74 		|01.4|	Copyright
     75 
     76 |usr_02.txt|  The first steps in Vim
     77 		|02.1|	Running Vim for the First Time
     78 		|02.2|	Inserting text
     79 		|02.3|	Moving around
     80 		|02.4|	Deleting characters
     81 		|02.5|	Undo and Redo
     82 		|02.6|	Other editing commands
     83 		|02.7|	Getting out
     84 		|02.8|	Finding help
     85 
     86 |usr_03.txt|  Moving around
     87 		|03.1|	Word movement
     88 		|03.2|	Moving to the start or end of a line
     89 		|03.3|	Moving to a character
     90 		|03.4|	Matching a paren
     91 		|03.5|	Moving to a specific line
     92 		|03.6|	Telling where you are
     93 		|03.7|	Scrolling around
     94 		|03.8|	Simple searches
     95 		|03.9|	Simple search patterns
     96 		|03.10|	Using marks
     97 
     98 |usr_04.txt|  Making small changes
     99 		|04.1|	Operators and motions
    100 		|04.2|	Changing text
    101 		|04.3|	Repeating a change
    102 		|04.4|	Visual mode
    103 		|04.5|	Moving text
    104 		|04.6|	Copying text
    105 		|04.7|	Using the clipboard
    106 		|04.8|	Text objects
    107 		|04.9|	Replace mode
    108 		|04.10|	Conclusion
    109 
    110 |usr_05.txt|  Set your settings
    111 		|05.1|	The vimrc file
    112 		|05.2|	The example vimrc file explained
    113 		|05.3|	The defaults.vim file explained
    114 		|05.4|	Simple mappings
    115 		|05.5|	Adding a package
    116 		|05.6|	Adding a plugin
    117 		|05.7|	Adding a help file
    118 		|05.8|	The option window
    119 		|05.9|	Often used options
    120 
    121 |usr_06.txt|  Using syntax highlighting
    122 		|06.1|	Switching it on
    123 		|06.2|	No or wrong colors?
    124 		|06.3|	Different colors
    125 		|06.4|	With colors or without colors
    126 		|06.5|	Printing with colors
    127 		|06.6|	Further reading
    128 
    129 |usr_07.txt|  Editing more than one file
    130 		|07.1|	Edit another file
    131 		|07.2|	A list of files
    132 		|07.3|	Jumping from file to file
    133 		|07.4|	Backup files
    134 		|07.5|	Copy text between files
    135 		|07.6|	Viewing a file
    136 		|07.7|	Changing the file name
    137 
    138 |usr_08.txt|  Splitting windows
    139 		|08.1|	Split a window
    140 		|08.2|	Split a window on another file
    141 		|08.3|	Window size
    142 		|08.4|	Vertical splits
    143 		|08.5|	Moving windows
    144 		|08.6|	Commands for all windows
    145 		|08.7|	Viewing differences with vimdiff
    146 		|08.8|	Various
    147 
    148 |usr_09.txt|  Using the GUI
    149 		|09.1|	Parts of the GUI
    150 		|09.2|	Using the mouse
    151 		|09.3|	The clipboard
    152 		|09.4|	Select mode
    153 
    154 |usr_10.txt|  Making big changes
    155 		|10.1|	Record and playback commands
    156 		|10.2|	Substitution
    157 		|10.3|	Command ranges
    158 		|10.4|	The global command
    159 		|10.5|	Visual block mode
    160 		|10.6|	Reading and writing part of a file
    161 		|10.7|	Formatting text
    162 		|10.8|	Changing case
    163 		|10.9|	Using an external program
    164 
    165 |usr_11.txt|  Recovering from a crash
    166 		|11.1|	Basic recovery
    167 		|11.2|	Where is the swap file?
    168 		|11.3|	Crashed or not?
    169 		|11.4|	Further reading
    170 
    171 |usr_12.txt|  Clever tricks
    172 		|12.1|	Replace a word
    173 		|12.2|	Change "Last, First" to "First Last"
    174 		|12.3|	Sort a list
    175 		|12.4|	Reverse line order
    176 		|12.5|	Count words
    177 		|12.6|	Find a man page
    178 		|12.7|	Trim blanks
    179 		|12.8|	Find where a word is used
    180 
    181 ==============================================================================
    182 Editing Effectively ~
    183 
    184 Subjects that can be read independently.
    185 
    186 |usr_20.txt|  Typing command-line commands quickly
    187 		|20.1|	Command line editing
    188 		|20.2|	Command line abbreviations
    189 		|20.3|	Command line completion
    190 		|20.4|	Command line history
    191 		|20.5|	Command line window
    192 
    193 |usr_21.txt|  Go away and come back
    194 		|21.1|	Suspend and resume
    195 		|21.2|	Executing shell commands
    196 		|21.3|	Remembering information; viminfo
    197 		|21.4|	Sessions
    198 		|21.5|	Views
    199 		|21.6|	Modelines
    200 
    201 |usr_22.txt|  Finding the file to edit
    202 		|22.1|	The file explorer
    203 		|22.2|	The current directory
    204 		|22.3|	Finding a file
    205 		|22.4|	The buffer list
    206 
    207 |usr_23.txt|  Editing other files
    208 		|23.1|	DOS, Mac and Unix files
    209 		|23.2|	Files on the internet
    210 		|23.3|	Encryption
    211 		|23.4|	Binary files
    212 		|23.5|	Compressed files
    213 
    214 |usr_24.txt|  Inserting quickly
    215 		|24.1|	Making corrections
    216 		|24.2|	Showing matches
    217 		|24.3|	Completion
    218 		|24.4|	Repeating an insert
    219 		|24.5|	Copying from another line
    220 		|24.6|	Inserting a register
    221 		|24.7|	Abbreviations
    222 		|24.8|	Entering special characters
    223 		|24.9|	Digraphs
    224 		|24.10|	Normal mode commands
    225 
    226 |usr_25.txt|  Editing formatted text
    227 		|25.1|	Breaking lines
    228 		|25.2|	Aligning text
    229 		|25.3|	Indents and tabs
    230 		|25.4|	Dealing with long lines
    231 		|25.5|	Editing tables
    232 
    233 |usr_26.txt|  Repeating
    234 		|26.1|	Repeating with Visual mode
    235 		|26.2|	Add and subtract
    236 		|26.3|	Making a change in many files
    237 		|26.4|	Using Vim from a shell script
    238 
    239 |usr_27.txt|  Search commands and patterns
    240 		|27.1|	Ignoring case
    241 		|27.2|	Wrapping around the file end
    242 		|27.3|	Offsets
    243 		|27.4|	Matching multiple times
    244 		|27.5|	Alternatives
    245 		|27.6|	Character ranges
    246 		|27.7|	Character classes
    247 		|27.8|	Matching a line break
    248 		|27.9|	Examples
    249 
    250 |usr_28.txt|  Folding
    251 		|28.1|	What is folding?
    252 		|28.2|	Manual folding
    253 		|28.3|	Working with folds
    254 		|28.4|	Saving and restoring folds
    255 		|28.5|	Folding by indent
    256 		|28.6|	Folding with markers
    257 		|28.7|	Folding by syntax
    258 		|28.8|	Folding by expression
    259 		|28.9|	Folding unchanged lines
    260 		|28.10|	Which fold method to use?
    261 
    262 |usr_29.txt|  Moving through programs
    263 		|29.1|	Using tags
    264 		|29.2|	The preview window
    265 		|29.3|	Moving through a program
    266 		|29.4|	Finding global identifiers
    267 		|29.5|	Finding local identifiers
    268 
    269 |usr_30.txt|  Editing programs
    270 		|30.1|	Compiling
    271 		|30.2|	Indenting C files
    272 		|30.3|	Automatic indenting
    273 		|30.4|	Other indenting
    274 		|30.5|	Tabs and spaces
    275 		|30.6|	Formatting comments
    276 
    277 |usr_31.txt|  Exploiting the GUI
    278 		|31.1|	The file browser
    279 		|31.2|	Confirmation
    280 		|31.3|	Menu shortcuts
    281 		|31.4|	Vim window position and size
    282 		|31.5|	Various
    283 
    284 |usr_32.txt|  The undo tree
    285 		|32.1|	Undo up to a file write
    286 		|32.2|	Numbering changes
    287 		|32.3|	Jumping around the tree
    288 		|32.4|	Time travelling
    289 
    290 ==============================================================================
    291 Tuning Vim ~
    292 
    293 Make Vim work as you like it.
    294 
    295 |usr_40.txt|  Make new commands
    296 		|40.1|	Key mapping
    297 		|40.2|	Defining command-line commands
    298 		|40.3|	Autocommands
    299 
    300 |usr_41.txt|  Write a Vim script
    301 		|41.1|	Introduction
    302 		|41.2|	Variables
    303 		|41.3|	Expressions
    304 		|41.4|	Conditionals
    305 		|41.5|	Executing an expression
    306 		|41.6|	Using functions
    307 		|41.7|	Defining a function
    308 		|41.8|	Lists and Dictionaries
    309 		|41.9|	White space
    310 		|41.10|	Line continuation
    311 		|41.11|	Comments
    312 		|41.12|	Fileformat
    313 
    314 |usr_42.txt|  Add new menus
    315 		|42.1|	Introduction
    316 		|42.2|	Menu commands
    317 		|42.3|	Various
    318 		|42.4|	Toolbar and popup menus
    319 
    320 |usr_43.txt|  Using filetypes
    321 		|43.1|	Plugins for a filetype
    322 		|43.2|	Adding a filetype
    323 
    324 |usr_44.txt|  Your own syntax highlighted
    325 		|44.1|	Basic syntax commands
    326 		|44.2|	Keywords
    327 		|44.3|	Matches
    328 		|44.4|	Regions
    329 		|44.5|	Nested items
    330 		|44.6|	Following groups
    331 		|44.7|	Other arguments
    332 		|44.8|	Clusters
    333 		|44.9|	Including another syntax file
    334 		|44.10|	Synchronizing
    335 		|44.11|	Installing a syntax file
    336 		|44.12|	Portable syntax file layout
    337 
    338 |usr_45.txt|  Select your language (locale)
    339 		|45.1|	Language for Messages
    340 		|45.2|	Language for Menus
    341 		|45.3|	Using another encoding
    342 		|45.4|	Editing files with a different encoding
    343 		|45.5|	Entering language text
    344 
    345 ==============================================================================
    346 Writing Vim script ~
    347 
    348 |usr_50.txt|  Advanced Vim script writing
    349 		|50.1|	Exceptions
    350 		|50.2|	Function with variable number of arguments
    351 		|50.3|	Restoring the view
    352 
    353 |usr_51.txt|  Write plugins
    354 		|51.1|	Writing a generic plugin
    355 		|51.2|	Writing a filetype plugin
    356 		|51.3|	Writing a compiler plugin
    357 		|51.4|	Distributing Vim scripts
    358 
    359 |usr_52.txt|  Write larger plugins
    360 		|52.1|	Export and import
    361 		|52.2|	Autoloading
    362 		|52.3|	Autoloading without import/export
    363 		|52.4|	Other mechanisms to use
    364 		|52.5|	Using a Vim9 script from legacy script
    365 		|52.6|	Vim9 examples: comment and highlight-yank plugin
    366 
    367 ==============================================================================
    368 Making Vim Run ~
    369 
    370 Before you can use Vim.
    371 
    372 |usr_90.txt|  Installing Vim
    373 		|90.1|	Unix
    374 		|90.2|	MS-Windows
    375 		|90.3|	Upgrading
    376 		|90.4|	Common installation issues
    377 		|90.5|	Uninstalling Vim
    378 
    379 ==============================================================================
    380 
    381 Copyright: see |manual-copyright|  vim:tw=78:ts=8:noet:ft=help:norl: