Skip to content

Update options.{txt,jax} #2133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update options.{txt,jax} #2133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e1f726
Update options.{txt,jax}
h-east Jun 29, 2025
edbf055
missing .txt file
h-east Jun 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 91 additions & 25 deletions doc/options.jax
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*options.txt* For Vim バージョン 9.1. Last change: 2025 Jun 18
*options.txt* For Vim バージョン 9.1. Last change: 2025 Jun 28


VIMリファレンスマニュアル by Bram Moolenaar
Expand Down Expand Up @@ -1829,8 +1829,9 @@ Note 1番目の形式では、行全体がオプション指定に使われる
"autoselect,exclude:cons\|linux"
それ以外では "")
グローバル
{VimのGUIバージョンか |+xterm_clipboard| 機能付きでコ
ンパイルされたもののみ有効}
{VimのGUIバージョンか |+xterm_clipboard| または
|+wayland_clipboard| 機能付きでコンパイルされたものの
み有効}
コンマ区切りのキーワードのリストを指定する。
Note: 要素の1つとして "exclude:" がある場合、要素を後ろに追加すること
はできない。従って += で後方への要素の追加ではなく ^= を使って前方への
Expand All @@ -1856,10 +1857,12 @@ Note 1番目の形式では、行全体がオプション指定に使われる
リップボードレジスタ '+' (|quoteplus|) が使われる。
"unnamed" も同時に指定した場合は、コピー操作 (削除、変
更、ペースト以外の操作) で、レジスタ '*' にもテキスト
がコピーされる。
|+X11| 機能が有効な場合のみ利用可能。
利用できるかどうかは次のコマンドで確認できる: >
if has('unnamedplus')
がコピーされる。Wayland が使用されており、コンポジタが
primary-selection-unstable-v1 プロトコルをサポートして
いない場合、代わりに通常のセレクションが使用される。
|+X11| または |+wayland_clipboard| 機能でのみ使用可能
である。使用可能かどうかは以下で確認できる: >
if has('unnamedplus')
<
*clipboard-autoselect*
autoselect 'guioptions' のフラグ 'a' のように働く: これが含まれる
Expand Down Expand Up @@ -1897,25 +1900,52 @@ Note 1番目の形式では、行全体がオプション指定に使われる
*clipboard-exclude*
exclude:{pattern}
ターミナルの名前 'term' にマッチするパターンを定義す
る。パターンがマッチすると、Xサーバーとの通信がなされ
なくなる。
る。パターンがマッチすると、X サーバーまたは Wayland
コンポジタとの通信がなされなくなる。
このオプションは以下の場合に便利である。
- Vimをコンソールで使用しているとき。
- アプリケーションを別のディスプレイで使うため、環境変
数 $DISPLAY が設定されているとき。
- コンソールではXサーバーと通信してほしくないが、ター
ミナルエミュレータ上では通信してほしいとき。
Xサーバーと全く通信しないようにするには、次のようにす
る: >
数 $DISPLAY/$WAYLAND_DISPLAY が設定されているとき。
- コンソールでは X サーバー/Wayland コンポジタと通信し
てほしくないが、ターミナルエミュレータ上では通信して
ほしいとき。
X サーバー/Wayland コンポジタと全く通信しないようにす
るには、次のようにする: >
exclude:.*
< これは引数 |-X| を使用したのと同じ効果を持つ。
< これは引数 |-X| または |-Y| を使用したのと同じ効果を持
つ。
Note Xサーバーと通信していないとき、ウィンドウタイトル
は復元されず、クリップボードにはアクセスできない。
は復元されず、クリップボードにはアクセスできない。これ
は Wayland でも同じだが、タイトルの復元はない。
'magic' の値は無視され、{pattern} は 'magic' がオンの
ときのように解釈される。オプション 'clipboard' の値の
残りは {pattern} として認識されるので、"exclude" は最
後に指定しなければならない。

*'clipmethod'* *'cpm'*
'clipmethod' 'cpm' 文字列 (Unix での既定値: "wayland,x11",
VMS: "x11",
その他: "")
グローバル
{|+xterm_clipboard| または |+wayland_clipboard| 機能付
きでコンパイルされたもののみ有効}
システムクリップボードへのアクセス方法を指定する。先に動作したメソッ
ド、または利用可能なメソッドに応じて使用される。サポートされているメ
ソッドは以下のとおり:
wayland Wayland セレクション
x11 X11 セレクション

Note: このオプションは、GUI が動作している場合、または Windows や
macOS など Wayland や X11 がサポートされていないシステムで Vim を実行
している場合には無視される。代わりに、GUI やシステムのクリップボードア
クセス方法が常に使用される。

オプションの値は、コンマ区切りの項目のリストである。リストは左から右へ
と順に解析され、Vim が最初に利用可能または動作していると判断するメソッ
ドが、クリップボードへのアクセスに実際に使用される。

現在使用されているメソッドは |v:clipmethod| 変数で確認できる。

*'cmdheight'* *'ch'*
'cmdheight' 'ch' 数値 (既定では 1)
グローバル／タブページについてローカル
Expand Down Expand Up @@ -4618,12 +4648,10 @@ Note 1番目の形式では、行全体がオプション指定に使われる
|hl-Title| t ":set all", ":autocmd" 等の出力のタイトル
|hl-VertSplit| c ウィンドウの垂直分割に使われる区切り
|hl-Visual| v ビジュアルモード
|hl-VisualNOS| V X11 Gui |gui-x11| と |xterm-clipboard| でのみ有効
な、選択領域をクリップボードに送らないビジュアル
モード
{訳注: "Not Owning the Selection" をこういう意味に
取りましたが、勘違いかもしれません。どなたかご教授
ください}
|hl-VisualNOS| V Vim が「セレクションを所有していない」場合のビジュ
アルモード。X11 Gui の |gui-x11|、
|xterm-clipboard|、および |wayland-selections| の
み。
|hl-WarningMsg| w 警告メッセージ
|hl-WildMenu| W 'wildmenu' によって表示されるワイルドカードマッチ
|hl-Folded| f 閉じられた折り畳みを表す行
Expand Down Expand Up @@ -9750,8 +9778,11 @@ Note 1番目の形式では、行全体がオプション指定に使われる
:set wc=X
:set wc=^I
:set wc=<Tab>
< NOTE: このオプションは 'compatible' がオンになるとViの既定値に設定され、
'compatible' がオフになるとVimの既定値に設定されるので注意。
< 'wildchar' は、|/|、|?|、|:s|、|:g|、|:v|、|:vim| などの検索パターンコ
ンテキストでも補完を有効にする。補完をトリガーする代わりに、文字の
<Tab> を挿入するには、<C-V><Tab> または "\t" と入力する。
NOTE: このオプションは 'compatible' がオンになると Vi の既定値に設定さ
れ、'compatible' がオフになると Vim の既定値に設定されるので注意。

*'wildcharm'* *'wcm'*
'wildcharm' 'wcm' 数値 (既定では空 (0))
Expand Down Expand Up @@ -10063,13 +10094,48 @@ Note 1番目の形式では、行全体がオプション指定に使われる
カレントウィンドウの列数の最小値。これは絶対的な最小値ではなく、余裕の
ないときには列数はこれよりも少なくなる。カレントウィンドウの列数が指定
したものより少ないときは、他のウィンドウの列数を減らしてそれを増やす。
カレントウィンドウが常に画面を埋めるようにするには、999 に設定すること。
カレントウィンドウが常に画面を埋めるようにするには、999 に設定するこ
と。
普通の編集時には小さい値に設定すること。
カレントウィンドウの幅を変更するコマンドの後では、ウィンドウの幅は調整
されない。
'winwidth' はカレントウィンドウに適用される。他のウィンドウの幅の最小
値の設定には、'winminwidth' を使うこと。

*'wlseat'* *'wse'*
'wlseat' 'wse' 文字列 (既定では "")
グローバル
{|+wayland| 機能付きでコンパイルされたときのみ有効}
Wayland 機能、特にクリップボードに使用する Wayland シートを指定する。
シートが存在しない場合、オプションは新しい値に設定され、結果として
Wayland クリップボードは使用できなくなる。空の値が渡された場合、Vim は
$XDG_SEAT が存在する場合はその値を使用しようとし、存在しない場合は最初
に見つかった利用可能なシートを使用する。このオプションを更新する
と、|v:clipmethod| も更新される。

*'wlsteal'* *'wst'* *'nowlsteal'* *'nowst'*
'wlsteal' 'wst' 切替 (既定ではオフ)
グローバル
{|+wayland_clipboard| 機能付きでコンパイルされたときの
み有効}
有効にすると、Vim はクリップボードにアクセスするために一時的なサーフェ
スを作成してフォーカスを奪取できるようになる。詳細については
|wayland-focus-steal| を参照。

*'wltimeoutlen'* *'wtm'*
'wltimeoutlen' 'wtm' 数値 (既定では 500)
グローバル
{|+wayland| 機能付きでコンパイルされたときのみ有効}
Vim が Wayland コンポジタの待機を諦めるまでのタイムアウト (ミリ秒単位)
である。コンポジタを待機している間、Vim は入力に応答せず画面も更新され
ない。そのため、この値を低く設定すると場合によっては Vim の応答性が向
上することがある。一方で、コンポジタの応答に通常よりも時間がかかる場
合、エラーが発生することもある。

さらに、このオプションは、サーフェスがフォーカスを取得するのを待機する
ときの最大タイムアウトとしても使用される。|wayland-focus-steal| を参
照。

*'wrap'* *'nowrap'*
'wrap' 切替 (既定ではオン)
ウィンドウについてローカル
Expand Down
111 changes: 90 additions & 21 deletions en/options.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*options.txt* For Vim version 9.1. Last change: 2025 Jun 18
*options.txt* For Vim version 9.1. Last change: 2025 Jun 28


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -1785,7 +1785,7 @@ A jump table for the options with a short description can be found at |Q_op|.
for X-windows, "" otherwise)
global
{only in GUI versions or when the |+xterm_clipboard|
feature is included}
or |+wayland_clipboard| features are included}
This option is a list of comma-separated names.
Note: if one of the items is "exclude:", then you can't add an item
after that. Therefore do not append an item with += but use ^= to
Expand All @@ -1810,12 +1810,14 @@ A jump table for the options with a short description can be found at |Q_op|.
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
'*'.
Only available with the |+X11| feature.
Availability can be checked with: >
if has('unnamedplus')
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*
autoselect Works like the 'a' flag in 'guioptions': If present,
Expand Down Expand Up @@ -1852,24 +1854,54 @@ A jump table for the options with a short description can be found at |Q_op|.
exclude:{pattern}
Defines a pattern that is matched against the name of
the terminal 'term'. If there is a match, no
connection will be made to the X server. This is
useful in this situation:
connection will be made to the X server or wayland
compositor. This is useful in this situation:
- Running Vim in a console.
- $DISPLAY is set to start applications on another
display.
- You do not want to connect to the X server in the
console, but do want this in a terminal emulator.
To never connect to the X server use: >
- $DISPLAY/$WAYLAND_DISPLAY is set to start
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| 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.
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.
The rest of the option value will be used for
{pattern}, this must be the last entry.

*'clipmethod'* *'cpm'*
'clipmethod' 'cpm' string (default for Unix: "wayland,x11",
for VMS: "x11",
otherwise: "")
global
{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:
wayland Wayland selections
x11 X11 selections

Note: This option is ignored when either the GUI is running or if Vim
is run on a system without wayland or X11 support, such as Windows or
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 current method that is being used can be found in the |v:clipmethod|
variable.

*'cmdheight'* *'ch'*
'cmdheight' 'ch' number (default 1)
global or local to tab page
Expand Down Expand Up @@ -4586,9 +4618,9 @@ A jump table for the options with a short description can be found at |Q_op|.
|hl-Title| t Titles for output from ":set all", ":autocmd" etc.
|hl-VertSplit| c column used to separate vertically split windows
|hl-Visual| v Visual mode
|hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
Selection" Only X11 Gui's |gui-x11| and
|xterm-clipboard|.
|hl-VisualNOS| V Visual mode when Vim is "Not Owning the
Selection" Only X11 Gui's |gui-x11|,
|xterm-clipboard| and |wayland-selections|
|hl-WarningMsg| w warning messages
|hl-WildMenu| W wildcard matches displayed for 'wildmenu'
|hl-Folded| f line used for closed folds
Expand Down Expand Up @@ -9720,7 +9752,10 @@ A jump table for the options with a short description can be found at |Q_op|.
:set wc=X
:set wc=^I
:set wc=<Tab>
< NOTE: This option is set to the Vi default value when 'compatible' is
< 'wildchar' also enables completion in search pattern contexts such as
|/|, |?|, |:s|, |:g|, |:v|, and |:vim|. To insert a literal <Tab>
instead of triggering completion, type <C-V><Tab> or "\t".
NOTE: This option is set to the Vi default value when 'compatible' is
set and to the Vim default value when 'compatible' is reset.

*'wildcharm'* *'wcm'*
Expand Down Expand Up @@ -10043,6 +10078,40 @@ A jump table for the options with a short description can be found at |Q_op|.
'winwidth' applies to the current window. Use 'winminwidth' to set
the minimal width for other windows.

*'wlseat'* *'wse'*
'wlseat' 'wse' string (default "")
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
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
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
option will also update |v:clipmethod|.

*'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
|wayland-focus-steal|.

*'wltimeoutlen'* *'wtm'*
'wltimeoutlen' 'wtm' number (default 500)
global
{only when the |+wayland| feature is included}
The timeout in milliseconds before Vim gives up on waiting for the
Wayland compositor. While Vim waits on the compositor, it is
unresponsive to input and does not update the screen. Therefore
setting this to a lower value may make Vim feel more responsive in
some cases. On the other hand, it may also mean you receive errors
when the compositor takes more time to respond than usual.

Additionally, this option is also used as the maximum timeout when
waiting for a surface to gain focus, see |wayland-focus-steal|.

*'wrap'* *'nowrap'*
'wrap' boolean (default on)
local to window
Expand Down