| 1 |
diff -Nrua vim63.orig/runtime/doc/vim.1 vim63/runtime/doc/vim.1
|
| 2 |
--- vim63.orig/runtime/doc/vim.1 2005-03-15 10:18:48.000000000 +0100
|
| 3 |
+++ vim63/runtime/doc/vim.1 2005-03-16 09:34:49.699114284 +0100
|
| 4 |
@@ -7,7 +7,7 @@
|
| 5 |
[options] [file ..]
|
| 6 |
.br
|
| 7 |
.B vim
|
| 8 |
-[options] -
|
| 9 |
+[options] \-
|
| 10 |
.br
|
| 11 |
.B vim
|
| 12 |
[options] \-t tag
|
| 13 |
@@ -69,13 +69,13 @@
|
| 14 |
The first one will be the current file and read into the buffer.
|
| 15 |
The cursor will be positioned on the first line of the buffer.
|
| 16 |
You can get to the other files with the ":next" command.
|
| 17 |
-To edit a file that starts with a dash, precede the filelist with "--".
|
| 18 |
+To edit a file that starts with a dash, precede the filelist with "\-\-".
|
| 19 |
.TP
|
| 20 |
--
|
| 21 |
+\-
|
| 22 |
The file to edit is read from stdin. Commands are read from stderr, which
|
| 23 |
should be a tty.
|
| 24 |
.TP
|
| 25 |
--t {tag}
|
| 26 |
+\-t {tag}
|
| 27 |
The file to edit and the initial cursor position depends on a "tag", a sort
|
| 28 |
of goto label.
|
| 29 |
{tag} is looked up in the tags file, the associated file becomes the current
|
| 30 |
@@ -84,9 +84,9 @@
|
| 31 |
name.
|
| 32 |
The effect is that the file containing that function becomes the current file
|
| 33 |
and the cursor is positioned on the start of the function.
|
| 34 |
-See ":help tag-commands".
|
| 35 |
+See ":help tag\-commands".
|
| 36 |
.TP
|
| 37 |
--q [errorfile]
|
| 38 |
+\-q [errorfile]
|
| 39 |
Start in quickFix mode.
|
| 40 |
The file [errorfile] is read and the first error is displayed.
|
| 41 |
If [errorfile] is omitted, the filename is obtained from the 'errorfile'
|
| 42 |
@@ -105,27 +105,27 @@
|
| 43 |
ex
|
| 44 |
Start in Ex mode.
|
| 45 |
Go to Normal mode with the ":vi" command.
|
| 46 |
-Can also be done with the "-e" argument.
|
| 47 |
+Can also be done with the "\-e" argument.
|
| 48 |
.TP
|
| 49 |
view
|
| 50 |
Start in read-only mode. You will be protected from writing the files. Can
|
| 51 |
-also be done with the "-R" argument.
|
| 52 |
+also be done with the "\-R" argument.
|
| 53 |
.TP
|
| 54 |
gvim gview
|
| 55 |
The GUI version.
|
| 56 |
Starts a new window.
|
| 57 |
-Can also be done with the "-g" argument.
|
| 58 |
+Can also be done with the "\-g" argument.
|
| 59 |
.TP
|
| 60 |
evim eview
|
| 61 |
The GUI version in easy mode.
|
| 62 |
Starts a new window.
|
| 63 |
-Can also be done with the "-y" argument.
|
| 64 |
+Can also be done with the "\-y" argument.
|
| 65 |
.TP
|
| 66 |
rvim rview rgvim rgview
|
| 67 |
Like the above, but with restrictions. It will not be possible to start shell
|
| 68 |
commands, or suspend
|
| 69 |
.B Vim.
|
| 70 |
-Can also be done with the "-Z" argument.
|
| 71 |
+Can also be done with the "\-Z" argument.
|
| 72 |
.SH OPTIONS
|
| 73 |
The options may be given in any order, before or after filenames.
|
| 74 |
Options without an argument can be combined after a single dash.
|
| 75 |
@@ -137,11 +137,11 @@
|
| 76 |
+/{pat}
|
| 77 |
For the first file the cursor will be positioned on the
|
| 78 |
first occurrence of {pat}.
|
| 79 |
-See ":help search-pattern" for the available search patterns.
|
| 80 |
+See ":help search\-pattern" for the available search patterns.
|
| 81 |
.TP
|
| 82 |
+{command}
|
| 83 |
.TP
|
| 84 |
--c {command}
|
| 85 |
+\-c {command}
|
| 86 |
{command} will be executed after the
|
| 87 |
first file has been read.
|
| 88 |
{command} is interpreted as an Ex command.
|
| 89 |
@@ -149,21 +149,21 @@
|
| 90 |
depends on the shell that is used).
|
| 91 |
Example: Vim "+set si" main.c
|
| 92 |
.br
|
| 93 |
-Note: You can use up to 10 "+" or "-c" commands.
|
| 94 |
+Note: You can use up to 10 "+" or "\-c" commands.
|
| 95 |
.TP
|
| 96 |
--S {file}
|
| 97 |
+\-S {file}
|
| 98 |
{file} will be sourced after the first file has been read.
|
| 99 |
-This is equivalent to -c "source {file}".
|
| 100 |
-{file} cannot start with '-'.
|
| 101 |
-If {file} is omitted "Session.vim" is used (only works when -S is the last
|
| 102 |
+This is equivalent to \-c "source {file}".
|
| 103 |
+{file} cannot start with '\-'.
|
| 104 |
+If {file} is omitted "Session.vim" is used (only works when \-S is the last
|
| 105 |
argument).
|
| 106 |
.TP
|
| 107 |
---cmd {command}
|
| 108 |
-Like using "-c", but the command is executed just before
|
| 109 |
+\-\-cmd {command}
|
| 110 |
+Like using "\-c", but the command is executed just before
|
| 111 |
processing any vimrc file.
|
| 112 |
-You can use up to 10 of these commands, independently from "-c" commands.
|
| 113 |
+You can use up to 10 of these commands, independently from "\-c" commands.
|
| 114 |
.TP
|
| 115 |
--A
|
| 116 |
+\-A
|
| 117 |
If
|
| 118 |
.B Vim
|
| 119 |
has been compiled with ARABIC support for editing right-to-left
|
| 120 |
@@ -174,45 +174,45 @@
|
| 121 |
.B Vim
|
| 122 |
aborts.
|
| 123 |
.TP
|
| 124 |
--b
|
| 125 |
+\-b
|
| 126 |
Binary mode.
|
| 127 |
A few options will be set that makes it possible to edit a binary or
|
| 128 |
executable file.
|
| 129 |
.TP
|
| 130 |
--C
|
| 131 |
+\-C
|
| 132 |
Compatible. Set the 'compatible' option.
|
| 133 |
This will make
|
| 134 |
.B Vim
|
| 135 |
behave mostly like Vi, even though a .vimrc file exists.
|
| 136 |
.TP
|
| 137 |
--d
|
| 138 |
+\-d
|
| 139 |
Start in diff mode.
|
| 140 |
There should be two or three file name arguments.
|
| 141 |
.B Vim
|
| 142 |
will open all the files and show differences between them.
|
| 143 |
Works like vimdiff(1).
|
| 144 |
.TP
|
| 145 |
--d {device}
|
| 146 |
+\-d {device}
|
| 147 |
Open {device} for use as a terminal.
|
| 148 |
Only on the Amiga.
|
| 149 |
Example:
|
| 150 |
"\-d con:20/30/600/150".
|
| 151 |
.TP
|
| 152 |
--D
|
| 153 |
+\-D
|
| 154 |
Debugging. Go to debugging mode when executing the first command from a
|
| 155 |
script.
|
| 156 |
.TP
|
| 157 |
--e
|
| 158 |
+\-e
|
| 159 |
Start
|
| 160 |
.B Vim
|
| 161 |
in Ex mode, just like the executable was called "ex".
|
| 162 |
.TP
|
| 163 |
--E
|
| 164 |
+\-E
|
| 165 |
Start
|
| 166 |
.B Vim
|
| 167 |
in improved Ex mode, just like the executable was called "exim".
|
| 168 |
.TP
|
| 169 |
--f
|
| 170 |
+\-f
|
| 171 |
Foreground. For the GUI version,
|
| 172 |
.B Vim
|
| 173 |
will not fork and detach from the shell it was started in.
|
| 174 |
@@ -225,12 +225,12 @@
|
| 175 |
session to finish (e.g. mail).
|
| 176 |
On the Amiga the ":sh" and ":!" commands will not work.
|
| 177 |
.TP
|
| 178 |
---nofork
|
| 179 |
+\-\-nofork
|
| 180 |
Foreground. For the GUI version,
|
| 181 |
.B Vim
|
| 182 |
will not fork and detach from the shell it was started in.
|
| 183 |
.TP
|
| 184 |
--F
|
| 185 |
+\-F
|
| 186 |
If
|
| 187 |
.B Vim
|
| 188 |
has been compiled with FKMAP support for editing right-to-left
|
| 189 |
@@ -241,7 +241,7 @@
|
| 190 |
.B Vim
|
| 191 |
aborts.
|
| 192 |
.TP
|
| 193 |
--g
|
| 194 |
+\-g
|
| 195 |
If
|
| 196 |
.B Vim
|
| 197 |
has been compiled with GUI support, this option enables the GUI.
|
| 198 |
@@ -249,13 +249,13 @@
|
| 199 |
.B Vim
|
| 200 |
aborts.
|
| 201 |
.TP
|
| 202 |
--h
|
| 203 |
+\-h
|
| 204 |
Give a bit of help about the command line arguments and options.
|
| 205 |
After this
|
| 206 |
.B Vim
|
| 207 |
exits.
|
| 208 |
.TP
|
| 209 |
--H
|
| 210 |
+\-H
|
| 211 |
If
|
| 212 |
.B Vim
|
| 213 |
has been compiled with RIGHTLEFT support for editing right-to-left
|
| 214 |
@@ -266,87 +266,87 @@
|
| 215 |
.B Vim
|
| 216 |
aborts.
|
| 217 |
.TP
|
| 218 |
--i {viminfo}
|
| 219 |
+\-i {viminfo}
|
| 220 |
When using the viminfo file is enabled, this option sets the filename to use,
|
| 221 |
instead of the default "~/.viminfo".
|
| 222 |
This can also be used to skip the use of the .viminfo file, by giving the name
|
| 223 |
"NONE".
|
| 224 |
.TP
|
| 225 |
--L
|
| 226 |
-Same as -r.
|
| 227 |
+\-L
|
| 228 |
+Same as \-r.
|
| 229 |
.TP
|
| 230 |
--l
|
| 231 |
+\-l
|
| 232 |
Lisp mode.
|
| 233 |
Sets the 'lisp' and 'showmatch' options on.
|
| 234 |
.TP
|
| 235 |
--m
|
| 236 |
+\-m
|
| 237 |
Modifying files is disabled.
|
| 238 |
Resets the 'write' option.
|
| 239 |
You can still modify the buffer, but writing a file is not possible.
|
| 240 |
.TP
|
| 241 |
--M
|
| 242 |
+\-M
|
| 243 |
Modifications not allowed. The 'modifiable' and 'write' options will be unset,
|
| 244 |
so that changes are not allowed and files can not be written. Note that these
|
| 245 |
options can be set to enable making modifications.
|
| 246 |
.TP
|
| 247 |
--N
|
| 248 |
+\-N
|
| 249 |
No-compatible mode. Reset the 'compatible' option.
|
| 250 |
This will make
|
| 251 |
.B Vim
|
| 252 |
behave a bit better, but less Vi compatible, even though a .vimrc file does
|
| 253 |
not exist.
|
| 254 |
.TP
|
| 255 |
--n
|
| 256 |
+\-n
|
| 257 |
No swap file will be used.
|
| 258 |
Recovery after a crash will be impossible.
|
| 259 |
Handy if you want to edit a file on a very slow medium (e.g. floppy).
|
| 260 |
Can also be done with ":set uc=0".
|
| 261 |
Can be undone with ":set uc=200".
|
| 262 |
.TP
|
| 263 |
--nb
|
| 264 |
+\-nb
|
| 265 |
Become an editor server for NetBeans. See the docs for details.
|
| 266 |
.TP
|
| 267 |
--o[N]
|
| 268 |
+\-o[N]
|
| 269 |
Open N windows stacked.
|
| 270 |
When N is omitted, open one window for each file.
|
| 271 |
.TP
|
| 272 |
--O[N]
|
| 273 |
+\-O[N]
|
| 274 |
Open N windows side by side.
|
| 275 |
When N is omitted, open one window for each file.
|
| 276 |
.TP
|
| 277 |
--R
|
| 278 |
+\-R
|
| 279 |
Read-only mode.
|
| 280 |
The 'readonly' option will be set.
|
| 281 |
You can still edit the buffer, but will be prevented from accidently
|
| 282 |
overwriting a file.
|
| 283 |
If you do want to overwrite a file, add an exclamation mark to the Ex command,
|
| 284 |
as in ":w!".
|
| 285 |
-The -R option also implies the -n option (see below).
|
| 286 |
+The \-R option also implies the \-n option (see below).
|
| 287 |
The 'readonly' option can be reset with ":set noro".
|
| 288 |
See ":help 'readonly'".
|
| 289 |
.TP
|
| 290 |
--r
|
| 291 |
+\-r
|
| 292 |
List swap files, with information about using them for recovery.
|
| 293 |
.TP
|
| 294 |
--r {file}
|
| 295 |
+\-r {file}
|
| 296 |
Recovery mode.
|
| 297 |
The swap file is used to recover a crashed editing session.
|
| 298 |
The swap file is a file with the same filename as the text file with ".swp"
|
| 299 |
appended.
|
| 300 |
See ":help recovery".
|
| 301 |
.TP
|
| 302 |
--s
|
| 303 |
-Silent mode. Only when started as "Ex" or when the "-e" option was given
|
| 304 |
-before the "-s" option.
|
| 305 |
+\-s
|
| 306 |
+Silent mode. Only when started as "Ex" or when the "\-e" option was given
|
| 307 |
+before the "\-s" option.
|
| 308 |
.TP
|
| 309 |
--s {scriptin}
|
| 310 |
+\-s {scriptin}
|
| 311 |
The script file {scriptin} is read.
|
| 312 |
The characters in the file are interpreted as if you had typed them.
|
| 313 |
The same can be done with the command ":source! {scriptin}".
|
| 314 |
If the end of the file is reached before the editor exits, further characters
|
| 315 |
are read from the keyboard.
|
| 316 |
.TP
|
| 317 |
--T {terminal}
|
| 318 |
+\-T {terminal}
|
| 319 |
Tells
|
| 320 |
.B Vim
|
| 321 |
the name of the terminal you are using.
|
| 322 |
@@ -356,49 +356,49 @@
|
| 323 |
.B Vim
|
| 324 |
(builtin) or defined in the termcap or terminfo file.
|
| 325 |
.TP
|
| 326 |
--u {vimrc}
|
| 327 |
+\-u {vimrc}
|
| 328 |
Use the commands in the file {vimrc} for initializations.
|
| 329 |
All the other initializations are skipped.
|
| 330 |
Use this to edit a special kind of files.
|
| 331 |
It can also be used to skip all initializations by giving the name "NONE".
|
| 332 |
See ":help initialization" within vim for more details.
|
| 333 |
.TP
|
| 334 |
--U {gvimrc}
|
| 335 |
+\-U {gvimrc}
|
| 336 |
Use the commands in the file {gvimrc} for GUI initializations.
|
| 337 |
All the other GUI initializations are skipped.
|
| 338 |
It can also be used to skip all GUI initializations by giving the name "NONE".
|
| 339 |
-See ":help gui-init" within vim for more details.
|
| 340 |
+See ":help gui\-init" within vim for more details.
|
| 341 |
.TP
|
| 342 |
--V[N]
|
| 343 |
+\-V[N]
|
| 344 |
Verbose. Give messages about which files are sourced and for reading and
|
| 345 |
writing a viminfo file. The optional number N is the value for 'verbose'.
|
| 346 |
Default is 10.
|
| 347 |
.TP
|
| 348 |
--v
|
| 349 |
+\-v
|
| 350 |
Start
|
| 351 |
.B Vim
|
| 352 |
in Vi mode, just like the executable was called "vi". This only has effect
|
| 353 |
when the executable is called "ex".
|
| 354 |
.TP
|
| 355 |
--w {scriptout}
|
| 356 |
+\-w {scriptout}
|
| 357 |
All the characters that you type are recorded in the file
|
| 358 |
{scriptout}, until you exit
|
| 359 |
.B Vim.
|
| 360 |
-This is useful if you want to create a script file to be used with "vim -s" or
|
| 361 |
+This is useful if you want to create a script file to be used with "vim \-s" or
|
| 362 |
":source!".
|
| 363 |
If the {scriptout} file exists, characters are appended.
|
| 364 |
.TP
|
| 365 |
--W {scriptout}
|
| 366 |
-Like -w, but an existing file is overwritten.
|
| 367 |
+\-W {scriptout}
|
| 368 |
+Like \-w, but an existing file is overwritten.
|
| 369 |
.TP
|
| 370 |
--x
|
| 371 |
+\-x
|
| 372 |
Use encryption when writing files. Will prompt for a crypt key.
|
| 373 |
.TP
|
| 374 |
--X
|
| 375 |
+\-X
|
| 376 |
Don't connect to the X server. Shortens startup time in a terminal, but the
|
| 377 |
window title and clipboard will not be used.
|
| 378 |
.TP
|
| 379 |
--y
|
| 380 |
+\-y
|
| 381 |
Start
|
| 382 |
.B Vim
|
| 383 |
in easy mode, just like the executable was called "evim" or "eview".
|
| 384 |
@@ -406,58 +406,58 @@
|
| 385 |
.B Vim
|
| 386 |
behave like a click-and-type editor.
|
| 387 |
.TP
|
| 388 |
--Z
|
| 389 |
+\-Z
|
| 390 |
Restricted mode. Works like the executable starts with "r".
|
| 391 |
.TP
|
| 392 |
---
|
| 393 |
+\-\-
|
| 394 |
Denotes the end of the options.
|
| 395 |
Arguments after this will be handled as a file name.
|
| 396 |
-This can be used to edit a filename that starts with a '-'.
|
| 397 |
+This can be used to edit a filename that starts with a '\-'.
|
| 398 |
.TP
|
| 399 |
---echo-wid
|
| 400 |
+\-\-echo\-wid
|
| 401 |
GTK GUI only: Echo the Window ID on stdout
|
| 402 |
.TP
|
| 403 |
---help
|
| 404 |
-Give a help message and exit, just like "-h".
|
| 405 |
+\-\-help
|
| 406 |
+Give a help message and exit, just like "\-h".
|
| 407 |
.TP
|
| 408 |
---literal
|
| 409 |
+\-\-literal
|
| 410 |
Take file name arguments literally, do not expand wildcards. Not needed on
|
| 411 |
Unix, the shell expand wildcards.
|
| 412 |
.TP
|
| 413 |
---noplugin
|
| 414 |
-Skip loading plugins. Implied by -u NONE.
|
| 415 |
+\-\-noplugin
|
| 416 |
+Skip loading plugins. Implied by \-u NONE.
|
| 417 |
.TP
|
| 418 |
---remote
|
| 419 |
+\-\-remote
|
| 420 |
Connect to a Vim server and make it edit the files given in the rest of the
|
| 421 |
arguments. If no server is found a warning is given and the files are edited
|
| 422 |
in the current Vim.
|
| 423 |
.TP
|
| 424 |
---remote-expr {expr}
|
| 425 |
+\-\-remote\-expr {expr}
|
| 426 |
Connect to a Vim server, evaluate {expr} in it and print the result on stdout.
|
| 427 |
.TP
|
| 428 |
---remote-send {keys}
|
| 429 |
+\-\-remote\-send {keys}
|
| 430 |
Connect to a Vim server and send {keys} to it.
|
| 431 |
.TP
|
| 432 |
---remote-silent
|
| 433 |
-As --remote, but without the warning when no server is found.
|
| 434 |
+\-\-remote\-silent
|
| 435 |
+As \-\-remote, but without the warning when no server is found.
|
| 436 |
.TP
|
| 437 |
---remote-wait
|
| 438 |
-As --remote, but Vim does not exit until the files have been edited.
|
| 439 |
+\-\-remote\-wait
|
| 440 |
+As \-\-remote, but Vim does not exit until the files have been edited.
|
| 441 |
.TP
|
| 442 |
---remote-wait-silent
|
| 443 |
-As --remote-wait, but without the warning when no server is found.
|
| 444 |
+\-\-remote\-wait\-silent
|
| 445 |
+As \-\-remote\-wait, but without the warning when no server is found.
|
| 446 |
.TP
|
| 447 |
---serverlist
|
| 448 |
+\-\-serverlist
|
| 449 |
List the names of all Vim servers that can be found.
|
| 450 |
.TP
|
| 451 |
---servername {name}
|
| 452 |
+\-\-servername {name}
|
| 453 |
Use {name} as the server name. Used for the current Vim, unless used with a
|
| 454 |
---remote argument, then it's the name of the server to connect to.
|
| 455 |
+\-\-remote argument, then it's the name of the server to connect to.
|
| 456 |
.TP
|
| 457 |
---socketid {id}
|
| 458 |
+\-\-socketid {id}
|
| 459 |
GTK GUI only: Use the GtkPlug mechanism to run gvim in another window.
|
| 460 |
.TP
|
| 461 |
---version
|
| 462 |
+\-\-version
|
| 463 |
Print version information and exit.
|
| 464 |
.SH ON-LINE HELP
|
| 465 |
Type ":help" in
|
| 466 |
@@ -465,7 +465,7 @@
|
| 467 |
to get started.
|
| 468 |
Type ":help subject" to get help on a specific subject.
|
| 469 |
For example: ":help ZZ" to get help for the "ZZ" command.
|
| 470 |
-Use <Tab> and CTRL-D to complete subjects (":help cmdline-completion").
|
| 471 |
+Use <Tab> and CTRL-D to complete subjects (":help cmdline\-completion").
|
| 472 |
Tags are present to jump from one place to another (sort of hypertext links,
|
| 473 |
see ":help").
|
| 474 |
All documentation files can be viewed in this way, for example
|
| 475 |
@@ -476,7 +476,7 @@
|
| 476 |
The
|
| 477 |
.B Vim
|
| 478 |
documentation files.
|
| 479 |
-Use ":help doc-file-list" to get the complete list.
|
| 480 |
+Use ":help doc\-file\-list" to get the complete list.
|
| 481 |
.TP
|
| 482 |
/usr/local/lib/vim/doc/tags
|
| 483 |
The tags file used for finding information in the documentation files.
|