thac0/vim
1
0
Fork 0
forked from aniani/vim
Code

runtime(man): update Vim manpage

Browse Source 
fixes: #14916

Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Christian Brabandt 2024-06-04 21:58:32 +02:00
parent 98fb81846d
commit ce6fe84db2
No known key found for this signature in database
GPG Key ID: F3F92DA383FDDE09
3 changed files with 159 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
runtime/doc/starting.txt
View File

@ -1,4 +1,4 @@
*starting.txt* For Vim version 9.1. Last change: 2024 May 18 *starting.txt* For Vim version 9.1. Last change: 2024 Jun 04
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -428,8 +428,8 @@ a slash. Thus "-R" means recovery and "-/R" readonly.
--not-a-term Tells Vim that the user knows that the input and/or output is --not-a-term Tells Vim that the user knows that the input and/or output is
not connected to a terminal. This will avoid the warning and not connected to a terminal. This will avoid the warning and
the two second delay that would happen. the two second delay that would happen.
Also avoids the "Reading from stdin..." message. Also avoids the "Reading from stdin..." as well as the
Also avoids the "N files to edit" message. "N files to edit" message.
--gui-dialog-file {name} *--gui-dialog-file* --gui-dialog-file {name} *--gui-dialog-file*
When using the GUI, instead of showing a dialog, write the When using the GUI, instead of showing a dialog, write the

88
runtime/doc/vim.1
View File

@ -1,4 +1,4 @@
.TH VIM 1 "2021 Jun 13" .TH VIM 1 "2024 Jun 04"
.SH NAME .SH NAME
vim \- Vi IMproved, a programmer's text editor vim \- Vi IMproved, a programmer's text editor
.SH SYNOPSIS .SH SYNOPSIS
@ -191,7 +191,7 @@ There should between two to eight file name arguments.
will open all the files and show differences between them. will open all the files and show differences between them.
Works like vimdiff(1). Works like vimdiff(1).
.TP .TP
\-d {device} \-d {device}, \-dev {device}
Open {device} for use as a terminal. Open {device} for use as a terminal.
Only on the Amiga. Only on the Amiga.
Example: Example:
@ -248,7 +248,13 @@ If no GUI support was compiled in, an error message is given and
.B Vim .B Vim
aborts. aborts.
.TP .TP
\-h \-\-gui-dialog-file {name}
When using the GUI, instead of showing a dialog, write the title and message of
the dialog to file {name}. The file is created or appended to. Only useful
for testing, to avoid that the test gets stuck on a dialog that can't be seen.
Without the GUI the argument is ignored.
.TP
\-\-help, \-h, \-?
Give a bit of help about the command line arguments and options. Give a bit of help about the command line arguments and options.
After this After this
.B Vim .B Vim
@ -317,6 +323,13 @@ When N is omitted, open one window for each file.
Open N tab pages. Open N tab pages.
When N is omitted, open one tab page for each file. When N is omitted, open one tab page for each file.
.TP .TP
\-P {parent-title}
Win32 GUI only: Specify the title of the parent application. When possible, Vim
will run in an MDI window inside the application. {parent-title} must appear in
the window title of the parent application. Make sure that it is specific
enough. Note that the implementation is still primitive. It won't work with
all applications and the menu doesn't work.
.TP
\-R \-R
Read-only mode. Read-only mode.
The 'readonly' option will be set. The 'readonly' option will be set.
@ -358,6 +371,16 @@ Should be a terminal known to
.B Vim .B Vim
(builtin) or defined in the termcap or terminfo file. (builtin) or defined in the termcap or terminfo file.
.TP .TP
\-\-not-a-term
Tells
.B Vim
that the user knows that the input and/or output is not connected to a
terminal. This will avoid the warning and the two second delay that would
happen.
.TP
\-\-ttyfail
When stdin or stdout is not a a terminal (tty) then exit right away.
.TP
\-u {vimrc} \-u {vimrc}
Use the commands in the file {vimrc} for initializations. Use the commands in the file {vimrc} for initializations.
All the other initializations are skipped. All the other initializations are skipped.
@ -376,12 +399,28 @@ Verbose. Give messages about which files are sourced and for reading and
writing a viminfo file. The optional number N is the value for 'verbose'. writing a viminfo file. The optional number N is the value for 'verbose'.
Default is 10. Default is 10.
.TP .TP
\-V[N]{filename}
Like \-V and set 'verbosefile' to {filename}. The result is that messages are
not displayed but written to the file {filename}. {filename} must not start
with a digit.
.TP
\-\-log {filename}
If
.B Vim
has been compiled with eval and channel feature, start logging and write
entries to {filename}. This works like calling
.I ch_logfile({filename}, 'ao')
very early during startup.
.TP
\-v \-v
Start Start
.B Vim .B Vim
in Vi mode, just like the executable was called "vi". This only has effect in Vi mode, just like the executable was called "vi". This only has effect
when the executable is called "ex". when the executable is called "ex".
.TP .TP
\-w{number}
Set the 'window' option to {number}.
.TP
\-w {scriptout} \-w {scriptout}
All the characters that you type are recorded in the file All the characters that you type are recorded in the file
{scriptout}, until you exit {scriptout}, until you exit
@ -423,9 +462,6 @@ a problem reproduces with a clean Vim setup.
\-\-echo\-wid \-\-echo\-wid
GTK GUI only: Echo the Window ID on stdout. GTK GUI only: Echo the Window ID on stdout.
.TP .TP
\-\-help
Give a help message and exit, just like "\-h".
.TP
\-\-literal \-\-literal
Take file name arguments literally, do not expand wildcards. This has no Take file name arguments literally, do not expand wildcards. This has no
effect on Unix where the shell expands wildcards. effect on Unix where the shell expands wildcards.
@ -468,6 +504,10 @@ During startup write timing messages to the file {fname}.
.TP .TP
\-\-version \-\-version
Print version information and exit. Print version information and exit.
.TP
\-\-windowid {id}
Win32 GUI only: Make gvim try to use the window {id} as a parent, so that it
runs inside that window.
.SH ON-LINE HELP .SH ON-LINE HELP
Type ":help" in Type ":help" in
.B Vim .B Vim
@ -481,53 +521,57 @@ All documentation files can be viewed in this way, for example
":help syntax.txt". ":help syntax.txt".
.SH FILES .SH FILES
.TP 15 .TP 15
/usr/local/lib/vim/doc/*.txt /usr/local/share/vim/vim??/doc/*.txt
The The
.B Vim .B Vim
documentation files. documentation files.
Use ":help doc\-file\-list" to get the complete list. Use ":help doc\-file\-list" to get the complete list.
.br
.I vim??
is short version number, like vim91 for
.B Vim 9.1
.TP .TP
/usr/local/lib/vim/doc/tags /usr/local/share/vim/vim??/doc/tags
The tags file used for finding information in the documentation files. The tags file used for finding information in the documentation files.
.TP .TP
/usr/local/lib/vim/syntax/syntax.vim /usr/local/share/vim/vim??/syntax/syntax.vim
System wide syntax initializations. System wide syntax initializations.
.TP .TP
/usr/local/lib/vim/syntax/*.vim /usr/local/share/vim/vim??/syntax/*.vim
Syntax files for various languages. Syntax files for various languages.
.TP .TP
/usr/local/lib/vim/vimrc /usr/local/share/vim/vimrc
System wide System wide
.B Vim .B Vim
initializations. initializations.
.TP .TP
~/.vimrc ~/.vimrc, ~/.vim/vimrc, $XDG_CONFIG_HOME/vim/vimrc
Your personal Your personal
.B Vim .B Vim
initializations. initializations (first one found is used).
.TP .TP
/usr/local/lib/vim/gvimrc /usr/local/share/vim/gvimrc
System wide gvim initializations. System wide gvim initializations.
.TP .TP
~/.gvimrc ~/.gvimrc, ~/.vim/gvimrc, $XDG_CONFIG_HOME/vim/gvimrc
Your personal gvim initializations. Your personal gvim initializations (first one found is used).
.TP .TP
/usr/local/lib/vim/optwin.vim /usr/local/share/vim/vim??/optwin.vim
Script used for the ":options" command, a nice way to view and set options. Script used for the ":options" command, a nice way to view and set options.
.TP .TP
/usr/local/lib/vim/menu.vim /usr/local/share/vim/vim??/menu.vim
System wide menu initializations for gvim. System wide menu initializations for gvim.
.TP .TP
/usr/local/lib/vim/bugreport.vim /usr/local/share/vim/vim??/bugreport.vim
Script to generate a bug report. See ":help bugs". Script to generate a bug report. See ":help bugs".
.TP .TP
/usr/local/lib/vim/filetype.vim /usr/local/share/vim/vim??/filetype.vim
Script to detect the type of a file by its name. See ":help 'filetype'". Script to detect the type of a file by its name. See ":help 'filetype'".
.TP .TP
/usr/local/lib/vim/scripts.vim /usr/local/share/vim/vim??/scripts.vim
Script to detect the type of a file by its contents. See ":help 'filetype'". Script to detect the type of a file by its contents. See ":help 'filetype'".
.TP .TP
/usr/local/lib/vim/print/*.ps /usr/local/share/vim/vim??/print/*.ps
Files used for PostScript printing. Files used for PostScript printing.
.PP .PP
For recent info read the VIM home page: For recent info read the VIM home page:

134
runtime/doc/vim.man
View File

@ -139,7 +139,8 @@ OPTIONS
name arguments. Vim will open all the files and show dif‐ name arguments. Vim will open all the files and show dif‐
ferences between them. Works like vimdiff(1). ferences between them. Works like vimdiff(1).
-d {device} Open {device} for use as a terminal. Only on the Amiga. -d {device}, -dev {device}
Open {device} for use as a terminal. Only on the Amiga.
Example: "-d con:20/30/600/150". Example: "-d con:20/30/600/150".
-D Debugging. Go to debugging mode when executing the first -D Debugging. Go to debugging mode when executing the first
@ -171,7 +172,15 @@ OPTIONS
ables the GUI. If no GUI support was compiled in, an error ables the GUI. If no GUI support was compiled in, an error
message is given and Vim aborts. message is given and Vim aborts.
-h Give a bit of help about the command line arguments and op‐ --gui-dialog-file {name}
When using the GUI, instead of showing a dialog, write the
title and message of the dialog to file {name}. The file
is created or appended to. Only useful for testing, to
avoid that the test gets stuck on a dialog that can't be
seen. Without the GUI the argument is ignored.
--help, -h, -?
Give a bit of help about the command line arguments and op‐
tions. After this Vim exits. tions. After this Vim exits.
-H If Vim has been compiled with RIGHTLEFT support for editing -H If Vim has been compiled with RIGHTLEFT support for editing
@ -220,6 +229,15 @@ OPTIONS
-p[N] Open N tab pages. When N is omitted, open one tab page for -p[N] Open N tab pages. When N is omitted, open one tab page for
each file. each file.
-P {parent-title}
Win32 GUI only: Specify the title of the parent applica‐
tion. When possible, Vim will run in an MDI window inside
the application. {parent-title} must appear in the window
title of the parent application. Make sure that it is spe‐
cific enough. Note that the implementation is still primi‐
tive. It won't work with all applications and the menu
doesn't work.
-R Read-only mode. The 'readonly' option will be set. You -R Read-only mode. The 'readonly' option will be set. You
can still edit the buffer, but will be prevented from acci‐ can still edit the buffer, but will be prevented from acci‐
dentally overwriting a file. If you do want to overwrite a dentally overwriting a file. If you do want to overwrite a
@ -252,26 +270,47 @@ OPTIONS
terminal known to Vim (builtin) or defined in the termcap terminal known to Vim (builtin) or defined in the termcap
or terminfo file. or terminfo file.
-u {vimrc} Use the commands in the file {vimrc} for initializations. --not-a-term
All the other initializations are skipped. Use this to Tells Vim that the user knows that the input and/or output
edit a special kind of files. It can also be used to skip is not connected to a terminal. This will avoid the warn‐
all initializations by giving the name "NONE". See ":help ing and the two second delay that would happen.
--ttyfail When stdin or stdout is not a a terminal (tty) then exit
right away.
-u {vimrc} Use the commands in the file {vimrc} for initializations.
All the other initializations are skipped. Use this to
edit a special kind of files. It can also be used to skip
all initializations by giving the name "NONE". See ":help
initialization" within vim for more details. initialization" within vim for more details.
-U {gvimrc} Use the commands in the file {gvimrc} for GUI initializa‐ -U {gvimrc} Use the commands in the file {gvimrc} for GUI initializa‐
tions. All the other GUI initializations are skipped. It tions. All the other GUI initializations are skipped. It
can also be used to skip all GUI initializations by giving can also be used to skip all GUI initializations by giving
the name "NONE". See ":help gui-init" within vim for more the name "NONE". See ":help gui-init" within vim for more
details. details.
-V[N] Verbose. Give messages about which files are sourced and -V[N] Verbose. Give messages about which files are sourced and
for reading and writing a viminfo file. The optional num‐ for reading and writing a viminfo file. The optional num‐
ber N is the value for 'verbose'. Default is 10. ber N is the value for 'verbose'. Default is 10.
-V[N]{filename}
Like -V and set 'verbosefile' to {filename}. The result is
that messages are not displayed but written to the file
{filename}. {filename} must not start with a digit.
--log {filename}
If Vim has been compiled with eval and channel feature,
start logging and write entries to {filename}. This works
like calling ch_logfile({filename}, 'ao') very early during
startup.
-v Start Vim in Vi mode, just like the executable was called -v Start Vim in Vi mode, just like the executable was called
"vi". This only has effect when the executable is called "vi". This only has effect when the executable is called
"ex". "ex".
-w{number} Set the 'window' option to {number}.
-w {scriptout} -w {scriptout}
All the characters that you type are recorded in the file All the characters that you type are recorded in the file
{scriptout}, until you exit Vim. This is useful if you {scriptout}, until you exit Vim. This is useful if you
@ -306,8 +345,6 @@ OPTIONS
--echo-wid GTK GUI only: Echo the Window ID on stdout. --echo-wid GTK GUI only: Echo the Window ID on stdout.
--help Give a help message and exit, just like "-h".
--literal Take file name arguments literally, do not expand wild‐ --literal Take file name arguments literally, do not expand wild‐
cards. This has no effect on Unix where the shell expands cards. This has no effect on Unix where the shell expands
wildcards. wildcards.
@ -354,58 +391,67 @@ OPTIONS
--version Print version information and exit. --version Print version information and exit.
--windowid {id}
Win32 GUI only: Make gvim try to use the window {id} as a
parent, so that it runs inside that window.
ON-LINE HELP ON-LINE HELP
Type ":help" in Vim to get started. Type ":help subject" to get help Type ":help" in Vim to get started. Type ":help subject" to get help
on a specific subject. For example: ":help ZZ" to get help for the on a specific subject. For example: ":help ZZ" to get help for the
"ZZ" command. Use <Tab> and CTRL-D to complete subjects (":help cmd‐ "ZZ" command. Use <Tab> and CTRL-D to complete subjects (":help cmd‐
line-completion"). Tags are present to jump from one place to another line-completion"). Tags are present to jump from one place to another
(sort of hypertext links, see ":help"). All documentation files can be (sort of hypertext links, see ":help"). All documentation files can be
viewed in this way, for example ":help syntax.txt". viewed in this way, for example ":help syntax.txt".
FILES FILES
/usr/local/lib/vim/doc/*.txt /usr/local/share/vim/vim??/doc/*.txt
The Vim documentation files. Use ":help doc-file-list" The Vim documentation files. Use ":help doc-file-list"
to get the complete list. to get the complete list.
vim?? is short version number, like vim91 for Vim 9.1
/usr/local/lib/vim/doc/tags /usr/local/share/vim/vim??/doc/tags
The tags file used for finding information in the docu‐ The tags file used for finding information in the docu‐
mentation files. mentation files.
/usr/local/lib/vim/syntax/syntax.vim /usr/local/share/vim/vim??/syntax/syntax.vim
System wide syntax initializations. System wide syntax initializations.
/usr/local/lib/vim/syntax/*.vim /usr/local/share/vim/vim??/syntax/*.vim
Syntax files for various languages. Syntax files for various languages.
/usr/local/lib/vim/vimrc /usr/local/share/vim/vimrc
System wide Vim initializations. System wide Vim initializations.
~/.vimrc Your personal Vim initializations. ~/.vimrc, ~/.vim/vimrc, $XDG_CONFIG_HOME/vim/vimrc
Your personal Vim initializations (first one found is
used).
/usr/local/lib/vim/gvimrc /usr/local/share/vim/gvimrc
System wide gvim initializations. System wide gvim initializations.
~/.gvimrc Your personal gvim initializations. ~/.gvimrc, ~/.vim/gvimrc, $XDG_CONFIG_HOME/vim/gvimrc
Your personal gvim initializations (first one found is
used).
/usr/local/lib/vim/optwin.vim /usr/local/share/vim/vim??/optwin.vim
Script used for the ":options" command, a nice way to Script used for the ":options" command, a nice way to
view and set options. view and set options.
/usr/local/lib/vim/menu.vim /usr/local/share/vim/vim??/menu.vim
System wide menu initializations for gvim. System wide menu initializations for gvim.
/usr/local/lib/vim/bugreport.vim /usr/local/share/vim/vim??/bugreport.vim
Script to generate a bug report. See ":help bugs". Script to generate a bug report. See ":help bugs".
/usr/local/lib/vim/filetype.vim /usr/local/share/vim/vim??/filetype.vim
Script to detect the type of a file by its name. See Script to detect the type of a file by its name. See
":help 'filetype'". ":help 'filetype'".
/usr/local/lib/vim/scripts.vim /usr/local/share/vim/vim??/scripts.vim
Script to detect the type of a file by its contents. Script to detect the type of a file by its contents.
See ":help 'filetype'". See ":help 'filetype'".
/usr/local/lib/vim/print/*.ps /usr/local/share/vim/vim??/print/*.ps
Files used for PostScript printing. Files used for PostScript printing.
For recent info read the VIM home page: For recent info read the VIM home page:
@ -417,19 +463,19 @@ SEE ALSO
AUTHOR AUTHOR
Most of Vim was made by Bram Moolenaar, with a lot of help from others. Most of Vim was made by Bram Moolenaar, with a lot of help from others.
See ":help credits" in Vim. See ":help credits" in Vim.
Vim is based on Stevie, worked on by: Tim Thompson, Tony Andrews and Vim is based on Stevie, worked on by: Tim Thompson, Tony Andrews and
G.R. (Fred) Walter. Although hardly any of the original code remains. G.R. (Fred) Walter. Although hardly any of the original code remains.
BUGS BUGS
Probably. See ":help todo" for a list of known problems. Probably. See ":help todo" for a list of known problems.
Note that a number of things that may be regarded as bugs by some, are Note that a number of things that may be regarded as bugs by some, are
in fact caused by a too-faithful reproduction of Vi's behaviour. And in fact caused by a too-faithful reproduction of Vi's behaviour. And
if you think other things are bugs "because Vi does it differently", if you think other things are bugs "because Vi does it differently",
you should take a closer look at the vi_diff.txt file (or type :help you should take a closer look at the vi_diff.txt file (or type :help
vi_diff.txt when in Vim). Also have a look at the 'compatible' and vi_diff.txt when in Vim). Also have a look at the 'compatible' and
'cpoptions' options. 'cpoptions' options.
2021 Jun 13 VIM(1) 2024 Jun 04 VIM(1)