diff options
Diffstat (limited to 'runtime/doc/terminal.txt')
| -rw-r--r-- | runtime/doc/terminal.txt | 53 |
1 files changed, 31 insertions, 22 deletions
diff --git a/runtime/doc/terminal.txt b/runtime/doc/terminal.txt index 3acc51382..a089ef94b 100644 --- a/runtime/doc/terminal.txt +++ b/runtime/doc/terminal.txt @@ -1,4 +1,4 @@ -*terminal.txt* For Vim version 9.0. Last change: 2022 Oct 10 +*terminal.txt* For Vim version 9.0. Last change: 2022 Nov 10 VIM REFERENCE MANUAL by Bram Moolenaar @@ -469,7 +469,6 @@ ConPTY problems have been fixed "winpty" will be preferred. Environment variables are used to pass information to the running job: VIM_SERVERNAME v:servername - ============================================================================== 2. Terminal functions *terminal-function-details* @@ -1129,7 +1128,6 @@ reference: > Creating a screen dump ~ *terminal-screendump* - To create the screen dump, run Vim (or any other program) in a terminal and make it show the desired state. Then use the |term_dumpwrite()| function to create a screen dump file. For example: > @@ -1153,7 +1151,6 @@ If there are differences then v:errors will contain the error message. Comparing screen dumps ~ *terminal-diffscreendump* - |assert_equalfile()| does not make it easy to see what is different. To spot the problem use |term_dumpdiff()|: > call term_dumpdiff("mysyntax.dump", "test.dump") @@ -1350,6 +1347,7 @@ If 'mouse' is set the plugin adds a window toolbar with these entries: Eval `:Evaluate` This way you can use the mouse to perform the most common commands. You need to have the 'mouse' option set to enable mouse clicks. +See |termdebug_winbar| for configuring this toolbar. *:Winbar* You can add the window toolbar in other windows you open with: > :Winbar @@ -1415,6 +1413,20 @@ TermdebugStopPost After debugging has ended, gdb-related windows the state before the debugging was restored. +Customizing ~ + *termdebug-customizing* *g:termdebug_config* +In the past several global variables were used for configuration. These are +deprecated and using the g:termdebug_config dictionary is preferred. When +g:termdebug_config exists the other global variables will NOT be used. +The recommended way is to start with an empty dictionary: > + let g:termdebug_config = {} + +Then you can add entries to the dictionary as mentioned below. The +deprecated global variable names are mentioned for completeness. If you are +switching over to using g:termdebug_config you can find the old variable name +and take over the value, then delete the deprecated variable. + + Prompt mode ~ *termdebug-prompt* When the |+terminal| feature is not supported and on MS-Windows, gdb will run @@ -1430,13 +1442,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 -Or if there is no g:termdebug_config: > +If there is no g:termdebug_config you can use: > let g:termdebug_use_prompt = 1 < *termdebug_map_K* The K key is normally mapped to :Evaluate. If you do not want this use: > let g:termdebug_config['map_K'] = 0 -Or if there is no g:termdebug_config: > +If there is no g:termdebug_config you can use: > let g:termdebug_map_K = 0 < *termdebug_disasm_window* @@ -1444,7 +1456,7 @@ If you want the Asm window shown by default, set the 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_height'] = 15 -or, if there is no g:termdebug_config: > +If there is no g:termdebug_config you can use: > let g:termdebug_disasm_window = 15 Any value greater than 1 will set the Asm window height to that value. @@ -1462,25 +1474,18 @@ interrupt the running program. But after using the MI command communication channel. -Customizing ~ - *termdebug-customizing* *g:termdebug_config* -In the past several global variables were used for configuration. These are -deprecated, using the g:termdebug_config dictionary is preferred. When -g:termdebug_config exists the other global variables will not be used. - - GDB command ~ *g:termdebugger* To change the name of the gdb command, set "debugger" entry in g:termdebug_config or the "g:termdebugger" variable before invoking `:Termdebug`: > let g:termdebug_config['command'] = "mygdb" -Or if there is no g:termdebug_config: > +If there is no g:termdebug_config you can use: > let g:termdebugger = "mygdb" If the command needs an argument use a List: > let g:termdebug_config['command'] = ['rr', 'replay', '--'] -Or if there is no g:termdebug_config: > +If there is no g:termdebug_config you can use: > let g:termdebugger = ['rr', 'replay', '--'] Several arguments will be added to make gdb work well for the debugger. @@ -1501,7 +1506,7 @@ Then your gdb is too old. Colors ~ - *hl-debugPC* *hl-debugBreakpoint* + *hl-debugPC* *hl-debugBreakpoint* The color of the signs can be adjusted with these highlight groups: - debugPC the current position - debugBreakpoint a breakpoint @@ -1517,7 +1522,6 @@ When 'background' is "dark": Shortcuts ~ *termdebug_shortcuts* - You can define your own shortcuts (mappings) to control gdb, that can work in any window, using the TermDebugSendCommand() function. Example: > map ,w :call TermDebugSendCommand('where')<CR> @@ -1526,7 +1530,6 @@ The argument is the gdb command. Popup menu ~ *termdebug_popup* - By default the Termdebug plugin sets 'mousemodel' to "popup_setpos" and adds these entries to the popup menu: Set breakpoint `:Break` @@ -1534,17 +1537,23 @@ these entries to the popup menu: Evaluate `:Evaluate` If you don't want this then disable it with: > let g:termdebug_config['popup'] = 0 -or if there is no g:termdebug_config: > +If there is no g:termdebug_config you can use: > let g:termdebug_popup = 0 +Window toolbar ~ + *termdebug_winbar* +By default the Termdebug plugin creates a window toolbar if the mouse is +enabled (see |:Winbar|). If you don't want this then disable it with: > + let g:termdebug_config['winbar'] = 0 + + Vim window width ~ *termdebug_wide* - To change the width of the Vim window when debugging starts and use a vertical split: > let g:termdebug_config['wide'] = 163 -Or if there is no g:termdebug_config: > +If there is no g:termdebug_config you can use: > let g:termdebug_wide = 163 This will set 'columns' to 163 when `:Termdebug` is used. The value is |