diff options
Diffstat (limited to 'runtime/doc/nvim_terminal_emulator.txt')
| -rw-r--r-- | runtime/doc/nvim_terminal_emulator.txt | 76 |
1 files changed, 66 insertions, 10 deletions
diff --git a/runtime/doc/nvim_terminal_emulator.txt b/runtime/doc/nvim_terminal_emulator.txt index 96f99528ed..dbc14f5a44 100644 --- a/runtime/doc/nvim_terminal_emulator.txt +++ b/runtime/doc/nvim_terminal_emulator.txt @@ -115,7 +115,7 @@ You can change the defaults with a TermOpen autocommand: >vim TERMINAL COLORS ~ The `{g,b}:terminal_color_x` variables control the terminal color palette, -where `x` is the color index between 0 and 255 inclusive. The variables are +where `x` is the color index between 0 and 15 inclusive. The variables are read during |TermOpen|. The value must be a color name or hexadecimal string. Example: >vim let g:terminal_color_4 = '#ff0000' @@ -239,7 +239,7 @@ gdb window and use a "print" command, e.g.: > print *eap If mouse pointer movements are working, Vim will also show a balloon when the mouse rests on text that can be evaluated by gdb. -You can also use the "K" mapping that will either use neovim floating windows +You can also use the "K" mapping that will either use Nvim floating windows if available to show the results or print below the status bar. Now go back to the source window and put the cursor on the first line after @@ -317,6 +317,18 @@ This is similar to using "print" in the gdb window. You can usually shorten `:Evaluate` to `:Ev`. +Navigating stack frames ~ + *termdebug-frames* *:Frame* *:Up* *:Down* + `:Frame` [frame] select frame [frame], which is a frame number, + address, or function name (default: current frame) + `:Up` [count] go up [count] frames (default: 1; the frame that + called the current) + `+` same (see |termdebug_map_plus| to disable) + `:Down` [count] go down [count] frames (default: 1; the frame called + by the current) + `-` same (see |termdebug_map_minus| to disable) + + Other commands ~ *termdebug-commands* *:Gdb* jump to the gdb window @@ -325,7 +337,9 @@ Other commands ~ isn't one *:Asm* jump to the window with the disassembly, create it if there isn't one - + *:Var* jump to the window with the local and argument variables, + create it if there isn't one. This window updates whenever the + program is stopped Events ~ *termdebug-events* @@ -385,20 +399,48 @@ Prompt mode can be used with: >vim If there is no g:termdebug_config you can use: >vim let g:termdebug_use_prompt = 1 < - *termdebug_map_K* -The K key is normally mapped to :Evaluate. If you do not want this use: >vim +Mappings ~ + *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: >vim let g:termdebug_config['map_K'] = 0 If there is no g:termdebug_config you can use: >vim let g:termdebug_map_K = 0 < + *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: >vim + let g:termdebug_config['map_minus'] = 0 +< + *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: >vim + let g:termdebug_config['map_plus'] = 0 +< *termdebug_disasm_window* -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: >vim +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: >vim let g:termdebug_config['disasm_window'] = 1 let g:termdebug_config['disasm_window_height'] = 15 If there is no g:termdebug_config you can use: >vim let g:termdebug_disasm_window = 15 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 +the height option won't be used). + + *termdebug_variables_window* +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: >vim + let g:termdebug_config['variables_window'] = 1 + let g:termdebug_config['variables_window_height'] = 15 +If there is no g:termdebug_config you can use: >vim + let g:termdebug_variables_window = 15 +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 +the height options won't be used). Communication ~ *termdebug-communication* @@ -428,14 +470,14 @@ If the command needs an argument use a List: >vim If there is no g:termdebug_config you can use: >vim let g:termdebugger = ['rr', 'replay', '--'] -To not use neovim floating windows for previewing variable evaluation, set the +To not use Nvim floating windows for previewing variable evaluation, set the `g:termdebug_useFloatingHover` variable like this: >vim let g:termdebug_useFloatingHover = 0 If you are a mouse person, you can also define a mapping using your right click to one of the terminal command like evaluate the variable under the cursor: >vim - nnoremap <RightMouse> :Evaluate<CR> + nnoremap <RightMouse> :Evaluate<CR> or set/unset a breakpoint: >vim nnoremap <RightMouse> :Break<CR> @@ -451,7 +493,7 @@ The function will be called with the list of arguments so far, and a second argument that is the name of the pty. *gdb-version* Only debuggers fully compatible with gdb will work. Vim uses the GDB/MI -interface. The "new-ui" command requires gdb version 7.12 or later. if you +interface. The "new-ui" command requires gdb version 7.12 or later. If you get this error: Undefined command: "new-ui". Try "help".~ Then your gdb is too old. @@ -493,6 +535,20 @@ If there is no g:termdebug_config you can use: >vim let g:termdebug_popup = 0 +Change default signs ~ + *termdebug_signs* +Termdebug uses the hex number of the breakpoint ID in the signcolumn to +represent breakpoints. if it is greater than "0xFF", then it will be displayed +as "F+", due to we really only have two screen cells for the sign. + +If you want to customize the breakpoint signs: >vim + let g:termdebug_config['sign'] = '>>' +If there is no g:terminal_config yet you can use: >vim + let g:termdebug_config = {'sign': '>>'} + +After this, breakpoints will be displayed as `>>` in the signcolumn. + + Vim window width ~ *termdebug_wide* To change the width of the Vim window when debugging starts and use a vertical |