Skip to content

Commit

Permalink
Merge pull request #1636 from vim-jp/hh-update-terminal
Browse files Browse the repository at this point in the history
Update terminal.{txt,jax}
  • Loading branch information
h-east authored Jul 29, 2024
2 parents 1a56880 + 9a7242e commit d5ec7fc
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 18 deletions.
36 changes: 27 additions & 9 deletions doc/terminal.jax
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*terminal.txt* For Vim バージョン 9.1. Last change: 2024 Jun 20
*terminal.txt* For Vim バージョン 9.1. Last change: 2024 Jul 28


VIMリファレンスマニュアル by Bram Moolenaar
Expand Down Expand Up @@ -1241,6 +1241,8 @@ SSH 接続が1つあればリモートで機能します。
*termdebug-starting*
以下のコマンドでプラグインを読み込みます: >
packadd termdebug
|.vimrc| ファイルからプラグインを読み込む時は、"!" 属性を追加します: >
packadd! termdebug
< *:Termdebug*
デバッグを開始するには `:Termdebug` または `:TermdebugCommand` に続けてコマン
ド名を入力します。例: >
Expand Down Expand Up @@ -1513,10 +1515,13 @@ TermdebugStopPost デバッグの終了後、gdb 関連ウィンドウが閉じ

*termdebug_use_prompt*
プロンプトモードは、|+terminal| 機能が有効な場合でも使用できます: >
let g:termdebug_config['use_prompt'] = 1
let g:termdebug_config['use_prompt'] = v:true
g:termdebug_config がない場合は、以下を使用できます: >
let g:termdebug_use_prompt = 1
let g:termdebug_use_prompt = v:true
<
ただし、後者の形式は将来のリリースでは非推奨になります。

マッピング ~
termdebug プラグインは、いくつかのデフォルトマッピングを有効にします。
termdebug セッションが終了すると、これらのマッピングはすべて元の値にリセットさ
Expand All @@ -1525,28 +1530,33 @@ termdebug セッションが終了すると、これらのマッピングはす
*termdebug_map_K* *termdebug-mappings*
K へのバッファローカル (|:map-local|) マッピングがすでに存在している場合を除
き、K キーは通常 |:Evaluate| にマップされています。これが不要な場合は: >
let g:termdebug_config['map_K'] = 0
let g:termdebug_config['map_K'] = v:false
g:termdebug_config がない場合は、以下を使用できます: >
let g:termdebug_map_K = 0
let g:termdebug_map_K = v:false
<
ただし、後者の形式は将来のリリースでは非推奨になります。

*termdebug_map_minus*
- へのバッファローカルマッピングがすでに存在している場合を除き、- は通常
|:Down| にマップされています。これが不要な場合は: >
let g:termdebug_config['map_minus'] = 0
let g:termdebug_config['map_minus'] = v:false
<
*termdebug_map_plus*
+ へのバッファローカルマッピングがすでに存在している場合を除き、+ は通常 |:Up|
にマップされています。これが不要な場合は: >
let g:termdebug_config['map_plus'] = 0
let g:termdebug_config['map_plus'] = v:false
<
*termdebug_disasm_window*
Asm ウィンドウをデフォルトで表示させたい場合、"disasm_window" フラグに 1 を設
定します。"disasm_window_height" エントリを使用してウィンドウの高さを設定でき
ます: >
let g:termdebug_config['disasm_window'] = 1
let g:termdebug_config['disasm_window'] = v:true
let g:termdebug_config['disasm_window_height'] = 15
g:termdebug_config がない場合は、以下を使用できます: >
let g:termdebug_disasm_window = 15
ただし、後者の形式は将来のリリースでは非推奨になります。

1以上の任意の値を設定でき、その値が Asm ウィンドウの高さになります。
カレントウィンドウに十分な水平方向のスペースがある場合、垂直方向に分割され、
Asm ウィンドウがソースコードウィンドウと並べて表示されます (高さのオプションは
Expand All @@ -1556,10 +1566,13 @@ Asm ウィンドウがソースコードウィンドウと並べて表示され
Var ウィンドウをデフォルトで表示させたい場合、"variables_window" フラグに 1 を
設定します。"variables_window_height" エントリを使用してウィンドウの高さを設定
できます: >
let g:termdebug_config['variables_window'] = 1
let g:termdebug_config['variables_window'] = v:true
let g:termdebug_config['variables_window_height'] = 15
g:termdebug_config がない場合は、以下を使用できます: >
let g:termdebug_variables_window = 15
ただし、後者の形式は将来のリリースでは非推奨になります。

1 以上の任意の値を設定でき、その値が Var ウィンドウの高さになります。
カレントウィンドウに十分な水平方向のスペースがある場合、垂直方向に分割され、
Var ウィンドウがソースコードウィンドウと並べて表示されます (高さのオプションは
Expand Down Expand Up @@ -1588,6 +1601,8 @@ g:termdebug_config の "debugger" エントリか "g:termdebugger" 変数を変
g:termdebug_config がない場合は、以下を使用できます: >
let g:termdebugger = "mygdb"
ただし、後者の形式は将来のリリースでは非推奨になります。

コマンドに引数が必要な場合はリストを使用してください: >
let g:termdebug_config['command'] = ['rr', 'replay', '--']
g:termdebug_config がない場合は、以下を使用できます: >
Expand Down Expand Up @@ -1644,6 +1659,7 @@ TermDebugSendCommand() 関数を使用して、任意のウィンドウで動作
g:termdebug_config がない場合は、以下を使用できます: >
let g:termdebug_popup = 0
ただし、後者の形式は将来のリリースでは非推奨になります。

デフォルトの目印の変更 ~
*termdebug_signs*
Expand Down Expand Up @@ -1675,6 +1691,8 @@ Vimのウィンドウ幅 ~
g:termdebug_config がない場合は、以下を使用できます: >
let g:termdebug_wide = 163
ただし、後者の形式は将来のリリースでは非推奨になります。

これは `:Termdebug` を実行した際に 'columns' を 163 に設定します。元の値はデ
バッガが終了する際に復元されます。

Expand Down
36 changes: 27 additions & 9 deletions en/terminal.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*terminal.txt* For Vim version 9.1. Last change: 2024 Jun 20
*terminal.txt* For Vim version 9.1. Last change: 2024 Jul 28


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -1253,6 +1253,8 @@ Starting ~
*termdebug-starting*
Load the plugin with this command: >
packadd termdebug
When loading the plugin from the |.vimrc| file, add the "!" attribute: >
packadd! termdebug
< *:Termdebug*
To start debugging use `:Termdebug` or `:TermdebugCommand` followed by the
command name, for example: >
Expand Down Expand Up @@ -1528,38 +1530,46 @@ in a buffer with 'buftype' set to "prompt". This works slightly differently:

*termdebug_use_prompt*
Prompt mode can be used even when the |+terminal| feature is present with: >
let g:termdebug_config['use_prompt'] = 1
let g:termdebug_config['use_prompt'] = v:true
If there is no g:termdebug_config you can use: >
let g:termdebug_use_prompt = 1
let g:termdebug_use_prompt = v:true
<
However, the latter form will be deprecated in future releases.

Mappings ~
The termdebug plugin enables a few default mappings. All those mappings
are reset to their original values once the termdebug session concludes.

*termdebug_map_K* *termdebug-mappings*
The K key is normally mapped to |:Evaluate| unless a buffer local (|:map-local|)
mapping to K already exists. If you do not want this use: >
let g:termdebug_config['map_K'] = 0
let g:termdebug_config['map_K'] = v:false
If there is no g:termdebug_config you can use: >
let g:termdebug_map_K = 0
let g:termdebug_map_K = v:false
<
However, the latter form will be deprecated in future releases.

*termdebug_map_minus*
The - key is normally mapped to |:Down| unless a buffer local mapping to the -
key already exists. If you do not want this use: >
let g:termdebug_config['map_minus'] = 0
let g:termdebug_config['map_minus'] = v:false
<
*termdebug_map_plus*
The + key is normally mapped to |:Up| unless a buffer local mapping to the +
key already exists. If you do not want this use: >
let g:termdebug_config['map_plus'] = 0
let g:termdebug_config['map_plus'] = v:false
<
*termdebug_disasm_window*
If you want the Asm window shown by default, set the "disasm_window" flag to
1. The "disasm_window_height" entry can be used to set the window height: >
let g:termdebug_config['disasm_window'] = 1
let g:termdebug_config['disasm_window'] = v:true
let g:termdebug_config['disasm_window_height'] = 15
If there is no g:termdebug_config you can use: >
let g:termdebug_disasm_window = 15
However, the latter form will be deprecated in future releases.

Any value greater than 1 will set the Asm window height to that value.
If the current window has enough horizontal space, it will be vertically split
and the Asm window will be shown side by side with the source code window (and
Expand All @@ -1569,10 +1579,13 @@ the height option won't be used).
If you want the Var window shown by default, set the "variables_window" flag
to 1. The "variables_window_height" entry can be used to set the window
height: >
let g:termdebug_config['variables_window'] = 1
let g:termdebug_config['variables_window'] = v:true
let g:termdebug_config['variables_window_height'] = 15
If there is no g:termdebug_config you can use: >
let g:termdebug_variables_window = 15
However, the latter form will be deprecated in future releases.

Any value greater than 1 will set the Var window height to that value.
If the current window has enough horizontal space, it will be vertically split
and the Var window will be shown side by side with the source code window (and
Expand Down Expand Up @@ -1601,6 +1614,8 @@ g:termdebug_config or the "g:termdebugger" variable before invoking
If there is no g:termdebug_config you can use: >
let g:termdebugger = "mygdb"
However, the latter form will be deprecated in future releases.

If the command needs an argument use a List: >
let g:termdebug_config['command'] = ['rr', 'replay', '--']
If there is no g:termdebug_config you can use: >
Expand Down Expand Up @@ -1658,6 +1673,7 @@ If you don't want this then disable it with: >
If there is no g:termdebug_config you can use: >
let g:termdebug_popup = 0
However, the latter form will be deprecated in future releases.

Change default signs ~
*termdebug_signs*
Expand Down Expand Up @@ -1688,6 +1704,8 @@ split: >
If there is no g:termdebug_config you can use: >
let g:termdebug_wide = 163
However, the latter form will be deprecated in future releases.

This will set 'columns' to 163 when `:Termdebug` is used. The value is
restored when quitting the debugger.

Expand Down

0 comments on commit d5ec7fc

Please sign in to comment.