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