vim: update release.sh to vim 7.3
[msysgit/mtrensch.git] / share / vim / vim72 / doc / usr_toc.txt
blob6f5ea487919a16be7cb53442c9c89a754a87b1c6
1 *usr_toc.txt*   For Vim version 7.2.  Last change: 2006 Apr 24
3                      VIM USER MANUAL - by Bram Moolenaar
5                               Table Of Contents                 *user-manual*
7 ==============================================================================
8 Overview ~
10 Getting 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
24 Editing 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 |usr_32.txt|  The undo tree
39 Tuning 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
47 Making Vim Run
48 |usr_90.txt|  Installing Vim
51 Reference manual
52 |reference_toc|     More detailed information for all commands
54 The user manual is available as a single, ready to print HTML and PDF file
55 here:
56         http://vimdoc.sf.net
58 ==============================================================================
59 Getting Started ~
61 Read this from start to end to learn the essential commands.
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
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
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
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
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
107                 |05.4|  Adding a plugin
108                 |05.5|  Adding a help file
109                 |05.6|  The option window
110                 |05.7|  Often used options
112 |usr_06.txt|  Using syntax highlighting
113                 |06.1|  Switching it on
114                 |06.2|  No or wrong colors?
115                 |06.3|  Different colors
116                 |06.4|  With colors or without colors
117                 |06.5|  Printing with colors
118                 |06.6|  Further reading
120 |usr_07.txt|  Editing more than one file
121                 |07.1|  Edit another file
122                 |07.2|  A list of files
123                 |07.3|  Jumping from file to file
124                 |07.4|  Backup files
125                 |07.5|  Copy text between files
126                 |07.6|  Viewing a file
127                 |07.7|  Changing the file name
129 |usr_08.txt|  Splitting windows
130                 |08.1|  Split a window
131                 |08.2|  Split a window on another file
132                 |08.3|  Window size
133                 |08.4|  Vertical splits
134                 |08.5|  Moving windows
135                 |08.6|  Commands for all windows
136                 |08.7|  Viewing differences with vimdiff
137                 |08.8|  Various
139 |usr_09.txt|  Using the GUI
140                 |09.1|  Parts of the GUI
141                 |09.2|  Using the mouse
142                 |09.3|  The clipboard
143                 |09.4|  Select mode
145 |usr_10.txt|  Making big changes
146                 |10.1|  Record and playback commands
147                 |10.2|  Substitution
148                 |10.3|  Command ranges
149                 |10.4|  The global command
150                 |10.5|  Visual block mode
151                 |10.6|  Reading and writing part of a file
152                 |10.7|  Formatting text
153                 |10.8|  Changing case
154                 |10.9|  Using an external program
156 |usr_11.txt|  Recovering from a crash
157                 |11.1|  Basic recovery
158                 |11.2|  Where is the swap file?
159                 |11.3|  Crashed or not?
160                 |11.4|  Further reading
162 |usr_12.txt|  Clever tricks
163                 |12.1|  Replace a word
164                 |12.2|  Change "Last, First" to "First Last"
165                 |12.3|  Sort a list
166                 |12.4|  Reverse line order
167                 |12.5|  Count words
168                 |12.6|  Find a man page
169                 |12.7|  Trim blanks
170                 |12.8|  Find where a word is used
172 ==============================================================================
173 Editing Effectively ~
175 Subjects that can be read independently.
177 |usr_20.txt|  Typing command-line commands quickly
178                 |20.1|  Command line editing
179                 |20.2|  Command line abbreviations
180                 |20.3|  Command line completion
181                 |20.4|  Command line history
182                 |20.5|  Command line window
184 |usr_21.txt|  Go away and come back
185                 |21.1|  Suspend and resume
186                 |21.2|  Executing shell commands
187                 |21.3|  Remembering information; viminfo
188                 |21.4|  Sessions
189                 |21.5|  Views
190                 |21.6|  Modelines
192 |usr_22.txt|  Finding the file to edit
193                 |22.1|  The file explorer
194                 |22.2|  The current directory
195                 |22.3|  Finding a file
196                 |22.4|  The buffer list
198 |usr_23.txt|  Editing other files
199                 |23.1|  DOS, Mac and Unix files
200                 |23.2|  Files on the internet
201                 |23.3|  Encryption
202                 |23.4|  Binary files
203                 |23.5|  Compressed files
205 |usr_24.txt|  Inserting quickly
206                 |24.1|  Making corrections
207                 |24.2|  Showing matches
208                 |24.3|  Completion
209                 |24.4|  Repeating an insert
210                 |24.5|  Copying from another line
211                 |24.6|  Inserting a register
212                 |24.7|  Abbreviations
213                 |24.8|  Entering special characters
214                 |24.9|  Digraphs
215                 |24.10| Normal mode commands
217 |usr_25.txt|  Editing formatted text
218                 |25.1|  Breaking lines
219                 |25.2|  Aligning text
220                 |25.3|  Indents and tabs
221                 |25.4|  Dealing with long lines
222                 |25.5|  Editing tables
224 |usr_26.txt|  Repeating
225                 |26.1|  Repeating with Visual mode
226                 |26.2|  Add and subtract
227                 |26.3|  Making a change in many files
228                 |26.4|  Using Vim from a shell script
230 |usr_27.txt|  Search commands and patterns
231                 |27.1|  Ignoring case
232                 |27.2|  Wrapping around the file end
233                 |27.3|  Offsets
234                 |27.4|  Matching multiple times
235                 |27.5|  Alternatives
236                 |27.6|  Character ranges
237                 |27.7|  Character classes
238                 |27.8|  Matching a line break
239                 |27.9|  Examples
241 |usr_28.txt|  Folding
242                 |28.1|  What is folding?
243                 |28.2|  Manual folding
244                 |28.3|  Working with folds
245                 |28.4|  Saving and restoring folds
246                 |28.5|  Folding by indent
247                 |28.6|  Folding with markers
248                 |28.7|  Folding by syntax
249                 |28.8|  Folding by expression
250                 |28.9|  Folding unchanged lines
251                 |28.10| Which fold method to use?
253 |usr_29.txt|  Moving through programs
254                 |29.1|  Using tags
255                 |29.2|  The preview window
256                 |29.3|  Moving through a program
257                 |29.4|  Finding global identifiers
258                 |29.5|  Finding local identifiers
260 |usr_30.txt|  Editing programs
261                 |30.1|  Compiling
262                 |30.2|  Indenting C files
263                 |30.3|  Automatic indenting
264                 |30.4|  Other indenting
265                 |30.5|  Tabs and spaces
266                 |30.6|  Formatting comments
268 |usr_31.txt|  Exploiting the GUI
269                 |31.1|  The file browser
270                 |31.2|  Confirmation
271                 |31.3|  Menu shortcuts
272                 |31.4|  Vim window position and size
273                 |31.5|  Various
275 |usr_32.txt|  The undo tree
276                 |32.1|  Numbering changes
277                 |32.2|  Jumping around the tree
278                 |32.3|  Time travelling
280 ==============================================================================
281 Tuning Vim ~
283 Make Vim work as you like it.
285 |usr_40.txt|  Make new commands
286                 |40.1|  Key mapping
287                 |40.2|  Defining command-line commands
288                 |40.3|  Autocommands
290 |usr_41.txt|  Write a Vim script
291                 |41.1|  Introduction
292                 |41.2|  Variables
293                 |41.3|  Expressions
294                 |41.4|  Conditionals
295                 |41.5|  Executing an expression
296                 |41.6|  Using functions
297                 |41.7|  Defining a function
298                 |41.8|  Lists and Dictionaries
299                 |41.9|  Exceptions
300                 |41.10| Various remarks
301                 |41.11| Writing a plugin
302                 |41.12| Writing a filetype plugin
303                 |41.13| Writing a compiler plugin
304                 |41.14| Writing a plugin that loads quickly
305                 |41.15| Writing library scripts
306                 |41.16| Distributing Vim scripts
308 |usr_42.txt|  Add new menus
309                 |42.1|  Introduction
310                 |42.2|  Menu commands
311                 |42.3|  Various
312                 |42.4|  Toolbar and popup menus
314 |usr_43.txt|  Using filetypes
315                 |43.1|  Plugins for a filetype
316                 |43.2|  Adding a filetype
318 |usr_44.txt|  Your own syntax highlighted
319                 |44.1|  Basic syntax commands
320                 |44.2|  Keywords
321                 |44.3|  Matches
322                 |44.4|  Regions
323                 |44.5|  Nested items
324                 |44.6|  Following groups
325                 |44.7|  Other arguments
326                 |44.8|  Clusters
327                 |44.9|  Including another syntax file
328                 |44.10| Synchronizing
329                 |44.11| Installing a syntax file
330                 |44.12| Portable syntax file layout
332 |usr_45.txt|  Select your language
333                 |45.1|  Language for Messages
334                 |45.2|  Language for Menus
335                 |45.3|  Using another encoding
336                 |45.4|  Editing files with a different encoding
337                 |45.5|  Entering language text
339 ==============================================================================
340 Making Vim Run ~
342 Before you can use Vim.
344 |usr_90.txt|  Installing Vim
345                 |90.1|  Unix
346                 |90.2|  MS-Windows
347                 |90.3|  Upgrading
348                 |90.4|  Common installation issues
349                 |90.5|  Uninstalling Vim
351 ==============================================================================
353 Copyright: see |manual-copyright|  vim:tw=78:ts=8:ft=help:norl: