tmux choose-client
Put a pane into client mode, allowing a client to be selected interactively from a list.
Syntax¶
tmux choose-client [-NrZ] [-F format] [-f filter] [-K key-format] [-O sort-order] [-t target-pane] [template]Behavior¶
-Z zooms the pane.
-y disables any confirmation prompts. The
following keys may be used in client mode:
| Key | Function |
Enter |
Choose selected client |
Up |
Select previous client |
Down |
Select next client |
C-s |
Search by name |
n |
Repeat last search forwards |
N |
Repeat last search backwards |
t |
Toggle if client is tagged |
T |
Tag no clients |
C-t |
Tag all clients |
d |
Detach selected client |
D |
Detach tagged clients |
x |
Detach and HUP selected client |
X |
Detach and HUP tagged clients |
z |
Suspend selected client |
Z |
Suspend tagged clients |
f |
Enter a format to filter items |
O |
Change sort order |
r |
Reverse sort order |
v |
Toggle preview |
F1 or
C-h |
Display help |
q |
Exit mode |
After a client is chosen,
‘%%’ is replaced by the client
name in template and the result executed as a
command. If template is not given,
"detach-client -t '%%'" is used.
-O specifies the initial sort order:
one of ‘name’,
‘size’,
‘creation’ (time), or
‘activity’ (time).
-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 list 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.
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.