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