Add documentation for pinning

This commit is contained in:
Jay Kamat 2017-05-12 13:28:53 -07:00
parent 2ae1bfc033
commit 1572be83be
No known key found for this signature in database
GPG Key ID: 5D2E399600F4F7B5
2 changed files with 35 additions and 2 deletions

View File

@ -82,6 +82,7 @@ It is possible to run or bind multiple commands by separating them with `;;`.
|<<tab-move,tab-move>>|Move the current tab according to the argument and [count].
|<<tab-next,tab-next>>|Switch to the next tab, or switch [count] tabs forward.
|<<tab-only,tab-only>>|Close all tabs except for the current one.
|<<tab-pin,tab-pin>>|Pin the current/[count]th tab.
|<<tab-prev,tab-prev>>|Switch to the previous tab, or switch [count] tabs back.
|<<unbind,unbind>>|Unbind a keychain.
|<<undo,undo>>|Re-open a closed tab (optionally skipping [count] closed tabs).
@ -334,7 +335,7 @@ Syntax: +:help [*--tab*] [*--bg*] [*--window*] ['topic']+
Show help about a command or setting.
==== positional arguments
* +'topic'+: The topic to show help for.
* +'topic'+: The topic to show help for.
- :__command__ for commands.
- __section__\->__option__ for settings.
@ -893,13 +894,27 @@ How many tabs to switch forward.
[[tab-only]]
=== tab-only
Syntax: +:tab-only [*--prev*] [*--next*]+
Syntax: +:tab-only [*--prev*] [*--next*] [*--force*]+
Close all tabs except for the current one.
==== optional arguments
* +*-p*+, +*--prev*+: Keep tabs before the current.
* +*-n*+, +*--next*+: Keep tabs after the current.
* +*-f*+, +*--force*+: Avoid confirmation for pinned tabs.
[[tab-pin]]
=== tab-pin
Syntax: +:tab-pin+
Pin the current/[count]th tab.
==== count
The tab index to pin
==== note
* Pinning a tab shrinks it to `tabs->pinned-width` size.
* Attempting to close a pinned tab will cause a confirmation, unless `--force` is passed.
[[tab-prev]]
=== tab-prev

View File

@ -124,6 +124,7 @@
|<<tabs-wrap,wrap>>|Whether to wrap when changing tabs.
|<<tabs-movable,movable>>|Whether tabs should be movable.
|<<tabs-close-mouse-button,close-mouse-button>>|On which mouse button to close tabs.
|<<tabs-pinned-width,pinned-width>>|The size of pinned tabs.
|<<tabs-position,position>>|The position of the tab bar.
|<<tabs-show-favicons,show-favicons>>|Whether to show favicons in the tab bar.
|<<tabs-favicon-scale,favicon-scale>>|Scale for favicons in the tab bar. The tab size is unchanged, so big favicons also require extra `tabs->padding`.
@ -131,6 +132,7 @@
|<<tabs-indicator-width,indicator-width>>|Width of the progress indicator (0 to disable).
|<<tabs-tabs-are-windows,tabs-are-windows>>|Whether to open windows instead of tabs.
|<<tabs-title-format,title-format>>|The format to use for the tab title. The following placeholders are defined:
|<<tabs-title-format-pinned,title-format-pinned>>|The format to use for the tab title, when it is pinned. The following placeholders are defined:
|<<tabs-title-alignment,title-alignment>>|Alignment of the text inside of tabs
|<<tabs-mousewheel-tab-switching,mousewheel-tab-switching>>|Switch between tabs using the mouse wheel.
|<<tabs-padding,padding>>|Padding for tabs (top, bottom, left, right).
@ -1183,6 +1185,14 @@ Valid values:
Default: +pass:[middle]+
[[tabs-pinned-width]]
=== pinned-width
The width for pinned tabs with a horizontal tabbar, in px.
See `:tab-pin` for more details.
Default: +43+
[[tabs-position]]
=== position
The position of the tab bar.
@ -1252,6 +1262,14 @@ The format to use for the tab title. The following placeholders are defined:
Default: +pass:[{index}: {title}]+
[[tabs-title-format-pinned]]
=== title-format-pinned
The format to use for the tab title when it is pinned.
The same syntax is used as `tabs->title-format`
Default: +pass:[{index}]+
[[tabs-title-alignment]]
=== title-alignment
Alignment of the text inside of tabs