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