patch 9.1.1486: documentation issues with Wayland
Problem: documentation issues with Wayland
(after v9.1.1485)
Solution: Tweak documentation style. Capitalize the first letter of
Wayland (Hirohito Higashi)
related: #17619
Signed-off-by: Hirohito Higashi <h.east.727@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index 969b9c7..00730a7 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -1,4 +1,4 @@
-*builtin.txt* For Vim version 9.1. Last change: 2025 Jun 27
+*builtin.txt* For Vim version 9.1. Last change: 2025 Jun 28
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -13039,7 +13039,7 @@
vtp Compiled for vcon support |+vtp| (check vcon to find
out if it works in the current console).
wayland Compiled with Wayland protocol support.
-wayland_clipboard Compiled with support for Wayland selections/clipboard
+wayland_clipboard Compiled with support for Wayland selections/clipboard
wildignore Compiled with 'wildignore' option.
wildmenu Compiled with 'wildmenu' option.
win16 old version for MS-Windows 3.1 (always false)
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 4ea7a5c..6a576d3 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -1,4 +1,4 @@
-*eval.txt* For Vim version 9.1. Last change: 2025 Jun 27
+*eval.txt* For Vim version 9.1. Last change: 2025 Jun 28
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -2242,11 +2242,11 @@
*v:clipmethod*
v:clipmethod The current method of accessing the clipboard that is being
- used. Can either have the value of:
+ used. Can either have the value of:
wayland The Wayland protocol is being used.
x11 X11 selections are being used.
- none The above methods are unavailable
- or cannot be used.
+ none The above methods are unavailable or
+ cannot be used.
See 'clipmethod' for more details.
*v:cmdarg* *cmdarg-variable*
diff --git a/runtime/doc/index.txt b/runtime/doc/index.txt
index 8205777..c9e80da 100644
--- a/runtime/doc/index.txt
+++ b/runtime/doc/index.txt
@@ -1,4 +1,4 @@
-*index.txt* For Vim version 9.1. Last change: 2025 Jun 27
+*index.txt* For Vim version 9.1. Last change: 2025 Jun 28
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1264,6 +1264,7 @@
|:class| :class start of a class declaration
|:clast| :cla[st] go to the specified error, default last one
|:clearjumps| :cle[arjumps] clear the jump list
+|:clipreset| :clip[reset] reset 'clipmethod'
|:clist| :cl[ist] list all errors
|:close| :clo[se] close current window
|:cmap| :cm[ap] like ":map" but for Command-line mode
@@ -1587,7 +1588,6 @@
|:redrawtabpanel| :redrawtabp[anel] force a redraw of the tabpanel
|:registers| :reg[isters] display the contents of registers
|:resize| :res[ize] change current window height
-|:clipreset| :clip[reset] reset 'clipmethod'
|:retab| :ret[ab] change tab size
|:return| :retu[rn] return from a user function
|:rewind| :rew[ind] go to the first file in the argument list
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index d4fb51e..df4842f 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1,4 +1,4 @@
-*options.txt* For Vim version 9.1. Last change: 2025 Jun 27
+*options.txt* For Vim version 9.1. Last change: 2025 Jun 28
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1810,14 +1810,13 @@
register '*' for all yank, delete, change and put
operations which would normally go to the unnamed
register. When "unnamed" is also included to the
- option, yank operations (but not delete, change or
- put) will additionally copy the text into register
- '*'. If wayland is being used and the compositor does
- not support the primary-selection-unstable-v1
- protocol, then the regular selection is used in its
- place. Only available with the |+X11| or
- |+wayland_clipboard| feature. Availability can be
- checked with: >
+ option, yank operations (but not delete, change or put)
+ will additionally copy the text into register '*'. If
+ wayland is being used and the compositor does not
+ support the primary-selection-unstable-v1 protocol,
+ then the regular selection is used in its place. Only
+ available with the |+X11| or |+wayland_clipboard|
+ feature. Availability can be checked with: >
if has('unnamedplus')
<
*clipboard-autoselect*
@@ -1859,17 +1858,18 @@
compositor. This is useful in this situation:
- Running Vim in a console.
- $DISPLAY/$WAYLAND_DISPLAY is set to start
- applications on another display.
+ applications on another display.
- You do not want to connect to the X server/Wayland
compositor in the console, but do want this in a
terminal emulator.
To never connect to the X server/Wayland compositor
use: >
exclude:.*
-< This has the same effect as using the |-X| or |-Y| argument.
+< This has the same effect as using the |-X| or |-Y|
+ argument.
Note that when there is no connection to the X server
the window title won't be restored and the clipboard
- cannot be accessed. This is the same for Wayland,
+ cannot be accessed. This is the same for Wayland,
except there is no title restoring.
The value of 'magic' is ignored, {pattern} is
interpreted as if 'magic' was on.
@@ -1880,10 +1880,9 @@
'clipmethod' 'cpm' string (default for Unix: "wayland,x11",
for VMS: "x11",
otherwise: "")
-
global
- {only when the |+xterm_clipboard| or |+wayland_clipboard|
- features are included}
+ {only when the |+xterm_clipboard| or
+ |+wayland_clipboard| features are included}
Specifies which method of accessing the system clipboard is used,
depending on which method works first or is available. Supported
methods are:
@@ -1895,10 +1894,10 @@
macOS. The GUI or system way of accessing the clipboard is always
used instead.
- The option value is a list of comma separated items. The list is parsed
- left to right in order, and the first method that Vim determines is
- available or is working is used as the actual method for accessing the
- clipboard.
+ The option value is a list of comma separated items. The list is
+ parsed left to right in order, and the first method that Vim
+ determines is available or is working is used as the actual method for
+ accessing the clipboard.
The current method that is being used can be found in the |v:clipmethod|
variable.
@@ -10081,19 +10080,19 @@
global
{only when the |+wayland| feature is included}
Specifies the Wayland seat to use for Wayland functionality,
- specifically the clipboard. If the seat does not exist, then the
+ specifically the clipboard. If the seat does not exist, then the
option will still be set to the new value, with the Wayland clipboard
- being unavailable as a result. If an empty value is passed then Vim
+ being unavailable as a result. If an empty value is passed then Vim
will attempt to use the value of $XDG_SEAT if it exists, if not then
- it resorts to using the first seat found available. Updating this
+ it resorts to using the first seat found available. Updating this
option will also update |v:clipmethod|.
- *'wlsteal'* *'wst'* *'nowlsteal'* *'nowst'*
+ *'wlsteal'* *'wst'* *'nowlsteal'* *'nowst'*
'wlsteal' 'wst' boolean (default off)
global
{only when the |+wayland_clipboard| feature is included}
When enabled, then allow Vim to steal focus by creating a temporary
- surface, in order to access the clipboard. For more information see
+ surface, in order to access the clipboard. For more information see
|wayland-focus-steal|.
*'wltimeoutlen'* *'wtm'*
diff --git a/runtime/doc/quickref.txt b/runtime/doc/quickref.txt
index 55e7cc3..a5d25b0 100644
--- a/runtime/doc/quickref.txt
+++ b/runtime/doc/quickref.txt
@@ -1,4 +1,4 @@
-*quickref.txt* For Vim version 9.1. Last change: 2025 Jun 27
+*quickref.txt* For Vim version 9.1. Last change: 2025 Jun 28
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -646,7 +646,7 @@
'cinscopedecls' 'cinsd' words that are recognized by 'cino-g'
'cinwords' 'cinw' words where 'si' and 'cin' add an indent
'clipboard' 'cb' use the clipboard as the unnamed register
-'clipmethod' 'cpm' specify order of what clipboard methods to use
+'clipmethod' 'cpm' specify order of what clipboard methods to use
'cmdheight' 'ch' number of lines to use for the command-line
'cmdwinheight' 'cwh' height of the command-line window
'colorcolumn' 'cc' columns to highlight
@@ -1019,9 +1019,9 @@
'winminwidth' 'wmw' minimal number of columns for any window
'winptydll' name of the winpty dynamic library
'winwidth' 'wiw' minimal number of columns for current window
-'wlseat' 'wse' the wayland seat to use
-'wlsteal' 'wst' allow focus stealing functionality for wayland
-'wltimeoutlen' 'wtm' timeout to use when polling in wayland
+'wlseat' 'wse' the Wayland seat to use
+'wlsteal' 'wst' allow focus stealing functionality for Wayland
+'wltimeoutlen' 'wtm' timeout to use when polling in Wayland
'wrap' long lines wrap and continue on the next line
'wrapmargin' 'wm' chars from the right where wrapping starts
'wrapscan' 'ws' searches wrap around the end of the file
diff --git a/runtime/doc/starting.txt b/runtime/doc/starting.txt
index 7d3cd2b..2fdf3fc 100644
--- a/runtime/doc/starting.txt
+++ b/runtime/doc/starting.txt
@@ -1,4 +1,4 @@
-*starting.txt* For Vim version 9.1. Last change: 2025 Jun 27
+*starting.txt* For Vim version 9.1. Last change: 2025 Jun 28
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -560,9 +560,9 @@
This does not enable the XSMP handler though.
*-Y*
--Y Do not try connecting to the Wayland compositor. Is only
+-Y Do not try connecting to the Wayland compositor. Is only
relevant for Unix when compiled with the |+wayland| feature,
- otherwise it's ignored. Note that this will make any feature
+ otherwise it's ignored. Note that this will make any feature
that uses Wayland unavailable, such as the clipboard.
*-s*
diff --git a/runtime/doc/various.txt b/runtime/doc/various.txt
index 7a097be..abca728 100644
--- a/runtime/doc/various.txt
+++ b/runtime/doc/various.txt
@@ -1,4 +1,4 @@
-*various.txt* For Vim version 9.1. Last change: 2025 Jun 27
+*various.txt* For Vim version 9.1. Last change: 2025 Jun 28
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -794,12 +794,12 @@
If the value was never specified, then it uses the
value of $DISPLAY environment variable as it was when
Vim was started. This will also update |v:clipmethod|.
- {only available when compiled with the |+xterm_clipboard|
- feature}
+ {only available when compiled with the
+ |+xterm_clipboard| feature}
*:clipreset* *:clip*
:clip[reset] Attempts to choose a new method for accessing the
- clipboard, using the 'clipmethod' option. This is
+ clipboard, using the 'clipmethod' option. This is
useful when the current method has become unavailable,
and you want to try using another method.
{only available when compiled with the |+clipboard|
diff --git a/runtime/doc/wayland.txt b/runtime/doc/wayland.txt
index b228dc1..e8c190a 100644
--- a/runtime/doc/wayland.txt
+++ b/runtime/doc/wayland.txt
@@ -1,4 +1,4 @@
-*wayland.txt* For Vim version 9.1. Last change: 2025 Jun 27
+*wayland.txt* For Vim version 9.1. Last change: 2025 Jun 28
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -15,7 +15,7 @@
*wayland-seat*
Functionality such as the clipboard for Wayland requires a seat to use. A
Wayland seat can consist of a keyboard, pointer, and touch device(s). The
-seat to use can be set with the 'wlseat' option. Only useful if you use
+seat to use can be set with the 'wlseat' option. Only useful if you use
multiple Wayland seats in the same Wayland session.
*wayland-gui*
@@ -26,24 +26,25 @@
Wayland commands:
*:wlrestore* *:wl*
-:wl[estore] [display] Reinitializes the connection to the wayland compositor.
+:wl[restore] [display] Reinitializes the connection to the Wayland compositor.
Useful when running Vim in a screen/tmux session that
continues running after the Wayland compositor
restarts.
[display] should be in the format of the
$WAYLAND_DISPLAY environment variable (e.g.
- "wayland-0"). If [display] is omitted, then it
+ "wayland-0"). If [display] is omitted, then it
reinitializes the connection using the same value as
was used for the previous execution of this command.
If the value was never specified, then it uses the
value of $WAYLAND_DISPLAY environment variable. This
will also update |v:clipmethod|.
- {only available when compiled with the |+wayland| feature}
+ {only available when compiled with the |+wayland|
+ feature}
Wayland errors:
*E1548*
-Vim failed communicating with the wayland compositor. This is likely due to
+Vim failed communicating with the Wayland compositor. This is likely due to
the Wayland compositor process being killed. Try the `:wlrestore` command to
try connecting again.
@@ -61,15 +62,15 @@
If you don't get any match, then please see |wayland-focus-steal| for more
information.
-If you come from X11, then the regular wayland selection is equivalent to the
-CLIPBOARD selection in X11, and the primary wayland selection equates to the
+If you come from X11, then the regular Wayland selection is equivalent to the
+CLIPBOARD selection in X11, and the primary Wayland selection equates to the
X11 primary selection. Accessing these selections is the same as X11 in Vim,
in which the + register is the regular selection, and the * register is the
primary selection, note that your compositor may not support primary
selections, see |wayland-primary-selection| for more details.
*wayland-persist*
-If you use X11 cut buffers, no such things exist on Wayland. Instead to
+If you use X11 cut buffers, no such things exist on Wayland. Instead to
emulate such functionality, a separate clipboard manager must be used in order
to persist selection data when a Wayland client exists.
@@ -78,7 +79,7 @@
Vim determines which one to use when accessing the clipboard using the
'clipmethod' option.
- *wayland-primary-selection*
+ *wayland-primary-selection*
If you find X11 style primary selections useful, Wayland also implements this
behaviour in its own protocols:
@@ -88,10 +89,10 @@
- Data control protocol available on your system, such as the ext or wlr
protocols, then primary selection is also supported. This is unless you are
using version 1 (not the same as the 'v1' in the protocol name), of the
- wlr-data-control protocol. Then the primary selection protocol will be used
+ wlr-data-control protocol. Then the primary selection protocol will be used
as a fallback.
- *wayland-focus-steal* *wayland-gnome*
+ *wayland-focus-steal* *wayland-gnome*
If you are using the GNOME desktop environment on Wayland, as of this writing,
there is no method of accessing/modifying the clipboard for external clients
such as Vim without being focused. Focused in this case means the client has