aniani/vim
0
0
Fork 1
mirror of https://github.com/vim/vim.git synced 2025-07-26 11:04:33 -04:00
Code

runtime(doc): documentation updates

Browse Source 
This is a collection of various improvements to the help pages

closes #12790

Co-authored-by: Houl <anwoku@yahoo.de>
Co-authored-by: Doug Kearns <dougkearns@gmail.com>
Co-authored-by: Adri Verhoef <a3@a3.xs4all.nl>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Christian Brabandt 2023-08-16 00:11:09 +02:00
parent 62145db91b
commit 596ad66d1d
No known key found for this signature in database
GPG Key ID: F3F92DA383FDDE09
8 changed files with 29 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
runtime/doc/channel.txt
View File

@ -1,4 +1,4 @@
*channel.txt* For Vim version 9.0. Last change: 2022 Dec 01 *channel.txt* For Vim version 9.0. Last change: 2023 Aug 15
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -956,7 +956,7 @@ job_start({command} [, {options}]) *job_start()*
to String. This works best on Unix. to String. This works best on Unix.
On MS-Windows, job_start() makes a GUI application hidden. If On MS-Windows, job_start() makes a GUI application hidden. If
want to show it, Use |:!start| instead. you want to show it, use |:!start| instead.
The command is executed directly, not through a shell, the The command is executed directly, not through a shell, the
'shell' option is not used. To use the shell: > 'shell' option is not used. To use the shell: >

4
runtime/doc/intro.txt
View File

@ -1,4 +1,4 @@
*intro.txt* For Vim version 9.0. Last change: 2023 Aug 09 *intro.txt* For Vim version 9.0. Last change: 2023 Aug 15
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -215,7 +215,7 @@ Vim would never have become what it is now, without the help of these people!
Eric Fischer Mac port, 'cindent', and other improvements Eric Fischer Mac port, 'cindent', and other improvements
Benji Fisher Answering lots of user questions Benji Fisher Answering lots of user questions
Bill Foster Athena GUI port (later removed) Bill Foster Athena GUI port (later removed)
Google Lets me work on Vim one day a week Google Let Bram work on Vim one day a week
Loic Grenie xvim (ideas for multi windows version) Loic Grenie xvim (ideas for multi windows version)
Sven Guckes Vim promoter and previous WWW page maintainer |Sven-Guckes| Sven Guckes Vim promoter and previous WWW page maintainer |Sven-Guckes|
Darren Hiebert Exuberant ctags Darren Hiebert Exuberant ctags

26
runtime/doc/options.txt
View File

@ -1,4 +1,4 @@
*options.txt* For Vim version 9.0. Last change: 2023 Jun 02 *options.txt* For Vim version 9.0. Last change: 2023 Aug 15
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -303,7 +303,7 @@ The options local to a window are remembered for each buffer. This also
happens when the buffer is not loaded, but they are lost when the buffer is happens when the buffer is not loaded, but they are lost when the buffer is
wiped out |:bwipe|. wiped out |:bwipe|.
Special local window options *special-local-window-option* Special local window options *local-noglobal*
The following local window options won't be copied over when new windows are The following local window options won't be copied over when new windows are
created, thus they behave slightly differently: created, thus they behave slightly differently:
@ -314,7 +314,7 @@ created, thus they behave slightly differently:
'winfixheight' specific to existing window 'winfixheight' specific to existing window
'winfixwidth' specific to existing window 'winfixwidth' specific to existing window
Special local buffer options *special-local-buffer-option* Special local buffer options
The following local buffer options won't be copied over when new buffers are The following local buffer options won't be copied over when new buffers are
created, thus they behave slightly differently: created, thus they behave slightly differently:
@ -1474,7 +1474,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*'bufhidden'* *'bh'* *'bufhidden'* *'bh'*
'bufhidden' 'bh' string (default: "") 'bufhidden' 'bh' string (default: "")
local to buffer |special-local-buffer-option| local to buffer |local-noglobal|
This option specifies what happens when a buffer is no longer This option specifies what happens when a buffer is no longer
displayed in a window: displayed in a window:
<empty> follow the global 'hidden' option <empty> follow the global 'hidden' option
@ -1506,7 +1506,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*'buftype'* *'bt'* *E382* *'buftype'* *'bt'* *E382*
'buftype' 'bt' string (default: "") 'buftype' 'bt' string (default: "")
local to buffer |special-local-buffer-option| local to buffer |local-noglobal|
The value of this option specifies the type of a buffer: The value of this option specifies the type of a buffer:
<empty> normal buffer <empty> normal buffer
nofile buffer which is not related to a file and will not be nofile buffer which is not related to a file and will not be
@ -3433,7 +3433,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*'filetype'* *'ft'* *'filetype'* *'ft'*
'filetype' 'ft' string (default: "") 'filetype' 'ft' string (default: "")
local to buffer |special-local-buffer-option| local to buffer |local-noglobal|
When this option is set, the FileType autocommand event is triggered. When this option is set, the FileType autocommand event is triggered.
All autocommands that match with the value of this option will be All autocommands that match with the value of this option will be
executed. Thus the value of 'filetype' is used in place of the file executed. Thus the value of 'filetype' is used in place of the file
@ -5590,7 +5590,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*'modified'* *'mod'* *'nomodified'* *'nomod'* *'modified'* *'mod'* *'nomodified'* *'nomod'*
'modified' 'mod' boolean (default off) 'modified' 'mod' boolean (default off)
local to buffer |special-local-buffer-option| local to buffer |local-noglobal|
When on, the buffer is considered to be modified. This option is set When on, the buffer is considered to be modified. This option is set
when: when:
1. A change was made to the text since it was last written. Using the 1. A change was made to the text since it was last written. Using the
@ -6161,7 +6161,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*'previewwindow'* *'nopreviewwindow'* *'previewwindow'* *'nopreviewwindow'*
*'pvw'* *'nopvw'* *E590* *'pvw'* *'nopvw'* *E590*
'previewwindow' 'pvw' boolean (default off) 'previewwindow' 'pvw' boolean (default off)
local to window |special-local-window-option| local to window |local-noglobal|
{not available when compiled without the |+quickfix| {not available when compiled without the |+quickfix|
feature} feature}
Identifies the preview window. Only one window can have this option Identifies the preview window. Only one window can have this option
@ -6356,7 +6356,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*'readonly'* *'ro'* *'noreadonly'* *'noro'* *'readonly'* *'ro'* *'noreadonly'* *'noro'*
'readonly' 'ro' boolean (default off) 'readonly' 'ro' boolean (default off)
local to buffer |special-local-buffer-option| local to buffer |local-noglobal|
If on, writes fail unless you use a '!'. Protects you from If on, writes fail unless you use a '!'. Protects you from
accidentally overwriting a file. Default on when Vim is started accidentally overwriting a file. Default on when Vim is started
in read-only mode ("vim -R") or when the executable is called "view". in read-only mode ("vim -R") or when the executable is called "view".
@ -6735,7 +6735,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*'scroll'* *'scr'* *'scroll'* *'scr'*
'scroll' 'scr' number (default: half the window height) 'scroll' 'scr' number (default: half the window height)
local to window |special-local-window-option| local to window |local-noglobal|
Number of lines to scroll with CTRL-U and CTRL-D commands. Will be Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
set to half the number of lines in the window when the window size set to half the number of lines in the window when the window size
changes. This may happen when enabling the |status-line| or changes. This may happen when enabling the |status-line| or
@ -7997,7 +7997,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*'syntax'* *'syn'* *'syntax'* *'syn'*
'syntax' 'syn' string (default empty) 'syntax' 'syn' string (default empty)
local to buffer |special-local-buffer-option| local to buffer |local-noglobal|
{not available when compiled without the |+syntax| {not available when compiled without the |+syntax|
feature} feature}
When this option is set, the syntax with this name is loaded, unless When this option is set, the syntax with this name is loaded, unless
@ -9445,7 +9445,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
'winfixheight' 'wfh' boolean (default off) 'winfixheight' 'wfh' boolean (default off)
local to window |special-local-window-option| local to window |local-noglobal|
Keep the window height when windows are opened or closed and Keep the window height when windows are opened or closed and
'equalalways' is set. Also for |CTRL-W_=|. Set by default for the 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
|preview-window| and |quickfix-window|. |preview-window| and |quickfix-window|.
@ -9453,7 +9453,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
'winfixwidth' 'wfw' boolean (default off) 'winfixwidth' 'wfw' boolean (default off)
local to window |special-local-window-option| local to window |local-noglobal|
Keep the window width when windows are opened or closed and Keep the window width when windows are opened or closed and
'equalalways' is set. Also for |CTRL-W_=|. 'equalalways' is set. Also for |CTRL-W_=|.
The width may be changed anyway when running out of room. The width may be changed anyway when running out of room.

6
runtime/doc/syntax.txt
View File

@ -2160,11 +2160,11 @@ should set a variable in your .vimrc file: >
:let lpc_syntax_for_c = 1 :let lpc_syntax_for_c = 1
If it doesn't work properly for some particular C or LPC files, use a If it doesn't work properly for some particular C or LPC files, use a
modeline. For a LPC file: modeline. For a LPC file: >
// vim:set ft=lpc: // vim:set ft=lpc:
For a C file that is recognized as LPC: For a C file that is recognized as LPC: >
// vim:set ft=c: // vim:set ft=c:
@ -2196,7 +2196,7 @@ LUA *lua.vim* *ft-lua-syntax*
The Lua syntax file can be used for versions 4.0, 5.0, 5.1 and 5.2 (5.2 is The Lua syntax file can be used for versions 4.0, 5.0, 5.1 and 5.2 (5.2 is
the default). You can select one of these versions using the global variables the default). You can select one of these versions using the global variables
lua_version and lua_subversion. For example, to activate Lua lua_version and lua_subversion. For example, to activate Lua
5.1 syntax highlighting, set the variables like this: 5.1 syntax highlighting, set the variables like this: >
:let lua_version = 5 :let lua_version = 5
:let lua_subversion = 1 :let lua_subversion = 1

3
runtime/doc/tags
View File

@ -8345,6 +8345,7 @@ load-plugins starting.txt /*load-plugins*
load-vim-script repeat.txt /*load-vim-script* load-vim-script repeat.txt /*load-vim-script*
local-additions help.txt /*local-additions* local-additions help.txt /*local-additions*
local-function userfunc.txt /*local-function* local-function userfunc.txt /*local-function*
local-noglobal options.txt /*local-noglobal*
local-options options.txt /*local-options* local-options options.txt /*local-options*
local-variable eval.txt /*local-variable* local-variable eval.txt /*local-variable*
local-variables userfunc.txt /*local-variables* local-variables userfunc.txt /*local-variables*
@ -9732,8 +9733,6 @@ spec_chglog_format pi_spec.txt /*spec_chglog_format*
spec_chglog_prepend pi_spec.txt /*spec_chglog_prepend* spec_chglog_prepend pi_spec.txt /*spec_chglog_prepend*
spec_chglog_release_info pi_spec.txt /*spec_chglog_release_info* spec_chglog_release_info pi_spec.txt /*spec_chglog_release_info*
special-buffers windows.txt /*special-buffers* special-buffers windows.txt /*special-buffers*
special-local-buffer-option options.txt /*special-local-buffer-option*
special-local-window-option options.txt /*special-local-window-option*
specifies vim9class.txt /*specifies* specifies vim9class.txt /*specifies*
speed-up tips.txt /*speed-up* speed-up tips.txt /*speed-up*
spell spell.txt /*spell* spell spell.txt /*spell*

2
runtime/doc/tips.txt
View File

@ -1,4 +1,4 @@
*tips.txt* For Vim version 9.0. Last change: 2021 Nov 06 *tips.txt* For Vim version 9.0. Last change: 2023 Aug 10
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar

2
runtime/doc/usr_05.txt
View File

@ -1,4 +1,4 @@
*usr_05.txt* For Vim version 9.0. Last change: 2019 May 23 *usr_05.txt* For Vim version 9.0. Last change: 2023 Aug 10
VIM USER MANUAL - by Bram Moolenaar VIM USER MANUAL - by Bram Moolenaar

12
runtime/doc/version9.txt
View File

@ -44,12 +44,12 @@ He registered the vim.org domain and created the first Vim website. We will
remember him! remember him!
*Bram* *Moolenaar* *Bram-Moolenaar* *Bram* *Moolenaar* *Bram-Moolenaar*
Vim version 9.1 is dedicated to Bram Moolenaar, who passed away on August 3rd 2023 Vim version 9.1 is dedicated to Bram Moolenaar, who passed away on August 3rd
while still working full-time on Vim. The Vim project would not exist without 2023 while still working full-time on Vim. The Vim project would not exist
his ongoing passion to lead and develop Vim and the community for more than 30 without his ongoing passion to lead and develop Vim and the community for more
years. Bram was also passionate about his |ICCF| foundation to help children than 30 years. Bram was also passionate about his |ICCF| foundation to help
in Uganda. If you enjoy using Vim, please consider donating! children in Uganda. If you enjoy using Vim, please consider donating! We will
We will miss his guidance, passion and leadership. miss his guidance, passion and leadership.
Obituary Articles: https://github.com/vim/vim/discussions/12742 Obituary Articles: https://github.com/vim/vim/discussions/12742
Say Farewell: https://github.com/vim/vim/discussions/12737 Say Farewell: https://github.com/vim/vim/discussions/12737