tmux choose-tree
Put a pane into tree mode, where a session, window or pane may be chosen interactively from a tree.
Syntax¶
tmux choose-tree [-GNrswZ] [-F format] [-f filter] [-K key-format] [-O sort-order] [-t target-pane] [template]Behavior¶
-s
starts with sessions collapsed and -w with windows
collapsed. -Z zooms the pane.
-y disables any confirmation prompts. The
following keys may be used in tree mode:
| Key | Function |
Enter |
Choose selected item |
Up |
Select previous item |
Down |
Select next item |
S-Up |
Swap the current window with the previous one |
S-Down |
Swap the current window with the next one |
+ |
Expand selected item |
- |
Collapse selected item |
M-+ |
Expand all items |
M-- |
Collapse all items |
x |
Kill selected item |
X |
Kill tagged items |
< |
Scroll list of previews left |
> |
Scroll list of previews right |
C-s |
Search by name |
m |
Set the marked pane |
M |
Clear the marked pane |
n |
Repeat last search forwards |
N |
Repeat last search backwards |
t |
Toggle if item is tagged |
T |
Tag no items |
C-t |
Tag all items |
: |
Run a command for each tagged item |
f |
Enter a format to filter items |
H |
Jump to the starting pane |
O |
Change sort order |
r |
Reverse sort order |
v |
Toggle preview |
F1 or
C-h |
Display help |
q |
Exit mode |
After a session, window or pane is chosen, the first instance
of ‘%%’ and all instances of
‘%1’ are replaced by the target in
template and the result executed as a command. If
template is not given, "switch-client -t
'%%'" is used.
-O specifies the initial sort order:
one of ‘index’,
‘name’,
‘activity’ (time) or
‘z’. -r
reverses the sort order. -f specifies an initial
filter: the filter is a format - if it evaluates to zero, the item in
the list is not shown, otherwise it is shown. If a filter would lead to
an empty list, it is ignored. -F specifies the
format for each item in the tree and -K a format
for each shortcut key; both are evaluated once for each line.
-N starts without the preview or if given twice
with the larger preview. -G includes all
sessions in any session groups in the tree rather than only the first.
This command works only if at least one client is attached.
C implementation¶
Internal declarations in tmux 3.7c:
Use from a library¶
Each API describes its own defaults, errors and execution model.
tmux sources and license
Syntax comes from tmux 3.7c list-commands. See the global options for sockets and configuration, and command syntax and targets.
Behavior is taken from the tmux 3.7c manual.
Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com> Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.