tmuxtmuxCLI Manual

Choose documentation 1

3.2a

tmux manual version

Latest (3.7c) 3.7c 3.2a
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

tmux customize-mode

Put a pane into customize mode, where options and key bindings may be browsed and modified from a list.

Syntax

tmux customize-mode [-NZ] [-F format] [-f filter] [-t target-pane]

Behavior

Put a pane into customize mode, where options and key bindings may be browsed and modified from a list. Option values in the list are shown for the active pane in the current window. -Z zooms the pane. The following keys may be used in customize mode:
Set pane, window, session or global option value
Select previous item
Select next item
Expand selected item
- Collapse selected item
Expand all items
Collapse all items
Set option value or key attribute
Set global option value
Set window option value, if option is for pane and window
Set an option or key to the default
Set tagged options and tagged keys to the default
Unset an option (set to default value if global) or unbind a key
Unset tagged options and unbind tagged keys
Search by name
Repeat last search
Toggle if item is tagged
Tag no items
Tag all items
Enter a format to filter items
Toggle option information
Exit mode

-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. -N starts without the option information. This command works only if at least one client is attached.

C implementation

Internal declarations in tmux 3.2a:

Use from a library

Each API describes its own defaults, errors and execution model.

tmux sources and license

Syntax comes from tmux 3.2a list-commands. See the global options for sockets and configuration, and command syntax and targets.

Behavior is taken from the tmux 3.2a manual.

Command declaration

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.
Esc

Type to search.