circlecloud/tmux
1
0
Fork 0
mirror of https://github.com/tmux/tmux.git synced 2024-12-13 01:48:47 +00:00
Code Issues Projects Releases Wiki Activity

Whoops, didn't mean to add this.

Browse Source
This commit is contained in:
Nicholas Marriott 2009-06-01 23:00:54 +00:00
parent 35876eaab9
commit 6e3f673ef7
1 changed files with 0 additions and 813 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

813
tmux.cat1
View File

@ -1,813 +0,0 @@
TMUX(1) OpenBSD Reference Manual TMUX(1)
NNAAMMEE
ttmmuuxx - terminal multiplexer
SSYYNNOOPPSSIISS
ttmmuuxx [--2288ddqqUUuuvv] [--ff _f_i_l_e] [--LL _s_o_c_k_e_t_-_n_a_m_e] [--SS _s_o_c_k_e_t_-_p_a_t_h]
[_c_o_m_m_a_n_d [_f_l_a_g_s]]
DDEESSCCRRIIPPTTIIOONN
ttmmuuxx is a terminal multiplexer; it enables a number of terminals to be
accessed and controlled from a single terminal.
ttmmuuxx runs as a server-client system. A server is created automatically
when necessary and holds a number of _s_e_s_s_i_o_n_s, each of which may have a
number of _w_i_n_d_o_w_s linked to it. A window may be split on screen into one
or more _p_a_n_e_s, each of which is a separate terminal. Any number of
_c_l_i_e_n_t_s may connect to a session, or the server may be controlled by is-
suing commands with ttmmuuxx. Communication takes place through a socket, by
default placed in _/_t_m_p.
The options are as follows:
--22 Force ttmmuuxx to assume the terminal supports 256 colours.
--88 Like --22, indicates the terminal supports 88 colours.
--dd Force ttmmuuxx to assume the terminal supports default colours.
--ff _f_i_l_e Specify an alternative configuration file. By default,
ttmmuuxx will look for a config file at _~_/_._t_m_u_x_._c_o_n_f. The con-
figuration file is a set of ttmmuuxx commands which are execut-
ed in sequence when the server is first started.
--qq Prevent the server sending various information messages,
for example when window flags are altered.
--LL _s_o_c_k_e_t_-_n_a_m_e
ttmmuuxx stores the server socket in a directory under _/_t_m_p;
the default socket is named _d_e_f_a_u_l_t. This option allows a
different socket name to be specified, allowing several in-
dependent ttmmuuxx servers to be run. Unlike --SS a full path is
not necessary: the sockets are all created in the same di-
rectory.
--SS _s_o_c_k_e_t_-_p_a_t_h
Specify a full alternative path to the server socket. If
--SS is specified, the default socket directory is not used
and any --LL flag is ignored.
--UU Unlock the server.
--uu Instruct ttmmuuxx that the terminal support UTF-8.
--vv Request verbose logging. This option may be specified mul-
tiple times for increasing verbosity. Log messages will be
saved into _t_m_u_x_-_c_l_i_e_n_t_-_P_I_D_._l_o_g and _t_m_u_x_-_s_e_r_v_e_r_-_P_I_D_._l_o_g
files in the current directory, where _P_I_D is the pid of the
server or client process.
_c_o_m_m_a_n_d [_f_l_a_g_s]
This specifies one of a set of commands used to control
ttmmuuxx, and described in the following sections. If no com-
mand and flags is specified, the nneeww--sseessssiioonn command is as-
sumed.
QQUUIICCKK SSTTAARRTT
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 nneeww:
$ 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.
KKEEYY BBIINNDDIINNGGSS
ttmmuuxx 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 lliisstt--kkeeyyss command (bound to `?'
by default). Key bindings may be changed with the bbiinndd--kkeeyy and uunnbbiinndd--
kkeeyy commands.
HHIISSTTOORRYY
ttmmuuxx maintains a configurable history buffer for each window. By de-
fault, up to 2000 lines are kept, this can be altered with the hhiissttoorryy--
lliimmiitt option (see the sseett--ooppttiioonn command below).
MMOODDEESS
A ttmmuuxx window may be in one of several modes. The default permits direct
access to the terminal attached to the window. The others are:
_o_u_t_p_u_t _m_o_d_e
This is entered when a command which produces output, such as
lliisstt--kkeeyyss, is executed from a key binding.
_s_c_r_o_l_l _m_o_d_e
This is entered with the ssccrroollll--mmooddee command (bound to `=' by de-
fault) and permits the window history buffer to be inspected.
_c_o_p_y _m_o_d_e
This permits a section of a window or its history to be copied to
a _p_a_s_t_e _b_u_f_f_e_r for later insertion into another window. This
mode is entered with the ccooppyy--mmooddee command, bound to `[' by de-
fault.
The keys available depend on whether emacs(1) or vi(1) mode is selected
(see the mmooddee--kkeeyyss option). The following keys are supported as appro-
priate for the mode:
FFuunnccttiioonn vvii eemmaaccss
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
BBUUFFFFEERRSS
ttmmuuxx maintains a stack of _p_a_s_t_e _b_u_f_f_e_r_s for each session. Up to the val-
ue of the bbuuffffeerr--lliimmiitt option are kept; when a new buffer is added, the
buffer at the bottom of the stack is removed. Buffers may be added using
ccooppyy--mmooddee or the sseett--bbuuffffeerr command, and pasted into a window using the
ppaassttee--bbuuffffeerr command.
PPAANNEESS AANNDD LLAAYYOOUUTTSS
Each window displayed by ttmmuuxx may be split into one or more _p_a_n_e_s; each
pane takes up a certain area of the display and is a separate terminal.
A window may be split into panes using the sspplliitt--wwiinnddooww command.
Panes are numbered beginning from zero; in horizontal layouts zero is the
leftmost pane and in vertical the topmost.
Panes may be arranged using several layouts. The layout may be cycled
with the nneexxtt--llaayyoouutt command (bound to `C-space' by default), the current
pane may be changed with the uupp--ppaannee and ddoowwnn--ppaannee commands and the
rroottaattee--wwiinnddooww and sswwaapp--ppaannee commands may be used to swap panes without
changing the window layout.
The following layouts are supported:
mmaannuuaall Manual layout splits windows vertically (running across); only
with this layout may panes be resized using the rreessiizzee--ppaannee com-
mand.
aaccttiivvee--oonnllyy
Only the active pane is shown - all other panes are hidden.
eevveenn--hhoorriizzoonnttaall
Panes are spread out evenly from left to right across the window.
eevveenn--vveerrttiiccaall
Panes are spread evenly from top to bottom.
mmaaiinn--vveerrttiiccaall
A large (81 column) pane is shown on the left of the window and
the remaining panes are spread from top to bottom in the leftover
space to the right.
CCOOMMMMAANNDDSS
This section contains a list of the commands supported by ttmmuuxx. Most
commands accept the optional --tt argument with one of _t_a_r_g_e_t_-_c_l_i_e_n_t,
_t_a_r_g_e_t_-_s_e_s_s_i_o_n or _t_a_r_g_e_t_-_w_i_n_d_o_w. These specify the client, session or
window which a command should affect. _t_a_r_g_e_t_-_c_l_i_e_n_t is the name of the
pty(4) file to which the client is connected, for example _/_d_e_v_/_t_t_y_p_1.
Clients may be listed with the lliisstt--cclliieennttss command.
_t_a_r_g_e_t_-_s_e_s_s_i_o_n is either the name of a session (as listed by the lliisstt--
sseessssiioonnss command); or the name of a client as for _t_a_r_g_e_t_-_c_l_i_e_n_t, 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 re-
quired, ttmmuuxx attempts to use the current session; if no current session
is available, the most recently created is chosen. If no client is spec-
ified, the current client is chosen, if possible, or an error is report-
ed.
_t_a_r_g_e_t_-_w_i_n_d_o_w specifies a window in the form _s_e_s_s_i_o_n:_i_n_d_e_x, for example
mysession:1. The session is in the same form as for _t_a_r_g_e_t_-_s_e_s_s_i_o_n.
_s_e_s_s_i_o_n, _i_n_d_e_x or both may be omitted. If _s_e_s_s_i_o_n is omitted, the same
rules as for _t_a_r_g_e_t_-_s_e_s_s_i_o_n are followed; if _i_n_d_e_x is not present, the
current window for the given session is used. When the argument does not
contain a colon (:), ttmmuuxx first attempts to parse it as window index; if
that fails, an attempt is made to match a session or client name.
Multiple commands may be specified together as part of a _c_o_m_m_a_n_d
_s_e_q_u_e_n_c_e. Each command should be separated by spaces and a semicolon (`
; '); commands are executed sequentially from left to right. A literal
semicolon may be included by escaping it with a backslash (for example,
when specifying a command sequence to bbiinndd--kkeeyy).
Examples 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 D detach-client \; lock-server
The following commands are available:
aattttaacchh--sseessssiioonn [--dd] [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
(alias: aattttaacchh)
Create a new client in the current terminal and attach it to a
session. If --dd is specified, any other clients attached to the
session are detached.
If no server is started, aattttaacchh--sseessssiioonn will attempt to start it;
this will fail unless sessions are created in the configuration
file.
bbiinndd--kkeeyy [--rr] _k_e_y _c_o_m_m_a_n_d [_a_r_g_u_m_e_n_t_s]
(alias: bbiinndd)
Bind key _k_e_y to _c_o_m_m_a_n_d. Keys may be specified prefixed with
`C-' or `^' for ctrl keys, or `M-' for alt (meta) keys. The --rr
flag indicates this key may repeat, see the rreeppeeaatt--ttiimmee option.
bbrreeaakk--ppaannee [--dd] [--pp _p_a_n_e_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: bbrreeaakkpp))
Break the current pane off from its containing window to make it
the only pane in a new window. If --dd is given, the new window
does not become the current window.
cchhoooossee--sseessssiioonn [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
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 ttmmuuxx.
cchhoooossee--wwiinnddooww [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
Put a window into window choice mode, where the window for the
session attached to the current client may be selected interac-
tively from a list. This command works only from inside ttmmuuxx.
cclloocckk--mmooddee [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
Display a large clock.
ccoommmmaanndd--pprroommpptt [--tt _t_a_r_g_e_t_-_c_l_i_e_n_t] [_t_e_m_p_l_a_t_e]
Open the command prompt in a client. This may be used from in-
side ttmmuuxx to execute commands interactively. If _t_e_m_p_l_a_t_e is
specified, it is used as the command; any %% in the template will
be replaced by what is entered at the prompt.
ccoonnffiirrmm--bbeeffoorree [--tt _t_a_r_g_e_t_-_c_l_i_e_n_t] _c_o_m_m_a_n_d
(alias: ccoonnffiirrmm))
Ask for confirmation before executing _c_o_m_m_a_n_d. This command
works only from inside ttmmuuxx.
ccooppyy--bbuuffffeerr [--aa _s_r_c_-_i_n_d_e_x] [--bb _d_s_t_-_i_n_d_e_x] [--ss _s_r_c_-_s_e_s_s_i_o_n] [--tt
_d_s_t_-_s_e_s_s_i_o_n]
(alias: ccooppyybb))
Copy a session paste buffer to another session. If no sessions
are specified, the current one is used instead.
ccooppyy--mmooddee [--uu] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
Enter copy mode. The --uu option scrolls one page up.
ddeelleettee--bbuuffffeerr [--bb _b_u_f_f_e_r_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
(alias: ddeelleetteebb)
Delete the buffer at _b_u_f_f_e_r_-_i_n_d_e_x, or the top buffer if not spec-
ified.
ddeettaacchh--cclliieenntt [--tt _t_a_r_g_e_t_-_c_l_i_e_n_t]
(alias: ddeettaacchh)
Detach the current client if bound to a key, or the specified
client with --tt.
ddoowwnn--ppaannee [--pp _p_a_n_e_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: ddoowwnnpp)
Move down a pane.
ffiinndd--wwiinnddooww [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w] _m_a_t_c_h_-_s_t_r_i_n_g
(alias: ffiinnddww)
Search for _m_a_t_c_h_-_s_t_r_i_n_g in window names, titles, and visible con-
tent (but not history). If only one window is matched, it'll be
automatically selected, otherwise a choice list is shown. This
command only works from inside ttmmuuxx.
hhaass--sseessssiioonn [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
(alias: hhaass)
Report an error and exit with 1 if the specified session does not
exist. If it does exist, exit with 0.
kkiillll--ppaannee [--pp _p_a_n_e_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: kkiillllpp)
Destroy the given pane.
kkiillll--sseerrvveerr
Kill the ttmmuuxx server and clients and destroy all sessions.
kkiillll--sseessssiioonn [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
Destroy the given session, closing any windows linked to it and
no other sessions, and detaching all clients attached to it.
kkiillll--wwiinnddooww [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: kkiillllww)
Kill the current window or the window at _t_a_r_g_e_t_-_w_i_n_d_o_w, removing
it from any sessions to which it is linked.
llaasstt--wwiinnddooww [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
(alias: llaasstt)
Select the last (previously selected) window. If no _t_a_r_g_e_t_-
_s_e_s_s_i_o_n is specified, select the last window of the current ses-
sion.
lliinnkk--wwiinnddooww [--ddkk] [--ss _s_r_c_-_w_i_n_d_o_w] [--tt _d_s_t_-_w_i_n_d_o_w]
(alias: lliinnkkww)
Link the window at _s_r_c_-_w_i_n_d_o_w to the specified _d_s_t_-_w_i_n_d_o_w. If
_d_s_t_-_w_i_n_d_o_w is specified and no such window exists, the _s_r_c_-_w_i_n_d_o_w
is linked there. If --kk is given and _d_s_t_-_w_i_n_d_o_w exists, it is
killed, otherwise an error is generated. If --dd is given, the
newly linked window is not selected.
lliisstt--bbuuffffeerrss [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
(alias: llssbb)
List the buffers in the given session.
lliisstt--cclliieennttss
(alias: llsscc)
List all clients attached to the server.
lliisstt--ccoommmmaannddss
(alias: llssccmm)
List the syntax of all commands supported by ttmmuuxx.
lliisstt--kkeeyyss
(alias: llsskk)
List all key bindings.
lliisstt--sseessssiioonnss
(alias: llss)
List all sessions managed by the server.
lliisstt--wwiinnddoowwss [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
(alias: llssww)
List windows in the current session or in _t_a_r_g_e_t_-_s_e_s_s_i_o_n.
llooaadd--bbuuffffeerr [--bb _b_u_f_f_e_r_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n] _p_a_t_h
(alias: llooaaddbb)
Load the contents of the specified paste buffer from _p_a_t_h.
lloocckk--sseerrvveerr
(alias: lloocckk)
Lock the server until a password is entered.
mmoovvee--wwiinnddooww [--dd] [--ss _s_r_c_-_w_i_n_d_o_w] [--tt _d_s_t_-_w_i_n_d_o_w]
(alias: mmoovveeww)
This is similar to lliinnkk--wwiinnddooww, except the window at _s_r_c_-_w_i_n_d_o_w
is moved to _d_s_t_-_w_i_n_d_o_w.
nneeww--sseessssiioonn [--dd] [--nn _w_i_n_d_o_w_-_n_a_m_e] [--ss _s_e_s_s_i_o_n_-_n_a_m_e] [_c_o_m_m_a_n_d]
(alias: nneeww)
Create a new session with name _s_e_s_s_i_o_n_-_n_a_m_e. The new session is
attached to the current terminal unless --dd is given. _w_i_n_d_o_w_-_n_a_m_e
and _c_o_m_m_a_n_d are the name of and command to execute in the initial
window.
nneeww--wwiinnddooww [--dd] [--nn _w_i_n_d_o_w_-_n_a_m_e] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w] [_c_o_m_m_a_n_d]
(alias: nneewwww)
Create a new window. If --dd is given, the session does not make
the new window the current window. _t_a_r_g_e_t_-_w_i_n_d_o_w represents the
window to be created. _c_o_m_m_a_n_d is the command to execute. If
_c_o_m_m_a_n_d is not specified, the default command is used.
The TERM environment variable must be set to ``screen'' for all
programs running _i_n_s_i_d_e ttmmuuxx. 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.
nneexxtt--llaayyoouutt [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: nneexxttll)
Move a window to the next layout and rearrange the panes to fit.
nneexxtt--wwiinnddooww [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
(alias: nneexxtt)
Move to the next window in the session.
ppaassttee--bbuuffffeerr [--dd] [--bb _b_u_f_f_e_r_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: ppaasstteebb)
Insert the contents of a paste buffer into the current window.
pprreevviioouuss--wwiinnddooww [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
(alias: pprreevv)
Move to the previous window in the session.
rreeffrreesshh--cclliieenntt [--tt _t_a_r_g_e_t_-_c_l_i_e_n_t]
(alias: rreeffrreesshh)
Refresh the current client if bound to a key, or a single client
if one is given with --tt.
rreennaammee--sseessssiioonn [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n] _n_e_w_-_n_a_m_e
(alias: rreennaammee)
Rename the session to _n_e_w_-_n_a_m_e.
rreennaammee--wwiinnddooww [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w] _n_e_w_-_n_a_m_e
(alias: rreennaammeeww)
Rename the current window, or the window at _t_a_r_g_e_t_-_w_i_n_d_o_w if
specified, to _n_e_w_-_n_a_m_e.
rreessiizzee--ppaannee [--DDUU] [--pp _p_a_n_e_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w] [_a_d_j_u_s_t_m_e_n_t]
(alias: rreessiizzeepp)
Resize a pane, upward with --UU (the default) or downward with --DD.
The _a_d_j_u_s_t_m_e_n_t is given in lines (the default is 1).
rreessppaawwnn--wwiinnddooww [--kk] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w] [_c_o_m_m_a_n_d]
(alias: rreessppaawwnnww)
Reactive a window in which the command has exited (see the
rreemmaaiinn--oonn--eexxiitt window option). If _c_o_m_m_a_n_d is not given, the com-
mand used when the window was created is executed. The window
must be already inactive, unless --kk is given, in which case any
existing command is killed.
rroottaattee--wwiinnddooww [--DDUU] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: rroottaatteeww)
Rotate the positions of the panes within a window, either upward
(numerically lower) with --UU or downward (numerically higher).
ssaavvee--bbuuffffeerr [--aa] [--bb _b_u_f_f_e_r_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n] _p_a_t_h
(alias: ssaavveebb)
Save the contents of the specified paste buffer to _p_a_t_h. The --aa
option appends to rather than overwriting the file.
ssccrroollll--mmooddee [--uu] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
Enter scroll mode. The --uu has the same meaning as in the ccooppyy--
mmooddee command.
sseelleecctt--ppaannee [--pp _p_a_n_e_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: sseelleeccttpp)
Make pane _p_a_n_e_-_i_n_d_e_x the active pane in window _t_a_r_g_e_t_-_w_i_n_d_o_w.
sseelleecctt--pprroommpptt [--tt _t_a_r_g_e_t_-_c_l_i_e_n_t]
Open a prompt inside _t_a_r_g_e_t_-_c_l_i_e_n_t allowing a window index to be
entered interactively.
sseelleecctt--wwiinnddooww [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: sseelleeccttww)
Select the window at _t_a_r_g_e_t_-_w_i_n_d_o_w.
sseenndd--kkeeyyss [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w] _k_e_y _._._.
(alias: sseenndd)
Send a key or keys to a window. Each argument _k_e_y 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.
sseenndd--pprreeffiixx [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
Send the prefix key to a window as if it was pressed.
sseerrvveerr--iinnffoo
(alias: iinnffoo)
Show server information and terminal details.
sseett--bbuuffffeerr [--bb _b_u_f_f_e_r_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n] _d_a_t_a
(alias: sseettbb)
Set the contents of the specified buffer to _d_a_t_a.
sseett--ooppttiioonn [--gguu] [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n] _o_p_t_i_o_n _v_a_l_u_e
(alias: sseett)
Set an option. If --gg 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 --gg is not used, the option applies
only to _t_a_r_g_e_t_-_s_e_s_s_i_o_n. The --uu flag unsets an option, so a ses-
sion inherits the option from the global options - it is not pos-
sible to unset a global option.
Possible options are:
bbeellll--aaccttiioonn [aannyy | nnoonnee | ccuurrrreenntt]
Set action on window bell. aannyy means a bell in any win-
dow linked to a session causes a bell in the current win-
dow of that session, nnoonnee means all bells are ignored and
ccuurrrreenntt means only bell in windows other than the current
window are ignored.
bbuuffffeerr--lliimmiitt _n_u_m_b_e_r
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.
ddeeffaauulltt--ccoommmmaanndd _c_o_m_m_a_n_d
Set the command used for new windows (if not specified
when the window is created) to _c_o_m_m_a_n_d. The default is
``exec $SHELL''.
ddeeffaauulltt--ppaatthh _p_a_t_h
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.
hhiissttoorryy--lliimmiitt _l_i_n_e_s
Set the maximum number of lines held in window history.
This setting applies only to new windows - existing win-
dow histories are not resized and retain the limit at the
point they were created.
lloocckk--aafftteerr--ttiimmee _n_u_m_b_e_r
Lock the server after _n_u_m_b_e_r seconds of inactivity. The
default is off (set to 0). This has no effect as a ses-
sion option; it must be set as a global option using --gg.
mmeessssaaggee--aattttrr _a_t_t_r_i_b_u_t_e_s
Set status line message attributes, where _a_t_t_r_i_b_u_t_e_s is
either ddeeffaauulltt or a comma-delimited list of one or more
of: bbrriigghhtt (or bboolldd), ddiimm, uunnddeerrssccoorree, bblliinnkk, rreevveerrssee,
hhiiddddeenn, or iittaalliiccss.
mmeessssaaggee--bbgg _c_o_l_o_u_r
Set status line message background colour, where _c_o_l_o_u_r
is one of: bbllaacckk, rreedd, ggrreeeenn, yyeellllooww, bblluuee, mmaaggeennttaa,
ccyyaann, wwhhiittee or ddeeffaauulltt.
mmeessssaaggee--ffgg _c_o_l_o_u_r
Set status line message foreground colour.
pprreeffiixx _k_e_y
Set the current prefix key.
rreeppeeaatt--ttiimmee _n_u_m_b_e_r
Allow multiple commands to be entered without pressing
the prefix-key again in the specified _n_u_m_b_e_r milliseconds
(the default is 500). Whether a key repeats may be set
when it is bound using the --rr flag to bbiinndd--kkeeyy. Repeat
is enabled for the default keys of the uupp--ppaannee, ddoowwnn--
ppaannee, rreessiizzee--ppaannee--uupp, and rreessiizzee--ppaannee--ddoowwnn commands.
sseett--rreemmaaiinn--oonn--eexxiitt [oonn | ooffff]
Set the rreemmaaiinn--oonn--eexxiitt window option for any windows
first created in this session.
sseett--ttiittlleess [oonn | ooffff]
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 environ-
ment variable is set.
ssttaattuuss [oonn | ooffff]
Show or hide the status line.
ssttaattuuss--aattttrr _a_t_t_r_i_b_u_t_e_s
Set status line attributes.
ssttaattuuss--bbgg _c_o_l_o_u_r
Set status line background colour.
ssttaattuuss--ffgg _c_o_l_o_u_r
Set status line foreground colour.
ssttaattuuss--iinntteerrvvaall _i_n_t_e_r_v_a_l
Update the status bar every _i_n_t_e_r_v_a_l seconds. By de-
fault, updates will occur every 15 seconds. A setting of
zero disables redrawing at interval.
ssttaattuuss--kkeeyyss [vvii | eemmaaccss]
Use vi(1)- or emacs(1)-style key bindings in the status
line, for example at the command prompt. Defaults to
emacs.
ssttaattuuss--lleefftt _s_t_r_i_n_g
Display _s_t_r_i_n_g to the left of the status bar. _s_t_r_i_n_g
will be passed through strftime(3) before being used. By
default, the session name is shown. _s_t_r_i_n_g may contain
any of the following special character pairs:
CChhaarraacctteerr ppaaiirr RReeppllaacceedd wwiitthh
#(command) First line of command's output
#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'.
ssttaattuuss--lleefftt--lleennggtthh _l_e_n_g_t_h
Set the maximum _l_e_n_g_t_h of the left component of the sta-
tus bar. The default is 10.
ssttaattuuss--rriigghhtt _s_t_r_i_n_g
Display _s_t_r_i_n_g to the right of the status bar. By de-
fault, the date and time will be shown. As with ssttaattuuss--
lleefftt, _s_t_r_i_n_g will be passed to strftime(3) and character
pairs are replaced.
ssttaattuuss--rriigghhtt--lleennggtthh _l_e_n_g_t_h
Set the maximum _l_e_n_g_t_h of the right component of the sta-
tus bar. The default is 40.
sseett--ppaasssswwoorrdd [--cc] _p_a_s_s_w_o_r_d
(alias: ppaassss)
Set the server password. If the --cc option is given, a pre-en-
crypted password may be specified. By default, the password is
blank, thus any entered password will be accepted when unlocking
the server (see the lloocckk--sseerrvveerr command). To prevent variable
expansion when an encrypted password is read from a configuration
file, enclose it in single quotes (').
sseett--wwiinnddooww--ooppttiioonn [--gguu] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w] _o_p_t_i_o_n _v_a_l_u_e
(alias: sseettww)
Set a window-specific option. The --gg and --uu flags work similarly
to the sseett--ooppttiioonn command.
Supported options are:
aaggggrreessssiivvee--rreessiizzee [oonn | ooffff]
Aggressively resize the chosen window. This means that
ttmmuuxx 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.
aauuttoommaattiicc--rreennaammee [oonn | ooffff]
Control automatic window renaming. When this setting is
enabled, ttmmuuxx will attempt - on supported platforms - to
rename the window to reflect the command currently run-
ning in it. This flag is automatically disabled for an
individual window when a name is specified at creation
with nneeww--wwiinnddooww oorr nneeww--sseessssiioonn, or later with rreennaammee--
wwiinnddooww. It may be switched off globally with:
set-window-option -g automatic-rename off
cclloocckk--mmooddee--ccoolloouurr _c_o_l_o_u_r
Set clock colour.
cclloocckk--mmooddee--ssttyyllee [1122 | 2244]
Set clock hour format.
ffoorrccee--hheeiigghhtt _h_e_i_g_h_t
ffoorrccee--wwiiddtthh _w_i_d_t_h
Prevent ttmmuuxx from resizing a window to greater than _w_i_d_t_h
or _h_e_i_g_h_t. A value of zero restores the default unlimit-
ed setting.
mmooddee--aattttrr _a_t_t_r_i_b_u_t_e_s
Set window modes attributes.
mmooddee--bbgg _c_o_l_o_u_r
Set window modes background colour.
mmooddee--ffgg _c_o_l_o_u_r
Set window modes foreground colour.
mmooddee--kkeeyyss [vvii | eemmaaccss]
Use vi(1)- or emacs(1)-style key bindings in scroll and
copy modes. Key bindings default to emacs.
mmoonniittoorr--aaccttiivviittyy [oonn | ooffff]
Monitor for activity in the window. Windows with activi-
ty are highlighted in the status line.
mmoonniittoorr--ccoonntteenntt _m_a_t_c_h_-_s_t_r_i_n_g
Monitor content in the window. When _m_a_t_c_h_-_s_t_r_i_n_g appears
in the window, it is highlighted in the status line.
rreemmaaiinn--oonn--eexxiitt [oonn | ooffff]
A window with this flag set is not destroyed when the
program running in it exits. The window may be reacti-
vated with the rreessppaawwnn--wwiinnddooww command.
uuttff88 [oonn | ooffff]
Instructs ttmmuuxx to expect UTF-8 sequences to appear in
this window.
wwiinnddooww--ssttaattuuss--aattttrr _a_t_t_r_i_b_u_t_e_s
Set status line attributes for a single window.
wwiinnddooww--ssttaattuuss--bbgg _c_o_l_o_u_r
Set status line background colour for a single window.
wwiinnddooww--ssttaattuuss--ffgg _c_o_l_o_u_r
Set status line foreground colour for a single window.
xxtteerrmm--kkeeyyss [oonn | ooffff]
If this option is set, ttmmuuxx will generate xterm(1)-style
function key sequences; these have a number included to
indicate modifiers such as shift, meta or ctrl.
sshhooww--bbuuffffeerr [--bb _b_u_f_f_e_r_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
(alias: sshhoowwbb)
Display the contents of the specified buffer.
sshhooww--ooppttiioonnss [--tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n] _o_p_t_i_o_n _v_a_l_u_e
(alias: sshhooww)
Show the currently set options. If a _t_a_r_g_e_t_-_s_e_s_s_i_o_n is speci-
fied, the options for that session are shown; otherwise, the
global options are listed.
sshhooww--wwiinnddooww--ooppttiioonnss [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w] _o_p_t_i_o_n _v_a_l_u_e
(alias: sshhoowwww)
List the current options for the given window.
ssoouurrccee--ffiillee _p_a_t_h
(alias: ssoouurrccee)
Execute commands from _p_a_t_h.
sspplliitt--wwiinnddooww [--dd] [--ll _l_i_n_e_s | --pp _p_e_r_c_e_n_t_a_g_e] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w] [_c_o_m_m_a_n_d]
(alias: splitw)
Creates a new window by splitting it vertically. The --ll and --pp
options specify the size of the new window in lines, or as a per-
centage, respectively. All other options have the same meaning
as in the nneeww--wwiinnddooww command.
A few notes with regard to panes:
1. If attempting to split a window with less than eight lines,
an error will be shown.
2. If the window is resized, as many panes are shown as can fit
without reducing them below four lines.
3. The minimum pane size is four lines (including the separator
line).
4. The panes are indexed from top (0) to bottom, with no num-
bers skipped.
ssttaarrtt--sseerrvveerr
(alias: ssttaarrtt)
Start the ttmmuuxx server, if not already running, without creating
any sessions.
ssuussppeenndd--cclliieenntt [--cc --ttaarrggeett--cclliieenntt]
(alias: ssuussppeennddcc)
Suspend a client by sending SIGTSTP (tty stop).
sswwaapp--ppaannee [--ddDDUU] [--pp _s_r_c_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w] [--qq _d_s_t_-_i_n_d_e_x]
(alias: sswwaapppp)
Swap two panes within a window. If --UU is used, the pane is
swapped with the pane above (before it numerically); --DD swaps
with the pane below (the next numerically); or _d_s_t_-_i_n_d_e_x may be
give to swap with a specific pane.
sswwaapp--wwiinnddooww [--dd] [--ss _s_r_c_-_w_i_n_d_o_w] [--tt _d_s_t_-_w_i_n_d_o_w]
(alias: sswwaappww)
This is similar to lliinnkk--wwiinnddooww, except the source and destination
windows are swapped. It is an error if no window exists at _s_r_c_-
_w_i_n_d_o_w.
sswwiittcchh--cclliieenntt [--cc _t_a_r_g_e_t_-_c_l_i_e_n_t --tt _t_a_r_g_e_t_-_s_e_s_s_i_o_n]
(alias: sswwiittcchhcc)
Switch the current session for client _t_a_r_g_e_t_-_c_l_i_e_n_t to _t_a_r_g_e_t_-
_s_e_s_s_i_o_n.
uunnbbiinndd--kkeeyy _k_e_y
(alias: uunnbbiinndd)
Unbind the key bound to _k_e_y.
uunnlliinnkk--wwiinnddooww [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: uunnlliinnkkww)
Unlink _t_a_r_g_e_t_-_w_i_n_d_o_w. A window may be unlinked only if it is
linked to multiple sessions - windows may not be linked to no
sessions.
uupp--ppaannee [--pp _p_a_n_e_-_i_n_d_e_x] [--tt _t_a_r_g_e_t_-_w_i_n_d_o_w]
(alias: uupppp)
Move up a pane.
FFIILLEESS
~/.tmux.conf
default ttmmuuxx configuration file
SSEEEE AALLSSOO
pty(4)
AAUUTTHHOORRSS
Nicholas Marriott <nicm@users.sourceforge.net>
OpenBSD 4.5 April 20, 2009 13