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