Mercurial > vim

comparison runtime/doc/vim.man @ 17909:cc953757ed2a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Runtime files update. Commit: https://github.com/vim/vim/commit/06fe74aef72606ac34c9f494186e52614b8fb59a Author: Bram Moolenaar <Bram@vim.org> Date: Sat Aug 31 16:20:32 2019 +0200 Runtime files update.
author Bram Moolenaar <Bram@vim.org>
date Sat, 31 Aug 2019 16:30:04 +0200
parents 34c8ec888122
children 3a1ed539ae2a
comparison
equal deleted inserted replaced
17908:d9ada976a4c0 17909:cc953757ed2a
60 the start of the function. See ":help tag-commands". 60 the start of the function. See ":help tag-commands".
61 61
62 -q [errorfile] 62 -q [errorfile]
63 Start in quickFix mode. The file [errorfile] is read and 63 Start in quickFix mode. The file [errorfile] is read and
64 the first error is displayed. If [errorfile] is omitted, 64 the first error is displayed. If [errorfile] is omitted,
65 the filename is obtained from the 'errorfile' option 65 the filename is obtained from the 'errorfile' option (de‐
66 (defaults to "AztecC.Err" for the Amiga, "errors.err" on 66 faults to "AztecC.Err" for the Amiga, "errors.err" on other
67 other systems). Further errors can be jumped to with the 67 systems). Further errors can be jumped to with the ":cn"
68 ":cn" command. See ":help quickfix". 68 command. See ":help quickfix".
69 69
70 Vim behaves differently, depending on the name of the command (the exe‐ 70 Vim behaves differently, depending on the name of the command (the exe‐
71 cutable may still be the same file). 71 cutable may still be the same file).
72 72
73 vim The "normal" way, everything is default. 73 vim The "normal" way, everything is default.
90 Like the above, but with restrictions. It will not be possi‐ 90 Like the above, but with restrictions. It will not be possi‐
91 ble to start shell commands, or suspend Vim. Can also be 91 ble to start shell commands, or suspend Vim. Can also be
92 done with the "-Z" argument. 92 done with the "-Z" argument.
93 93
94 OPTIONS 94 OPTIONS
95 The options may be given in any order, before or after filenames. 95 The options may be given in any order, before or after filenames. Op‐
96 Options without an argument can be combined after a single dash. 96 tions without an argument can be combined after a single dash.
97 97
98 +[num] For the first file the cursor will be positioned on line 98 +[num] For the first file the cursor will be positioned on line
99 "num". If "num" is missing, the cursor will be positioned 99 "num". If "num" is missing, the cursor will be positioned
100 on the last line. 100 on the last line.
101 101
130 130
131 -b Binary mode. A few options will be set that makes it pos‐ 131 -b Binary mode. A few options will be set that makes it pos‐
132 sible to edit a binary or executable file. 132 sible to edit a binary or executable file.
133 133
134 -C Compatible. Set the 'compatible' option. This will make 134 -C Compatible. Set the 'compatible' option. This will make
135 Vim behave mostly like Vi, even though a .vimrc file 135 Vim behave mostly like Vi, even though a .vimrc file ex‐
136 exists. 136 ists.
137 137
138 -d Start in diff mode. There should be two, three or four 138 -d Start in diff mode. There should be two, three or four
139 file name arguments. Vim will open all the files and show 139 file name arguments. Vim will open all the files and show
140 differences between them. Works like vimdiff(1). 140 differences between them. Works like vimdiff(1).
141 141
149 "ex". 149 "ex".
150 150
151 -E Start Vim in improved Ex mode, just like the executable was 151 -E Start Vim in improved Ex mode, just like the executable was
152 called "exim". 152 called "exim".
153 153
154 -f Foreground. For the GUI version, Vim will not fork and 154 -f Foreground. For the GUI version, Vim will not fork and de‐
155 detach from the shell it was started in. On the Amiga, Vim 155 tach from the shell it was started in. On the Amiga, Vim
156 is not restarted to open a new window. This option should 156 is not restarted to open a new window. This option should
157 be used when Vim is executed by a program that will wait 157 be used when Vim is executed by a program that will wait
158 for the edit session to finish (e.g. mail). On the Amiga 158 for the edit session to finish (e.g. mail). On the Amiga
159 the ":sh" and ":!" commands will not work. 159 the ":sh" and ":!" commands will not work.
160 160
161 --nofork Foreground. For the GUI version, Vim will not fork and 161 --nofork Foreground. For the GUI version, Vim will not fork and de‐
162 detach from the shell it was started in. 162 tach from the shell it was started in.
163 163
164 -F If Vim has been compiled with FKMAP support for editing 164 -F If Vim has been compiled with FKMAP support for editing
165 right-to-left oriented files and Farsi keyboard mapping, 165 right-to-left oriented files and Farsi keyboard mapping,
166 this option starts Vim in Farsi mode, i.e. 'fkmap' and 166 this option starts Vim in Farsi mode, i.e. 'fkmap' and
167 'rightleft' are set. Otherwise an error message is given 167 'rightleft' are set. Otherwise an error message is given
168 and Vim aborts. 168 and Vim aborts.
169 169
170 -g If Vim has been compiled with GUI support, this option 170 -g If Vim has been compiled with GUI support, this option en‐
171 enables the GUI. If no GUI support was compiled in, an 171 ables the GUI. If no GUI support was compiled in, an error
172 error message is given and Vim aborts. 172 message is given and Vim aborts.
173 173
174 -h Give a bit of help about the command line arguments and 174 -h Give a bit of help about the command line arguments and op‐
175 options. After this Vim exits. 175 tions. After this Vim exits.
176 176
177 -H If Vim has been compiled with RIGHTLEFT support for editing 177 -H If Vim has been compiled with RIGHTLEFT support for editing
178 right-to-left oriented files and Hebrew keyboard mapping, 178 right-to-left oriented files and Hebrew keyboard mapping,
179 this option starts Vim in Hebrew mode, i.e. 'hkmap' and 179 this option starts Vim in Hebrew mode, i.e. 'hkmap' and
180 'rightleft' are set. Otherwise an error message is given 180 'rightleft' are set. Otherwise an error message is given
181 and Vim aborts. 181 and Vim aborts.
182 182
183 -i {viminfo} 183 -i {viminfo}
184 When using the viminfo file is enabled, this option sets 184 Specifies the filename to use when reading or writing the
185 the filename to use, instead of the default "~/.viminfo". 185 viminfo file, instead of the default "~/.viminfo". This
186 This can also be used to skip the use of the .viminfo file, 186 can also be used to skip the use of the .viminfo file, by
187 by giving the name "NONE". 187 giving the name "NONE".
188 188
189 -L Same as -r. 189 -L Same as -r.
190 190
191 -l Lisp mode. Sets the 'lisp' and 'showmatch' options on. 191 -l Lisp mode. Sets the 'lisp' and 'showmatch' options on.
192 192
197 -M Modifications not allowed. The 'modifiable' and 'write' 197 -M Modifications not allowed. The 'modifiable' and 'write'
198 options will be unset, so that changes are not allowed and 198 options will be unset, so that changes are not allowed and
199 files can not be written. Note that these options can be 199 files can not be written. Note that these options can be
200 set to enable making modifications. 200 set to enable making modifications.
201 201
202 -N No-compatible mode. Reset the 'compatible' option. This 202 -N No-compatible mode. Resets the 'compatible' option. This
203 will make Vim behave a bit better, but less Vi compatible, 203 will make Vim behave a bit better, but less Vi compatible,
204 even though a .vimrc file does not exist. 204 even though a .vimrc file does not exist.
205 205
206 -n No swap file will be used. Recovery after a crash will be 206 -n No swap file will be used. Recovery after a crash will be
207 impossible. Handy if you want to edit a file on a very 207 impossible. Handy if you want to edit a file on a very
208 slow medium (e.g. floppy). Can also be done with ":set 208 slow medium (e.g. floppy). Can also be done with ":set
209 uc=0". Can be undone with ":set uc=200". 209 uc=0". Can be undone with ":set uc=200".
210 210
211 -nb Become an editor server for NetBeans. See the docs for 211 -nb Become an editor server for NetBeans. See the docs for de‐
212 details. 212 tails.
213 213
214 -o[N] Open N windows stacked. When N is omitted, open one window 214 -o[N] Open N windows stacked. When N is omitted, open one window
215 for each file. 215 for each file.
216 216
217 -O[N] Open N windows side by side. When N is omitted, open one 217 -O[N] Open N windows side by side. When N is omitted, open one
226 file, add an exclamation mark to the Ex command, as in 226 file, add an exclamation mark to the Ex command, as in
227 ":w!". The -R option also implies the -n option (see 227 ":w!". The -R option also implies the -n option (see
228 above). The 'readonly' option can be reset with ":set 228 above). The 'readonly' option can be reset with ":set
229 noro". See ":help 'readonly'". 229 noro". See ":help 'readonly'".
230 230
231 -r List swap files, with information about using them for 231 -r List swap files, with information about using them for re‐
232 recovery. 232 covery.
233 233
234 -r {file} Recovery mode. The swap file is used to recover a crashed 234 -r {file} Recovery mode. The swap file is used to recover a crashed
235 editing session. The swap file is a file with the same 235 editing session. The swap file is a file with the same
236 filename as the text file with ".swp" appended. See ":help 236 filename as the text file with ".swp" appended. See ":help
237 recovery". 237 recovery".
245 can be done with the command ":source! {scriptin}". If the 245 can be done with the command ":source! {scriptin}". If the
246 end of the file is reached before the editor exits, further 246 end of the file is reached before the editor exits, further
247 characters are read from the keyboard. 247 characters are read from the keyboard.
248 248
249 -T {terminal} 249 -T {terminal}
250 Tells Vim the name of the terminal you are using. Only 250 Tells Vim the name of the terminal you are using. Only re‐
251 required when the automatic way doesn't work. Should be a 251 quired when the automatic way doesn't work. Should be a
252 terminal known to Vim (builtin) or defined in the termcap 252 terminal known to Vim (builtin) or defined in the termcap
253 or terminfo file. 253 or terminfo file.
254 254
255 -u {vimrc} Use the commands in the file {vimrc} for initializations. 255 -u {vimrc} Use the commands in the file {vimrc} for initializations.
256 All the other initializations are skipped. Use this to 256 All the other initializations are skipped. Use this to
340 Use {name} as the server name. Used for the current Vim, 340 Use {name} as the server name. Used for the current Vim,
341 unless used with a --remote argument, then it's the name of 341 unless used with a --remote argument, then it's the name of
342 the server to connect to. 342 the server to connect to.
343 343
344 --socketid {id} 344 --socketid {id}
345 GTK GUI only: Use the GtkPlug mechanism to run gvim in 345 GTK GUI only: Use the GtkPlug mechanism to run gvim in an‐
346 another window. 346 other window.
347 347
348 --version Print version information and exit. 348 --version Print version information and exit.
349 349
350 ON-LINE HELP 350 ON-LINE HELP
351 Type ":help" in Vim to get started. Type ":help subject" to get help 351 Type ":help" in Vim to get started. Type ":help subject" to get help