nvim-plugins/toggleterm.nvim
1
0
Fork 0
mirror of https://github.com/akinsho/toggleterm.nvim synced 2024-09-16 21:34:03 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore(build): auto-generate vimdoc

Browse source
This commit is contained in:
github-actions[bot] 2023-09-11 06:46:50 +00:00
parent 81ea9f71a3
commit 0427b908eb
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/toggleterm.txt
View file

@ -213,10 +213,10 @@ TOGGLETERM ~
This is the command the mappings call under the hood. You can use it directly
and prefix it with a count to target a specific terminal. This function also
takes arguments `size`, `dir` and `direction`. e.g.
takes arguments `size`, `dir`, `direction` and `name`. e.g.
>vim
:ToggleTerm size=40 dir=~/Desktop direction=horizontal
:ToggleTerm size=40 dir=~/Desktop direction=horizontal name=desktop
<
If `dir` is specified on creation toggle term will open at the specified
@ -234,6 +234,10 @@ changed to `size`.
If `direction` is specified, and the command opens a terminal, the terminal
will be changed to the specified direction.
If `name` is specified, the display name is set for the toggled terminal. This
name will be visible when using `TermSelect` command to indicate the specific
terminal.
`size` and `direction` are ignored if the command closes a terminal.
@ -264,8 +268,8 @@ The `cmd` and `dir` arguments can also expand the same special keywords as
These special keywords can be escaped using the `\` character, if you want to
print character as is.
The `size` and `direction` arguments are like the `size` and `direction`
arguments of `ToggleTerm`.
The `size`, `direction` and `name` arguments are like the `size`, `direction`
and `name` arguments of `ToggleTerm`.
By default, focus is returned to the original window after executing the
command (except for floating terminals). Use argument `go_back=0` to disable