Skip to content

Update options.{txt,jax} #2029

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

Merged
merged 4 commits into from
Apr 21, 2025
Merged

Update options.{txt,jax} #2029

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f13a25e
Update options.{txt,jax}
h-east Apr 6, 2025
ff65e3b
Update by original
h-east Apr 9, 2025
ea94650
s/ロケーション/location/
h-east Apr 9, 2025
1e44971
Fix by review
h-east Apr 19, 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
92 changes: 76 additions & 16 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 Mar 14
*options.txt* For Vim バージョン 9.1. Last change: 2025 Apr 08


VIMリファレンスマニュアル by Bram Moolenaar
Expand Down Expand Up @@ -1625,7 +1625,7 @@ Note 1番目の形式では、行全体がオプション指定に使われる
るというのがあり、もしファイルが他のプログラムに変更されても認識されな
い。

"quickfix" バッファはエラーリストとロケーションリストにのみ使われる。
"quickfix" バッファはエラーリストと location リストにのみ使われる。
この値はコマンド|:cwindow| と|:lwindow|で設定され、ユーザーが変更するこ
とはないはずである。

Expand Down Expand Up @@ -1765,6 +1765,17 @@ Note 1番目の形式では、行全体がオプション指定に使われる
セキュリティ上の理由から、このオプションを |modeline| または |sandbox|
内で設定することはできない。

*'chistory'* *'chi'*
'chistory' 'chi' 数値 (既定では 10)
グローバル
{|+quickfix| 機能付きでコンパイルされたときのみ有効}
quickfix スタックに記憶する quickfix リストの数。1 から 100 の間で指定
する必要がある。このオプションが quickfix リストスタック内のエントリ数
よりも小さい値に設定された場合、エントリは最も古いものから削除される。
現在の quickfix リストが削除された場合、スタックの先頭 (最も最近作成さ
れたもの) の quickfix リストが代わりに使用される。詳細については、
|quickfix-stack| を参照。

*'cindent'* *'cin'* *'nocindent'* *'nocin'*
'cindent' 'cin' 切替 (既定ではオフ)
バッファについてローカル
Expand Down Expand Up @@ -2934,7 +2945,8 @@ Note 1番目の形式では、行全体がオプション指定に使われる
内で設定することはできない。

*'dip'* *'diffopt'*
'diffopt' 'dip' 文字列 (既定では "internal,filler,closeoff")
'diffopt' 'dip' 文字列 (既定では
"internal,filler,closeoff,inline:simple")
グローバル
{|+diff| 機能付きでコンパイルされたときのみ有効}
差分モード用のオプション設定。以下の項目で構成できる。すべてオプション
Expand Down Expand Up @@ -2997,6 +3009,23 @@ Note 1番目の形式では、行全体がオプション指定に使われる
内部 diff ライブラリのインデントヒューリスティ
ックを使用する。

inline:{text} 変更内のインライン diff をハイライトする。
|view-diffs| を参照。サポートされている値は次
のとおり:

none インラインハイライトを実行しない。
simple 各行の最初の異なる文字から最後の文字ま
でをハイライトする。`inline:` 値が設定
されていない場合はこれがデフォルトであ
る。
char 内部 diff を使用して文字ごとの diff を
実行し、違いをハイライトする。
word 内部 diff を使用して |word| 単位の
diff を実行し、違いをハイライトする。
絵文字や CJK 文字などの英数字以外のマ
ルチバイト文字は、個別の単語として扱わ
れる。

internal 内部 diff ライブラリを使用する。'diffexpr' が
設定されている場合は無視される。 *E960*
バッファを書き込むときにメモリが不足すると、こ
Expand Down Expand Up @@ -3596,9 +3625,10 @@ Note 1番目の形式では、行全体がオプション指定に使われる
*'fillchars'* *'fcs'*
'fillchars' 'fcs' 文字列 (既定では "vert:|,fold:-,eob:~,lastline:@")
グローバル／ウィンドウについてローカル |global-local|
ウィンドウのステータス行、垂直分割の区切り、特殊行を埋める文字。
これはコンマで区切られた項目のリストである。各項目には、名前、コロン、
およびその項目の値がある: |E1511|
ウィンドウのステータス行、垂直分割の区切り、特殊行、および
|ins-completion-menu| 内の切り捨てられたテキストを埋めるための文字。こ
れはコンマで区切られた項目のリストである。各項目には、名前、コロン、お
よびその項目の値がある: |E1511|

キーワード 既定値 変更の対象 ~
stl ' ' カレントウィンドウのステータス行
Expand All @@ -3611,6 +3641,8 @@ Note 1番目の形式では、行全体がオプション指定に使われる
diff '-' 'diff' での削除された行
eob '~' バッファ終端以降の空行
lastline '@' 'display' が含む最終行/切り捨て
trunc '>' |ins-completion-menu| 内の切り捨てられ
たテキスト

指定されなかったキーワードについては、既定値が使われる。

Expand All @@ -3621,15 +3653,20 @@ Note 1番目の形式では、行全体がオプション指定に使われる
トおよびマルチバイトの文字をサポートしている。しかし全角文字幅の文字は
サポートしていない。|E1512|

強調表示が行われるものおよびその属するグループ:
ハイライトが行われるものおよびその属するグループ:
項目名 ハイライトグループ ~
stl StatusLine |hl-StatusLine|
stlnc StatusLineNC |hl-StatusLineNC|
vert VertSplit |hl-VertSplit|
fold Folded |hl-Folded|
foldopen FoldColumn |hl-FoldColumn|
foldclose FoldColumn |hl-FoldColumn|
foldsep FoldColumn |hl-FoldColumn|
diff DiffDelete |hl-DiffDelete|
eob EndOfBuffer |hl-EndOfBuffer|
lastline NonText |hl-NonText|
trunc |hl-PmenuSel| のような多くのポップアップメニューハイラ
イトグループの 1 つ。

*'findfunc'* *'ffu'* *E1514*
'findfunc' 'ffu' 文字列 (既定では "")
Expand Down Expand Up @@ -4424,10 +4461,10 @@ Note 1番目の形式では、行全体がオプション指定に使われる
v:Visual,V:VisualNOS,w:WarningMsg,
W:WildMenu,f:Folded,F:FoldColumn,
A:DiffAdd,C:DiffChange,D:DiffDelete,
T:DiffText,>:SignColumn,-:Conceal,
B:SpellBad,P:SpellCap,R:SpellRare,
L:SpellLocal,+:Pmenu,=:PmenuSel,
k:PmenuMatch,<:PmenuMatchSel,
T:DiffText,E:DiffTextAdd,>:SignColumn,
-:Conceal,B:SpellBad,P:SpellCap,
R:SpellRare, L:SpellLocal,+:Pmenu,
=:PmenuSel, k:PmenuMatch,<:PmenuMatchSel,
[:PmenuKind,]:PmenuKindSel,
{:PmenuExtra,}:PmenuExtraSel,
x:PmenuSbar,X:PmenuThumb,*:TabLine,
Expand Down Expand Up @@ -4483,7 +4520,8 @@ Note 1番目の形式では、行全体がオプション指定に使われる
|hl-DiffAdd| A 差分モードで追加された行
|hl-DiffChange| C 差分モードで変更された行
|hl-DiffDelete| D 差分モードで削除された行
|hl-DiffText| T 差分モードで挿入されたテキスト
|hl-DiffText| T 差分モードで変更されたテキスト
|hl-DiffTextAdd| E 差分モードで挿入されたテキスト
|hl-SignColumn| > |signs| に使われる桁
|hl-Conceal| - Conceal テキストの代替表示 ('conceallevel' 参照)
|hl-SpellBad| B スペルミスの単語 |spell|
Expand Down Expand Up @@ -5348,6 +5386,17 @@ Note 1番目の形式では、行全体がオプション指定に使われる
これにより表示エラーとなることがある。再描画によってちらつきや速度低下
になる場合にのみ一時的に設定することを目的としてる。

*'lhistory'* *'lhi'*
'lhistory' 'lhi' 数値 (既定では 10)
ウィンドウについてローカル
{|+quickfix| 機能付きでコンパイルされたときのみ有効}
'chistory' と同様だが、ウィンドウに関連付けられた location リストスタッ
クを対象としている。 location リストウィンドウ自体、または location リ
ストスタックに関連付けられたウィンドウのいずれかでオプションが変更され
た場合、新しい値はもう一方のウィンドウにも適用される。つまりこの値は、
特定の location リストウィンドウとそれに対応するウィンドウで常に同じに
なる。詳細については |quickfix-stack| を参照。

*'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
'linebreak' 'lbr' 切替 (既定ではオフ)
ウィンドウについてローカル
Expand Down Expand Up @@ -6495,6 +6544,17 @@ Note 1番目の形式では、行全体がオプション指定に使われる
0 のときはスペースの許す限り多く表示される。
|ins-completion-menu|

*'pummaxwidth'* *'pmw'*
'pummaxwidth' 'pmw' 数値 (既定では 0)
グローバル
補完用のポップアップメニューに使用する最大幅を決定する。ゼロの場合、最
大幅の制限はない。それ以外の場合、ポップアップメニューはこの値より広く
なることはない。切り捨てられたテキストは、'fillchars' オプションの
"trunc" 値によって表示される。

このオプションは 'pumwidth' よりも優先される。
|ins-completion-menu|。

*'pumwidth'* *'pw'*
'pumwidth' 'pw' 数値 (既定では 15)
グローバル
Expand Down Expand Up @@ -6574,10 +6634,10 @@ Note 1番目の形式では、行全体がオプション指定に使われる
'quickfixtextfunc' 'qftf' 文字列 (既定では "")
グローバル
{|+quickfix| 機能付きでコンパイルされたときのみ有効}
このオプションはクイックフィックスもしくはロケーションリストで表示する
テキストを取得するのに利用される関数を指定する。クイックフィックスもし
くはロケーションリストでの情報を各表示項目に付随する情報をカスタマイズ
して表示するときに利用できる。関数の書き方と例については
このオプションは quickfix もしくは location リストで表示するテキストを
取得するのに利用される関数を指定する。クイックフィックスもしくは
location リストでの情報を各表示項目に付随する情報をカスタマイズして表
示するときに利用できる。関数の書き方と例については
|quickfix-window-function| を参照。値として関数名、|lambda|、|Funcref|
が使える。詳細は |option-value-function| を参照。

Expand Down
83 changes: 73 additions & 10 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 Mar 14
*options.txt* For Vim version 9.1. Last change: 2025 Apr 08


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -1717,6 +1717,19 @@ A jump table for the options with a short description can be found at |Q_op|.
This option cannot be set from a |modeline| or in the |sandbox|, for
security reasons.

*'chistory'* *'chi'*
'chistory' 'chi' number (default: 10)
global
{only available when compiled with the |+quickfix|
feature}
Number of quickfix lists that should be remembered for the quickfix
stack. Must be between 1 and 100. If the option is set to a value
that is lower than the amount of entries in the quickfix list stack,
entries will be removed starting from the oldest one. If the current
quickfix list was removed, then the quickfix list at top of the stack
(the most recently created) will be used in its place. For additional
info, see |quickfix-stack|.

*'cindent'* *'cin'* *'nocindent'* *'nocin'*
'cindent' 'cin' boolean (default off)
local to buffer
Expand Down Expand Up @@ -2655,7 +2668,7 @@ A jump table for the options with a short description can be found at |Q_op|.
*E1193* *E1194* *E1195* *E1196* *E1230*
*E1197* *E1198* *E1199* *E1200* *E1201*
xchacha20 XChaCha20 Cipher with Poly1305 Message Authentication
Code. Medium strong till strong encryption.
Code. Medium strong to strong encryption.
Encryption is provided by the libsodium library, it
requires Vim to be built with |+sodium|.
It adds a seed and a message authentication code (MAC)
Expand Down Expand Up @@ -2910,7 +2923,8 @@ A jump table for the options with a short description can be found at |Q_op|.
security reasons.

*'dip'* *'diffopt'*
'diffopt' 'dip' string (default "internal,filler,closeoff")
'diffopt' 'dip' string (default
"internal,filler,closeoff,inline:simple")
global
{not available when compiled without the |+diff|
feature}
Expand Down Expand Up @@ -2975,6 +2989,24 @@ A jump table for the options with a short description can be found at |Q_op|.
Use the indent heuristic for the internal
diff library.

inline:{text} Highlight inline differences within a change.
See |view-diffs|. Supported values are:

none Do not perform inline highlighting.
simple Highlight from first different
character to the last one in each
line. This is the default if no
`inline:` value is set.
char Use internal diff to perform a
character-wise diff and highlight the
difference.
word Use internal diff to perform a
|word|-wise diff and highlight the
difference. Non-alphanumeric
multi-byte characters such as emoji
and CJK characters are considered
individual words.

internal Use the internal diff library. This is
ignored when 'diffexpr' is set. *E960*
When running out of memory when writing a
Expand Down Expand Up @@ -3571,8 +3603,8 @@ A jump table for the options with a short description can be found at |Q_op|.
*'fillchars'* *'fcs'*
'fillchars' 'fcs' string (default "vert:|,fold:-,eob:~,lastline:@")
global or local to window |global-local|
Characters to fill the statuslines, vertical separators and special
lines in the window.
Characters to fill the statuslines, vertical separators, special
lines in the window and truncated text in the |ins-completion-menu|.
It is a comma-separated list of items. Each item has a name, a colon
and the value of that item: |E1511|

Expand All @@ -3587,6 +3619,8 @@ A jump table for the options with a short description can be found at |Q_op|.
diff '-' deleted lines of the 'diff' option
eob '~' empty lines below the end of a buffer
lastline '@' 'display' contains lastline/truncate
trunc '>' truncated text in the
|ins-completion-menu|.

Any one that is omitted will fall back to the default.

Expand All @@ -3603,9 +3637,14 @@ A jump table for the options with a short description can be found at |Q_op|.
stlnc StatusLineNC |hl-StatusLineNC|
vert VertSplit |hl-VertSplit|
fold Folded |hl-Folded|
foldopen FoldColumn |hl-FoldColumn|
foldclose FoldColumn |hl-FoldColumn|
foldsep FoldColumn |hl-FoldColumn|
diff DiffDelete |hl-DiffDelete|
eob EndOfBuffer |hl-EndOfBuffer|
lastline NonText |hl-NonText|
trunc one of the many Popup menu highlighting groups like
|hl-PmenuSel|

*'findfunc'* *'ffu'* *E1514*
'findfunc' 'ffu' string (default empty)
Expand Down Expand Up @@ -4392,10 +4431,10 @@ A jump table for the options with a short description can be found at |Q_op|.
v:Visual,V:VisualNOS,w:WarningMsg,
W:WildMenu,f:Folded,F:FoldColumn,
A:DiffAdd,C:DiffChange,D:DiffDelete,
T:DiffText,>:SignColumn,-:Conceal,
B:SpellBad,P:SpellCap,R:SpellRare,
L:SpellLocal,+:Pmenu,=:PmenuSel,
k:PmenuMatch,<:PmenuMatchSel,
T:DiffText,E:DiffTextAdd,>:SignColumn,
-:Conceal,B:SpellBad,P:SpellCap,
R:SpellRare, L:SpellLocal,+:Pmenu,
=:PmenuSel, k:PmenuMatch,<:PmenuMatchSel,
[:PmenuKind,]:PmenuKindSel,
{:PmenuExtra,}:PmenuExtraSel,
x:PmenuSbar,X:PmenuThumb,*:TabLine,
Expand Down Expand Up @@ -4447,7 +4486,8 @@ A jump table for the options with a short description can be found at |Q_op|.
|hl-DiffAdd| A added line in diff mode
|hl-DiffChange| C changed line in diff mode
|hl-DiffDelete| D deleted line in diff mode
|hl-DiffText| T inserted text in diff mode
|hl-DiffText| T changed text in diff mode
|hl-DiffTextAdd| E inserted text in diff mode
|hl-SignColumn| > column used for |signs|
|hl-Conceal| - the placeholders used for concealed characters
(see 'conceallevel')
Expand Down Expand Up @@ -5296,6 +5336,18 @@ A jump table for the options with a short description can be found at |Q_op|.
temporarily when performing an operation where redrawing may cause
flickering or cause a slowdown.

*'lhistory'* *'lhi'*
'lhistory' 'lhi' number (default: 10)
local to window
{only available when compiled with the |+quickfix|
feature}
Like 'chistory', but for the location list stack associated with a
window. If the option is changed in either the location list window
itself or the window that is associated with the location list stack,
the new value will also be applied to the other one. This means this
value will always be the same for a given location list window and its
corresponding window. See |quickfix-stack| for additional info.

*'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
'linebreak' 'lbr' boolean (default off)
local to window
Expand Down Expand Up @@ -6459,6 +6511,17 @@ A jump table for the options with a short description can be found at |Q_op|.
global
Determines the maximum number of items to show in the popup menu for
Insert mode completion. When zero as much space as available is used.
|ins-completion-menu|.

*'pummaxwidth'* *'pmw'*
'pummaxwidth' 'pmw' number (default 0)
global
Determines the maximum width to use for the popup menu for completion.
When zero, there is no maximum width limit, otherwise the popup menu
will never be wider than this value. Truncated text will be indicated
by "trunc" value of 'fillchars' option.

This option takes precedence over 'pumwidth'.
|ins-completion-menu|.

*'pumwidth'* *'pw'*
Expand Down