TMUX(1) | General Commands Manual | TMUX(1) |
tmux | [-2lCquvV] [-c shell-command] [-f file] [-L socket-name] [-S socket-path] [command [flags]] |
When tmux is started it creates a new session with a single window and displays it on screen. A status line at the bottom of the screen shows information on the current session and is used to enter interactive commands.
A session is a single collection of pseudo terminals under the management of tmux. Each session has one or more windows linked to it. A window occupies the entire screen and may be split into rectangular panes, each of which is a separate pseudo terminal (the pty(7) manual page documents the technical details of pseudo terminals). Any number of tmux instances may connect to the same session, and any number of windows may be present in the same session. Once all sessions are killed, tmux exits.
Each session is persistent and will survive accidental disconnection (such as ssh(1) connection timeout) or intentional detaching (with the ‘C-b d
’ key strokes). tmux may be reattached using:
$ tmux attach
In tmux, a session is displayed on screen by a client and all sessions are managed by a single server. The server and each client are separate processes which communicate through a socket in /tmp.
The options are as follows:
The configuration file is a set of tmux commands which are executed in sequence when the server is first started. tmux loads configuration files once when the server process has started. The source-file command may be used to load a file later.
tmux shows any error messages from commands in configuration files in the first session created, and continues to process the rest of the configuration file.
If the socket is accidentally removed, the SIGUSR1 signal may be sent to the tmux server process to recreate it.
If the server is started from a client passed -u or where UTF-8 is detected, the utf8 and status-utf8 options are enabled in the global window and session options respectively.
C-b
’ (Ctrl-b) by default, followed by a command key.The default command key bindings are:
Key bindings may be changed with the bind-key and unbind-key commands.
target-session is the session id prefixed with a $, the name of a session (as listed by the list-sessions command), or the name of a client with the same syntax as target-client, in which case the session attached to the client is used. When looking for the session name, tmux initially searches for an exact match; if none is found, the session names are checked for any for which target-session is a prefix or for which it matches as an fnmatch(3) pattern. If a single match is found, it is used as the target session; multiple matches produce an error. If a session is omitted, the current session is used if available; if no current session is available, the most recently used is chosen.
target-window specifies a window in the form session:window. session follows the same rules as for target-session, and window is looked for in order: as a window index, for example mysession:1; as a window ID, such as @1; as an exact window name, such as mysession:mywindow; then as an fnmatch(3) pattern or the start of a window name, such as mysession:mywin* or mysession:mywin. An empty window name specifies the next unused index if appropriate (for example the new-window and link-window commands) otherwise the current window in session is chosen. The special character ‘!
’ uses the last (previously current) window, ‘^
’ selects the highest numbered window, ‘$
’ selects the lowest numbered window, and ‘+
’ and ‘-
’ select the next window or the previous window by number. When the argument does not contain a colon, tmux first attempts to parse it as window; if that fails, an attempt is made to match a session.
target-pane takes a similar form to target-window but with the optional addition of a period followed by a pane index, for example: mysession:mywindow.1. If the pane index is omitted, the currently active pane in the specified window is used. If neither a colon nor period appears, tmux first attempts to use the argument as a pane index; if that fails, it is looked up as for target-window. A ‘+
’ or ‘-
’ indicate the next or previous pane index, respectively. One of the strings top, bottom, left, right, top-left, top-right, bottom-left or bottom-right may be used instead of a pane index.
The special characters ‘+
’ and ‘-
’ may be followed by an offset, for example:
select-window -t:+2
When dealing with a session that doesn't contain sequential window indexes, they will be correctly skipped.
tmux also gives each pane created in a server an identifier consisting of a ‘%
’ and a number, starting from zero. A pane's identifier is unique for the life of the tmux server and is passed to the child process of the pane in the TMUX_PANE environment variable. It may be used alone to target a pane or the window containing it.
shell-command arguments are sh(1) commands. These must be passed as a single item, which typically means quoting them, for example:
new-window 'vi /etc/passwd'
command [arguments] refers to a tmux command, passed with the command and arguments separately, for example:
bind-key F1 set-window-option force-width 81
Or if using sh(1):
$ tmux bind-key F1 set-window-option force-width 81
Multiple commands may be specified together as part of a command sequence. Each command should be separated by spaces and a semicolon; commands are executed sequentially from left to right and lines ending with a backslash continue on to the next line, except when escaped by another backslash. A literal semicolon may be included by escaping it with a backslash (for example, when specifying a command sequence to bind-key).
Example tmux commands include:
refresh-client -t/dev/ttyp2 rename-session -tfirst newname set-window-option -t:0 monitor-activity on new-window ; split-window -d bind-key R source-file ~/.tmux.conf \; \ display-message "source-file done"
Or from sh(1):
$ tmux kill-window -t :1 $ tmux new-window \; split-window -d $ tmux new-session -d 'vi /etc/passwd' \; split-window -d \; attach
The following commands are available to manage clients and sessions:
If run from outside tmux, create a new client in the current terminal and attach it to target-session. If used from inside, switch the current client. If -d is specified, any other clients attached to the session are detached. -r signifies the client is read-only (only keys bound to the detach-client or switch-client commands have any effect)(alias: attach)
If no server is started, attach-session will attempt to start it; this will fail unless sessions are created in the configuration file.
The target-session rules for attach-session are slightly adjusted: if tmux needs to select the most recently used session, it will prefer the most recently used unattached session.
-c will set the session working directory (used for new windows) to working-directory.
Detach the current client if bound to a key, the client specified with -t, or all clients currently attached to the session specified by -s. The -a option kills all but the client given with -t. If -P is given, send SIGHUP to the parent process of the client, typically causing it to exit.(alias: detach)
Report an error and exit with 1 if the specified session does not exist. If it does exist, exit with 0.(alias: has)
List all clients attached to the server. For the meaning of the -F flag, see the FORMATS section. If target-session is specified, list only clients connected to that session.(alias: lsc)
List the syntax of all commands supported by tmux.(alias: lscm)
List all sessions managed by the server. For the meaning of the -F flag, see the FORMATS section.(alias: ls)
Lock target-client, see the lock-server command.(alias: lockc)
Lock all clients attached to target-session.(alias: locks)
Create a new session with name session-name.(alias: new)
The new session is attached to the current terminal unless -d is given. window-name and shell-command are the name of and shell command to execute in the initial window. If -d is used, -x and -y specify the size of the initial window (80 by 24 if not given).
If run from a terminal, any termios(3) special characters are saved and used for new windows in the new session.
The -A flag makes new-session behave like attach-session if session-name already exists; in the case, -D behaves like -d to attach-session.
If -t is given, the new session is grouped with target-session. This means they share the same set of windows - all windows from target-session are linked to the new session and any subsequent new windows or windows being closed are applied to both sessions. The current and previous window and any session options remain independent and either session may be killed without affecting the other. Giving -n or shell-command are invalid if -t is used.
The -P option prints information about the new session after it has been created. By default, it uses the format ‘#{session_name}:
’ but a different format may be specified with -F.
Refresh the current client if bound to a key, or a single client if one is given with -t. If -S is specified, only update the client's status bar.(alias: refresh)
Rename the session to new-name.(alias: rename)
Show client messages or server information. Any messages displayed on the status line are saved in a per-client message log, up to a maximum of the limit set by the message-limit session option for the session attached to that client. With -t, display the log for target-client. -I, -J and -T show debugging information about the running server, jobs and terminals.(alias: showmsgs)
Execute commands from path.(alias: source)
Start the tmux server, if not already running, without creating any sessions.(alias: start)
Suspend a client by sending SIGTSTP (tty stop).(alias: suspendc)
Switch the current session for client target-client to target-session. If -l, -n or -p is used, the client is moved to the last, next or previous session respectively. -r toggles whether a client is read-only (see the attach-session command).(alias: switchc)
[
’ by default. It is also entered when a command that produces output, such as list-keys, is executed from a key binding.The keys available depend on whether emacs or vi mode is selected (see the mode-keys option). The following keys are supported as appropriate for the mode:
Function | vi | emacs |
Back to indentation |
^ | M-m |
Bottom of history |
G | M-< |
Clear selection |
Escape | C-g |
Copy selection |
Enter | M-w |
Cursor down |
j | Down |
Cursor left |
h | Left |
Cursor right |
l | Right |
Cursor to bottom line |
L | |
Cursor to middle line |
M | M-r |
Cursor to top line |
H | M-R |
Cursor up |
k | Up |
Delete entire line |
d | C-u |
Delete/Copy to end of line |
D | C-k |
End of line |
$ | C-e |
Go to line |
: | g |
Half page down |
C-d | M-Down |
Half page up |
C-u | M-Up |
Jump forward |
f | f |
Jump to forward |
t | |
Jump backward |
F | F |
Jump to backward |
T | |
Jump again |
; | ; |
Jump again in reverse |
, | , |
Next page |
C-f | Page down |
Next space |
W | |
Next space, end of word |
E | |
Next word |
w | |
Next word end |
e | M-f |
Other end of selection |
o | |
Paste buffer |
p | C-y |
Previous page |
C-b | Page up |
Previous word |
b | M-b |
Previous space |
B | |
Quit mode |
q | Escape |
Rectangle toggle |
v | R |
Scroll down |
C-Down or C-e | C-Down |
Scroll up |
C-Up or C-y | C-Up |
Search again |
n | n |
Search again in reverse |
N | N |
Search backward |
? | C-r |
Search forward |
/ | C-s |
Start of line |
0 | C-a |
Start selection |
Space | C-Space |
Top of history |
g | M-> |
Transpose characters |
C-t |
The next and previous word keys use space and the ‘-
’, ‘_
’ and ‘@
’ characters as word delimiters by default, but this can be adjusted by setting the word-separators session option. Next word moves to the start of the next word, next word end to the end of the next word and previous word to the start of the previous word. The three next and previous space keys work similarly but use a space alone as the word separator.
The jump commands enable quick movement within a line. For instance, typing ‘f
’ followed by ‘/
’ will move the cursor to the next ‘/
’ character on the current line. A ‘;
’ will then jump to the next occurrence.
Commands in copy mode may be prefaced by an optional repeat count. With vi key bindings, a prefix is entered using the number keys; with emacs, the Alt (meta) key and a number begins prefix entry. For example, to move the cursor forward by ten words, use ‘M-1 0 M-f
’ in emacs mode, and ‘10w
’ in vi.
When copying the selection, the repeat count indicates the buffer index to replace, if used.
Mode key bindings are defined in a set of named tables: vi-edit and emacs-edit for keys used when line editing at the command prompt; vi-choice and emacs-choice for keys used when choosing from lists (such as produced by the choose-window command); and vi-copy and emacs-copy used in copy mode. The tables may be viewed with the list-keys command and keys modified or removed with bind-key and unbind-key. One command accepts an argument, copy-pipe, which copies the selection and pipes it to a command. For example the following will bind ‘C-q
’ to copy the selection into /tmp as well as the paste buffer:
bind-key -temacs-copy C-q copy-pipe "cat >/tmp/out"
The paste buffer key pastes the first line from the top paste buffer on the stack.
The synopsis for the copy-mode command is:
Each window displayed by tmux may be split into one or more panes; each pane takes up a certain area of the display and is a separate terminal. A window may be split into panes using the split-window command. Windows may be split horizontally (with the -h flag) or vertically. Panes may be resized with the resize-pane command (bound to ‘C-up
’, ‘C-down
’ ‘C-left
’ and ‘C-right
’ by default), the current pane may be changed with the select-pane command and the rotate-window and swap-pane commands may be used to swap panes without changing their position. Panes are numbered beginning from zero in the order they are created.
A number of preset layouts are available. These may be selected with the select-layout command or cycled with next-layout (bound to ‘Space
’ by default); once a layout is chosen, panes within it may be moved and resized as normal.
The following layouts are supported:
In addition, select-layout may be used to apply a previously used layout - the list-windows command displays the layout of each window in a form suitable for use with select-layout. For example:
$ tmux list-windows 0: ksh [159x48] layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0} $ tmux select-layout bb62,159x48,0,0{79x48,0,0,79x48,80,0}
tmux automatically adjusts the size of the layout for the current window size. Note that a layout cannot be applied to a window with more panes than that from which the layout was originally defined.
Commands related to windows and panes are as follows:
Break target-pane off from its containing window to make it the only pane in a new window. If -d is given, the new window does not become the current window. The -P option prints information about the new window after it has been created. By default, it uses the format ‘(alias: breakp)
#{session_name}:#{window_index}
’ but a different format may be specified with -F.Capture the contents of a pane. If -p is given, the output goes to stdout, otherwise to the buffer specified with -b or a new buffer if omitted. If -a is given, the alternate screen is used, and the history is not accessible. If no alternate screen exists, an error will be returned unless -q is given. If -e is given, the output includes escape sequences for text and background attributes. -C also escapes non-printable characters as octal \xxx. -J joins wrapped lines and preserves trailing spaces at each line's end. -P captures only any output that the pane has received that is the beginning of an as-yet incomplete escape sequence.(alias: capturep)
-S and -E specify the starting and ending line numbers, zero is the first line of the visible pane and negative numbers are lines in the history. The default is to capture only the visible contents of the pane.
%%
’ is replaced by the client pty(7) path in template and the result executed as a command. If template is not given, "detach-client -t '%%'" is used. For the meaning of the -F flag, see the FORMATS section. This command works only if at least one client is attached.%%
’ is replaced by the chosen item in the template and the result is executed as a command. If template is not given, "run-shell '%%'" is used. items also accepts format specifiers. For the meaning of this see the FORMATS section. This command works only if at least one client is attached.%%
’ is replaced by the session name in template and the result executed as a command. If template is not given, "switch-client -t '%%'" is used. For the meaning of the -F flag, see the FORMATS section. This command works only if at least one client is attached.Note that the choose-window and choose-session commands are wrappers around choose-tree.
If -s is given, will show sessions. If -w is given, will show windows.
By default, the tree is collapsed and sessions must be expanded to windows with the right arrow key. The -u option will start with all sessions expanded instead.
If -b is given, will override the default session command. Note that ‘%%
’ can be used and will be replaced with the session name. The default option if not specified is "switch-client -t '%%'". If -c is given, will override the default window command. Like -b, ‘%%
’ can be used and will be replaced with the session name and window index. When a window is chosen from the list, the session command is run before the window command.
If -S is given will display the specified format instead of the default session format. If -W is given will display the specified format instead of the default window format. For the meaning of the -s and -w options, see the FORMATS section.
This command works only if at least one client is attached.
%%
’ is replaced by the session name and window index in template and the result executed as a command. If template is not given, "select-window -t '%%'" is used. For the meaning of the -F flag, see the FORMATS section. This command works only if at least one client is attached.Display a visible indicator of each pane shown by target-client. See the display-panes-time, display-panes-colour, and display-panes-active-colour session options. While the indicator is on screen, a pane may be selected with the ‘(alias: displayp)
0
’ to ‘9
’ keys.Search for the fnmatch(3) pattern match-string in window names, titles, and visible content (but not history). The flags control matching behavior: -C matches only visible window contents, -N matches only the window name and -T matches only the window title. The default is -CNT. If only one window is matched, it'll be automatically selected, otherwise a choice list is shown. For the meaning of the -F flag, see the FORMATS section. This command works only if at least one client is attached.(alias: findw)
Like split-window, but instead of splitting dst-pane and creating a new pane, split it and move src-pane into the space. This can be used to reverse break-pane. The -b option causes src-pane to be joined to left of or above dst-pane.(alias: joinp)
Destroy the given pane. If no panes remain in the containing window, it is also destroyed. The -a option kills all but the pane given with -t.(alias: killp)
Kill the current window or the window at target-window, removing it from any sessions to which it is linked. The -a option kills all but the window given with -t.(alias: killw)
Select the last (previously selected) pane.(alias: lastp)
Select the last (previously selected) window. If no target-session is specified, select the last window of the current session.(alias: last)
Link the window at src-window to the specified dst-window. If dst-window is specified and no such window exists, the src-window is linked there. If -k is given and dst-window exists, it is killed, otherwise an error is generated. If -d is given, the newly linked window is not selected.(alias: linkw)
If -a is given, target is ignored and all panes on the server are listed. If -s is given, target is a session (or the current session). If neither is given, target is a window (or the current window). For the meaning of the -F flag, see the FORMATS section.(alias: lsp)
If -a is given, list all windows on the server. Otherwise, list windows in the current session or in target-session. For the meaning of the -F flag, see the FORMATS section.(alias: lsw)
Like join-pane, but src-pane and dst-pane may belong to the same window.(alias: movep)
This is similar to link-window, except the window at src-window is moved to dst-window. With -r, all windows in the session are renumbered in sequential order, respecting the base-index option.(alias: movew)
Create a new window. With -a, the new window is inserted at the next index up from the specified target-window, moving windows up if necessary, otherwise target-window is the new window location.(alias: neww)
If -d is given, the session does not make the new window the current window. target-window represents the window to be created; if the target already exists an error is shown, unless the -k flag is used, in which case it is destroyed. shell-command is the command to execute. If shell-command is not specified, the value of the default-command option is used. -c specifies the working directory in which the new window is created.
When the shell command completes, the window closes. See the remain-on-exit option to change this behaviour.
The TERM environment variable must be set to “screen” for all programs running inside tmux. New windows will automatically have “TERM=screen” added to their environment, but care must be taken not to reset this in shell start-up files.
The -P option prints information about the new window after it has been created. By default, it uses the format ‘#{session_name}:#{window_index}
’ but a different format may be specified with -F.
Move a window to the next layout and rearrange the panes to fit.(alias: nextl)
Move to the next window in the session. If -a is used, move to the next window with an alert.(alias: next)
Pipe any output sent by the program in target-pane to a shell command. A pane may only be piped to one command at a time, any existing pipe is closed before shell-command is executed. The shell-command string may contain the special character sequences supported by the status-left option. If no shell-command is given, the current pipe (if any) is closed.(alias: pipep)
The -o option only opens a new pipe if no previous pipe exists, allowing a pipe to be toggled with a single key, for example:
bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
Move to the previous layout in the session.(alias: prevl)
Move to the previous window in the session. With -a, move to the previous window with an alert.(alias: prev)
Rename the current window, or the window at target-window if specified, to new-name.(alias: renamew)
Resize a pane, up, down, left or right by adjustment with -U, -D, -L or -R, or to an absolute size with -x or -y. The adjustment is given in lines or cells (the default is 1).(alias: resizep)
With -Z, the active pane is toggled between zoomed (occupying the whole of the window) and unzoomed (its normal position in the layout).
Reactivate a pane in which the command has exited (see the remain-on-exit window option). If shell-command is not given, the command used when the pane was created is executed. The pane must be already inactive, unless -k is given, in which case any existing command is killed.(alias: respawnp)
Reactivate a window in which the command has exited (see the remain-on-exit window option). If shell-command is not given, the command used when the window was created is executed. The window must be already inactive, unless -k is given, in which case any existing command is killed.(alias: respawnw)
Rotate the positions of the panes within a window, either upward (numerically lower) with -U or downward (numerically higher).(alias: rotatew)
Choose a specific layout for a window. If layout-name is not given, the last preset layout used (if any) is reapplied. -n and -p are equivalent to the next-layout and previous-layout commands.(alias: selectl)
Make pane target-pane the active pane in window target-window. If one of -D, -L, -R, or -U is used, respectively the pane below, to the left, to the right, or above the target pane is used. -l is the same as using the last-pane command.(alias: selectp)
Select the window at target-window. -l, -n and -p are equivalent to the last-window, next-window and previous-window commands. If -T is given and the selected window is already the current window, the command behaves like last-window.(alias: selectw)
Create a new pane by splitting target-pane: -h does a horizontal split and -v a vertical split; if neither is specified, -v is assumed. The -l and -p options specify the size of the new pane in lines (for vertical split) or in cells (for horizontal split), or as a percentage, respectively. All other options have the same meaning as for the new-window command.(alias: splitw)
Swap two panes. If -U is used and no source pane is specified with -s, dst-pane is swapped with the previous pane (before it numerically); -D swaps with the next pane (after it numerically). -d instructs tmux not to change the active pane.(alias: swapp)
This is similar to link-window, except the source and destination windows are swapped. It is an error if no window exists at src-window.(alias: swapw)
Unlink target-window. Unless -k is given, a window may be unlinked only if it is linked to multiple sessions - windows may not be linked to no sessions; if -k is specified and the window is linked to only one session, it is unlinked and destroyed.(alias: unlinkw)
A
’ to ‘Z
’). Ctrl keys may be prefixed with ‘C-
’ or ‘^
’, and Alt (meta) with ‘M-
’. In addition, the following special key names are accepted: Up, Down, Left, Right, BSpace, BTab, DC (Delete), End, Enter, Escape, F1 to F20, Home, IC (Insert), NPage/PageDown/PgDn, PPage/PageUp/PgUp, Space, and Tab. Note that to bind the ‘"
’ or ‘'
’ keys, quotation marks are necessary, for example:
bind-key '"' split-window bind-key "'" new-window
Commands related to key bindings are as follows:
Bind key key to command. By default (without -t) the primary key bindings are modified (those normally activated with the prefix key); in this case, if -n is specified, it is not necessary to use the prefix key, command is bound to key alone. The -r flag indicates this key may repeat, see the repeat-time option.(alias: bind)
If -t is present, key is bound in key-table: the binding for command mode with -c or for normal mode without. To view the default bindings and possible commands, see the list-keys command.
List all key bindings. Without -t the primary key bindings - those executed when preceded by the prefix key - are printed.(alias: lsk)
With -t, the key bindings in key-table are listed; this may be one of: vi-edit, emacs-edit, vi-choice, emacs-choice, vi-copy or emacs-copy.
Send a key or keys to a window. Each argument key is the name of the key (such as ‘(alias: send)
C-a
’ or ‘npage
’ ) to send; if the string is not recognised as a key, it is sent as a series of characters. The -l flag disables key name lookup and sends the keys literally. All arguments are sent sequentially from first to last. The -R flag causes the terminal state to be reset.Unbind the command bound to key. Without -t the primary key bindings are modified; in this case, if -n is specified, the command bound to key without a prefix (if any) is removed. If -a is present, all key bindings are removed.(alias: unbind)
If -t is present, key in key-table is unbound: the binding for command mode with -c or for normal mode without.
The tmux server has a set of global options which do not apply to any particular window or session. These are altered with the set-option -s command, or displayed with the show-options -s command.
In addition, each individual session may have a set of session options, and there is a separate set of global session options. Sessions which do not have a particular option configured inherit the value from the global session options. Session options are set or unset with the set-option command and may be listed with the show-options command. The available server and session options are listed under the set-option command.
Similarly, a set of window options is attached to each window, and there is a set of global window options from which any unset options are inherited. Window options are altered with the set-window-option command and can be listed with the show-window-options command. All window options are documented with the set-window-option command.
tmux also supports user options which are prefixed with a ‘@
’. User options may have any name, so long as they are prefixed with ‘@
’, and be set to any string. For example
$ tmux setw -q @foo "abc123" $ tmux showw -v @foo abc123
Commands which set options are as follows:
Set a window option with -w (equivalent to the set-window-option command), a server option with -s, otherwise a session option.(alias: set)
If -g is specified, the global session or window option is set. The -u flag unsets an option, so a session inherits the option from the global options. It is not possible to unset a global option.
The -o flag prevents setting an option that is already set.
The -q flag suppresses the informational message (as if the quiet server option was set).
With -a, and if the option expects a string or a style, value is appended to the existing setting. For example:
set -g status-left "foo" set -ag status-left "bar"
Will result in ‘foobar
’. And:
set -g status-style "bg=red" set -ag status-style "fg=blue"
Will result in a red background and blue foreground. Without -a, the result would be the default background and a blue foreground.
Available window options are listed under set-window-option.
value depends on the option and may be a number, a string, or a flag (on, off, or omitted to toggle).
Available server options are:
disallowedWindowOps: 20,21,SetXprop
Or changing this property from the xterm(1) interactive menu when required.
Available session options are:
screen
’ or a derivative of it.
These may be ‘bg=colour
’ to set the background colour, ‘fg=colour
’ to set the foreground colour, and a list of attributes as specified below.
The colour is one of: black, red, green, yellow, blue, magenta, cyan, white, aixterm bright variants (if supported: brightred, brightgreen, and so on), colour0 to colour255 from the 256-colour set, default, or a hexadecimal RGB string such as ‘#ffffff
’, which chooses the closest match from the default 256-colour set.
The attributes is either none or a comma-delimited list of one or more of: bright (or bold), dim, underscore, blink, reverse, hidden, or italics, to turn an attribute on, or an attribute prefixed with ‘no
’ to turn one off.
Examples are:
fg=yellow,bold,underscore,blink bg=black,fg=default,noreverse
With the -a flag to the set-option command the new style is added otherwise the existing style is replaced.
vi
’.Character pair | Replaced with |
#(shell-command) |
First line of the command's output |
#[attributes] |
Colour or attribute change |
## |
A literal ‘# ’ |
The #(shell-command) form executes ‘shell-command
’ and inserts the first line of its output. Note that shell commands are only executed once at the interval specified by the status-interval option: if the status line is redrawn in the meantime, the previous result is used. Shell commands are executed with the tmux global environment set (see the ENVIRONMENT section).
For details on how the names and titles can be set see the NAMES AND TITLES section. For a list of allowed attributes see the message-command-style option.
Examples are:
#(sysctl vm.loadavg) #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
Where appropriate, special character sequences may be prefixed with a number to specify the maximum length, for example ‘#24T
’.
By default, UTF-8 in string is not interpreted, to enable UTF-8, use the status-utf8 option.
For example, to set the ‘clear
’ terminfo(5) entry to ‘\e[H\e[2J
’ for all terminal types and the ‘dch1
’ entry to ‘\e[P
’ for the ‘rxvt
’ terminal type, the option could be set to the string:
"*:clear=\e[H\e[2J,rxvt:dch1=\e[P"
The terminal entry value is passed through strunvis(3) before interpretation. The default value forcibly corrects the ‘colors
’ entry for terminals which support 256 colours:
"*256col*:colors=256,xterm*:XT"
-_@
’.Set a window option. The -a, -g, -o, -q and -u flags work similarly to the set-option command.(alias: setw)
Supported window options are:
set-window-option -g automatic-rename off
vi
’.
#I:#W#F
’.
Show the window options (or a single window option if given) with -w (equivalent to show-window-options), the server options with -s, otherwise the session options for target session. Global session or window options are listed if -g is used. -v shows only the option value, not the name. If -q is set, no error will be returned if option is unset.(alias: show)
List the window options or a single option for target-window, or the global window options if -g is used. -v shows only the option value, not the name.(alias: showw)
#{
’ and ‘}
’, for example ‘#{session_name}
’. Some variables also have an shorter alias such as ‘#S
’. ‘##
’ is replaced by a single ‘#
’. Conditionals are also accepted by prefixing with ‘?
’ and separating two alternatives with a comma; if the specified variable exists and is not zero, the first alternative is chosen, otherwise the second is used. For example ‘#{?session_attached,attached,not attached}
’ will include the string ‘attached
’ if the session is attached and the string ‘not attached
’ if it is unattached. A limit may be placed on the length of the resultant string by prefixing it by an ‘=
’, a number and a colon, so ‘#{=10:pane_title}
’ will include at most the first 10 characters of the pane title.The following variables are available, where appropriate:
Variable name | Alias | Replaced with |
alternate_on |
If pane is in alternate screen | |
alternate_saved_x |
Saved cursor X in alternate screen | |
alternate_saved_y |
Saved cursor Y in alternate screen | |
buffer_sample |
First 50 characters from buffer | |
buffer_size |
Size of the specified buffer in bytes | |
client_activity |
Integer time client last had activity | |
client_activity_string |
String time client last had activity | |
client_created |
Integer time client created | |
client_created_string |
String time client created | |
client_height |
Height of client | |
client_last_session |
Name of the client's last session | |
client_prefix |
1 if prefix key has been pressed | |
client_readonly |
1 if client is readonly | |
client_session |
Name of the client's session | |
client_termname |
Terminal name of client | |
client_tty |
Pseudo terminal of client | |
client_utf8 |
1 if client supports utf8 | |
client_width |
Width of client | |
cursor_flag |
Pane cursor flag | |
cursor_x |
Cursor X position in pane | |
cursor_y |
Cursor Y position in pane | |
history_bytes |
Number of bytes in window history | |
history_limit |
Maximum window history lines | |
history_size |
Size of history in bytes | |
host |
#H | Hostname of local host |
host_short |
#h | Hostname of local host (no domain name) |
insert_flag |
Pane insert flag | |
keypad_cursor_flag |
Pane keypad cursor flag | |
keypad_flag |
Pane keypad flag | |
line |
Line number in the list | |
mouse_any_flag |
Pane mouse any flag | |
mouse_button_flag |
Pane mouse button flag | |
mouse_standard_flag |
Pane mouse standard flag | |
mouse_utf8_flag |
Pane mouse UTF-8 flag | |
pane_active |
1 if active pane | |
pane_current_command |
Current command if available | |
pane_current_path |
Current path if available | |
pane_dead |
1 if pane is dead | |
pane_height |
Height of pane | |
pane_id |
#D | Unique pane ID |
pane_in_mode |
If pane is in a mode | |
pane_synchronized |
If pane is synchronized | |
pane_index |
#P | Index of pane |
pane_pid |
PID of first process in pane | |
pane_start_command |
Command pane started with | |
pane_start_path |
Path pane started with | |
pane_tabs |
Pane tab positions | |
pane_title |
#T | Title of pane |
pane_tty |
Pseudo terminal of pane | |
pane_width |
Width of pane | |
saved_cursor_x |
Saved cursor X in pane | |
saved_cursor_y |
Saved cursor Y in pane | |
scroll_region_lower |
Bottom of scroll region in pane | |
scroll_region_upper |
Top of scroll region in pane | |
session_attached |
1 if session attached | |
session_created |
Integer time session created | |
session_created_string |
String time session created | |
session_group |
Number of session group | |
session_grouped |
1 if session in a group | |
session_height |
Height of session | |
session_id |
Unique session ID | |
session_name |
#S | Name of session |
session_width |
Width of session | |
session_windows |
Number of windows in session | |
window_active |
1 if window active | |
window_activity_flag |
1 if window has activity alert | |
window_bell_flag |
1 if window has bell | |
window_content_flag |
1 if window has content alert | |
window_find_matches |
Matched data from the find-window | |
window_flags |
#F | Window flags |
window_height |
Height of window | |
window_id |
Unique window ID | |
window_index |
#I | Index of window |
window_layout |
Window layout description | |
window_name |
#W | Name of window |
window_panes |
Number of panes in window | |
window_silence_flag |
1 if window has silence alert | |
window_width |
Width of window | |
wrap_flag |
Pane wrap flag |
A session's name is set with the new-session and rename-session commands. A window's name is set with one of:
$ printf '\033kWINDOW_NAME\033\\'
When a pane is first created, its title is the hostname. A pane's title can be set via the OSC title setting sequence, for example:
$ printf '\033]2;My Title\033\\'
The update-environment session option may be used to update the session environment from the client when a new session is created or an old reattached. tmux also initialises the TMUX variable with some internal information to allow commands to be executed from inside, and the TERM variable with the correct terminal setting of ‘screen
’.
Commands to alter and view the environment are:
Set or unset an environment variable. If -g is used, the change is made in the global environment; otherwise, it is applied to the session environment for target-session. The -u flag unsets a variable. -r indicates the variable is to be removed from the environment before starting a new process.(alias: setenv)
Display the environment for target-session or the global environment with -g. If variable is omitted, all variables are shown. Variables removed from the environment are prefixed with ‘(alias: showenv)
-
’.The status line is made of three parts: configurable left and right sections (which may contain dynamic content such as the time or output from a shell command, see the status-left, status-left-length, status-right, and status-right-length options below), and a central window list. By default, the window list shows the index, name and (if any) flag of the windows present in the current session in ascending numerical order. It may be customised with the window-status-format and window-status-current-format options. The flag is one of the following symbols appended to the window name:
Symbol | Meaning |
* |
Denotes the current window. |
- |
Marks the last window (previously selected). |
# |
Window is monitored and activity has been detected. |
! |
A bell has occurred in the window. |
+ |
Window is monitored for content and it has appeared. |
~ |
The window has been silent for the monitor-silence interval. |
Z |
The window's active pane is zoomed. |
The # symbol relates to the monitor-activity and + to the monitor-content window options. The window name is printed in inverted colours if an alert (bell, activity or content) is present.
The colour and attributes of the status line may be configured, the entire status line using the status-style session option and individual windows using the window-status-style window option.
The status line is automatically refreshed at interval if it has changed, the interval may be controlled with the status-interval session option.
Commands related to the status line are as follows:
If template is specified, it is used as the command. If present, -I is a comma-separated list of the initial text for each prompt. If -p is given, prompts is a comma-separated list of prompts which are displayed in order; otherwise a single prompt is displayed, constructed from template if it is present, or ‘:
’ if not.
Both inputs and prompts may contain the special character sequences supported by the status-left option.
Before the command is executed, the first occurrence of the string ‘%%
’ and all occurrences of ‘%1
’ are replaced by the response to the first prompt, the second ‘%%
’ and all ‘%2
’ are replaced with the response to the second prompt, and so on for further prompts. Up to nine prompt responses may be replaced (‘%1
’ to ‘%9
’).
Ask for confirmation before executing command. If -p is given, prompt is the prompt to display; otherwise a prompt is constructed from command. It may contain the special character sequences supported by the status-left option.(alias: confirm)
This command works only from inside tmux.
Display a message. If -p is given, the output is printed to stdout, otherwise it is displayed in the target-client status line. The format of message is described in the FORMATS section; information is taken from target-pane if -t is given, otherwise the active pane for the session attached to target-client.(alias: display)
A configurable history buffer is also maintained for each window. By default, up to 2000 lines are kept; this can be altered with the history-limit option (see the set-option command above).
The buffer commands are as follows:
%%
’ is replaced by the buffer index in template and the result executed as a command. If template is not given, "paste-buffer -b '%%'" is used. For the meaning of the -F flag, see the FORMATS section. This command works only if at least one client is attached.Remove and free the history for the specified pane.(alias: clearhist)
Delete the buffer at buffer-index, or the top buffer if not specified.(alias: deleteb)
List the global buffers. For the meaning of the -F flag, see the FORMATS section.(alias: lsb)
Load the contents of the specified paste buffer from path.(alias: loadb)
Insert the contents of a paste buffer into the specified pane. If not specified, paste into the current one. With -d, also delete the paste buffer from the stack. When output, any linefeed (LF) characters in the paste buffer are replaced with a separator, by default carriage return (CR). A custom separator may be specified using the -s flag. The -r flag means to do no replacement (equivalent to a separator of LF). If -p is specified, paste bracket control codes are inserted around the buffer if the application has requested bracketed paste mode.(alias: pasteb)
Save the contents of the specified paste buffer to path. The -a option appends to rather than overwriting the file.(alias: saveb)
Set the contents of the specified buffer to data.(alias: setb)
Display the contents of the specified buffer.(alias: showb)
Execute the first command if shell-command returns success or the second command otherwise. Before being executed, shell-command is expanded using the rules specified in the FORMATS section, including those relevant to target-pane. With -b, shell-command is run in the background.(alias: if)
Lock each client individually by running the command specified by the lock-command option.(alias: lock)
Execute shell-command in the background without creating a window. Before being executed, shell-command is expanded using the rules specified in the FORMATS section. With -b, the command is run in the background. After it finishes, any output to stdout is displayed in copy mode (in the pane specified by -t or the current pane if omitted). If the command doesn't return success, the exit status is also displayed.(alias: run)
When used without options, prevents the client from exiting until woken using wait-for -S with the same channel. When -L is used, the channel is locked and any clients that try to lock the same channel are made to wait until the channel is unlocked with wait-for -U. This command only works from outside tmux.(alias: wait)
$ printf '\033]12;red\033\\'
$ printf '\033[4 q'
If Csr is set, it will be used to reset the cursor style instead of Cs.
In control mode, a client sends tmux commands or command sequences terminated by newlines on standard input. Each command will produce one block of output on standard output. An output block consists of a %begin line followed by the output (which may be empty). The output block ends with a %end or %error. %begin and matching %end or %error have two arguments: an integer time (as seconds from epoch) and command number. For example:
%begin 1363006971 2 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active) %end 1363006971 2
In control mode, tmux outputs notifications. A notification will never occur inside an output block.
The following notifications are defined:
$ tmux new-session vi
Most commands have a shorter form, known as an alias. For new-session, this is new:
$ tmux new vi
Alternatively, the shortest unambiguous form of a command is accepted. If there are several options, they are listed:
$ tmux n ambiguous command: n, could be: new-session, new-window, next-window
Within an active session, a new window may be created by typing ‘C-b c
’ (Ctrl followed by the ‘b
’ key followed by the ‘c
’ key).
Windows may be navigated with: ‘C-b 0
’ (to select window 0), ‘C-b 1
’ (to select window 1), and so on; ‘C-b n
’ to select the next window; and ‘C-b p
’ to select the previous window.
A session may be detached using ‘C-b d
’ (or by an external event such as ssh(1) disconnection) and reattached with:
$ tmux attach-session
Typing ‘C-b ?
’ lists the current key bindings in the current window; up and down may be used to navigate the list or ‘q
’ to exit from it.
Commands to be run when the tmux server is started may be placed in the ~/.tmux.conf configuration file. Common examples include:
Changing the default prefix key:
set-option -g prefix C-a unbind-key C-b bind-key C-a send-prefix
Turning the status line off, or changing its colour:
set-option -g status off set-option -g status-style bg=blue
Setting other options, such as the default command, or locking after 30 minutes of inactivity:
set-option -g default-command "exec /bin/ksh" set-option -g lock-after-time 1800
Creating new key bindings:
bind-key b set-option status bind-key / command-prompt "split-window 'exec man %%'" bind-key S command-prompt "new-window -n %1 'ssh %1'"
$Mdocdate: March 25 2013 $ | NetBSD 7.2 |