diff options
Diffstat (limited to 'runtime/doc/terminal.txt')
| -rw-r--r-- | runtime/doc/terminal.txt | 36 |
1 files changed, 27 insertions, 9 deletions
diff --git a/runtime/doc/terminal.txt b/runtime/doc/terminal.txt index 5058bf05e5..6f98cba447 100644 --- a/runtime/doc/terminal.txt +++ b/runtime/doc/terminal.txt @@ -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 20 VIM REFERENCE MANUAL by Bram Moolenaar @@ -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: > @@ -1528,10 +1530,13 @@ 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. @@ -1539,27 +1544,32 @@ 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 @@ -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 @@ -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: > @@ -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* @@ -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. |