Skip to content

Update options.{txt,jax} #2060

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 3 commits into
base: master
Choose a base branch
from
Open

Update options.{txt,jax} #2060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c078347
Update options.{txt,jax}
h-east Apr 30, 2025
77b0b73
Fix by nvcheck
h-east Apr 30, 2025
7873ca4
Update by original
h-east May 1, 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
154 changes: 108 additions & 46 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 Apr 08
*options.txt* For Vim バージョン 9.1. Last change: 2025 Apr 30


VIMリファレンスマニュアル by Bram Moolenaar
Expand Down Expand Up @@ -235,7 +235,7 @@ Termcap オプションを設定するには、{option} に "t_xx" の形式を
:set makeprg=make,file 結果は "make,file"
:set makeprg=make\\,file 結果は "make\,file"
:set tags=tags,file 結果は "tags" と "file"
:set tags=tags\\,file 結果は "tags,file"
:set tags=tags\\,file 結果は "tags\,file"
:let &tags='tags\,file' (同上)

文字 "|" によって、コマンド ":set" を後に続くコマンドと分けることができる。文
Expand Down Expand Up @@ -2127,6 +2127,27 @@ Note 1番目の形式では、行全体がオプション指定に使われる
前またはマクロを検索 |i_CTRL-X_CTRL-D|
] タグ補完
t "]" と同じ
f{func} 関数 {func} を呼び出す。複数の "f" フラグを指定できる。関数の
呼び出し方法と戻り値の詳細については、|complete-functions| を
参照。値は関数名または |Funcref| を指定できる。|Funcref| 値の
場合、スペースはバックスラッシュ ('\') で、コンマは 2 つのバッ
クスラッシュ ('\\') でエスケープする必要がある (
|option-backslash| を参照)。
{func} によって返される Dict に {"refresh": "always"} が含まれ
る場合、先頭のテキストが変更されるたびに関数が再度呼び出され
る。
a:findstart が 1 の場合、{func} によって返される列に関係なく補
完マッチは常にキーワード境界に挿入される。これにより、他の補完
ソースとの互換性が確保される。
挿入されたテキストをさらに変更するには、{func} で
|CompleteDonePre| を使用できる。
マッチの生成が遅くなる可能性がある場合は、ブロックを避けてエ
ディタの応答性を保つために、|complete_check()| を使用するべき
である。
f 'completefunc' オプションから取得した関数を使って "f{func}" を
使用するのと同じである。
o 'omnifunc' オプションから取得した関数を使って "f{func}" を使用
するのと同じである。

読み込まれていないバッファでは、何しろ読み込まれていないのだから、
|:autocmd| は実行されていない。そのため、ある種のファイルからは思いも
Expand All @@ -2146,6 +2167,13 @@ Note 1番目の形式では、行全体がオプション指定に使われる
きる (つまり辞書 |i_CTRL-X_CTRL-K|、インクルードされるパターン
|i_CTRL-X_CTRL-I|、タグ |i_CTRL-X_CTRL-]| および通常の展開)。

補完ソースのフラグにキャレット ("^") と {count} を付加することで、補完
ソースに任意のマッチ数制限を指定できる。
例えば、".^9,w,u,t^5" は、カレントバッファからのマッチ数を 9 個まで、
タグからのマッチ数を 5 個までに制限する。その他の補完元は無制限である。
Note: マッチ数制限は前方補完 (CTRL-N) 時にのみ有効で、後方補完 (CTRL-P)
時には無視される。

*'completefunc'* *'cfu'*
'completefunc' 'cfu' 文字列 (既定では空)
バッファについてローカル
Expand Down Expand Up @@ -2224,6 +2252,12 @@ Note 1番目の形式では、行全体がオプション指定に使われる
ついて付加的な情報があるときに便利である。例えば、それがど
のファイルに含まれているかなど。

nearest マッチ項目はカーソル位置からの距離に基づいてリストされ、デ
フォルトの動作であるカーソル下に表示されるマッチのみ近さを
考慮する方法とは異なる。これはカレントバッファ内のマッチ項
目にのみ適用される。"fuzzy" が指定されている場合は効果がな
い。

noinsert いかなるマッチしたテキストも、ユーザーがメニューから選択し
ない限り挿入しない。"menu" か "menuone" と組み合わせたとき
にだけ機能する。"longest" が指定された場合には、なんの影響
Expand Down Expand Up @@ -3643,6 +3677,7 @@ Note 1番目の形式では、行全体がオプション指定に使われる
lastline '@' 'display' が含む最終行/切り捨て
trunc '>' |ins-completion-menu| 内の切り捨てられ
たテキスト
truncrl '<' 'rightleft' モードの "trunc" と同じ

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

Expand All @@ -3667,6 +3702,7 @@ Note 1番目の形式では、行全体がオプション指定に使われる
lastline NonText |hl-NonText|
trunc |hl-PmenuSel| のような多くのポップアップメニューハイラ
イトグループの 1 つ。
truncrl "trunc" と同じ

*'findfunc'* *'ffu'* *E1514*
'findfunc' 'ffu' 文字列 (既定では "")
Expand Down Expand Up @@ -4853,7 +4889,7 @@ Note 1番目の形式では、行全体がオプション指定に使われる
コマンド |gf| でも、ファイルの実際の名前が見つからないときは、これが使
われる。プログラミング言語の 'include' 文の後で "gf" を使えるようにな
る。
また |<cfile>| にも使われる。
Note: |<cfile>| では使用されない。

式が s: か |<SID>| で始まる場合、スクリプトID(|local-function|) に置き
換えられる。例: >
Expand Down Expand Up @@ -4990,6 +5026,22 @@ Note 1番目の形式では、行全体がオプション指定に使われる
文字があるならば、補完される部分もみな大文字になる。
'noinfercase' にすると、マッチした単語がそのまま挿入される。

*'isexpand'* *'ise'*
'isexpand' 'ise' 文字列 (既定では "")
バッファについてローカル
挿入モードで補完する文字とパターンを定義する。|complete_match()| 関数
で補完の開始位置を決定するために使用される。これはコンマ区切りのトリ
ガーのリストである。各トリガーは以下のいずれかになる:
- "." や "/" のような単一の文字
- "->"、"/*" または "/**" のような文字のシーケンス

Note: トリガー文字としてリテラルのコンマを追加するには、"\\," を使用す
る。|option-backslash| を参照。

例: >
set isexpand=.,->,/*,\\,
<

*'insertmode'* *'im'* *'noinsertmode'* *'noim'*
'insertmode' 'im' 切替 (既定ではオフ)
グローバル
Expand Down Expand Up @@ -8507,11 +8559,12 @@ Note 1番目の形式では、行全体がオプション指定に使われる
'tagfunc' 'tfu' 文字列 (既定では "")
バッファについてローカル
{|+eval| 機能付きでコンパイルされたときのみ有効}
このオプションは、タグ検索を実行するために使用される関数を指定する。こ
の関数はタグパターンを取得し、一致するタグのリストを返さなければならな
い。|tag-function| を参照。関数の書き方と例の説明がある。値として関数
名、|lambda|、|Funcref| が使える。詳細は |option-value-function| を参
照。
このオプションは、タグ検索 (|taglist()| を含む) を実行するために使用さ
れる関数を指定する。
この関数はタグパターンを取得し、一致するタグのリストを返さなければなら
ない。|tag-function| を参照。関数の書き方と例の説明がある。値として関
数名、|lambda|、|Funcref| が使える。詳細は |option-value-function| を
参照。
セキュリティ上の理由から、このオプションを |modeline| または |sandbox|
内で設定することはできない。

Expand Down Expand Up @@ -9668,53 +9721,62 @@ Note 1番目の形式では、行全体がオプション指定に使われる
*'wildmode'* *'wim'*
'wildmode' 'wim' 文字列 (Vimの既定値は "full")
グローバル
オプション 'wildchar' で指定されたキーで開始する補完モード。値は、キー
ワードの4個までのコンマ区切りのリストである。それぞれのキーワードで、
連続して 'wildchar' を使ったときの動作を指定する。1個目のキーワードが
'wildchar' を1回目に使ったときの動作を指定し、2個目のキーワードが2回目
の動作を指定、等となる。

各部分はコロンで区切られたリストで次の可能な値で構成される:
"" 最初のマッチのみを補完する。
"full" 次のマッチを完全に補完する。最後のマッチの次には元の文
字列が使われ、その次は再び最初のマッチが補完される。
'wildmenu' が有効ならばそれも開始する。
"longest" 共通する最長の文字列までが補完される。それ以上長い文字
列を補完できないときは、次の候補に移る。
"list" 複数のマッチがあるときは、全てのマッチを羅列する。
"lastused" バッファ名が補完され1より多くマッチした時、バッファを
最終利用時刻でソートする (カレントバッファ以外)。
"noselect" 最初のメニュー項目を事前に選択せず、有効な場合は
'wildmenu' を開始する。
マッチするものが 1 つしかない場合は、"noselect" が存在する場合を除き、
すべてのケースで完全に補完される。

コロン区切りで利用できる例:
"longest:full" "longest" と似ているが、'wildmenu' が有効ならばそれも
開始する。次の完全なマッチを補完しない。
"list:full" 複数のマッチがあるときは、全てのマッチを羅列し、最初の
マッチを補完する。
"list:longest" 複数のマッチがあるときは、全てのマッチを羅列し、共通す
る最長の文字列までが補完される。
"list:lastused" 複数のバッファが一致する場合、一致する全バッファを最終
利用時刻でソートし羅列する (カレントバッファ以外)。
'wildchar' で指定された文字に使用される補完モード。このオプションは最
大 4 つの部分からなるコンマ区切りのリストで、それぞれ 'wildchar' の 1
回目、2 回目、3 回目および 4 回目の押下に対応する。各部分はコロンで区
切られた補完動作のリストで、それぞれのフェーズで同時に適用される。

可能な動作値は以下の通り:
"" 最初のマッチだけを補完 (挿入) する。それ以降のマッチは
繰り返されたりリストされたりしない。
"full" 次の完全なマッチを補完する。すべてのマッチを順に巡り、
最後のマッチの後は元の入力に戻る。'wildmenu' が有効に
なっている場合は、それが表示される。
"longest" 最長共通の部分文字列まで補完する。これで入力が拡張され
ない場合は、次の 'wildmode' 部分が使用される。
"list" 複数のマッチが見つかった場合は、すべてをリストする。
"lastused" バッファ名を補完する際、最近使用した順に並べ替える (カ
レントバッファを除く)。バッファ名の補完にのみ適用され
る。
"noselect" 'wildmenu' が有効な場合、メニューは表示されるが、最初
の項目は事前に選択されない。
マッチするものが 1 つしかない場合は、"noselect" が指定されていない限り
完全に補完される。

コロンで区切られた値の便利な組み合わせの例:
"longest:full" 最長共通の文字列から開始し、 'wildmenu' (有効
な場合) を表示する。完全マッチは循環しない。
"list:full" すべてのマッチをリストし、最初のマッチを補完す
る。
"list:longest" すべてのマッチをリストし、最長の共通プリフィッ
クスまで補完する。
"list:lastused" すべてのマッチをリストする。バッファを補完する
ときに、最近使用した順に並べ替える (カレント
バッファを除く)。
"noselect:lastused" 'wildmenu' がアクティブな場合、最初の項目を事
前に選択しない。バッファを補完する際、最近使用
した順に並べ替える (カレントバッファは除く)。

例: >
:set wildmode=full
< 最初のマッチ、次のマッチ...を完全に補完する (既定値) >
< 押下のたびに完全マッチを補完する (デフォルトの動作) >
:set wildmode=longest,full
< 共通する最長の文字列を補完し、次からマッチを完全に補完する >
< 1 回目の押下: 最長共通の部分文字列
2 回目の押下: 完全マッチを順に切り替える >
:set wildmode=list:full
< 全てのマッチを羅列し、そして最初のマッチを完全に補完する >
< 1 回目の押下: すべてのマッチをリストし、最初の項目を補完する >
:set wildmode=list,full
< 補完せずに全てのマッチを羅列し、次からマッチを完全に補完する >
< 1 回目の押下: マッチのみをリストする
2 回目の押下: 完全マッチを補完する >
:set wildmode=longest,list
< 共通する最長の文字列を補完し、次から他の候補を羅列する >
< 1 回目の押下: 最長共通の部分文字列
2 回目の押下: すべてのマッチをリストする >
:set wildmode=noselect:full
< 補完せずに 'wildmenu' を表示し、次に各完全マッチを表示する >
< 1 回目の押下: 補完も選択もせずに 'wildmenu' を表示
2 回目の押下: 完全マッチを循環する >
:set wildmode=noselect:lastused,full
< 上記と同じだが、バッファを最後に使用した時間でソートする。
より詳しくは |cmdline-completion| を参照。
< 上記と同じだが、バッファのマッチは最後に使用された時間でソートされる
詳細はこちら |cmdline-completion|。

*'wildoptions'* *'wop'*
'wildoptions' 'wop' 文字列 (既定では "")
Expand Down
Loading