@@ -114,6 +114,9 @@ break: >
114114 tnoremap <Esc> <C-W>N
115115 set notimeout ttimeout timeoutlen=100
116116
117+ You can also create menus similar to terminal mode mappings, but you have to
118+ use | :tlmenu | instead of | :tmenu | .
119+
117120< *options-in-terminal*
118121After opening the terminal window and setting 'buftype' to "terminal" the
119122TerminalOpen autocommand event is triggered. This makes it possible to set
@@ -228,6 +231,10 @@ Syntax ~
228231
229232 If you want to use more options use the | term_start() |
230233 function.
234+ If you want to split the window vertically, use: >
235+ :vertical terminal
236+ < Or short: >
237+ :vert ter
231238
232239 When the buffer associated with the terminal is forcibly unloaded or wiped out
233240the job is killed, similar to calling `job_stop(job, "kill")` .
@@ -523,9 +530,9 @@ inspects the resulting screen state.
523530
524531Functions ~
525532
526- term_sendkeys() send keystrokes to a terminal (not subject to tmap)
527- term_wait() wait for screen to be updated
528- term_scrape() inspect terminal screen
533+ | term_sendkeys() | send keystrokes to a terminal (not subject to tmap)
534+ | term_wait() | wait for screen to be updated
535+ | term_scrape() | inspect terminal screen
529536
530537
531538==============================================================================
@@ -552,7 +559,7 @@ src/testdir/test_syntax.vim. The main parts are:
552559 characters. This makes sure the dump is always this size. The function
553560 RunVimInTerminal() takes care of this. Pass it the arguments for the Vim
554561 command.
555- - Send any commands to Vim using term_sendkeys(). For example: >
562+ - Send any commands to Vim using | term_sendkeys() | . For example: >
556563 call term_sendkeys(buf, ":echo &lines &columns\<CR>")
557564 - Check that the screen is now in the expected state, using
558565 VerifyScreenDump(). This expects the reference screen dump to be in the
@@ -580,21 +587,21 @@ Creating a screen dump ~
580587 *terminal-screendump*
581588
582589To create the screen dump, run Vim (or any other program) in a terminal and
583- make it show the desired state. Then use the term_dumpwrite() function to
590+ make it show the desired state. Then use the | term_dumpwrite() | function to
584591create a screen dump file. For example: >
585592 :call term_dumpwrite(77, "mysyntax.dump")
586593
587594 Here "77" is the buffer number of the terminal. Use `:ls ! ` to see it.
588595
589- You can view the screen dump with term_dumpload(): >
596+ You can view the screen dump with | term_dumpload() | : >
590597 :call term_dumpload("mysyntax.dump")
591598
592599 To verify that Vim still shows exactly the same screen, run Vim again with
593600exactly the same way to show the desired state. Then create a screen dump
594601again, using a different file name: >
595602 :call term_dumpwrite(88, "test.dump")
596603
597- To assert that the files are exactly the same use assert_equalfile(): >
604+ To assert that the files are exactly the same use | assert_equalfile() | : >
598605 call assert_equalfile("mysyntax.dump", "test.dump")
599606
600607 If there are differences then v:errors will contain the error message.
@@ -603,8 +610,8 @@ If there are differences then v:errors will contain the error message.
603610Comparing screen dumps ~
604611 *terminal-diffscreendump*
605612
606- assert_equalfile() does not make it easy to see what is different.
607- To spot the problem use term_dumpdiff(): >
613+ | assert_equalfile() | does not make it easy to see what is different.
614+ To spot the problem use | term_dumpdiff() | : >
608615 call term_dumpdiff("mysyntax.dump", "test.dump")
609616
610617 This will open a window consisting of three parts:
@@ -613,7 +620,18 @@ This will open a window consisting of three parts:
6136203. The contents of the second dump
614621
615622You can usually see what differs in the second part. Use the 'ruler' to
616- relate it to the position in the first or second dump.
623+ relate it to the position in the first or second dump. Letters indicate the
624+ kind of difference:
625+ X different character
626+ > cursor in first but not in second
627+ < cursor in second but not in first
628+ w character width differs (single vs double width)
629+ f foreground color differs
630+ b background color differs
631+ a attribute differs (bold, underline, reverse, etc.)
632+ ? character missing in both
633+ + character missing in first
634+ - character missing in second
617635
618636Alternatively, press "s" to swap the first and second dump. Do this several
619637times so that you can spot the difference in the context of the text.
@@ -635,7 +653,7 @@ Starting ~
635653Load the plugin with this command: >
636654 packadd termdebug
637655< *:Termdebug*
638- To start debugging use `:Termdebug ` or `:TermdebugCommand ` ` followed by the
656+ To start debugging use `:Termdebug ` or `:TermdebugCommand ` followed by the
639657command name, for example: >
640658 :Termdebug vim
641659
@@ -900,7 +918,7 @@ Vim window width *termdebug_wide*
900918To change the width of the Vim window when debugging starts, and use a
901919vertical split: >
902920 let g:termdebug_wide = 163
903- This will set &columns to 163 when :Termdebug is used. The value is restored
921+ This will set &columns to 163 when ` :Termdebug ` is used. The value is restored
904922when quitting the debugger.
905923If g:termdebug_wide is set and &columns is already larger than
906924g:termdebug_wide then a vertical split will be used without changing &columns.
0 commit comments