NAME

tmux —

terminal multiplexer

SYNOPSIS

tmux [-2dqUuVv] [-f file] [-S socket-path] [command [flags]]

DESCRIPTION

tmux is a terminal multiplexer; it enables a number of terminals (or windows) to be accessed and controlled from a single terminal.

tmux runs as a server-client system. A server is created automatically when necessary and holds a number of sessions, each of which may have a number of windows linked to it. Any number of clients may connect to a session, or the server may be controlled by issuing commands with tmux. Communication takes place through a socket, by default placed in /tmp.

The options are as follows:

-2: Force tmux to assume the terminal supports 256 colours.
-d: Force tmux to assume the terminal supports default colours.
-f file: Specify an alternative configuration file. By default, tmux will look for a config file at ~/.tmux.conf. The configuration file is a set of tmux commands which are executed in sequence when the server is first started.
-q: Prevent the server sending various information messages, for example when window flags are altered.
-S socket-path: Specify an alternative path to the server socket. The default is /tmp/tmux-UID, where UID is the uid of the user who invoked tmux.
-U: Unlock the server.
-u: Instruct tmux that the terminal support UTF-8.
-V: Print program version.
-v: Request verbose logging. This option may be specified multiple times for increasing verbosity. Log messages will be saved into tmux-client-PID.log and tmux-server-PID.log files in the current directory, where PID is the pid of the server or client process.
command [flags]: This specifies one of a set of commands used to control tmux, and described in the following sections. If no command and flags is specified, the new-session command is assumed.

QUICK START

To create a new tmux session running vi(1):

$ 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’ (ctrl-b, known as the prefix 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’ 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.

KEY BINDINGS

tmux may be controlled from an attached client by using a key combination of a prefix key, ‘C-b’ (ctrl-b) by default, followed by a command key.

Some of the default key bindings include:

‘d’: Detach current client.
‘c’: Create new window.
‘n’: Change to next window in the current session.
‘p’: Change to previous window in the current session.
‘l’: Move to last (previously selected) window in the current session.
‘t’: Display a large clock.
‘?’: List current key bindings.

A complete list may be obtained with the list-keys command (bound to ‘?’ by default). Key bindings may be changed with the bind-key and unbind-key commands.

HISTORY

tmux maintains a configurable history buffer 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 below).

MODES

A tmux window may be in one of several modes. The default permits direct access to the terminal attached to the window. The others are:

output mode: This is entered when a command which produces output, such as list-keys, is executed from a key binding.
scroll mode: This is entered with the scroll-mode command (bound to ‘=’ by default) and permits the window history buffer to be inspected.
copy mode: This permits a section of a window or its history to be copied to a paste buffer for later insertion into another window. This mode is entered with the copy-mode command, bound to [‘’ by default.

The keys available depend on whether emacs(1) or vi(1) mode is selected (see the mode-keys option). The following keys are supported as appropriate for the mode:

Function	vi	emacs
`Start of line`	0 or ^	C-a
`Clear selection`	Escape	C-g
`Copy selection`	Enter	M-w
`Cursor down`	j	Down
`End of line`	$	C-e
`Cursor left`	h	Left
`Next page`	C-f	Page down
`Next word`	w	M-f
`Previous page`	C-u	Page up
`Previous word`	b	M-b
`Quit mode`	q	Escape
`Cursor right`	l	Right
`Start selection`	Space	C-Space
`Cursor up`	k	Up

BUFFERS

tmux maintains a stack of paste buffers for each session. Up to the value of the buffer-limit option are kept; when a new buffer is added, the buffer at the bottom of the stack is removed. Buffers may be added using copy-mode or the set-buffer command, and pasted into a window using the paste-buffer command.

COMMANDS

This section contains a list of the commands supported by tmux. Most commands accept the optional -t argument with one of target-client, target-session or target-window. These specify the client, session or window which a command should affect. target-client is the name of the pty(4) file to which the client is connected, for example /dev/ttyp1. Clients may be listed with the list-clients command.

target-session is either the name of a session (as listed by the list-sessions command); or the name of a client as for target-client, in this case, the session attached to the client is used. An fnmatch(3) pattern may be used to match the session name. If a session is omitted when required, tmux attempts to use the current session; if no current session is available, the most recently created is chosen. If no client is specified, the current client is chosen, if possible, or an error is reported.

target-window specifies a window in the form session:index, for example mysession:1. The session is in the same form as for target-session. session, index or both may be omitted. If session is omitted, the same rules as for target-session are followed; if index is not present, the current window for the given session is used. When the argument does not contain a colon (:), tmux first attempts to parse it as window index; if that fails, an attempt is made to match a session or client name.

Examples include:

refresh-client -t/dev/ttyp2

rename-session -tfirst newname

set-window-option -t:0 monitor-activity on

The following commands are available:

attach-session [-d] [-t target-session]

(alias: attach)

Create a new client in the current terminal and attach it to a session. If -d is specified, any other clients attached to the session are detached.

If no server is started, attach-session will attempt to start it; this will fail unless sessions are created in the configuration file.

bind-key key command [arguments]

(alias: bind)

Bind key key to command. Keys may be specified prefixed with ‘C-’ or ‘^’ for ctrl keys, or ‘M-’ for alt (meta) keys.

choose-session [-t target-window]

Put a window into session choice mode, where the session for the current client may be selected interactively from a list. This command works only from inside tmux.

choose-window [-t target-window]

Put a window into window choice mode, where the window for the session attached to the current client may be selected interactively from a list. This command works only from inside tmux.

clock-mode [-t target-window]

Display a large clock.

command-prompt [-t target-client] [template]

Open the command prompt in a client. This may be used from inside tmux to execute commands interactively. If template is specified, it is used as the command; any %% in the template will be replaced by what is entered at the prompt.

copy-mode [-t target-window]

Enter copy mode.

delete-buffer [-b buffer-index] [-t target-session]

(alias: deleteb)

Delete the buffer at buffer-index, or the top buffer if not specified.

detach-client [-t target-client]

(alias: detach)

Detach the current client if bound to a key, or the specified client with -t.

down-pane [-p pane-index] [-t target-window]

(alias: downp)

Move down a pane.

has-session [-t target-session]

(alias: has)

Report an error and exit with 1 if the specified session does not exist. If it does exist, exit with 0.

kill-pane [-p pane-index] [-t target-window]

(alias: killp)

Destroy the given pane.

kill-server

Kill the tmux server and clients and destroy all sessions.

kill-session [-t target-session]

Destroy the given session, closing any windows linked to it and no other sessions, and detaching all clients attached to it.

kill-window [-t target-window]

(alias: killw)

Kill the current window or the window at target-window, removing it from any sessions to which it is linked.

last-window [-t target-session]

(alias: last)

Select the last (previously selected) window. If no target-session is specified, select the last window of the current session.

link-window [-dk] [-s src-window] [-t dst-window]

(alias: linkw)

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.

list-buffers [-t target-session]

(alias: lsb)

List the buffers in the given session.

list-clients

(alias: lsc)

List all clients attached to the server.

list-commands

(alias: lscm)

List the syntax of all commands supported by tmux.

list-keys

(alias: lsk)

List all key bindings.

list-sessions

(alias: ls)

List all sessions managed by the server.

list-windows [-t target-session]

(alias: lsw)

List windows in the current session or in target-session.

load-buffer [-b buffer-index] [-t target-session] path

(alias: loadb)

Load the contents of the specified paste buffer from path.

lock-server

(alias: lock)

Lock the server until a password is entered.

move-window [-d] [-s src-window] [-t dst-window]

(alias: movew)

This is similar to link-window, except the window at src-window is moved to dst-window.

new-session [-d] [-n window-name] [-s session-name] [command]

(alias: new)

Create a new session with name session-name. The new session is attached to the current terminal unless -d is given. window-name and command are the name of and command to execute in the initial window.

new-window [-d] [-n window-name] [-t target-window] [command]

(alias: neww)

Create a new window. If -d is given, the session does not make the new window the current window. target-window represents the window to be created. command is the command to execute. If command is not specified, the default command is used.

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.

next-window [-t target-session]

(alias: next)

Move to the next window in the session.

paste-buffer [-d] [-b buffer-index] [-t target-window]

(alias: pasteb)

Insert the contents of a paste buffer into the current window.

previous-window [-t target-session]

(alias: prev)

Move to the previous window in the session.

refresh-client [-t target-client]

(alias: refresh)

Refresh the current client if bound to a key, or a single client if one is given with -t.

rename-session [-t target-session] new-name

(alias: rename)

Rename the session to new-name.

rename-window [-t target-window] new-name

(alias: renamew)

Rename the current window, or the window at target-window if specifed, to new-name.

resize-pane-down [-p pane-index] [-t target-window] [adjustment]

(alias: resizep-down)

resize-pane-up [-p pane-index] [-t target-window] [adjustment]

(alias: resizep-up)

Resize a pane. The adjustment is given in lines (the default is 1).

respawn-window [-k] [-t target-window] [command]

(alias: respawnw)

Reactive a window in which the command has exited (see the remain-in-exit windowoption). If 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.

save-buffer [-a] [-b buffer-index] [-t target-session] path

(alias: saveb)

Save the contents of the specified paste buffer to path. The -a option appends to rather than overwriting the file.

scroll-mode [-t target-window]

Enter scroll mode.

select-pane [-p pane-index] [-t target-window]

(alias: selectp)

Make pane pane-index the active pane in window target-window.

select-prompt [-t target-client]

Open a prompt inside target-client allowing a window index to be entered interactively.

select-window [-t target-window]

(alias: selectw)

Select the window at target-window.

send-keys [-t target-window] key ...

(alias: send)

Send a key or keys to a window. Each argument key is the name of the key (such as ‘C-a’ or ‘npage’ ) to send; if the string is not recognised as a key, it is sent as a series of characters. All arguments are sent sequentially from first to last.

send-prefix [-t target-window]

Send the prefix key to a window as if it was pressed.

server-info

(alias: info)

Show server information and terminal details.

set-buffer [-b buffer-index] [-t target-session] data

(alias: setb)

Set the contents of the specified buffer to data.

set-option [-gu] [-t target-session] option value

(alias: set)

Set an option. If -g is specified, the option is set as a global option. Global options apply to all sessions which don't have the option explicitly set. If -g is not used, the option applies only to target-session. 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.

Possible options are:

bell-action [any | none | current]

Set action on window bell. any means a bell in any window linked to a session causes a bell in the current window of that session, none means all bells are ignored and current means only bell in windows other than the current window are ignored.

buffer-limit number

Set the number of buffers kept for each session; as new buffers are added to the top of the stack, old ones are removed from the bottom if necessary to maintain this maximum length.

default-command command

Set the command used for new windows (if not specified when the window is created) to command. The default is “exec $SHELL”.

default-path path

Set the default working directory for processes created from keys, or interactively from the prompt. The default is the current working directory when the server is started.

history-limit lines

Set the maximum number of lines held in window history. This setting applies only to new windows - existing window histories are not resized and retain the limit at the point they were created.

lock-after-time number

Lock the server after number seconds of inactivity. The default is off (set to 0). This has no effect as a session option; it must be set as a global option using -g.

message-bg colour

Set status line message background colour, where colour is one of: black, red, green, yellow, blue, magenta, cyan, white or default.

message-fg colour

Set status line message foreground colour.

message-attr attributes

Set status line message attributes, where attributes is either default or a comma-delimited list of one or more of: bright (or bold), dim, underscore, blink, reverse, hidden, or italics.

prefix key

Set the current prefix key.

repeat-time number

Allow multiple commands to be entered without pressing the prefix-key again in the specified number miliseconds (the default is 500). It only applies to up-pane, down-pane, next-window, previous-window, resize-pane-up, and resize-pane-down.

set-titles [on | off]

Attempt to set the window title using the \e]2;...\007 xterm code and the terminal appears to be an xterm. This option is enabled by default. Note that elinks(1) will only attempt to set the window title if the STY environment variable is set.

status [on | off]

Show or hide the status line.

status-bg colour

Set status line background colour.

status-fg colour

Set status line foreground colour.

status-attr attributes

Set status line attributes.

status-interval interval

Update the status bar every interval seconds. By default, updates will occur every 15 seconds.

status-left string

Display string to the left of the status bar. string will be passed through strftime(3) before being used. By default, nothing is displayed. string may contain any of the following special character pairs:

Character pair	Replaced with
`#H`	Hostname of local host
`#S`	Session name
`#T`	Current window title
`##`	A literal ‘`#`’

Where appropriate, these may be prefixed with a number to specify the maximum length, for example ‘#24T’.

status-left-length length

Set the maximum length of the left component of the status bar. The default is 10.

status-right string

Display string to the right of the status bar. By default, the date and time will be shown. As with status-left, string will be passed to strftime(3) and character pairs are replaced.

status-right-length length

Set the maximum length of the right component of the status bar. The default is 40.

set-password [-c] password

(alias: pass)

Set the server password. If the -c option is given, a pre-encrypted password may be specified. By default, the password is blank, thus any entered password will be accepted when unlocking the server (see the lock-server command). To prevent variable expansion when an encrypted password is read from a configuration file, enclose it in single quotes (').

set-window-option [-gu] [-t target-window] option value

(alias: setw)

Set a window-specific option. The -g and -u flags work similarly to the set-option command.

Supported options are:

aggressive-resize [on | off]: Aggressively resize the chosen window. This means that tmux will resize the window to the size of the smallest session for which it is the current window, rather than the smallest session to which it is attached. The window may resize when the current window is changed on another sessions; this option is good for full-screen programs which support SIGWINCH and poor for interactive programs such as shells.
clock-mode-colour colour: Set clock colour.
clock-mode-style [12 | 24]: Set clock hour format.
force-height height
force-width width: Prevent tmux from resizing a window to greater than width or height. A value of zero restores the default unlimited setting.
mode-bg colour: Set window modes background colour.
mode-fg colour: Set window modes foreground colour.
mode-attr attributes: Set window modes attributes.
mode-keys [vi | emacs]: Use vi(1) - or emacs(1) - style key bindings in scroll and copy modes. Key bindings default to emacs.
monitor-activity [on | off]: Monitor for activity in the window. Windows with activity are highlighted in the status line.
remain-on-exit [on | off]: A window with this flag set is not destroyed when the program running in it exits. The window may be reactivated with the respawn-window command.
utf8 [on | off]: Instructs tmux to expect UTF-8 sequences to appear in this window.
xterm-keys [on | off]: If this option is set, tmux will generate xterm(1) -style function key sequences; these have a number included to indicate modifiers such as shift, meta or ctrl.

show-buffer [-b buffer-index] [-t target-session]

(alias: showb)

Display the contents of the specified buffer.

show-options [-t target-session] option value

(alias: show)

Show the currently set options. If a target-session is specified, the options for that session are shown; otherwise, the global options are listed.

show-window-options [-t target-window] option value

(alias: showw)

List the current options for the given window.

source-file path

(alias: source)

Execute commands from path.

split-window [-d] [-t target-window] [command]

(alias: splitw)

Creates a new window by splitting it vertically. All options have the same meaning as in the new-window command.

A few notes with regard to panes:

If attempting to split a window with less than eight lines, an error will be shown.
If the window is resized, as many panes are shown as can fit without reducing them below four lines.
The minimum pane size is four lines (including the separator line).
The panes are indexed from top (0) to bottom, with no numbers skipped.

start-server