Mercurial > vim
annotate runtime/doc/vim.man @ 31277:68d13970fe8b v9.0.0972
patch 9.0.0972: build failure on some systems
Commit: https://github.com/vim/vim/commit/4e6072b8d3e7ad85d2ca010c9172c2bdcdc62f44
Author: Bram Moolenaar <Bram@vim.org>
Date: Tue Nov 29 16:09:18 2022 +0000
patch 9.0.0972: build failure on some systems
Problem: Build failure on some systems.
Solution: Adjust #ifdefs related to the termresponse feature.
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Tue, 29 Nov 2022 17:15:03 +0100 |
| parents | 3649b5a6b1b6 |
| children | a73a934e173b |
| rev | line source |
|---|---|
| 6918 | 1 VIM(1) General Commands Manual VIM(1) |
| 7 | 2 |
| 3 | |
| 4 | |
| 5 NAME | |
| 12254 | 6 vim - Vi IMproved, a programmer's text editor |
| 7 | 7 |
| 8 SYNOPSIS | |
| 9 vim [options] [file ..] | |
| 10 vim [options] - | |
| 11 vim [options] -t tag | |
| 12 vim [options] -q [errorfile] | |
| 13 | |
| 14 ex | |
| 15 view | |
| 16 gvim gview evim eview | |
| 17 rvim rview rgvim rgview | |
| 18 | |
| 19 DESCRIPTION | |
| 20 Vim is a text editor that is upwards compatible to Vi. It can be used | |
| 21 to edit all kinds of plain text. It is especially useful for editing | |
| 22 programs. | |
| 23 | |
| 6918 | 24 There are a lot of enhancements above Vi: multi level undo, multi win‐ |
| 7 | 25 dows and buffers, syntax highlighting, command line editing, filename |
| 26 completion, on-line help, visual selection, etc.. See ":help | |
| 27 vi_diff.txt" for a summary of the differences between Vim and Vi. | |
| 28 | |
| 29 While running Vim a lot of help can be obtained from the on-line help | |
| 6918 | 30 system, with the ":help" command. See the ON-LINE HELP section below. |
| 7 | 31 |
| 32 Most often Vim is started to edit a single file with the command | |
| 33 | |
| 34 vim file | |
| 35 | |
| 36 More generally Vim is started with: | |
| 37 | |
| 38 vim [options] [filelist] | |
| 39 | |
| 40 If the filelist is missing, the editor will start with an empty buffer. | |
| 6918 | 41 Otherwise exactly one out of the following four may be used to choose |
| 7 | 42 one or more files to be edited. |
| 43 | |
| 6918 | 44 file .. A list of filenames. The first one will be the current |
| 45 file and read into the buffer. The cursor will be posi‐ | |
| 7 | 46 tioned on the first line of the buffer. You can get to the |
| 6918 | 47 other files with the ":next" command. To edit a file that |
| 7 | 48 starts with a dash, precede the filelist with "--". |
| 49 | |
| 6918 | 50 - The file to edit is read from stdin. Commands are read |
| 7 | 51 from stderr, which should be a tty. |
| 52 | |
| 53 -t {tag} The file to edit and the initial cursor position depends on | |
| 6918 | 54 a "tag", a sort of goto label. {tag} is looked up in the |
| 7 | 55 tags file, the associated file becomes the current file and |
| 6918 | 56 the associated command is executed. Mostly this is used |
| 57 for C programs, in which case {tag} could be a function | |
| 7 | 58 name. The effect is that the file containing that function |
| 6918 | 59 becomes the current file and the cursor is positioned on |
| 7 | 60 the start of the function. See ":help tag-commands". |
| 61 | |
| 62 -q [errorfile] | |
| 6918 | 63 Start in quickFix mode. The file [errorfile] is read and |
| 64 the first error is displayed. If [errorfile] is omitted, | |
| 17909 | 65 the filename is obtained from the 'errorfile' option (de‐ |
| 66 faults to "AztecC.Err" for the Amiga, "errors.err" on other | |
| 67 systems). Further errors can be jumped to with the ":cn" | |
| 68 command. See ":help quickfix". | |
| 7 | 69 |
| 6918 | 70 Vim behaves differently, depending on the name of the command (the exe‐ |
| 7 | 71 cutable may still be the same file). |
| 72 | |
| 73 vim The "normal" way, everything is default. | |
| 74 | |
| 6918 | 75 ex Start in Ex mode. Go to Normal mode with the ":vi" command. |
| 7 | 76 Can also be done with the "-e" argument. |
| 77 | |
| 6918 | 78 view Start in read-only mode. You will be protected from writing |
| 7 | 79 the files. Can also be done with the "-R" argument. |
| 80 | |
| 81 gvim gview | |
| 82 The GUI version. Starts a new window. Can also be done with | |
| 83 the "-g" argument. | |
| 84 | |
| 85 evim eview | |
| 86 The GUI version in easy mode. Starts a new window. Can also | |
| 87 be done with the "-y" argument. | |
| 88 | |
| 89 rvim rview rgvim rgview | |
| 6918 | 90 Like the above, but with restrictions. It will not be possi‐ |
| 91 ble to start shell commands, or suspend Vim. Can also be | |
| 7 | 92 done with the "-Z" argument. |
| 93 | |
| 94 OPTIONS | |
| 17909 | 95 The options may be given in any order, before or after filenames. Op‐ |
| 96 tions without an argument can be combined after a single dash. | |
| 7 | 97 |
| 6918 | 98 +[num] For the first file the cursor will be positioned on line |
| 99 "num". If "num" is missing, the cursor will be positioned | |
| 7 | 100 on the last line. |
| 101 | |
| 6918 | 102 +/{pat} For the first file the cursor will be positioned in the |
| 103 line with the first occurrence of {pat}. See ":help | |
| 104 search-pattern" for the available search patterns. | |
| 7 | 105 |
| 106 +{command} | |
| 107 | |
| 108 -c {command} | |
| 6918 | 109 {command} will be executed after the first file has been |
| 110 read. {command} is interpreted as an Ex command. If the | |
| 111 {command} contains spaces it must be enclosed in double | |
| 112 quotes (this depends on the shell that is used). Example: | |
| 21499 | 113 vim "+set si" main.c |
| 7 | 114 Note: You can use up to 10 "+" or "-c" commands. |
| 115 | |
| 6918 | 116 -S {file} {file} will be sourced after the first file has been read. |
| 117 This is equivalent to -c "source {file}". {file} cannot | |
| 7 | 118 start with '-'. If {file} is omitted "Session.vim" is used |
| 119 (only works when -S is the last argument). | |
| 120 | |
| 121 --cmd {command} | |
| 6918 | 122 Like using "-c", but the command is executed just before |
| 123 processing any vimrc file. You can use up to 10 of these | |
| 7 | 124 commands, independently from "-c" commands. |
| 125 | |
| 6918 | 126 -A If Vim has been compiled with ARABIC support for editing |
| 127 right-to-left oriented files and Arabic keyboard mapping, | |
| 128 this option starts Vim in Arabic mode, i.e. 'arabic' is | |
| 7 | 129 set. Otherwise an error message is given and Vim aborts. |
| 130 | |
| 6918 | 131 -b Binary mode. A few options will be set that makes it pos‐ |
| 7 | 132 sible to edit a binary or executable file. |
| 133 | |
| 6918 | 134 -C Compatible. Set the 'compatible' option. This will make |
| 17909 | 135 Vim behave mostly like Vi, even though a .vimrc file ex‐ |
| 136 ists. | |
| 7 | 137 |
| 24911 | 138 -d Start in diff mode. There should between two to eight file |
| 139 name arguments. Vim will open all the files and show dif‐ | |
| 140 ferences between them. Works like vimdiff(1). | |
| 7 | 141 |
| 6918 | 142 -d {device} Open {device} for use as a terminal. Only on the Amiga. |
| 7 | 143 Example: "-d con:20/30/600/150". |
| 144 | |
| 6918 | 145 -D Debugging. Go to debugging mode when executing the first |
| 7 | 146 command from a script. |
| 147 | |
| 6918 | 148 -e Start Vim in Ex mode, just like the executable was called |
| 7 | 149 "ex". |
| 150 | |
| 151 -E Start Vim in improved Ex mode, just like the executable was | |
| 152 called "exim". | |
| 153 | |
| 17909 | 154 -f Foreground. For the GUI version, Vim will not fork and de‐ |
| 155 tach from the shell it was started in. On the Amiga, Vim | |
| 6918 | 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 | |
| 158 for the edit session to finish (e.g. mail). On the Amiga | |
| 7 | 159 the ":sh" and ":!" commands will not work. |
| 160 | |
| 17909 | 161 --nofork Foreground. For the GUI version, Vim will not fork and de‐ |
| 162 tach from the shell it was started in. | |
| 7 | 163 |
| 6918 | 164 -F If Vim has been compiled with FKMAP support for editing |
| 165 right-to-left oriented files and Farsi keyboard mapping, | |
| 166 this option starts Vim in Farsi mode, i.e. 'fkmap' and | |
| 167 'rightleft' are set. Otherwise an error message is given | |
| 168 and Vim aborts. | |
| 169 | |
| 17909 | 170 -g If Vim has been compiled with GUI support, this option en‐ |
| 171 ables the GUI. If no GUI support was compiled in, an error | |
| 172 message is given and Vim aborts. | |
| 6918 | 173 |
| 17909 | 174 -h Give a bit of help about the command line arguments and op‐ |
| 175 tions. After this Vim exits. | |
| 6918 | 176 |
| 177 -H If Vim has been compiled with RIGHTLEFT support for editing | |
| 178 right-to-left oriented files and Hebrew keyboard mapping, | |
| 179 this option starts Vim in Hebrew mode, i.e. 'hkmap' and | |
| 7 | 180 'rightleft' are set. Otherwise an error message is given |
| 181 and Vim aborts. | |
| 182 | |
| 183 -i {viminfo} | |
| 17909 | 184 Specifies the filename to use when reading or writing the |
| 185 viminfo file, instead of the default "~/.viminfo". This | |
| 186 can also be used to skip the use of the .viminfo file, by | |
| 187 giving the name "NONE". | |
| 7 | 188 |
| 189 -L Same as -r. | |
| 190 | |
| 191 -l Lisp mode. Sets the 'lisp' and 'showmatch' options on. | |
| 192 | |
| 6918 | 193 -m Modifying files is disabled. Resets the 'write' option. |
| 194 You can still modify the buffer, but writing a file is not | |
| 7 | 195 possible. |
| 196 | |
| 6918 | 197 -M Modifications not allowed. The 'modifiable' and 'write' |
| 198 options will be unset, so that changes are not allowed and | |
| 199 files can not be written. Note that these options can be | |
| 7 | 200 set to enable making modifications. |
| 201 | |
| 17909 | 202 -N No-compatible mode. Resets the 'compatible' option. This |
| 6918 | 203 will make Vim behave a bit better, but less Vi compatible, |
| 7 | 204 even though a .vimrc file does not exist. |
| 205 | |
| 6918 | 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 | |
| 208 slow medium (e.g. floppy). Can also be done with ":set | |
| 7 | 209 uc=0". Can be undone with ":set uc=200". |
| 210 | |
| 17909 | 211 -nb Become an editor server for NetBeans. See the docs for de‐ |
| 212 tails. | |
| 7 | 213 |
| 214 -o[N] Open N windows stacked. When N is omitted, open one window | |
| 215 for each file. | |
| 216 | |
| 6918 | 217 -O[N] Open N windows side by side. When N is omitted, open one |
| 7 | 218 window for each file. |
| 219 | |
| 803 | 220 -p[N] Open N tab pages. When N is omitted, open one tab page for |
| 221 each file. | |
| 222 | |
| 6918 | 223 -R Read-only mode. The 'readonly' option will be set. You |
| 224 can still edit the buffer, but will be prevented from acci‐ | |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
6918
diff
changeset
|
225 dentally overwriting a file. If you do want to overwrite a |
| 6918 | 226 file, add an exclamation mark to the Ex command, as in |
| 227 ":w!". The -R option also implies the -n option (see | |
| 12559 | 228 above). The 'readonly' option can be reset with ":set |
| 7 | 229 noro". See ":help 'readonly'". |
| 230 | |
| 17909 | 231 -r List swap files, with information about using them for re‐ |
| 232 covery. | |
| 7 | 233 |
| 6918 | 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 | |
| 7 | 236 filename as the text file with ".swp" appended. See ":help |
| 237 recovery". | |
| 238 | |
| 6918 | 239 -s Silent mode. Only when started as "Ex" or when the "-e" |
| 7 | 240 option was given before the "-s" option. |
| 241 | |
| 242 -s {scriptin} | |
| 6918 | 243 The script file {scriptin} is read. The characters in the |
| 244 file are interpreted as if you had typed them. The same | |
| 7 | 245 can be done with the command ":source! {scriptin}". If the |
| 246 end of the file is reached before the editor exits, further | |
| 247 characters are read from the keyboard. | |
| 248 | |
| 249 -T {terminal} | |
| 17909 | 250 Tells Vim the name of the terminal you are using. Only re‐ |
| 251 quired when the automatic way doesn't work. Should be a | |
| 6918 | 252 terminal known to Vim (builtin) or defined in the termcap |
| 7 | 253 or terminfo file. |
| 254 | |
| 6918 | 255 -u {vimrc} Use the commands in the file {vimrc} for initializations. |
| 256 All the other initializations are skipped. Use this to | |
| 257 edit a special kind of files. It can also be used to skip | |
| 258 all initializations by giving the name "NONE". See ":help | |
| 7 | 259 initialization" within vim for more details. |
| 260 | |
| 6918 | 261 -U {gvimrc} Use the commands in the file {gvimrc} for GUI initializa‐ |
| 262 tions. All the other GUI initializations are skipped. It | |
| 263 can also be used to skip all GUI initializations by giving | |
| 264 the name "NONE". See ":help gui-init" within vim for more | |
| 7 | 265 details. |
| 266 | |
| 6918 | 267 -V[N] Verbose. Give messages about which files are sourced and |
| 268 for reading and writing a viminfo file. The optional num‐ | |
| 7 | 269 ber N is the value for 'verbose'. Default is 10. |
| 270 | |
| 6918 | 271 -v Start Vim in Vi mode, just like the executable was called |
| 272 "vi". This only has effect when the executable is called | |
| 7 | 273 "ex". |
| 274 | |
| 275 -w {scriptout} | |
| 6918 | 276 All the characters that you type are recorded in the file |
| 277 {scriptout}, until you exit Vim. This is useful if you | |
| 278 want to create a script file to be used with "vim -s" or | |
| 7 | 279 ":source!". If the {scriptout} file exists, characters are |
| 280 appended. | |
| 281 | |
| 282 -W {scriptout} | |
| 283 Like -w, but an existing file is overwritten. | |
| 284 | |
| 36 | 285 -x Use encryption when writing files. Will prompt for a crypt |
| 286 key. | |
| 7 | 287 |
| 6918 | 288 -X Don't connect to the X server. Shortens startup time in a |
| 289 terminal, but the window title and clipboard will not be | |
| 7 | 290 used. |
| 291 | |
| 292 -y Start Vim in easy mode, just like the executable was called | |
| 6918 | 293 "evim" or "eview". Makes Vim behave like a click-and-type |
| 7 | 294 editor. |
| 295 | |
| 6918 | 296 -Z Restricted mode. Works like the executable starts with |
| 7 | 297 "r". |
| 298 | |
| 6918 | 299 -- Denotes the end of the options. Arguments after this will |
| 300 be handled as a file name. This can be used to edit a | |
| 7 | 301 filename that starts with a '-'. |
| 302 | |
| 24468 | 303 --clean Do not use any personal configuration (vimrc, plugins, |
| 304 etc.). Useful to see if a problem reproduces with a clean | |
| 305 Vim setup. | |
| 306 | |
| 36 | 307 --echo-wid GTK GUI only: Echo the Window ID on stdout. |
| 7 | 308 |
| 309 --help Give a help message and exit, just like "-h". | |
| 310 | |
| 6918 | 311 --literal Take file name arguments literally, do not expand wild‐ |
| 312 cards. This has no effect on Unix where the shell expands | |
| 36 | 313 wildcards. |
| 7 | 314 |
| 315 --noplugin Skip loading plugins. Implied by -u NONE. | |
| 316 | |
| 317 --remote Connect to a Vim server and make it edit the files given in | |
| 318 the rest of the arguments. If no server is found a warning | |
| 319 is given and the files are edited in the current Vim. | |
| 320 | |
| 321 --remote-expr {expr} | |
| 6918 | 322 Connect to a Vim server, evaluate {expr} in it and print |
| 7 | 323 the result on stdout. |
| 324 | |
| 325 --remote-send {keys} | |
| 326 Connect to a Vim server and send {keys} to it. | |
| 327 | |
| 328 --remote-silent | |
| 6918 | 329 As --remote, but without the warning when no server is |
| 7 | 330 found. |
| 331 | |
| 332 --remote-wait | |
| 6918 | 333 As --remote, but Vim does not exit until the files have |
| 7 | 334 been edited. |
| 335 | |
| 336 --remote-wait-silent | |
| 337 As --remote-wait, but without the warning when no server is | |
| 338 found. | |
| 339 | |
| 340 --serverlist | |
| 341 List the names of all Vim servers that can be found. | |
| 342 | |
| 343 --servername {name} | |
| 6918 | 344 Use {name} as the server name. Used for the current Vim, |
| 7 | 345 unless used with a --remote argument, then it's the name of |
| 346 the server to connect to. | |
| 347 | |
| 348 --socketid {id} | |
| 17909 | 349 GTK GUI only: Use the GtkPlug mechanism to run gvim in an‐ |
| 350 other window. | |
| 7 | 351 |
| 22824 | 352 --startuptime {file} |
| 353 During startup write timing messages to the file {fname}. | |
| 354 | |
| 7 | 355 --version Print version information and exit. |
| 356 | |
| 357 ON-LINE HELP | |
| 6918 | 358 Type ":help" in Vim to get started. Type ":help subject" to get help |
| 359 on a specific subject. For example: ":help ZZ" to get help for the | |
| 360 "ZZ" command. Use <Tab> and CTRL-D to complete subjects (":help cmd‐ | |
| 361 line-completion"). Tags are present to jump from one place to another | |
| 7 | 362 (sort of hypertext links, see ":help"). All documentation files can be |
| 363 viewed in this way, for example ":help syntax.txt". | |
| 364 | |
| 365 FILES | |
| 366 /usr/local/lib/vim/doc/*.txt | |
| 6918 | 367 The Vim documentation files. Use ":help doc-file-list" |
| 7 | 368 to get the complete list. |
| 369 | |
| 370 /usr/local/lib/vim/doc/tags | |
| 6918 | 371 The tags file used for finding information in the docu‐ |
| 7 | 372 mentation files. |
| 373 | |
| 374 /usr/local/lib/vim/syntax/syntax.vim | |
| 375 System wide syntax initializations. | |
| 376 | |
| 377 /usr/local/lib/vim/syntax/*.vim | |
| 378 Syntax files for various languages. | |
| 379 | |
| 380 /usr/local/lib/vim/vimrc | |
| 381 System wide Vim initializations. | |
| 382 | |
| 170 | 383 ~/.vimrc Your personal Vim initializations. |
| 384 | |
| 7 | 385 /usr/local/lib/vim/gvimrc |
| 386 System wide gvim initializations. | |
| 387 | |
| 170 | 388 ~/.gvimrc Your personal gvim initializations. |
| 389 | |
| 7 | 390 /usr/local/lib/vim/optwin.vim |
| 6918 | 391 Script used for the ":options" command, a nice way to |
| 7 | 392 view and set options. |
| 393 | |
| 394 /usr/local/lib/vim/menu.vim | |
| 395 System wide menu initializations for gvim. | |
| 396 | |
| 397 /usr/local/lib/vim/bugreport.vim | |
| 398 Script to generate a bug report. See ":help bugs". | |
| 399 | |
| 400 /usr/local/lib/vim/filetype.vim | |
| 6918 | 401 Script to detect the type of a file by its name. See |
| 7 | 402 ":help 'filetype'". |
| 403 | |
| 404 /usr/local/lib/vim/scripts.vim | |
| 6918 | 405 Script to detect the type of a file by its contents. |
| 7 | 406 See ":help 'filetype'". |
| 407 | |
| 1698 | 408 /usr/local/lib/vim/print/*.ps |
| 7 | 409 Files used for PostScript printing. |
| 410 | |
| 411 For recent info read the VIM home page: | |
| 412 <URL:http://www.vim.org/> | |
| 413 | |
| 414 SEE ALSO | |
| 415 vimtutor(1) | |
| 416 | |
| 417 AUTHOR | |
| 418 Most of Vim was made by Bram Moolenaar, with a lot of help from others. | |
| 419 See ":help credits" in Vim. | |
| 6918 | 420 Vim is based on Stevie, worked on by: Tim Thompson, Tony Andrews and |
| 421 G.R. (Fred) Walter. Although hardly any of the original code remains. | |
| 7 | 422 |
| 423 BUGS | |
| 424 Probably. See ":help todo" for a list of known problems. | |
| 425 | |
| 803 | 426 Note that a number of things that may be regarded as bugs by some, are |
| 427 in fact caused by a too-faithful reproduction of Vi's behaviour. And | |
| 428 if you think other things are bugs "because Vi does it differently", | |
| 429 you should take a closer look at the vi_diff.txt file (or type :help | |
| 430 vi_diff.txt when in Vim). Also have a look at the 'compatible' and | |
| 7 | 431 'cpoptions' options. |
| 432 | |
| 433 | |
| 434 | |
| 27321 | 435 2021 Jun 13 VIM(1) |