3 .\" Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
14 .\" IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
15 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 .Nd terminal multiplexer
27 .Op Fl c Ar shell-command
29 .Op Fl L Ar socket-name
30 .Op Fl S Ar socket-path
32 .Op Ar command Op Ar flags
36 is a terminal multiplexer:
37 it enables a number of terminals to be created, accessed, and
38 controlled from a single screen.
40 may be detached from a screen
41 and continue running in the background,
42 then later reattached.
46 is started, it creates a new
50 and displays it on screen.
51 A status line at the bottom of the screen
52 shows information on the current session
53 and is used to enter interactive commands.
55 A session is a single collection of
57 under the management of
59 Each session has one or more
61 A window occupies the entire screen
62 and may be split into rectangular panes,
63 each of which is a separate pseudo terminal
66 manual page documents the technical details of pseudo terminals).
69 instances may connect to the same session,
70 and any number of windows may be present in the same session.
71 Once all sessions are killed,
75 Each session is persistent and will survive accidental disconnection
78 connection timeout) or intentional detaching (with the
82 may be reattached using:
88 a session is displayed on screen by a
90 and all sessions are managed by a single
92 The server and each client are separate processes which communicate through a
96 The options are as follows:
97 .Bl -tag -width "XXXXXXXXXXXX"
101 to assume the terminal supports 256 colours.
102 This is equivalent to
105 Start in control mode (see the
111 .It Fl c Ar shell-command
114 using the default shell.
117 server will be started to retrieve the
120 This option is for compatibility with
124 is used as a login shell.
135 may not be specified.
137 Specify an alternative configuration file.
140 loads the system configuration file from
142 if present, then looks for a user configuration file at
145 The configuration file is a set of
147 commands which are executed in sequence when the server is first started.
149 loads configuration files once when the server process has started.
152 command may be used to load a file later.
155 shows any error messages from commands in configuration files in the first
156 session created, and continues to process the rest of the configuration file.
157 .It Fl L Ar socket-name
159 stores the server socket in a directory under
164 The default socket is named
166 This option allows a different socket name to be specified, allowing several
172 a full path is not necessary: the sockets are all created in a directory
174 under the directory given by
180 directory is created by
182 and must not be world readable, writable or executable.
184 If the socket is accidentally removed, the
186 signal may be sent to the
188 server process to recreate it (note that this will fail if any parent
189 directories are missing).
191 Behave as a login shell.
192 This flag currently has no effect and is for compatibility with other shells
193 when using tmux as a login shell.
195 Do not start the server even if the command would normally do so (for example
199 .It Fl S Ar socket-path
200 Specify a full alternative path to the server socket.
203 is specified, the default socket directory is not used and any
207 Write UTF-8 output to the terminal even if the first environment
213 that is set does not contain
217 This is equivalent to
220 Set terminal features for the client.
221 This is a comma-separated list of features.
223 .Ic terminal-features
226 Request verbose logging.
227 Log messages will be saved into
228 .Pa tmux-client-PID.log
230 .Pa tmux-server-PID.log
231 files in the current directory, where
233 is the PID of the server or client process.
236 is specified twice, an additional
238 file is generated with a copy of everything
240 writes to the terminal.
244 signal may be sent to the
246 server process to toggle logging between on (as if
253 .It Ar command Op Ar flags
254 This specifies one of a set of commands used to control
256 as described in the following sections.
257 If no commands are specified, the
261 .Sh DEFAULT KEY BINDINGS
263 may be controlled from an attached client by using a key combination of a
266 (Ctrl-b) by default, followed by a command key.
268 The default command key bindings are:
270 .Bl -tag -width "XXXXXXXXXX" -offset indent -compact
272 Send the prefix key (C-b) through to the application.
274 Rotate the panes in the current window forwards.
280 Break the current pane out of the window.
283 Split the current pane into two, top and bottom.
285 List all paste buffers.
287 Rename the current session.
289 Split the current pane into two, left and right.
291 Kill the current window.
293 Prompt for a window index to select.
295 Switch the attached client to the previous session.
297 Switch the attached client to the next session.
299 Rename the current window.
301 Delete the most recently copied buffer of text.
303 Prompt for an index to move the current window.
305 Select windows 0 to 9.
311 Move to the previously active pane.
313 Choose which buffer to paste interactively from a list.
315 List all key bindings.
317 Choose a client to detach.
319 Switch the attached client back to the last session.
321 Enter copy mode to copy text or view the history.
323 Paste the most recently copied buffer of text.
327 Detach the current client.
329 Prompt to search for text in open windows.
331 Display some information about the current window.
333 Move to the previously selected window.
335 Mark the current pane (see
339 Clear the marked pane.
341 Change to the next window.
343 Select the next pane in the current window.
345 Change to the previous window.
347 Briefly display pane indexes.
349 Force redraw of the attached client.
351 Select a new session for the attached client interactively.
355 Choose the current window interactively.
357 Kill the current pane.
359 Toggle zoom state of the current pane.
361 Swap the current pane with the previous pane.
363 Swap the current pane with the next pane.
365 Show previous messages from
369 Enter copy mode and scroll one page up.
372 Change to the pane above, below, to the left, or to the right of the current
375 Arrange panes in one of the five preset layouts: even-horizontal,
376 even-vertical, main-horizontal, main-vertical, or tiled.
378 Arrange the current window in the next preset layout.
380 Move to the next window with a bell or activity marker.
382 Rotate the panes in the current window backwards.
384 Move to the previous window with a bell or activity marker.
387 Resize the current pane in steps of one cell.
390 Resize the current pane in steps of five cells.
393 Key bindings may be changed with the
398 .Sh COMMAND PARSING AND EXECUTION
400 supports a large number of commands which can be used to control its
402 Each command is named and can accept zero or more flags and arguments.
403 They may be bound to a key with the
405 command or run from the shell prompt, a shell script, a configuration file or
407 For example, the same
409 command run from the shell prompt, from
411 and bound to a key may look like:
412 .Bd -literal -offset indent
413 $ tmux set-option -g status-style bg=cyan
415 set-option -g status-style bg=cyan
417 bind-key C set-option -g status-style bg=cyan
420 Here, the command name is
430 distinguishes between command parsing and execution.
431 In order to execute a command,
433 needs it to be split up into its name and arguments.
434 This is command parsing.
435 If a command is run from the shell, the shell parses it; from inside
437 or from a configuration file,
443 .Bl -dash -offset indent
445 in a configuration file;
447 typed at the command prompt (see
448 .Ic command-prompt ) ;
453 passed as arguments to
459 To execute commands, each client has a
461 A global command queue not attached to any client is used on startup
462 for configuration files like
464 Parsed commands added to the queue are executed in order.
469 parse their argument to create a new command which is inserted immediately
471 This means that arguments can be parsed twice or more - once when the parent command (such as
473 is parsed and again when it parses and executes its command.
479 stop execution of subsequent commands on the queue until something happens -
483 until a shell command finishes and
485 until a key is pressed.
486 For example, the following commands:
487 .Bd -literal -offset indent
488 new-session; new-window
489 if-shell "true" "split-window"
508 commands and their arguments.
510 This section describes the syntax of commands parsed by
512 for example in a configuration file or at the command prompt.
513 Note that when commands are entered into the shell, they are parsed by the shell
519 Each command is terminated by a newline or a semicolon (;).
520 Commands separated by semicolons together form a
522 - if a command in the sequence encounters an error, no subsequent commands are
525 It is recommended that a semicolon used as a command separator should be
526 written as an individual token, for example from
528 .Bd -literal -offset indent
529 $ tmux neww \\; splitw
533 .Bd -literal -offset indent
534 $ tmux neww ';' splitw
537 Or from the tmux command prompt:
538 .Bd -literal -offset indent
542 However, a trailing semicolon is also interpreted as a command separator,
546 .Bd -literal -offset indent
547 $ tmux neww\e\e; splitw
551 .Bd -literal -offset indent
552 $ tmux 'neww;' splitw
555 As in these examples, when running tmux from the shell extra care must be taken
556 to properly quote semicolons:
559 Semicolons that should be interpreted as a command separator
560 should be escaped according to the shell conventions.
563 this typically means quoted (such as
564 .Ql neww ';' splitw )
566 .Ql neww \e\e\e\e; splitw ) .
568 Individual semicolons or trailing semicolons that should be interpreted as
569 arguments should be escaped twice: once according to the shell conventions and
573 .Bd -literal -offset indent
574 $ tmux neww 'foo\e\e;' bar
575 $ tmux neww foo\e\e\e\e; bar
578 Semicolons that are not individual tokens or trailing another token should only
579 be escaped once according to shell conventions; for example:
580 .Bd -literal -offset indent
581 $ tmux neww 'foo-;-bar'
582 $ tmux neww foo-\e\e;-bar
586 Comments are marked by the unquoted # character - any remaining text after a
587 comment is ignored until the end of the line.
589 If the last character of a line is \e, the line is joined with the following
590 line (the \e and the newline are completely removed).
591 This is called line continuation and applies both inside and outside quoted
592 strings and in comments, but not inside braces.
594 Command arguments may be specified as strings surrounded by single (') quotes,
595 double quotes (") or braces ({}).
597 This is required when the argument contains any special character.
598 Single and double quoted strings cannot span multiple lines except with line
600 Braces can span multiple lines.
602 Outside of quotes and inside double quotes, these replacements are performed:
603 .Bl -dash -offset indent
605 Environment variables preceded by $ are replaced with their value from the
606 global environment (see the
607 .Sx GLOBAL AND SESSION ENVIRONMENT
610 A leading ~ or ~user is expanded to the home directory of the current or
613 \euXXXX or \euXXXXXXXX is replaced by the Unicode codepoint corresponding to
614 the given four or eight digit hexadecimal number.
616 When preceded (escaped) by a \e, the following characters are replaced: \ee by
617 the escape character; \er by a carriage return; \en by a newline; and \et by a
620 \eooo is replaced by a character of the octal value ooo.
621 Three octal digits are required, for example \e001.
622 The largest valid character is \e377.
624 Any other characters preceded by \e are replaced by themselves (that is, the \e
625 is removed) and are not treated as having any special meaning - so for example
626 \e; will not mark a command sequence and \e$ will not expand an environment
630 Braces are parsed as a configuration file (so conditions such as
632 are processed) and then converted into a string.
633 They are designed to avoid the need for additional escaping when passing a
636 commands as an argument (for example to
638 These two examples produce an identical command - note that no escaping is
639 needed when using {}:
640 .Bd -literal -offset indent
642 display -p 'brace-dollar-foo: }$foo'
645 if-shell true "display -p 'brace-dollar-foo: }\e$foo'"
648 Braces may be enclosed inside braces, for example:
649 .Bd -literal -offset indent
650 bind x if-shell "true" {
657 Environment variables may be set by using the syntax
660 .Ql HOME=/home/user .
661 Variables set during parsing are added to the global environment.
662 A hidden variable may be set with
665 .Bd -literal -offset indent
669 Hidden variables are not passed to the environment of processes created
672 .Sx GLOBAL AND SESSION ENVIRONMENT
675 Commands may be parsed conditionally by surrounding them with
685 is expanded as a format (see
687 and if it evaluates to false (zero or empty), subsequent text is ignored until
694 .Bd -literal -offset indent
695 %if "#{==:#{host},myhost}"
696 set -g status-style bg=red
697 %elif "#{==:#{host},myotherhost}"
698 set -g status-style bg=green
700 set -g status-style bg=blue
704 Will change the status line to red if running on
708 or blue if running on another host.
709 Conditionals may be given on one line, for example:
710 .Bd -literal -offset indent
711 %if #{==:#{host},myhost} set -g status-style bg=red %endif
714 This section describes the commands supported by
716 Most commands accept the optional
726 These specify the client, session, window or pane which a command should affect.
729 should be the name of the client,
732 file to which the client is connected, for example either of
736 for the client attached to
738 If no client is specified,
740 attempts to work out the client currently in use; if that fails, an error is
742 Clients may be listed with the
747 is tried as, in order:
750 A session ID prefixed with a $.
752 An exact name of a session (as listed by the
756 The start of a session name, for example
758 would match a session named
763 pattern which is matched against the session name.
766 If the session name is prefixed with an
768 only an exact match is accepted (so
770 will only match exactly
775 If a single session is found, it is used as the target session; multiple matches
777 If a session is omitted, the current session is used if available; if no
778 current session is available, the most recently used is chosen.
785 specifies a window in the form
786 .Em session Ns \&: Ns Em window .
788 follows the same rules as for
792 is looked for in order as:
795 A special token, listed below.
797 A window index, for example
799 is window 1 in session
802 A window ID, such as @1.
804 An exact window name, such as
805 .Ql mysession:mywindow .
807 The start of a window name, such as
808 .Ql mysession:mywin .
812 pattern matched against the window name.
817 prefix will do an exact match only.
818 An empty window name specifies the next unused index if appropriate (for
824 otherwise the current window in
828 The following special tokens are available to indicate particular windows.
829 Each has a single-character alternative form.
830 .Bl -column "XXXXXXXXXX" "X"
831 .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
832 .It Li "{start}" Ta "^" Ta "The lowest-numbered window"
833 .It Li "{end}" Ta "$" Ta "The highest-numbered window"
834 .It Li "{last}" Ta "!" Ta "The last (previously current) window"
835 .It Li "{next}" Ta "+" Ta "The next window by number"
836 .It Li "{previous}" Ta "-" Ta "The previous window by number"
844 may be a pane ID or takes a similar form to
846 but with the optional addition of a period followed by a pane index or pane ID,
848 .Ql mysession:mywindow.1 .
849 If the pane index is omitted, the currently active pane in the specified
851 The following special tokens are available for the pane index:
852 .Bl -column "XXXXXXXXXXXXXX" "X"
853 .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
854 .It Li "{last}" Ta "!" Ta "The last (previously active) pane"
855 .It Li "{next}" Ta "+" Ta "The next pane by number"
856 .It Li "{previous}" Ta "-" Ta "The previous pane by number"
857 .It Li "{top}" Ta "" Ta "The top pane"
858 .It Li "{bottom}" Ta "" Ta "The bottom pane"
859 .It Li "{left}" Ta "" Ta "The leftmost pane"
860 .It Li "{right}" Ta "" Ta "The rightmost pane"
861 .It Li "{top-left}" Ta "" Ta "The top-left pane"
862 .It Li "{top-right}" Ta "" Ta "The top-right pane"
863 .It Li "{bottom-left}" Ta "" Ta "The bottom-left pane"
864 .It Li "{bottom-right}" Ta "" Ta "The bottom-right pane"
865 .It Li "{up-of}" Ta "" Ta "The pane above the active pane"
866 .It Li "{down-of}" Ta "" Ta "The pane below the active pane"
867 .It Li "{left-of}" Ta "" Ta "The pane to the left of the active pane"
868 .It Li "{right-of}" Ta "" Ta "The pane to the right of the active pane"
875 may be followed by an offset, for example:
876 .Bd -literal -offset indent
885 may consist entirely of the token
889 to specify the session, window or pane where the most recent mouse event occurred
897 to specify the marked pane (see
901 Sessions, window and panes are each numbered with a unique ID; session IDs are
908 These are unique and are unchanged for the life of the session, window or pane
912 The pane ID is passed to the child process of the pane in the
914 environment variable.
915 IDs may be displayed using the
923 .Ic display-message ,
934 This may be a single argument passed to the shell, for example:
935 .Bd -literal -offset indent
936 new-window 'vi ~/.tmux.conf'
940 .Bd -literal -offset indent
941 /bin/sh -c 'vi ~/.tmux.conf'
953 to be given as multiple arguments and executed directly (without
955 This can avoid issues with shell quoting.
957 .Bd -literal -offset indent
958 $ tmux new-window vi ~/.tmux.conf
963 directly without invoking the shell.
969 command, either passed with the command and arguments separately, for example:
970 .Bd -literal -offset indent
971 bind-key F1 set-option status off
974 Or passed as a single string argument in
977 .Bd -literal -offset indent
978 bind-key F1 { set-option status off }
984 .Bd -literal -offset indent
985 refresh-client -t/dev/ttyp2
987 rename-session -tfirst newname
989 set-option -wt:0 monitor-activity on
991 new-window ; split-window -d
993 bind-key R source-file ~/.tmux.conf \e; \e
994 display-message "source-file done"
999 .Bd -literal -offset indent
1000 $ tmux kill-window -t :1
1002 $ tmux new-window \e; split-window -d
1004 $ tmux new-session -d 'vi ~/.tmux.conf' \e; split-window -d \e; attach
1006 .Sh CLIENTS AND SESSIONS
1009 server manages clients, sessions, windows and panes.
1010 Clients are attached to sessions to interact with them, either
1011 when they are created with the
1013 command, or later with the
1016 Each session has one or more windows
1019 Windows may be linked to multiple sessions and are made up of one or
1021 each of which contains a pseudo terminal.
1022 Commands for creating, linking and otherwise manipulating windows
1025 .Sx WINDOWS AND PANES
1028 The following commands are available to manage clients and sessions:
1031 .It Xo Ic attach-session
1033 .Op Fl c Ar working-directory
1035 .Op Fl t Ar target-session
1037 .D1 Pq alias: Ic attach
1040 create a new client in the current terminal and attach it to
1041 .Ar target-session .
1042 If used from inside, switch the current client.
1045 is specified, any other clients attached to the session are detached.
1050 to the parent process of the client as well as
1051 detaching the client, typically causing it to exit.
1053 sets a comma-separated list of client flags.
1057 the client has an independent active pane
1059 the client does not affect the size of other clients
1061 the client does not receive pane output in control mode
1062 .It pause-after=seconds
1063 output is paused once the pane is
1065 behind in control mode
1067 the client is read-only
1069 wait for an empty line input before exiting in control mode
1074 turns a flag off if the client is already attached.
1078 .Ar read-only,ignore-size .
1079 When a client is read-only, only keys bound to the
1083 commands have any effect.
1086 flag allows the active pane to be selected independently of the window's active
1087 pane used by clients without the flag.
1088 This only affects the cursor position and commands issued from the client;
1089 other features such as hooks and styles continue to use the window's active
1092 If no server is started,
1094 will attempt to start it; this will fail unless sessions are created in the
1101 are slightly adjusted: if
1103 needs to select the most recently used session, it will prefer the most
1109 will set the session working directory (used for new windows) to
1110 .Ar working-directory .
1115 .Ic update-environment
1116 option will not be applied.
1118 .It Xo Ic detach-client
1120 .Op Fl E Ar shell-command
1121 .Op Fl s Ar target-session
1122 .Op Fl t Ar target-client
1124 .D1 Pq alias: Ic detach
1125 Detach the current client if bound to a key, the client specified with
1127 or all clients currently attached to the session specified by
1131 option kills all but the client given with
1137 to the parent process of the client, typically causing it
1143 to replace the client.
1145 .It Ic has-session Op Fl t Ar target-session
1146 .D1 Pq alias: Ic has
1147 Report an error and exit with 1 if the specified session does not exist.
1148 If it does exist, exit with 0.
1152 server and clients and destroy all sessions.
1153 .It Xo Ic kill-session
1155 .Op Fl t Ar target-session
1157 Destroy the given session, closing any windows linked to it and no other
1158 sessions, and detaching all clients attached to it.
1161 is given, all sessions but the specified one is killed.
1164 flag clears alerts (bell, activity, or silence) in all windows linked to the
1167 .It Xo Ic list-clients
1169 .Op Fl t Ar target-session
1171 .D1 Pq alias: Ic lsc
1172 List all clients attached to the server.
1173 For the meaning of the
1180 is specified, list only clients connected to that session.
1182 .It Xo Ic list-commands
1186 .D1 Pq alias: Ic lscm
1189 or - if omitted - of all commands supported by
1192 .It Xo Ic list-sessions
1197 List all sessions managed by the server.
1199 specifies the format of each line and
1202 Only sessions for which the filter is true are shown.
1207 .It Ic lock-client Op Fl t Ar target-client
1208 .D1 Pq alias: Ic lockc
1215 .It Ic lock-session Op Fl t Ar target-session
1216 .D1 Pq alias: Ic locks
1217 Lock all clients attached to
1218 .Ar target-session .
1220 .It Xo Ic new-session
1222 .Op Fl c Ar start-directory
1223 .Op Fl e Ar environment
1226 .Op Fl n Ar window-name
1227 .Op Fl s Ar session-name
1228 .Op Fl t Ar group-name
1231 .Op Ar shell-command
1233 .D1 Pq alias: Ic new
1234 Create a new session with name
1237 The new session is attached to the current terminal unless
1243 are the name of and shell command to execute in the initial window.
1246 the initial size comes from the global
1252 can be used to specify a different size.
1254 uses the size of the current client if any.
1261 option is set for the session.
1263 sets a comma-separated list of client flags (see
1264 .Ic attach-session ) .
1266 If run from a terminal, any
1268 special characters are saved and used for new windows in the new session.
1278 already exists; in this case,
1283 .Ic attach-session ,
1289 .Ic attach-session .
1293 is given, it specifies a
1295 Sessions in the same group share the same set of windows - new windows are
1296 linked to all sessions in the group and any windows closed removed from all
1298 The current and previous window and any session options remain independent and
1299 any session in a group may be killed without affecting the others.
1305 the name of an existing group, in which case the new session is added to that
1308 the name of an existing session - the new session is added to the same group
1309 as that session, creating a new group if necessary;
1311 the name for a new group containing only the new session.
1323 option prints information about the new session after it has been created.
1324 By default, it uses the format
1325 .Ql #{session_name}:\&
1326 but a different format may be specified with
1332 .Ic update-environment
1333 option will not be applied.
1337 and sets an environment variable for the newly created session; it may be
1338 specified multiple times.
1340 .It Xo Ic refresh-client
1342 .Op Fl A Ar pane:state
1343 .Op Fl B Ar name:what:format
1346 .Op Fl l Op Ar target-pane
1347 .Op Fl t Ar target-client
1350 .D1 Pq alias: Ic refresh
1351 Refresh the current client if bound to a key, or a single client if one is given
1356 is specified, only update the client's status line.
1365 flags allow the visible portion of a window which is larger than the client
1368 moves the visible part up by
1380 returns to tracking the cursor automatically.
1383 is omitted, 1 is used.
1384 Note that the visible position is a property of the client not of the
1385 window, changing the current window in the attached session will reset
1389 sets the width and height of a control mode client or of a window for a
1390 control mode client,
1395 .Ql window ID:widthxheight ,
1401 allows a control mode client to trigger actions on a pane.
1402 The argument is a pane ID (with leading
1404 a colon, then one of
1413 will not send output from the pane to the client and if all clients have turned
1414 the pane off, will stop reading from the pane.
1418 will return to sending output to the pane if it was paused (manually or with the
1424 will pause the pane.
1426 may be given multiple times for different panes.
1429 sets a subscription to a format for a control mode client.
1430 The argument is split into three items by colons:
1432 is a name for the subscription;
1434 is a type of item to subscribe to;
1437 After a subscription is added, changes to the format are reported with the
1438 .Ic %subscription-changed
1439 notification, at most once a second.
1440 If only the name is given, the subscription is removed.
1442 may be empty to check the format only for the attached session, or one of:
1446 for all panes in the attached session;
1451 for all windows in the attached session.
1454 sets a comma-separated list of client flags, see
1455 .Ic attach-session .
1458 requests the clipboard from the client using the
1463 is given, the clipboard is sent (in encoded form), otherwise it is stored in a
1471 move the visible portion of the window left, right, up or down
1474 if the window is larger than the client.
1476 resets so that the position follows the cursor.
1481 .It Xo Ic rename-session
1482 .Op Fl t Ar target-session
1485 .D1 Pq alias: Ic rename
1486 Rename the session to
1488 .It Xo Ic server-access
1492 Change the access or read/write permission of
1494 The user running the
1496 server (its owner) and the root user cannot be changed and are always
1502 are used to give or revoke access for the specified user.
1503 If the user is already attached, the
1505 flag causes their clients to be detached.
1510 change the permissions for
1513 makes their clients read-only and
1517 lists current access permissions.
1519 By default, the access list is empty and
1521 creates sockets with file system permissions preventing access by any user
1522 other than the owner (and root).
1523 These permissions must be changed manually.
1524 Great care should be taken not to allow access to untrusted users even
1527 .It Xo Ic show-messages
1529 .Op Fl t Ar target-client
1531 .D1 Pq alias: Ic showmsgs
1532 Show server messages or information.
1533 Messages are stored, up to a maximum of the limit set by the
1539 show debugging information about jobs and terminals.
1541 .It Xo Ic source-file
1546 .D1 Pq alias: Ic source
1547 Execute commands from one or more files specified by
1556 is expanded as a format.
1559 is given, no error will be returned if
1564 the file is parsed but no commands are executed.
1566 shows the parsed commands and line numbers if possible.
1569 .D1 Pq alias: Ic start
1572 server, if not already running, without creating any sessions.
1574 Note that as by default the
1576 server will exit with no sessions, this is only useful if a session is created in
1579 is turned off, or another command is run as part of the same command sequence.
1581 .Bd -literal -offset indent
1582 $ tmux start \\; show -g
1585 .It Xo Ic suspend-client
1586 .Op Fl t Ar target-client
1588 .D1 Pq alias: Ic suspendc
1589 Suspend a client by sending
1593 .It Xo Ic switch-client
1595 .Op Fl c Ar target-client
1596 .Op Fl t Ar target-session
1597 .Op Fl T Ar key-table
1599 .D1 Pq alias: Ic switchc
1600 Switch the current session for client
1603 .Ar target-session .
1606 may refer to a pane (a target that contains
1611 to change session, window and pane.
1614 keeps the window zoomed if it was zoomed.
1620 is used, the client is moved to the last, next or previous session
1634 .Ic update-environment
1635 option will not be applied.
1638 sets the client's key table; the next key from the client will be interpreted
1641 This may be used to configure multiple prefix keys, or to bind commands to
1643 For example, to make typing
1648 .Bd -literal -offset indent
1649 bind-key -Ttable2 c list-keys
1650 bind-key -Ttable1 b switch-client -Ttable2
1651 bind-key -Troot a switch-client -Ttable1
1654 .Sh WINDOWS AND PANES
1655 Each window displayed by
1657 may be split into one or more
1659 each pane takes up a certain area of the display and is a separate terminal.
1660 A window may be split into panes using the
1663 Windows may be split horizontally (with the
1665 flag) or vertically.
1666 Panes may be resized with the
1674 by default), the current pane may be changed with the
1680 commands may be used to swap panes without changing their position.
1681 Panes are numbered beginning from zero in the order they are created.
1685 pane permits direct access to the terminal contained in the pane.
1686 A pane may also be put into one of several modes:
1687 .Bl -dash -offset indent
1689 Copy mode, which permits a section of a window or its
1690 history to be copied to a
1692 for later insertion into another window.
1693 This mode is entered with the
1698 Copied text can be pasted with the
1703 View mode, which is like copy mode but is entered when a command that produces
1706 is executed from a key binding.
1708 Choose mode, which allows an item to be chosen from a list.
1709 This may be a client, a session or window or pane, or a buffer.
1710 This mode is entered with the
1718 In copy mode an indicator is displayed in the top-right corner of the pane with
1719 the current position and the number of lines in the history.
1721 Commands are sent to copy mode using the
1726 When a key is pressed, copy mode automatically uses one of two key tables,
1734 Key tables may be viewed with the
1738 The following commands are supported in copy mode:
1739 .Bl -column "CommandXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXXXXXXXX" "emacs" -offset indent
1740 .It Sy "Command" Ta Sy "vi" Ta Sy "emacs"
1741 .It Li "append-selection" Ta "" Ta ""
1742 .It Li "append-selection-and-cancel" Ta "A" Ta ""
1743 .It Li "back-to-indentation" Ta "^" Ta "M-m"
1744 .It Li "begin-selection" Ta "Space" Ta "C-Space"
1745 .It Li "bottom-line" Ta "L" Ta ""
1746 .It Li "cancel" Ta "q" Ta "Escape"
1747 .It Li "clear-selection" Ta "Escape" Ta "C-g"
1748 .It Li "copy-end-of-line [<prefix>]" Ta "" Ta ""
1749 .It Li "copy-end-of-line-and-cancel [<prefix>]" Ta "" Ta ""
1750 .It Li "copy-pipe-end-of-line [<command>] [<prefix>]" Ta "" Ta ""
1751 .It Li "copy-pipe-end-of-line-and-cancel [<command>] [<prefix>]" Ta "D" Ta "C-k"
1752 .It Li "copy-line [<prefix>]" Ta "" Ta ""
1753 .It Li "copy-line-and-cancel [<prefix>]" Ta "" Ta ""
1754 .It Li "copy-pipe-line [<command>] [<prefix>]" Ta "" Ta ""
1755 .It Li "copy-pipe-line-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1756 .It Li "copy-pipe [<command>] [<prefix>]" Ta "" Ta ""
1757 .It Li "copy-pipe-no-clear [<command>] [<prefix>]" Ta "" Ta ""
1758 .It Li "copy-pipe-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1759 .It Li "copy-selection [<prefix>]" Ta "" Ta ""
1760 .It Li "copy-selection-no-clear [<prefix>]" Ta "" Ta ""
1761 .It Li "copy-selection-and-cancel [<prefix>]" Ta "Enter" Ta "M-w"
1762 .It Li "cursor-down" Ta "j" Ta "Down"
1763 .It Li "cursor-down-and-cancel" Ta "" Ta ""
1764 .It Li "cursor-left" Ta "h" Ta "Left"
1765 .It Li "cursor-right" Ta "l" Ta "Right"
1766 .It Li "cursor-up" Ta "k" Ta "Up"
1767 .It Li "end-of-line" Ta "$" Ta "C-e"
1768 .It Li "goto-line <line>" Ta ":" Ta "g"
1769 .It Li "halfpage-down" Ta "C-d" Ta "M-Down"
1770 .It Li "halfpage-down-and-cancel" Ta "" Ta ""
1771 .It Li "halfpage-up" Ta "C-u" Ta "M-Up"
1772 .It Li "history-bottom" Ta "G" Ta "M->"
1773 .It Li "history-top" Ta "g" Ta "M-<"
1774 .It Li "jump-again" Ta ";" Ta ";"
1775 .It Li "jump-backward <to>" Ta "F" Ta "F"
1776 .It Li "jump-forward <to>" Ta "f" Ta "f"
1777 .It Li "jump-reverse" Ta "," Ta ","
1778 .It Li "jump-to-backward <to>" Ta "T" Ta ""
1779 .It Li "jump-to-forward <to>" Ta "t" Ta ""
1780 .It Li "jump-to-mark" Ta "M-x" Ta "M-x"
1781 .It Li "middle-line" Ta "M" Ta "M-r"
1782 .It Li "next-matching-bracket" Ta "%" Ta "M-C-f"
1783 .It Li "next-paragraph" Ta "}" Ta "M-}"
1784 .It Li "next-space" Ta "W" Ta ""
1785 .It Li "next-space-end" Ta "E" Ta ""
1786 .It Li "next-word" Ta "w" Ta ""
1787 .It Li "next-word-end" Ta "e" Ta "M-f"
1788 .It Li "other-end" Ta "o" Ta ""
1789 .It Li "page-down" Ta "C-f" Ta "PageDown"
1790 .It Li "page-down-and-cancel" Ta "" Ta ""
1791 .It Li "page-up" Ta "C-b" Ta "PageUp"
1792 .It Li "pipe [<command>] [<prefix>]" Ta "" Ta ""
1793 .It Li "pipe-no-clear [<command>] [<prefix>]" Ta "" Ta ""
1794 .It Li "pipe-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1795 .It Li "previous-matching-bracket" Ta "" Ta "M-C-b"
1796 .It Li "previous-paragraph" Ta "{" Ta "M-{"
1797 .It Li "previous-space" Ta "B" Ta ""
1798 .It Li "previous-word" Ta "b" Ta "M-b"
1799 .It Li "rectangle-on" Ta "" Ta ""
1800 .It Li "rectangle-off" Ta "" Ta ""
1801 .It Li "rectangle-toggle" Ta "v" Ta "R"
1802 .It Li "refresh-from-pane" Ta "r" Ta "r"
1803 .It Li "scroll-down" Ta "C-e" Ta "C-Down"
1804 .It Li "scroll-down-and-cancel" Ta "" Ta ""
1805 .It Li "scroll-up" Ta "C-y" Ta "C-Up"
1806 .It Li "search-again" Ta "n" Ta "n"
1807 .It Li "search-backward <for>" Ta "?" Ta ""
1808 .It Li "search-backward-incremental <for>" Ta "" Ta "C-r"
1809 .It Li "search-backward-text <for>" Ta "" Ta ""
1810 .It Li "search-forward <for>" Ta "/" Ta ""
1811 .It Li "search-forward-incremental <for>" Ta "" Ta "C-s"
1812 .It Li "search-forward-text <for>" Ta "" Ta ""
1813 .It Li "search-reverse" Ta "N" Ta "N"
1814 .It Li "select-line" Ta "V" Ta ""
1815 .It Li "select-word" Ta "" Ta ""
1816 .It Li "set-mark" Ta "X" Ta "X"
1817 .It Li "start-of-line" Ta "0" Ta "C-a"
1818 .It Li "stop-selection" Ta "" Ta ""
1819 .It Li "toggle-position" Ta "P" Ta "P"
1820 .It Li "top-line" Ta "H" Ta "M-R"
1823 The search commands come in several varieties:
1827 search for a regular expression;
1830 variants search for a plain text string rather than a regular expression;
1832 perform an incremental search and expect to be used with the
1838 repeats the last search and
1840 does the same but reverses the direction (forward becomes backward and backward
1843 Copy commands may take an optional buffer prefix argument which is used
1844 to generate the buffer name (the default is
1846 so buffers are named
1850 Pipe commands take a command argument which is the command to which the
1851 selected text is piped.
1853 variants also copy the selection.
1856 variants of some commands exit copy mode after they have completed (for copy
1857 commands) or when the cursor reaches the bottom (for scrolling commands).
1859 variants do not clear the selection.
1861 The next and previous word keys skip over whitespace and treat consecutive
1862 runs of either word separators or other letters as words.
1863 Word separators can be customized with the
1866 Next word moves to the start of the next word, next word end to the end of the
1867 next word and previous word to the start of the previous word.
1868 The three next and previous space keys work similarly but use a space alone as
1872 to the empty string makes next/previous word equivalent to next/previous space.
1874 The jump commands enable quick movement within a line.
1875 For instance, typing
1879 will move the cursor to the next
1881 character on the current line.
1884 will then jump to the next occurrence.
1886 Commands in copy mode may be prefaced by an optional repeat count.
1887 With vi key bindings, a prefix is entered using the number keys; with
1888 emacs, the Alt (meta) key and a number begins prefix entry.
1890 The synopsis for the
1896 .Op Fl s Ar src-pane
1897 .Op Fl t Ar target-pane
1902 option scrolls one page up.
1904 begins a mouse drag (only valid if bound to a mouse key binding, see
1905 .Sx MOUSE SUPPORT ) .
1907 hides the position indicator in the top right.
1909 cancels copy mode and any other modes.
1917 specifies that scrolling to the bottom of the history (to the visible screen)
1918 should exit copy mode.
1919 While in copy mode, pressing a key other than those used for scrolling will
1920 disable this behaviour.
1921 This is intended to allow fast scrolling through a pane's history, for
1923 .Bd -literal -offset indent
1924 bind PageUp copy-mode -eu
1928 A number of preset arrangements of panes are available, these are called layouts.
1929 These may be selected with the
1931 command or cycled with
1935 by default); once a layout is chosen, panes within it may be moved and resized
1938 The following layouts are supported:
1940 .It Ic even-horizontal
1941 Panes are spread out evenly from left to right across the window.
1942 .It Ic even-vertical
1943 Panes are spread evenly from top to bottom.
1944 .It Ic main-horizontal
1945 A large (main) pane is shown at the top of the window and the remaining panes
1946 are spread from left to right in the leftover space at the bottom.
1948 .Em main-pane-height
1949 window option to specify the height of the top pane.
1950 .It Ic main-vertical
1953 but the large pane is placed on the left and the others spread from top to
1954 bottom along the right.
1959 Panes are spread out as evenly as possible over the window in both rows and
1965 may be used to apply a previously used layout - the
1967 command displays the layout of each window in a form suitable for use with
1970 .Bd -literal -offset indent
1973 layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1974 $ tmux select-layout bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1978 automatically adjusts the size of the layout for the current window size.
1979 Note that a layout cannot be applied to a window with more panes than that
1980 from which the layout was originally defined.
1982 Commands related to windows and panes are as follows:
1985 .It Xo Ic break-pane
1988 .Op Fl n Ar window-name
1989 .Op Fl s Ar src-pane
1990 .Op Fl t Ar dst-window
1992 .D1 Pq alias: Ic breakp
1995 off from its containing window to make it the only pane in
2001 the window is moved to the next index after or before (existing windows are
2002 moved if necessary).
2005 is given, the new window does not become the current window.
2008 option prints information about the new window after it has been created.
2009 By default, it uses the format
2010 .Ql #{session_name}:#{window_index}.#{pane_index}
2011 but a different format may be specified with
2014 .It Xo Ic capture-pane
2016 .Op Fl b Ar buffer-name
2017 .Op Fl E Ar end-line
2018 .Op Fl S Ar start-line
2019 .Op Fl t Ar target-pane
2021 .D1 Pq alias: Ic capturep
2022 Capture the contents of a pane.
2025 is given, the output goes to stdout, otherwise to the buffer specified with
2027 or a new buffer if omitted.
2030 is given, the alternate screen is used, and the history is not accessible.
2031 If no alternate screen exists, an error will be returned unless
2036 is given, the output includes escape sequences for text and background
2039 also escapes non-printable characters as octal \exxx.
2041 preserves trailing spaces at each line's end and
2043 preserves trailing spaces and joins any wrapped lines.
2045 captures only any output that the pane has received that is the beginning of an
2046 as-yet incomplete escape sequence.
2051 specify the starting and ending line numbers, zero is the first line of the
2052 visible pane and negative numbers are lines in the history.
2056 is the start of the history and to
2058 the end of the visible pane.
2059 The default is to capture only the visible contents of the pane.
2065 .Op Fl K Ar key-format
2066 .Op Fl O Ar sort-order
2067 .Op Fl t Ar target-pane
2070 Put a pane into client mode, allowing a client to be selected interactively from
2072 Each client is shown on one line.
2073 A shortcut key is shown on the left in brackets allowing for immediate choice,
2074 or the list may be navigated and an item chosen or otherwise manipulated using
2078 The following keys may be used in client mode:
2079 .Bl -column "Key" "Function" -offset indent
2080 .It Sy "Key" Ta Sy "Function"
2081 .It Li "Enter" Ta "Choose selected client"
2082 .It Li "Up" Ta "Select previous client"
2083 .It Li "Down" Ta "Select next client"
2084 .It Li "C-s" Ta "Search by name"
2085 .It Li "n" Ta "Repeat last search"
2086 .It Li "t" Ta "Toggle if client is tagged"
2087 .It Li "T" Ta "Tag no clients"
2088 .It Li "C-t" Ta "Tag all clients"
2089 .It Li "d" Ta "Detach selected client"
2090 .It Li "D" Ta "Detach tagged clients"
2091 .It Li "x" Ta "Detach and HUP selected client"
2092 .It Li "X" Ta "Detach and HUP tagged clients"
2093 .It Li "z" Ta "Suspend selected client"
2094 .It Li "Z" Ta "Suspend tagged clients"
2095 .It Li "f" Ta "Enter a format to filter items"
2096 .It Li "O" Ta "Change sort field"
2097 .It Li "r" Ta "Reverse sort order"
2098 .It Li "v" Ta "Toggle preview"
2099 .It Li "q" Ta "Exit mode"
2102 After a client is chosen,
2104 is replaced by the client name in
2106 and the result executed as a command.
2109 is not given, "detach-client -t '%%'" is used.
2112 specifies the initial sort field: one of
2119 reverses the sort order.
2121 specifies an initial filter: the filter is a format - if it evaluates to zero,
2122 the item in the list is not shown, otherwise it is shown.
2123 If a filter would lead to an empty list, it is ignored.
2125 specifies the format for each item in the list and
2127 a format for each shortcut key; both are evaluated once for each line.
2129 starts without the preview.
2130 This command works only if at least one client is attached.
2136 .Op Fl K Ar key-format
2137 .Op Fl O Ar sort-order
2138 .Op Fl t Ar target-pane
2141 Put a pane into tree mode, where a session, window or pane may be chosen
2142 interactively from a tree.
2143 Each session, window or pane is shown on one line.
2144 A shortcut key is shown on the left in brackets allowing for immediate choice,
2145 or the tree may be navigated and an item chosen or otherwise manipulated using
2148 starts with sessions collapsed and
2150 with windows collapsed.
2153 The following keys may be used in tree mode:
2154 .Bl -column "Key" "Function" -offset indent
2155 .It Sy "Key" Ta Sy "Function"
2156 .It Li "Enter" Ta "Choose selected item"
2157 .It Li "Up" Ta "Select previous item"
2158 .It Li "Down" Ta "Select next item"
2159 .It Li "+" Ta "Expand selected item"
2160 .It Li "-" Ta "Collapse selected item"
2161 .It Li "M-+" Ta "Expand all items"
2162 .It Li "M--" Ta "Collapse all items"
2163 .It Li "x" Ta "Kill selected item"
2164 .It Li "X" Ta "Kill tagged items"
2165 .It Li "<" Ta "Scroll list of previews left"
2166 .It Li ">" Ta "Scroll list of previews right"
2167 .It Li "C-s" Ta "Search by name"
2168 .It Li "m" Ta "Set the marked pane"
2169 .It Li "M" Ta "Clear the marked pane"
2170 .It Li "n" Ta "Repeat last search"
2171 .It Li "t" Ta "Toggle if item is tagged"
2172 .It Li "T" Ta "Tag no items"
2173 .It Li "C-t" Ta "Tag all items"
2174 .It Li "\&:" Ta "Run a command for each tagged item"
2175 .It Li "f" Ta "Enter a format to filter items"
2176 .It Li "H" Ta "Jump to the starting pane"
2177 .It Li "O" Ta "Change sort field"
2178 .It Li "r" Ta "Reverse sort order"
2179 .It Li "v" Ta "Toggle preview"
2180 .It Li "q" Ta "Exit mode"
2183 After a session, window or pane is chosen, the first instance of
2185 and all instances of
2187 are replaced by the target in
2189 and the result executed as a command.
2192 is not given, "switch-client -t '%%'" is used.
2195 specifies the initial sort field: one of
2201 reverses the sort order.
2203 specifies an initial filter: the filter is a format - if it evaluates to zero,
2204 the item in the list is not shown, otherwise it is shown.
2205 If a filter would lead to an empty list, it is ignored.
2207 specifies the format for each item in the tree and
2209 a format for each shortcut key; both are evaluated once for each line.
2211 starts without the preview.
2213 includes all sessions in any session groups in the tree rather than only the
2215 This command works only if at least one client is attached.
2221 .Op Fl t Ar target-pane
2224 Put a pane into customize mode, where options and key bindings may be browsed
2225 and modified from a list.
2226 Option values in the list are shown for the active pane in the current window.
2229 The following keys may be used in customize mode:
2230 .Bl -column "Key" "Function" -offset indent
2231 .It Sy "Key" Ta Sy "Function"
2232 .It Li "Enter" Ta "Set pane, window, session or global option value"
2233 .It Li "Up" Ta "Select previous item"
2234 .It Li "Down" Ta "Select next item"
2235 .It Li "+" Ta "Expand selected item"
2236 .It Li "-" Ta "Collapse selected item"
2237 .It Li "M-+" Ta "Expand all items"
2238 .It Li "M--" Ta "Collapse all items"
2239 .It Li "s" Ta "Set option value or key attribute"
2240 .It Li "S" Ta "Set global option value"
2241 .It Li "w" Ta "Set window option value, if option is for pane and window"
2242 .It Li "d" Ta "Set an option or key to the default"
2243 .It Li "D" Ta "Set tagged options and tagged keys to the default"
2244 .It Li "u" Ta "Unset an option (set to default value if global) or unbind a key"
2245 .It Li "U" Ta "Unset tagged options and unbind tagged keys"
2246 .It Li "C-s" Ta "Search by name"
2247 .It Li "n" Ta "Repeat last search"
2248 .It Li "t" Ta "Toggle if item is tagged"
2249 .It Li "T" Ta "Tag no items"
2250 .It Li "C-t" Ta "Tag all items"
2251 .It Li "f" Ta "Enter a format to filter items"
2252 .It Li "v" Ta "Toggle option information"
2253 .It Li "q" Ta "Exit mode"
2257 specifies an initial filter: the filter is a format - if it evaluates to zero,
2258 the item in the list is not shown, otherwise it is shown.
2259 If a filter would lead to an empty list, it is ignored.
2261 specifies the format for each item in the tree.
2263 starts without the option information.
2264 This command works only if at least one client is attached.
2269 .Op Fl d Ar duration
2270 .Op Fl t Ar target-client
2273 .D1 Pq alias: Ic displayp
2274 Display a visible indicator of each pane shown by
2277 .Ic display-panes-colour
2279 .Ic display-panes-active-colour
2281 The indicator is closed when a key is pressed (unless
2285 milliseconds have passed.
2289 .Ic display-panes-time
2291 A duration of zero means the indicator stays until a key is pressed.
2292 While the indicator is on screen, a pane may be chosen with the
2296 keys, which will cause
2298 to be executed as a command with
2300 substituted by the pane ID.
2303 is "select-pane -t '%%'".
2306 other commands are not blocked from running until the indicator is closed.
2308 .It Xo Ic find-window
2310 .Op Fl t Ar target-pane
2313 .D1 Pq alias: Ic findw
2320 in window names, titles, and visible content (but not history).
2321 The flags control matching behavior:
2323 matches only visible window contents,
2325 matches only the window name and
2327 matches only the window title.
2329 makes the search ignore case.
2335 This command works only if at least one client is attached.
2340 .Op Fl s Ar src-pane
2341 .Op Fl t Ar dst-pane
2343 .D1 Pq alias: Ic joinp
2346 but instead of splitting
2348 and creating a new pane, split it and move
2351 This can be used to reverse
2357 to be joined to left of or above
2362 is omitted and a marked pane is present (see
2365 the marked pane is used rather than the current pane.
2369 .Op Fl t Ar target-pane
2371 .D1 Pq alias: Ic killp
2372 Destroy the given pane.
2373 If no panes remain in the containing window, it is also destroyed.
2376 option kills all but the pane given with
2379 .It Xo Ic kill-window
2381 .Op Fl t Ar target-window
2383 .D1 Pq alias: Ic killw
2384 Kill the current window or the window at
2386 removing it from any sessions to which it is linked.
2389 option kills all but the window given with
2394 .Op Fl t Ar target-window
2396 .D1 Pq alias: Ic lastp
2397 Select the last (previously selected) pane.
2399 keeps the window zoomed if it was zoomed.
2403 disables input to the pane.
2405 .It Ic last-window Op Fl t Ar target-session
2406 .D1 Pq alias: Ic last
2407 Select the last (previously selected) window.
2410 is specified, select the last window of the current session.
2412 .It Xo Ic link-window
2414 .Op Fl s Ar src-window
2415 .Op Fl t Ar dst-window
2417 .D1 Pq alias: Ic linkw
2424 is specified and no such window exists, the
2431 the window is moved to the next index after or before
2433 (existing windows are moved if necessary).
2438 exists, it is killed, otherwise an error is generated.
2441 is given, the newly linked window is not selected.
2443 .It Xo Ic list-panes
2449 .D1 Pq alias: Ic lsp
2454 is ignored and all panes on the server are listed.
2459 is a session (or the current session).
2460 If neither is given,
2462 is a window (or the current window).
2464 specifies the format of each line and
2467 Only panes for which the filter is true are shown.
2472 .It Xo Ic list-windows
2476 .Op Fl t Ar target-session
2478 .D1 Pq alias: Ic lsw
2481 is given, list all windows on the server.
2482 Otherwise, list windows in the current session or in
2483 .Ar target-session .
2485 specifies the format of each line and
2488 Only windows for which the filter is true are shown.
2496 .Op Fl s Ar src-pane
2497 .Op Fl t Ar dst-pane
2499 .D1 Pq alias: Ic movep
2503 .It Xo Ic move-window
2505 .Op Fl s Ar src-window
2506 .Op Fl t Ar dst-window
2508 .D1 Pq alias: Ic movew
2511 except the window at
2517 all windows in the session are renumbered in sequential order, respecting
2522 .It Xo Ic new-window
2524 .Op Fl c Ar start-directory
2525 .Op Fl e Ar environment
2527 .Op Fl n Ar window-name
2528 .Op Fl t Ar target-window
2529 .Op Ar shell-command
2531 .D1 Pq alias: Ic neww
2532 Create a new window.
2537 the new window is inserted at the next index after or before the specified
2539 moving windows up if necessary;
2542 is the new window location.
2546 is given, the session does not make the new window the current window.
2548 represents the window to be created; if the target already exists an error is
2551 flag is used, in which case it is destroyed.
2554 is given and a window named
2556 already exists, it is selected (unless
2558 is also given in which case the command does nothing).
2561 is the command to execute.
2564 is not specified, the value of the
2568 specifies the working directory in which the new window is created.
2570 When the shell command completes, the window closes.
2573 option to change this behaviour.
2578 and sets an environment variable for the newly created window; it may be
2579 specified multiple times.
2583 environment variable must be set to
2587 for all programs running
2590 New windows will automatically have
2592 added to their environment, but care must be taken not to reset this in shell
2593 start-up files or by the
2599 option prints information about the new window after it has been created.
2600 By default, it uses the format
2601 .Ql #{session_name}:#{window_index}
2602 but a different format may be specified with
2605 .It Ic next-layout Op Fl t Ar target-window
2606 .D1 Pq alias: Ic nextl
2607 Move a window to the next layout and rearrange the panes to fit.
2609 .It Xo Ic next-window
2611 .Op Fl t Ar target-session
2613 .D1 Pq alias: Ic next
2614 Move to the next window in the session.
2617 is used, move to the next window with an alert.
2621 .Op Fl t Ar target-pane
2622 .Op Ar shell-command
2624 .D1 Pq alias: Ic pipep
2625 Pipe output sent by the program in
2627 to a shell command or vice versa.
2628 A pane may only be connected to one command at a time, any existing pipe is
2634 string may contain the special character sequences supported by the
2639 is given, the current pipe (if any) is closed.
2644 specify which of the
2646 output streams are connected to the pane:
2649 stdout is connected (so anything
2651 prints is written to the pane as if it were typed);
2654 stdin is connected (so any output in the pane is piped to
2655 .Ar shell-command ) .
2656 Both may be used together and if neither are specified,
2662 option only opens a new pipe if no previous pipe exists, allowing a pipe to
2663 be toggled with a single key, for example:
2664 .Bd -literal -offset indent
2665 bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
2668 .It Xo Ic previous-layout
2669 .Op Fl t Ar target-window
2671 .D1 Pq alias: Ic prevl
2672 Move to the previous layout in the session.
2674 .It Xo Ic previous-window
2676 .Op Fl t Ar target-session
2678 .D1 Pq alias: Ic prev
2679 Move to the previous window in the session.
2682 move to the previous window with an alert.
2684 .It Xo Ic rename-window
2685 .Op Fl t Ar target-window
2688 .D1 Pq alias: Ic renamew
2689 Rename the current window, or the window at
2694 .It Xo Ic resize-pane
2696 .Op Fl t Ar target-pane
2701 .D1 Pq alias: Ic resizep
2702 Resize a pane, up, down, left or right by
2718 is given in lines or columns (the default is 1);
2722 may be a given as a number of lines or columns or followed by
2724 for a percentage of the window size (for example
2728 the active pane is toggled between zoomed (occupying the whole of the window)
2729 and unzoomed (its normal position in the layout).
2732 begins mouse resizing (only valid if bound to a mouse key binding, see
2733 .Sx MOUSE SUPPORT ) .
2736 trims all lines below the current cursor position and moves lines out of the
2737 history to replace them.
2739 .It Xo Ic resize-window
2741 .Op Fl t Ar target-window
2746 .D1 Pq alias: Ic resizew
2747 Resize a window, up, down, left or right by
2763 is given in lines or cells (the default is 1).
2765 sets the size of the largest session containing the window;
2767 the size of the smallest.
2768 This command will automatically set
2770 to manual in the window options.
2772 .It Xo Ic respawn-pane
2774 .Op Fl c Ar start-directory
2775 .Op Fl e Ar environment
2776 .Op Fl t Ar target-pane
2777 .Op Ar shell-command
2779 .D1 Pq alias: Ic respawnp
2780 Reactivate a pane in which the command has exited (see the
2785 is not given, the command used when the pane was created or last respawned is
2787 The pane must be already inactive, unless
2789 is given, in which case any existing command is killed.
2791 specifies a new working directory for the pane.
2794 option has the same meaning as for the
2798 .It Xo Ic respawn-window
2800 .Op Fl c Ar start-directory
2801 .Op Fl e Ar environment
2802 .Op Fl t Ar target-window
2803 .Op Ar shell-command
2805 .D1 Pq alias: Ic respawnw
2806 Reactivate a window in which the command has exited (see the
2811 is not given, the command used when the window was created or last respawned is
2813 The window must be already inactive, unless
2815 is given, in which case any existing command is killed.
2817 specifies a new working directory for the window.
2820 option has the same meaning as for the
2824 .It Xo Ic rotate-window
2826 .Op Fl t Ar target-window
2828 .D1 Pq alias: Ic rotatew
2829 Rotate the positions of the panes within a window, either upward (numerically
2832 or downward (numerically higher).
2834 keeps the window zoomed if it was zoomed.
2836 .It Xo Ic select-layout
2838 .Op Fl t Ar target-pane
2841 .D1 Pq alias: Ic selectl
2842 Choose a specific layout for a window.
2845 is not given, the last preset layout used (if any) is reapplied.
2849 are equivalent to the
2855 applies the last set layout if possible (undoes the most recent layout change).
2857 spreads the current pane and any panes next to it out evenly.
2859 .It Xo Ic select-pane
2862 .Op Fl t Ar target-pane
2864 .D1 Pq alias: Ic selectp
2867 the active pane in its window.
2874 is used, respectively the pane below, to the left, to the right, or above the
2875 target pane is used.
2877 keeps the window zoomed if it was zoomed.
2879 is the same as using the
2885 disables input to the pane.
2887 sets the pane title.
2892 are used to set and clear the
2894 There is one marked pane at a time, setting a new marked pane clears the last.
2895 The marked pane is the default target for
2904 .It Xo Ic select-window
2906 .Op Fl t Ar target-window
2908 .D1 Pq alias: Ic selectw
2909 Select the window at
2915 are equivalent to the
2923 is given and the selected window is already the current window,
2924 the command behaves like
2927 .It Xo Ic split-window
2929 .Op Fl c Ar start-directory
2930 .Op Fl e Ar environment
2932 .Op Fl t Ar target-pane
2933 .Op Ar shell-command
2936 .D1 Pq alias: Ic splitw
2937 Create a new pane by splitting
2940 does a horizontal split and
2942 a vertical split; if neither is specified,
2947 option specifies the size of the new pane in lines (for vertical split) or in
2948 columns (for horizontal split);
2952 to specify a percentage of the available space.
2955 option causes the new pane to be created to the left of or above
2959 option creates a new pane spanning the full window height (with
2961 or full window width (with
2963 instead of splitting the active pane.
2965 zooms if the window is not zoomed, or keeps it zoomed if already zoomed.
2969 ('') will create a pane with no command running in it.
2970 Output can be sent to such a pane with the
2977 is not specified or empty)
2978 will create an empty pane and forward any output from stdin to it.
2980 .Bd -literal -offset indent
2981 $ make 2>&1|tmux splitw -dI &
2984 All other options have the same meaning as for the
2990 .Op Fl s Ar src-pane
2991 .Op Fl t Ar dst-pane
2993 .D1 Pq alias: Ic swapp
2997 is used and no source pane is specified with
3000 is swapped with the previous pane (before it numerically);
3002 swaps with the next pane (after it numerically).
3006 not to change the active pane and
3008 keeps the window zoomed if it was zoomed.
3012 is omitted and a marked pane is present (see
3015 the marked pane is used rather than the current pane.
3017 .It Xo Ic swap-window
3019 .Op Fl s Ar src-window
3020 .Op Fl t Ar dst-window
3022 .D1 Pq alias: Ic swapw
3025 except the source and destination windows are swapped.
3026 It is an error if no window exists at
3030 is given, the new window does not become the current window.
3034 is omitted and a marked pane is present (see
3037 the window containing the marked pane is used rather than the current window.
3039 .It Xo Ic unlink-window
3041 .Op Fl t Ar target-window
3043 .D1 Pq alias: Ic unlinkw
3048 is given, a window may be unlinked only if it is linked to multiple sessions -
3049 windows may not be linked to no sessions;
3052 is specified and the window is linked to only one session, it is unlinked and
3057 allows a command to be bound to most keys, with or without a prefix key.
3058 When specifying keys, most represent themselves (for example
3062 Ctrl keys may be prefixed with
3070 In addition, the following special key names are accepted:
3088 .Em NPage/PageDown/PgDn ,
3089 .Em PPage/PageUp/PgUp ,
3093 Note that to bind the
3097 keys, quotation marks are necessary, for example:
3098 .Bd -literal -offset indent
3099 bind-key '"' split-window
3100 bind-key "'" new-window
3103 A command bound to the
3105 key will execute for all keys which do not have a more specific binding.
3107 Commands related to key bindings are as follows:
3113 .Op Fl T Ar key-table
3114 .Ar key command Op Ar arguments
3116 .D1 Pq alias: Ic bind
3121 Keys are bound in a key table.
3122 By default (without -T), the key is bound in
3126 This table is used for keys pressed after the prefix key (for example,
3135 creates a new window).
3138 table is used for keys pressed without the prefix key: binding
3144 table (not recommended) means a plain
3146 will create a new window.
3151 Keys may also be bound in custom key tables and the
3154 command used to switch to them from a key binding.
3157 flag indicates this key may repeat, see the
3161 attaches a note to the key (shown with
3165 To view the default bindings and possible commands, see the
3171 .Op Fl P Ar prefix-string Fl T Ar key-table
3174 .D1 Pq alias: Ic lsk
3176 There are two forms: the default lists keys as
3180 lists only keys with attached notes and shows only the key and note for each
3183 With the default form, all key tables are listed by default.
3190 form, only keys in the
3194 key tables are listed by default;
3196 also lists only keys in
3199 specifies a prefix to print before each key and
3201 lists only the first matching key.
3203 lists the command for keys that do not have a note rather than skipping them.
3207 .Op Fl N Ar repeat-count
3208 .Op Fl t Ar target-pane
3211 .D1 Pq alias: Ic send
3212 Send a key or keys to a window.
3215 is the name of the key (such as
3219 to send; if the string is not recognised as a key, it is sent as a series of
3221 All arguments are sent sequentially from first to last.
3222 If no keys are given and the command is bound to a key, then that key is used.
3226 flag disables key name lookup and processes the keys as literal UTF-8
3230 flag expects each key to be a hexadecimal number for an ASCII character.
3234 flag causes the terminal state to be reset.
3237 passes through a mouse event (only valid if bound to a mouse key binding, see
3238 .Sx MOUSE SUPPORT ) .
3241 is used to send a command into copy mode - see
3243 .Sx WINDOWS AND PANES
3246 specifies a repeat count and
3248 expands formats in arguments where appropriate.
3249 .It Xo Ic send-prefix
3251 .Op Fl t Ar target-pane
3253 Send the prefix key, or with
3255 the secondary prefix key, to a window as if it was pressed.
3257 .It Xo Ic unbind-key
3259 .Op Fl T Ar key-table
3262 .D1 Pq alias: Ic unbind
3263 Unbind the command bound to
3272 is present, all key bindings are removed.
3275 option prevents errors being returned.
3278 The appearance and behaviour of
3280 may be modified by changing the value of various options.
3281 There are four types of option:
3282 .Em server options ,
3283 .Em session options ,
3284 .Em window options ,
3290 server has a set of global server options which do not apply to any particular
3291 window or session or pane.
3292 These are altered with the
3295 command, or displayed with the
3300 In addition, each individual session may have a set of session options, and
3301 there is a separate set of global session options.
3302 Sessions which do not have a particular option configured inherit the value
3303 from the global session options.
3304 Session options are set or unset with the
3306 command and may be listed with the
3309 The available server and session options are listed under the
3313 Similarly, a set of window options is attached to each window and a set of pane
3314 options to each pane.
3315 Pane options inherit from window options.
3316 This means any pane option may be set as a window option to apply the option to
3317 all panes in the window without the option set, for example these commands will
3318 set the background colour to red for all panes except pane 0:
3319 .Bd -literal -offset indent
3320 set -w window-style bg=red
3321 set -pt:.0 window-style bg=blue
3324 There is also a set of global window options from which any unset window or
3325 pane options are inherited.
3326 Window and pane options are altered with
3331 commands and displayed with
3338 also supports user options which are prefixed with a
3340 User options may have any name, so long as they are prefixed with
3342 and be set to any string.
3344 .Bd -literal -offset indent
3345 $ tmux set -wq @foo "abc123"
3346 $ tmux show -wv @foo
3350 Commands which set options are as follows:
3353 .It Xo Ic set-option
3355 .Op Fl t Ar target-pane
3358 .D1 Pq alias: Ic set
3359 Set a pane option with
3361 a window option with
3363 a server option with
3365 otherwise a session option.
3366 If the option is not a user option,
3370 may be unnecessary -
3372 will infer the type from the option name, assuming
3377 is given, the global session or window option is set.
3380 expands formats in the option value.
3383 flag unsets an option, so a session inherits the option from the global
3386 restores a global option to the default).
3388 unsets an option (like
3390 but if the option is a pane option also unsets the option on any panes in the
3393 depends on the option and may be a number, a string, or a flag (on, off, or
3398 flag prevents setting an option that is already set and the
3400 flag suppresses errors about unknown or ambiguous options.
3404 and if the option expects a string or a style,
3406 is appended to the existing setting.
3408 .Bd -literal -offset indent
3409 set -g status-left "foo"
3410 set -ag status-left "bar"
3416 .Bd -literal -offset indent
3417 set -g status-style "bg=red"
3418 set -ag status-style "fg=blue"
3421 Will result in a red background
3426 the result would be the default background and a blue foreground.
3428 .It Xo Ic show-options
3430 .Op Fl t Ar target-pane
3433 .D1 Pq alias: Ic show
3434 Show the pane options (or a single option if
3438 the window options with
3440 the server options with
3442 otherwise the session options.
3443 If the option is not a user option,
3447 may be unnecessary -
3449 will infer the type from the option name, assuming
3452 Global session or window options are listed if
3456 shows only the option value, not the name.
3459 is set, no error will be returned if
3463 includes hooks (omitted by default).
3465 includes options inherited from a parent set of options, such options are
3466 marked with an asterisk.
3469 Available server options are:
3471 .It Ic backspace Ar key
3475 .It Ic buffer-limit Ar number
3476 Set the number of buffers; as new buffers are added to the top of the stack,
3477 old ones are removed from the bottom if necessary to maintain this maximum
3479 .It Xo Ic command-alias[]
3482 This is an array of custom aliases for commands.
3483 If an unknown command matches
3489 .Dl set -s command-alias[100] zoom='resize-pane -Z'
3497 .Dl resize-pane -Z -t:.1
3499 Note that aliases are expanded when a command is parsed rather than when it is
3500 executed, so binding an alias with
3502 will bind the expanded form.
3503 .It Ic default-terminal Ar terminal
3504 Set the default terminal for new windows created in this session - the
3505 default value of the
3507 environment variable.
3510 to work correctly, this
3515 or a derivative of them.
3516 .It Ic copy-command Ar shell-command
3517 Give the command to pipe to if the
3519 copy mode command is used without arguments.
3520 .It Ic escape-time Ar time
3521 Set the time in milliseconds for which
3523 waits after an escape is input to determine if it is part of a function or meta
3525 The default is 500 milliseconds.
3526 .It Ic editor Ar shell-command
3527 Set the command used when
3530 .It Xo Ic exit-empty
3533 If enabled (the default), the server will exit when there are no active
3535 .It Xo Ic exit-unattached
3538 If enabled, the server will exit when there are no attached clients.
3539 .It Xo Ic extended-keys
3540 .Op Ic on | off | always
3546 the escape sequence to enable extended keys is sent to the terminal, if
3548 knows that it is supported.
3550 always recognises extended keys itself.
3554 will only forward extended keys to applications when they request them; if
3557 will always forward the keys.
3558 .It Xo Ic focus-events
3561 When enabled, focus events are requested from the terminal if supported and
3562 passed through to applications running in
3564 Attached clients should be detached and attached again after changing this
3566 .It Ic history-file Ar path
3567 If not empty, a file to which
3569 will write command prompt history on exit and load it from on start.
3570 .It Ic message-limit Ar number
3571 Set the number of error or information messages to save in the message log for
3573 .It Ic prompt-history-limit Ar number
3574 Set the number of history items to save in the history file for each type of
3576 .It Xo Ic set-clipboard
3577 .Op Ic on | external | off
3579 Attempt to set the terminal clipboard content using the
3581 escape sequence, if there is an
3585 description (see the
3586 .Sx TERMINFO EXTENSIONS
3592 will both accept the escape sequence to create a buffer and attempt to set
3593 the terminal clipboard.
3597 will attempt to set the terminal clipboard but ignore attempts
3598 by applications to set
3604 will neither accept the clipboard escape sequence nor attempt to set the
3607 Note that this feature needs to be enabled in
3609 by setting the resource:
3610 .Bd -literal -offset indent
3611 disallowedWindowOps: 20,21,SetXprop
3614 Or changing this property from the
3616 interactive menu when required.
3617 .It Ic terminal-features[] Ar string
3618 Set terminal features for terminal types read from
3621 has a set of named terminal features.
3622 Each will apply appropriate changes to the
3627 can detect features for a few common terminals; this option can be used to
3628 easily tell tmux about features supported by terminals it cannot detect.
3630 .Ic terminal-overrides
3631 option allows individual
3633 capabilities to be set instead,
3634 .Ic terminal-features
3635 is intended for classes of functionality supported in a standard way but not
3638 Care must be taken to configure this only with features the terminal actually
3641 This is an array option where each entry is a colon-separated string made up
3642 of a terminal type pattern (matched using
3644 followed by a list of terminal features.
3645 The available features are:
3648 Supports 256 colours with the SGR escape sequences.
3650 Allows setting the system clipboard.
3652 Allows setting the cursor colour.
3654 Allows setting the cursor style.
3656 Supports extended keys.
3658 Supports focus reporting.
3660 Supports DECSLRM margins.
3666 Supports the OSC 7 working directory extension.
3668 Supports the overline SGR attribute.
3670 Supports the DECFRA rectangle fill escape sequence.
3672 Supports RGB colour with the SGR escape sequences.
3674 Supports the strikethrough SGR escape sequence.
3676 Supports synchronized updates.
3682 Allows underscore style and colour to be set.
3684 .It Ic terminal-overrides[] Ar string
3685 Allow terminal descriptions read using
3688 Each entry is a colon-separated string made up of a terminal type pattern
3695 For example, to set the
3700 for all terminal types matching
3703 .Dl "rxvt*:clear=\ee[H\ee[2J"
3705 The terminal entry value is passed through
3707 before interpretation.
3708 .It Ic user-keys[] Ar key
3709 Set list of user-defined key escape sequences.
3710 Each item is associated with a key named
3716 .Bd -literal -offset indent
3717 set -s user-keys[0] "\ee[5;30012~"
3718 bind User0 resize-pane -L 3
3722 Available session options are:
3724 .It Xo Ic activity-action
3725 .Op Ic any | none | current | other
3727 Set action on window activity when
3728 .Ic monitor-activity
3731 means activity in any window linked to a session causes a bell or message
3733 .Ic visual-activity )
3734 in the current window of that session,
3736 means all activity is ignored (equivalent to
3737 .Ic monitor-activity
3740 means only activity in windows other than the current window are ignored and
3742 means activity in the current window is ignored but not those in other windows.
3743 .It Ic assume-paste-time Ar milliseconds
3744 If keys are entered faster than one in
3746 they are assumed to have been pasted rather than typed and
3748 key bindings are not processed.
3749 The default is one millisecond and zero disables.
3750 .It Ic base-index Ar index
3751 Set the base index from which an unused index should be searched when a new
3753 The default is zero.
3754 .It Xo Ic bell-action
3755 .Op Ic any | none | current | other
3757 Set action on a bell in a window when
3760 The values are the same as those for
3761 .Ic activity-action .
3762 .It Ic default-command Ar shell-command
3763 Set the command used for new windows (if not specified when the window is
3769 The default is an empty string, which instructs
3771 to create a login shell using the value of the
3774 .It Ic default-shell Ar path
3775 Specify the default shell.
3776 This is used as the login shell for new windows when the
3778 option is set to empty, and must be the full path of the executable.
3781 tries to set a default value from the first suitable of the
3783 environment variable, the shell returned by
3787 This option should be configured when
3789 is used as a login shell.
3790 .It Ic default-size Ar XxY
3791 Set the default size of new windows when the
3793 option is set to manual or when a session is created with
3796 The value is the width and height separated by an
3799 The default is 80x24.
3800 .It Xo Ic destroy-unattached
3803 If enabled and the session is no longer attached to any clients, it is
3805 .It Xo Ic detach-on-destroy
3806 .Op Ic off | on | no-detached
3808 If on (the default), the client is detached when the session it is attached to
3810 If off, the client is switched to the most recently active of the remaining
3814 the client is detached only if there are no detached sessions; if detached
3815 sessions exist, the client is switched to the most recently active.
3816 .It Ic display-panes-active-colour Ar colour
3817 Set the colour used by the
3819 command to show the indicator for the active pane.
3820 .It Ic display-panes-colour Ar colour
3821 Set the colour used by the
3823 command to show the indicators for inactive panes.
3824 .It Ic display-panes-time Ar time
3825 Set the time in milliseconds for which the indicators shown by the
3828 .It Ic display-time Ar time
3829 Set the amount of time for which status line messages and other on-screen
3830 indicators are displayed.
3831 If set to 0, messages and indicators are displayed until a key is pressed.
3834 .It Ic history-limit Ar lines
3835 Set the maximum number of lines held in window history.
3836 This setting applies only to new windows - existing window histories are not
3837 resized and retain the limit at the point they were created.
3838 .It Ic key-table Ar key-table
3839 Set the default key table to
3843 .It Ic lock-after-time Ar number
3844 Lock the session (like the
3848 seconds of inactivity.
3849 The default is not to lock (set to 0).
3850 .It Ic lock-command Ar shell-command
3851 Command to run when locking each client.
3852 The default is to run
3856 .It Ic message-command-style Ar style
3857 Set status line message command style.
3858 This is used for the command prompt with
3860 keys when in command mode.
3866 .It Ic message-style Ar style
3867 Set status line message style.
3868 This is used for messages and for the command prompt.
3879 captures the mouse and allows mouse events to be bound as key bindings.
3882 section for details.
3883 .It Ic prefix Ar key
3884 Set the key accepted as a prefix key.
3885 In addition to the standard keys described under
3888 can be set to the special key
3891 .It Ic prefix2 Ar key
3892 Set a secondary key accepted as a prefix key.
3898 .It Xo Ic renumber-windows
3901 If on, when a window is closed in a session, automatically renumber the other
3902 windows in numerical order.
3905 option if it has been set.
3906 If off, do not renumber the windows.
3907 .It Ic repeat-time Ar time
3908 Allow multiple commands to be entered without pressing the prefix-key again
3911 milliseconds (the default is 500).
3912 Whether a key repeats may be set when it is bound using the
3916 Repeat is enabled for the default keys bound to the
3919 .It Xo Ic set-titles
3922 Attempt to set the client terminal title using the
3927 entries if they exist.
3929 automatically sets these to the \ee]0;...\e007 sequence if
3930 the terminal appears to be
3932 This option is off by default.
3933 .It Ic set-titles-string Ar string
3934 String used to set the client terminal title if
3937 Formats are expanded, see the
3940 .It Xo Ic silence-action
3941 .Op Ic any | none | current | other
3943 Set action on window silence when
3946 The values are the same as those for
3947 .Ic activity-action .
3949 .Op Ic off | on | 2 | 3 | 4 | 5
3951 Show or hide the status line or specify its size.
3954 gives a status line one row in height;
3961 .It Ic status-format[] Ar format
3962 Specify the format to be used for each line of the status line.
3963 The default builds the top status line from the various individual status
3965 .It Ic status-interval Ar interval
3966 Update the status line every
3969 By default, updates will occur every 15 seconds.
3970 A setting of zero disables redrawing at interval.
3971 .It Xo Ic status-justify
3972 .Op Ic left | centre | right | absolute-centre
3974 Set the position of the window list in the status line: left, centre or right.
3975 centre puts the window list in the relative centre of the available free space;
3976 absolute-centre uses the centre of the entire horizontal space.
3977 .It Xo Ic status-keys
3980 Use vi or emacs-style
3981 key bindings in the status line, for example at the command prompt.
3982 The default is emacs, unless the
3986 environment variables are set and contain the string
3988 .It Ic status-left Ar string
3991 (by default the session name) to the left of the status line.
3993 will be passed through
4001 For details on how the names and titles can be set see the
4002 .Sx "NAMES AND TITLES"
4006 .Bd -literal -offset indent
4007 #(sysctl vm.loadavg)
4008 #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
4013 .It Ic status-left-length Ar length
4016 of the left component of the status line.
4018 .It Ic status-left-style Ar style
4019 Set the style of the left part of the status line.
4025 .It Xo Ic status-position
4028 Set the position of the status line.
4029 .It Ic status-right Ar string
4032 to the right of the status line.
4033 By default, the current pane title in double quotes, the date and the time
4040 and character pairs are replaced.
4041 .It Ic status-right-length Ar length
4044 of the right component of the status line.
4046 .It Ic status-right-style Ar style
4047 Set the style of the right part of the status line.
4053 .It Ic status-style Ar style
4054 Set status line style.
4060 .It Ic update-environment[] Ar variable
4061 Set list of environment variables to be copied into the session environment
4062 when a new session is created or an existing session is attached.
4063 Any variables that do not exist in the source environment are set to be
4064 removed from the session environment (as if
4069 .It Xo Ic visual-activity
4070 .Op Ic on | off | both
4072 If on, display a message instead of sending a bell when activity occurs in a
4073 window for which the
4074 .Ic monitor-activity
4075 window option is enabled.
4076 If set to both, a bell and a message are produced.
4077 .It Xo Ic visual-bell
4078 .Op Ic on | off | both
4080 If on, a message is shown on a bell in a window for which the
4082 window option is enabled instead of it being passed through to the
4083 terminal (which normally makes a sound).
4084 If set to both, a bell and a message are produced.
4088 .It Xo Ic visual-silence
4089 .Op Ic on | off | both
4093 is enabled, prints a message after the interval has expired on a given window
4094 instead of sending a bell.
4095 If set to both, a bell and a message are produced.
4096 .It Ic word-separators Ar string
4097 Sets the session's conception of what characters are considered word
4098 separators, for the purposes of the next and previous word commands in
4102 Available window options are:
4104 .Bl -tag -width Ds -compact
4105 .It Xo Ic aggressive-resize
4108 Aggressively resize the chosen window.
4111 will resize the window to the size of the smallest or largest session
4114 option) for which it is the current window, rather than the session to
4115 which it is attached.
4116 The window may resize when the current window is changed on another
4117 session; this option is good for full-screen programs which support
4119 and poor for interactive programs such as shells.
4121 .It Xo Ic automatic-rename
4124 Control automatic window renaming.
4125 When this setting is enabled,
4127 will rename the window automatically using the format specified by
4128 .Ic automatic-rename-format .
4129 This flag is automatically disabled for an individual window when a name
4130 is specified at creation with
4136 or with a terminal escape sequence.
4137 It may be switched off globally with:
4138 .Bd -literal -offset indent
4139 set-option -wg automatic-rename off
4142 .It Ic automatic-rename-format Ar format
4146 .Ic automatic-rename
4149 .It Ic clock-mode-colour Ar colour
4152 .It Xo Ic clock-mode-style
4155 Set clock hour format.
4157 .It Ic fill-character Ar character
4158 Set the character used to fill areas of the terminal unused by a window.
4160 .It Ic main-pane-height Ar height
4161 .It Ic main-pane-width Ar width
4162 Set the width or height of the main (left or top) pane in the
4169 this is a percentage of the window size.
4171 .It Ic copy-mode-match-style Ar style
4172 Set the style of search matches in copy mode.
4179 .It Ic copy-mode-mark-style Ar style
4180 Set the style of the line containing the mark in copy mode.
4187 .It Ic copy-mode-current-match-style Ar style
4188 Set the style of the current search match in copy mode.
4198 Use vi or emacs-style key bindings in copy mode.
4199 The default is emacs, unless
4206 .It Ic mode-style Ar style
4207 Set window modes style.
4214 .It Xo Ic monitor-activity
4217 Monitor for activity in the window.
4218 Windows with activity are highlighted in the status line.
4220 .It Xo Ic monitor-bell
4223 Monitor for a bell in the window.
4224 Windows with a bell are highlighted in the status line.
4226 .It Xo Ic monitor-silence
4229 Monitor for silence (no activity) in the window within
4232 Windows that have been silent for the interval are highlighted in the
4234 An interval of zero disables the monitoring.
4236 .It Ic other-pane-height Ar height
4237 Set the height of the other panes (not the main pane) in the
4240 If this option is set to 0 (the default), it will have no effect.
4242 .Ic main-pane-height
4244 .Ic other-pane-height
4245 options are set, the main pane will grow taller to make the other panes the
4246 specified height, but will never shrink to do so.
4249 this is a percentage of the window size.
4251 .It Ic other-pane-width Ar width
4253 .Ic other-pane-height ,
4254 but set the width of other panes in the
4258 .It Ic pane-active-border-style Ar style
4259 Set the pane border style for the currently active pane.
4265 Attributes are ignored.
4267 .It Ic pane-base-index Ar index
4270 but set the starting index for pane numbers.
4272 .It Ic pane-border-format Ar format
4273 Set the text shown in pane border status lines.
4275 .It Xo Ic pane-border-indicators
4276 .Op Ic off | colour | arrows | both
4278 Indicate active pane by colouring only half of the border in windows with
4279 exactly two panes, by displaying arrow markers, by drawing both or neither.
4281 .It Ic pane-border-lines Ar type
4282 Set the type of characters used for drawing pane borders.
4287 single lines using ACS or UTF-8 characters
4289 double lines using UTF-8 characters
4291 heavy lines using UTF-8 characters
4293 simple ASCII characters
4301 will fall back to standard ACS line drawing when UTF-8 is not supported.
4303 .It Xo Ic pane-border-status
4304 .Op Ic off | top | bottom
4306 Turn pane border status lines off or set their position.
4308 .It Ic pane-border-style Ar style
4309 Set the pane border style for panes aside from the active pane.
4315 Attributes are ignored.
4317 .It Ic popup-style Ar style
4318 Set the popup style.
4324 Attributes are ignored.
4326 .It Ic popup-border-style Ar style
4327 Set the popup border style.
4333 Attributes are ignored.
4335 .It Ic popup-border-lines Ar type
4336 Set the type of characters used for drawing popup borders.
4341 single lines using ACS or UTF-8 characters (default)
4343 variation of single with rounded corners using UTF-8 characters
4345 double lines using UTF-8 characters
4347 heavy lines using UTF-8 characters
4349 simple ASCII characters
4351 simple ASCII space character
4359 will fall back to standard ACS line drawing when UTF-8 is not supported.
4361 .It Ic window-status-activity-style Ar style
4362 Set status line style for windows with an activity alert.
4369 .It Ic window-status-bell-style Ar style
4370 Set status line style for windows with a bell alert.
4377 .It Ic window-status-current-format Ar string
4379 .Ar window-status-format ,
4380 but is the format used when the window is the current window.
4382 .It Ic window-status-current-style Ar style
4383 Set status line style for the currently active window.
4390 .It Ic window-status-format Ar string
4391 Set the format in which the window is displayed in the status line window list.
4398 .It Ic window-status-last-style Ar style
4399 Set status line style for the last active window.
4406 .It Ic window-status-separator Ar string
4407 Sets the separator drawn between windows in the status line.
4408 The default is a single space character.
4410 .It Ic window-status-style Ar style
4411 Set status line style for a single window.
4418 .It Xo Ic window-size
4419 .Ar largest | Ar smallest | Ar manual | Ar latest
4423 determines the window size.
4426 the size of the largest attached session is used; if
4428 the size of the smallest.
4431 the size of a new window is set from the
4433 option and windows are resized automatically.
4437 uses the size of the client that had the most recent activity.
4441 .Ic aggressive-resize
4444 .It Xo Ic wrap-search
4447 If this option is set, searches will wrap around the end of the pane contents.
4451 Available pane options are:
4453 .Bl -tag -width Ds -compact
4454 .It Xo Ic allow-passthrough
4457 Allow programs in the pane to bypass
4459 using a terminal escape sequence (\eePtmux;...\ee\e\e).
4461 .It Xo Ic allow-rename
4464 Allow programs in the pane to change the window name using a terminal escape
4465 sequence (\eek...\ee\e\e).
4467 .It Xo Ic alternate-screen
4470 This option configures whether programs running inside the pane may use the
4471 terminal alternate screen feature, which allows the
4477 The alternate screen feature preserves the contents of the window when an
4478 interactive application starts and restores it on exit, so that any output
4479 visible before the application starts reappears unchanged after it exits.
4481 .It Ic cursor-colour Ar colour
4482 Set the colour of the cursor.
4484 .It Ic pane-colours[] Ar colour
4485 The default colour palette.
4486 Each entry in the array defines the colour
4488 uses when the colour with that index is requested.
4489 The index may be from zero to 255.
4491 .It Ic cursor-style Ar style
4492 Set the style of the cursor.
4493 Available styles are:
4495 .Ic blinking-block ,
4497 .Ic blinking-underline ,
4502 .It Xo Ic remain-on-exit
4503 .Op Ic on | off | failed
4505 A pane with this flag set is not destroyed when the program running in it
4509 then only when the program exit status is not zero.
4510 The pane may be reactivated with the
4514 .It Ic remain-on-exit-format Ar string
4515 Set the text shown at the bottom of exited panes when
4519 .It Xo Ic scroll-on-clear
4522 When the entire screen is cleared and this option is on, scroll the contents of
4523 the screen into history before clearing it.
4525 .It Xo Ic synchronize-panes
4528 Duplicate input to all other panes in the same window where this option is also
4529 on (only for panes that are not in any mode).
4531 .It Ic window-active-style Ar style
4532 Set the pane style when it is the active pane.
4539 .It Ic window-style Ar style
4549 allows commands to run on various triggers, called
4555 hook and there are a number of hooks not associated with commands.
4557 Hooks are stored as array options, members of the array are executed in
4558 order when the hook is triggered.
4559 Like options different hooks may be global or belong to a session, window or pane.
4560 Hooks may be configured with the
4564 commands and displayed with
4569 The following two commands are equivalent:
4570 .Bd -literal -offset indent.
4571 set-hook -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4572 set-option -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4575 Setting a hook without specifying an array index clears the hook and sets the
4576 first member of the array.
4579 hook is run after it completes, except when the command is run as part of a hook
4581 They are named with an
4584 For example, the following command adds a hook to select the even-vertical
4587 .Bd -literal -offset indent
4588 set-hook -g after-split-window "selectl even-vertical"
4591 All the notifications listed in the
4593 section are hooks (without any arguments), except
4595 The following additional hooks are available:
4596 .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXX"
4598 Run when a window has activity.
4600 .Ic monitor-activity .
4602 Run when a window has received a bell.
4606 Run when a window has been silent.
4608 .Ic monitor-silence .
4610 Run when a client becomes the latest active client of its session.
4612 Run when a client is attached.
4614 Run when a client is detached
4616 Run when focus enters a client
4617 .It client-focus-out
4618 Run when focus exits a client
4620 Run when a client is resized.
4621 .It client-session-changed
4622 Run when a client's attached session is changed.
4624 Run when the program running in a pane exits, but
4626 is on so the pane has not closed.
4628 Run when the program running in a pane exits.
4630 Run when the focus enters a pane, if the
4634 Run when the focus exits a pane, if the
4637 .It pane-set-clipboard
4638 Run when the terminal clipboard is set using the
4642 Run when a new session created.
4644 Run when a session closed.
4646 Run when a session is renamed.
4648 Run when a window is linked into a session.
4650 Run when a window is renamed.
4652 Run when a window is resized.
4653 This may be after the
4657 Run when a window is unlinked from a session.
4660 Hooks are managed with these commands:
4664 .Op Fl t Ar target-pane
4676 The flags are the same as for
4684 .It Xo Ic show-hooks
4686 .Op Fl t Ar target-pane
4689 The flags are the same as for
4695 option is on (the default is off),
4697 allows mouse events to be bound as keys.
4698 The name of each key is made up of a mouse event (such as
4700 and a location suffix, one of the following:
4701 .Bl -column "XXXXXXXXXXXXX" -offset indent
4702 .It Li "Pane" Ta "the contents of a pane"
4703 .It Li "Border" Ta "a pane border"
4704 .It Li "Status" Ta "the status line window list"
4705 .It Li "StatusLeft" Ta "the left part of the status line"
4706 .It Li "StatusRight" Ta "the right part of the status line"
4707 .It Li "StatusDefault" Ta "any other part of the status line"
4710 The following mouse events are available:
4711 .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
4712 .It Li "WheelUp" Ta "WheelDown" Ta ""
4713 .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
4714 .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
4715 .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
4716 .It Li "SecondClick1" Ta "SecondClick2" Ta "SecondClick3"
4717 .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3"
4718 .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3"
4723 events are fired for the second click of a double click, even if there may be a
4724 third click which will fire
4729 Each should be suffixed with a location, for example
4730 .Ql MouseDown1Status .
4740 in commands bound to mouse key bindings.
4741 It resolves to the window or pane over which the mouse event took place
4742 (for example, the window in the status line over which button 1 was released for a
4744 binding, or the pane over which the wheel was scrolled for a
4751 flag may be used to forward a mouse event to a pane.
4753 The default key bindings allow the mouse to be used to select and resize panes,
4754 to copy text and to change window using the status line.
4755 These take effect if the
4757 option is turned on.
4759 Certain commands accept the
4764 This is a string which controls the output format of the command.
4765 Format variables are enclosed in
4770 .Ql #{session_name} .
4771 The possible variables are listed in the table below, or the name of a
4773 option may be used for an option's value.
4774 Some variables have a shorter alias such as
4777 is replaced by a single
4787 Conditionals are available by prefixing with
4789 and separating two alternatives with a comma;
4790 if the specified variable exists and is not zero, the first alternative
4791 is chosen, otherwise the second is used.
4793 .Ql #{?session_attached,attached,not attached}
4794 will include the string
4796 if the session is attached and the string
4798 if it is unattached, or
4799 .Ql #{?automatic-rename,yes,no}
4803 .Ic automatic-rename
4807 Conditionals can be nested arbitrarily.
4808 Inside a conditional,
4816 unless they are part of a
4820 .Bd -literal -offset indent
4821 #{?pane_in_mode,#[fg=white#,bg=red],#[fg=red#,bg=white]}#W .
4824 String comparisons may be expressed by prefixing two comma-separated
4835 .Ql #{==:#{host},myhost}
4845 evaluate to true if either or both of two comma-separated alternatives are
4847 .Ql #{||:#{pane_in_mode},#{alternate_on}} .
4853 or regular expression comparison.
4854 The first argument is the pattern and the second the string to compare.
4855 An optional argument specifies flags:
4857 means the pattern is a regular expression instead of the default
4861 means to ignore case.
4863 .Ql #{m:*foo*,#{host}}
4865 .Ql #{m/ri:^A,MYVAR} .
4868 performs a search for an
4870 pattern or regular expression in the pane content and evaluates to zero if not
4871 found, or a line number if found.
4876 flag means search for a regular expression and
4882 Numeric operators may be performed by prefixing two comma-separated alternatives with an
4887 flag may be given after the operator to use floating point numbers, otherwise integers are used.
4888 This may be followed by a number giving the number of decimal places to use for the result.
4889 The available operators are:
4906 in formats which are also expanded by
4908 and numeric comparison operators
4917 .Ql #{e|*|f|4:5.5,3}
4918 multiplies 5.5 by 3 for a result with four decimal places and
4920 returns the modulus of 7 and 3.
4922 replaces a numeric argument by its ASCII equivalent, so
4929 colour by its six-digit hexadecimal RGB value.
4931 A limit may be placed on the length of the resultant string by prefixing it
4934 a number and a colon.
4935 Positive numbers count from the start of the string and negative from the end,
4937 .Ql #{=5:pane_title}
4938 will include at most the first five characters of the pane title, or
4939 .Ql #{=-5:pane_title}
4940 the last five characters.
4941 A suffix or prefix may be given as a second argument - if provided then it is
4942 appended or prepended to the string if the length has been trimmed, for example
4943 .Ql #{=/5/...:pane_title}
4946 if the pane title is more than five characters.
4949 pads the string to a given width, for example
4950 .Ql #{p10:pane_title}
4951 will result in a width of at least 10 characters.
4952 A positive width pads on the left, a negative on the right.
4954 expands to the length of the variable and
4956 to its width when displayed, for example
4957 .Ql #{n:window_name} .
4959 Prefixing a time variable with
4961 will convert it to a string, so if
4962 .Ql #{window_activity}
4965 .Ql #{t:window_activity}
4967 .Ql Sun Oct 25 09:25:02 2015 .
4971 will use shorter but less accurate time format for times in the past.
4972 A custom format may be given using an
4978 if the format is separately being passed through
4983 .Ql #{t/f/%%H#:%%M:window_activity} ,
4995 of the variable respectively.
4999 special characters or with a
5001 suffix, escape hash characters (so
5006 will expand the format twice, for example
5007 .Ql #{E:status-left}
5008 is the result of expanding the content of the
5010 option rather than the option itself.
5021 will loop over each session, window or pane and insert the format once
5023 For windows and panes, two comma-separated formats may be given:
5024 the second is used for the current window or active pane.
5025 For example, to get a list of windows formatted like the status line:
5026 .Bd -literal -offset indent
5027 #{W:#{E:window-status-format} ,#{E:window-status-current-format} }
5031 checks if a window (without any suffix or with the
5033 suffix) or a session (with the
5035 suffix) name exists, for example
5037 is replaced with 1 if a window named
5041 A prefix of the form
5048 The first argument may be an extended regular expression and a final argument may be
5050 to ignore case, for example
5051 .Ql s/a(.)/\e1x/i:\&
5057 In addition, the last line of a shell command's output may be inserted using
5061 will insert the system's uptime.
5062 When constructing formats,
5066 commands to finish; instead, the previous result from running the same command is used,
5067 or a placeholder if the command has not been run before.
5068 If the command hasn't exited, the most recent line of output will be used, but the status
5069 line will not be updated more than once a second.
5070 Commands are executed using
5074 global environment set (see the
5075 .Sx GLOBAL AND SESSION ENVIRONMENT
5080 specifies that a string should be interpreted literally and not expanded.
5082 .Ql #{l:#{?pane_in_mode,yes,no}}
5084 .Ql #{?pane_in_mode,yes,no} .
5086 The following variables are available, where appropriate:
5087 .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
5088 .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
5089 .It Li "active_window_index" Ta "" Ta "Index of active window in session"
5090 .It Li "alternate_on" Ta "" Ta "1 if pane is in alternate screen"
5091 .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
5092 .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
5093 .It Li "buffer_created" Ta "" Ta "Time buffer created"
5094 .It Li "buffer_name" Ta "" Ta "Name of buffer"
5095 .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
5096 .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
5097 .It Li "client_activity" Ta "" Ta "Time client last had activity"
5098 .It Li "client_cell_height" Ta "" Ta "Height of each client cell in pixels"
5099 .It Li "client_cell_width" Ta "" Ta "Width of each client cell in pixels"
5100 .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
5101 .It Li "client_created" Ta "" Ta "Time client created"
5102 .It Li "client_discarded" Ta "" Ta "Bytes discarded when client behind"
5103 .It Li "client_flags" Ta "" Ta "List of client flags"
5104 .It Li "client_height" Ta "" Ta "Height of client"
5105 .It Li "client_key_table" Ta "" Ta "Current key table"
5106 .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
5107 .It Li "client_name" Ta "" Ta "Name of client"
5108 .It Li "client_pid" Ta "" Ta "PID of client process"
5109 .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
5110 .It Li "client_readonly" Ta "" Ta "1 if client is read-only"
5111 .It Li "client_session" Ta "" Ta "Name of the client's session"
5112 .It Li "client_termfeatures" Ta "" Ta "Terminal features of client, if any"
5113 .It Li "client_termname" Ta "" Ta "Terminal name of client"
5114 .It Li "client_termtype" Ta "" Ta "Terminal type of client, if available"
5115 .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
5116 .It Li "client_uid" Ta "" Ta "UID of client process"
5117 .It Li "client_user" Ta "" Ta "User of client process"
5118 .It Li "client_utf8" Ta "" Ta "1 if client supports UTF-8"
5119 .It Li "client_width" Ta "" Ta "Width of client"
5120 .It Li "client_written" Ta "" Ta "Bytes written to client"
5121 .It Li "command" Ta "" Ta "Name of command in use, if any"
5122 .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
5123 .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
5124 .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
5125 .It Li "config_files" Ta "" Ta "List of configuration files loaded"
5126 .It Li "copy_cursor_line" Ta "" Ta "Line the cursor is on in copy mode"
5127 .It Li "copy_cursor_word" Ta "" Ta "Word under cursor in copy mode"
5128 .It Li "copy_cursor_x" Ta "" Ta "Cursor X position in copy mode"
5129 .It Li "copy_cursor_y" Ta "" Ta "Cursor Y position in copy mode"
5130 .It Li "current_file" Ta "" Ta "Current configuration file"
5131 .It Li "cursor_character" Ta "" Ta "Character at cursor in pane"
5132 .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
5133 .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
5134 .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
5135 .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
5136 .It Li "history_limit" Ta "" Ta "Maximum window history lines"
5137 .It Li "history_size" Ta "" Ta "Size of history in lines"
5138 .It Li "hook" Ta "" Ta "Name of running hook, if any"
5139 .It Li "hook_client" Ta "" Ta "Name of client where hook was run, if any"
5140 .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
5141 .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
5142 .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
5143 .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
5144 .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
5145 .It Li "host" Ta "#H" Ta "Hostname of local host"
5146 .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
5147 .It Li "insert_flag" Ta "" Ta "Pane insert flag"
5148 .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
5149 .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
5150 .It Li "last_window_index" Ta "" Ta "Index of last window in session"
5151 .It Li "line" Ta "" Ta "Line number in the list"
5152 .It Li "mouse_all_flag" Ta "" Ta "Pane mouse all flag"
5153 .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
5154 .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
5155 .It Li "mouse_line" Ta "" Ta "Line under mouse, if any"
5156 .It Li "mouse_sgr_flag" Ta "" Ta "Pane mouse SGR flag"
5157 .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
5158 .It Li "mouse_utf8_flag" Ta "" Ta "Pane mouse UTF-8 flag"
5159 .It Li "mouse_word" Ta "" Ta "Word under mouse, if any"
5160 .It Li "mouse_x" Ta "" Ta "Mouse X position, if any"
5161 .It Li "mouse_y" Ta "" Ta "Mouse Y position, if any"
5162 .It Li "next_session_id" Ta "" Ta "Unique session ID for next new session"
5163 .It Li "origin_flag" Ta "" Ta "Pane origin flag"
5164 .It Li "pane_active" Ta "" Ta "1 if active pane"
5165 .It Li "pane_at_bottom" Ta "" Ta "1 if pane is at the bottom of window"
5166 .It Li "pane_at_left" Ta "" Ta "1 if pane is at the left of window"
5167 .It Li "pane_at_right" Ta "" Ta "1 if pane is at the right of window"
5168 .It Li "pane_at_top" Ta "" Ta "1 if pane is at the top of window"
5169 .It Li "pane_bg" Ta "" Ta "Pane background colour"
5170 .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
5171 .It Li "pane_current_command" Ta "" Ta "Current command if available"
5172 .It Li "pane_current_path" Ta "" Ta "Current path if available"
5173 .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
5174 .It Li "pane_dead_signal" Ta "" Ta "Exit signal of process in dead pane"
5175 .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
5176 .It Li "pane_dead_time" Ta "" Ta "Exit time of process in dead pane"
5177 .It Li "pane_fg" Ta "" Ta "Pane foreground colour"
5178 .It Li "pane_format" Ta "" Ta "1 if format is for a pane"
5179 .It Li "pane_height" Ta "" Ta "Height of pane"
5180 .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
5181 .It Li "pane_in_mode" Ta "" Ta "1 if pane is in a mode"
5182 .It Li "pane_index" Ta "#P" Ta "Index of pane"
5183 .It Li "pane_input_off" Ta "" Ta "1 if input to pane is disabled"
5184 .It Li "pane_last" Ta "" Ta "1 if last pane"
5185 .It Li "pane_left" Ta "" Ta "Left of pane"
5186 .It Li "pane_marked" Ta "" Ta "1 if this is the marked pane"
5187 .It Li "pane_marked_set" Ta "" Ta "1 if a marked pane is set"
5188 .It Li "pane_mode" Ta "" Ta "Name of pane mode, if any"
5189 .It Li "pane_path" Ta "" Ta "Path of pane (can be set by application)"
5190 .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
5191 .It Li "pane_pipe" Ta "" Ta "1 if pane is being piped"
5192 .It Li "pane_right" Ta "" Ta "Right of pane"
5193 .It Li "pane_search_string" Ta "" Ta "Last search string in copy mode"
5194 .It Li "pane_start_command" Ta "" Ta "Command pane started with"
5195 .It Li "pane_synchronized" Ta "" Ta "1 if pane is synchronized"
5196 .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
5197 .It Li "pane_title" Ta "#T" Ta "Title of pane (can be set by application)"
5198 .It Li "pane_top" Ta "" Ta "Top of pane"
5199 .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
5200 .It Li "pane_width" Ta "" Ta "Width of pane"
5201 .It Li "pid" Ta "" Ta "Server PID"
5202 .It Li "rectangle_toggle" Ta "" Ta "1 if rectangle selection is activated"
5203 .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
5204 .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
5205 .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
5206 .It Li "search_match" Ta "" Ta "Search match if any"
5207 .It Li "search_present" Ta "" Ta "1 if search started in copy mode"
5208 .It Li "selection_active" Ta "" Ta "1 if selection started and changes with the cursor in copy mode"
5209 .It Li "selection_end_x" Ta "" Ta "X position of the end of the selection"
5210 .It Li "selection_end_y" Ta "" Ta "Y position of the end of the selection"
5211 .It Li "selection_present" Ta "" Ta "1 if selection started in copy mode"
5212 .It Li "selection_start_x" Ta "" Ta "X position of the start of the selection"
5213 .It Li "selection_start_y" Ta "" Ta "Y position of the start of the selection"
5214 .It Li "session_activity" Ta "" Ta "Time of session last activity"
5215 .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
5216 .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
5217 .It Li "session_attached_list" Ta "" Ta "List of clients session is attached to"
5218 .It Li "session_created" Ta "" Ta "Time session created"
5219 .It Li "session_format" Ta "" Ta "1 if format is for a session"
5220 .It Li "session_group" Ta "" Ta "Name of session group"
5221 .It Li "session_group_attached" Ta "" Ta "Number of clients sessions in group are attached to"
5222 .It Li "session_group_attached_list" Ta "" Ta "List of clients sessions in group are attached to"
5223 .It Li "session_group_list" Ta "" Ta "List of sessions in group"
5224 .It Li "session_group_many_attached" Ta "" Ta "1 if multiple clients attached to sessions in group"
5225 .It Li "session_group_size" Ta "" Ta "Size of session group"
5226 .It Li "session_grouped" Ta "" Ta "1 if session in a group"
5227 .It Li "session_id" Ta "" Ta "Unique session ID"
5228 .It Li "session_last_attached" Ta "" Ta "Time session last attached"
5229 .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
5230 .It Li "session_marked" Ta "" Ta "1 if this session contains the marked pane"
5231 .It Li "session_name" Ta "#S" Ta "Name of session"
5232 .It Li "session_path" Ta "" Ta "Working directory of session"
5233 .It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
5234 .It Li "session_windows" Ta "" Ta "Number of windows in session"
5235 .It Li "socket_path" Ta "" Ta "Server socket path"
5236 .It Li "start_time" Ta "" Ta "Server start time"
5237 .It Li "uid" Ta "" Ta "Server UID"
5238 .It Li "user" Ta "" Ta "Server user"
5239 .It Li "version" Ta "" Ta "Server version"
5240 .It Li "window_active" Ta "" Ta "1 if window active"
5241 .It Li "window_active_clients" Ta "" Ta "Number of clients viewing this window"
5242 .It Li "window_active_clients_list" Ta "" Ta "List of clients viewing this window"
5243 .It Li "window_active_sessions" Ta "" Ta "Number of sessions on which this window is active"
5244 .It Li "window_active_sessions_list" Ta "" Ta "List of sessions on which this window is active"
5245 .It Li "window_activity" Ta "" Ta "Time of window last activity"
5246 .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
5247 .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
5248 .It Li "window_bigger" Ta "" Ta "1 if window is larger than client"
5249 .It Li "window_cell_height" Ta "" Ta "Height of each cell in pixels"
5250 .It Li "window_cell_width" Ta "" Ta "Width of each cell in pixels"
5251 .It Li "window_end_flag" Ta "" Ta "1 if window has the highest index"
5252 .It Li "window_flags" Ta "#F" Ta "Window flags with # escaped as ##"
5253 .It Li "window_format" Ta "" Ta "1 if format is for a window"
5254 .It Li "window_height" Ta "" Ta "Height of window"
5255 .It Li "window_id" Ta "" Ta "Unique window ID"
5256 .It Li "window_index" Ta "#I" Ta "Index of window"
5257 .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
5258 .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
5259 .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
5260 .It Li "window_linked_sessions" Ta "" Ta "Number of sessions this window is linked to"
5261 .It Li "window_linked_sessions_list" Ta "" Ta "List of sessions this window is linked to"
5262 .It Li "window_marked_flag" Ta "" Ta "1 if window contains the marked pane"
5263 .It Li "window_name" Ta "#W" Ta "Name of window"
5264 .It Li "window_offset_x" Ta "" Ta "X offset into window if larger than client"
5265 .It Li "window_offset_y" Ta "" Ta "Y offset into window if larger than client"
5266 .It Li "window_panes" Ta "" Ta "Number of panes in window"
5267 .It Li "window_raw_flags" Ta "" Ta "Window flags with nothing escaped"
5268 .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
5269 .It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
5270 .It Li "window_start_flag" Ta "" Ta "1 if window has the lowest index"
5271 .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
5272 .It Li "window_width" Ta "" Ta "Width of window"
5273 .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
5274 .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
5278 offers various options to specify the colour and attributes of aspects of the
5279 interface, for example
5281 for the status line.
5282 In addition, embedded styles may be specified in format options, such as
5284 by enclosing them in
5289 A style may be the single term
5291 to specify the default style (which may come from an option, for example
5293 in the status line) or a space
5294 or comma separated list of the following:
5297 Set the foreground colour.
5298 The colour is one of:
5307 if supported the bright variants
5314 from the 256-colour set;
5316 for the default colour;
5318 for the terminal default colour; or a hexadecimal RGB string such as
5321 Set the background colour.
5323 Set no attributes (turn off any active attributes).
5336 .Ic double-underscore ,
5337 .Ic curly-underscore ,
5338 .Ic dotted-underscore ,
5339 .Ic dashed-underscore
5342 Any of the attributes may be prefixed with
5346 is the terminal alternate character set.
5347 .It Xo Ic align=left
5353 Align text to the left, centre or right of the available space if appropriate.
5355 Fill the available space with a background colour if appropriate.
5358 .Ic list=left-marker ,
5359 .Ic list=right-marker ,
5362 Mark the position of the various window list components in the
5366 marks the start of the list;
5368 is the part of the list that should be kept in focus if the entire list won't fit
5369 in the available space (typically the current window);
5370 .Ic list=left-marker
5372 .Ic list=right-marker
5373 mark the text to be used to mark that text has been trimmed from the left or
5374 right of the list if there is not enough space.
5375 .It Xo Ic push-default ,
5378 Store the current colours and attributes as the default or reset to the previous
5382 affects any subsequent use of the
5386 Only one default may be pushed (each
5388 replaces the previous saved default).
5389 .It Xo Ic range=left ,
5391 .Ic range=window|X ,
5400 are the text used for the
5406 is the range for a window passed to the
5414 .Bd -literal -offset indent
5415 fg=yellow bold underscore blink
5416 bg=black,fg=default,noreverse
5418 .Sh NAMES AND TITLES
5420 distinguishes between names and titles.
5421 Windows and sessions have names, which may be used to specify them in targets
5422 and are displayed in the status line and various lists: the name is the
5424 identifier for a window or session.
5425 Only panes have titles.
5426 A pane's title is typically set by the program running inside the pane using
5427 an escape sequence (like it would set the
5431 Windows themselves do not have titles - a window's title is the title of its
5434 itself may set the title of the terminal in which the client is running, see
5439 A session's name is set with the
5444 A window's name is set with one of:
5447 A command argument (such as
5454 An escape sequence (if the
5456 option is turned on):
5457 .Bd -literal -offset indent
5458 $ printf '\e033kWINDOW_NAME\e033\e\e'
5461 Automatic renaming, which sets the name to the active command in the window's
5464 .Ic automatic-rename
5468 When a pane is first created, its title is the hostname.
5469 A pane's title can be set via the title setting escape sequence, for example:
5470 .Bd -literal -offset indent
5471 $ printf '\e033]2;My Title\e033\e\e'
5474 It can also be modified with the
5478 .Sh GLOBAL AND SESSION ENVIRONMENT
5479 When the server is started,
5481 copies the environment into the
5482 .Em global environment ;
5483 in addition, each session has a
5484 .Em session environment .
5485 When a window is created, the session and global environments are merged.
5486 If a variable exists in both, the value from the session environment is used.
5487 The result is the initial environment passed to the new process.
5490 .Ic update-environment
5491 session option may be used to update the session environment from the client
5492 when a new session is created or an old reattached.
5494 also initialises the
5496 variable with some internal information to allow commands to be executed
5497 from inside, and the
5499 variable with the correct terminal setting of
5502 Variables in both session and global environments may be marked as hidden.
5503 Hidden variables are not passed into the environment of new processes and
5504 instead can only be used by tmux itself (for example in formats, see the
5508 Commands to alter and view the environment are:
5511 .It Xo Ic set-environment
5513 .Op Fl t Ar target-session
5514 .Ar name Op Ar value
5516 .D1 Pq alias: Ic setenv
5517 Set or unset an environment variable.
5520 is used, the change is made in the global environment; otherwise, it is applied
5521 to the session environment for
5522 .Ar target-session .
5527 is expanded as a format.
5530 flag unsets a variable.
5532 indicates the variable is to be removed from the environment before starting a
5535 marks the variable as hidden.
5537 .It Xo Ic show-environment
5539 .Op Fl t Ar target-session
5542 .D1 Pq alias: Ic showenv
5543 Display the environment for
5545 or the global environment with
5549 is omitted, all variables are shown.
5550 Variables removed from the environment are prefixed with
5554 is used, the output is formatted as a set of Bourne shell commands.
5556 shows hidden variables (omitted by default).
5560 includes an optional status line which is displayed in the bottom line of each
5563 By default, the status line is enabled and one line in height (it may be
5564 disabled or made multiple lines with the
5566 session option) and contains, from left-to-right: the name of the current
5567 session in square brackets; the window list; the title of the active pane
5568 in double quotes; and the time and date.
5570 Each line of the status line is configured with the
5573 The default is made of three parts: configurable left and right sections (which
5574 may contain dynamic content such as the time or output from a shell command,
5577 .Ic status-left-length ,
5580 .Ic status-right-length
5581 options below), and a central window list.
5582 By default, the window list shows the index, name and (if any) flag of the
5583 windows present in the current session in ascending numerical order.
5584 It may be customised with the
5585 .Ar window-status-format
5587 .Ar window-status-current-format
5589 The flag is one of the following symbols appended to the window name:
5590 .Bl -column "Symbol" "Meaning" -offset indent
5591 .It Sy "Symbol" Ta Sy "Meaning"
5592 .It Li "*" Ta "Denotes the current window."
5593 .It Li "-" Ta "Marks the last window (previously selected)."
5594 .It Li "#" Ta "Window activity is monitored and activity has been detected."
5595 .It Li "\&!" Ta "Window bells are monitored and a bell has occurred in the window."
5596 .It Li "~" Ta "The window has been silent for the monitor-silence interval."
5597 .It Li "M" Ta "The window contains the marked pane."
5598 .It Li "Z" Ta "The window's active pane is zoomed."
5601 The # symbol relates to the
5602 .Ic monitor-activity
5604 The window name is printed in inverted colours if an alert (bell, activity or
5605 silence) is present.
5607 The colour and attributes of the status line may be configured, the entire
5608 status line using the
5610 session option and individual windows using the
5611 .Ic window-status-style
5614 The status line is automatically refreshed at interval if it has changed, the
5615 interval may be controlled with the
5619 Commands related to the status line are as follows:
5622 .It Xo Ic clear-prompt-history
5623 .Op Fl T Ar prompt-type
5625 .D1 Pq alias: Ic clearphist
5626 Clear status prompt history for prompt type
5630 is omitted, then clear history for all types.
5633 for possible values for
5635 .It Xo Ic command-prompt
5639 .Op Fl t Ar target-client
5640 .Op Fl T Ar prompt-type
5643 Open the command prompt in a client.
5644 This may be used from inside
5646 to execute commands interactively.
5650 is specified, it is used as the command.
5654 is expanded as a format.
5658 is a comma-separated list of the initial text for each prompt.
5663 is a comma-separated list of prompts which are displayed in order; otherwise
5664 a single prompt is displayed, constructed from
5666 if it is present, or
5670 Before the command is executed, the first occurrence of the string
5672 and all occurrences of
5674 are replaced by the response to the first prompt, all
5676 are replaced with the response to the second prompt, and so on for further
5678 Up to nine prompt responses may be replaced
5687 but any quotation marks are escaped.
5690 makes the prompt only accept one key press, in this case the resulting input
5691 is a single character.
5695 but the key press is translated to a key name.
5697 makes the prompt only accept numeric key presses.
5699 executes the command every time the prompt input changes instead of when the
5700 user exits the command prompt.
5706 This affects what completions are offered when
5709 Available types are:
5716 The following keys have a special meaning in the command prompt, depending
5720 .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
5721 .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
5722 .It Li "Cancel command prompt" Ta "q" Ta "Escape"
5723 .It Li "Delete from cursor to start of word" Ta "" Ta "C-w"
5724 .It Li "Delete entire command" Ta "d" Ta "C-u"
5725 .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
5726 .It Li "Execute command" Ta "Enter" Ta "Enter"
5727 .It Li "Get next command from history" Ta "" Ta "Down"
5728 .It Li "Get previous command from history" Ta "" Ta "Up"
5729 .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
5730 .It Li "Look for completions" Ta "Tab" Ta "Tab"
5731 .It Li "Move cursor left" Ta "h" Ta "Left"
5732 .It Li "Move cursor right" Ta "l" Ta "Right"
5733 .It Li "Move cursor to end" Ta "$" Ta "C-e"
5734 .It Li "Move cursor to next word" Ta "w" Ta "M-f"
5735 .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
5736 .It Li "Move cursor to start" Ta "0" Ta "C-a"
5737 .It Li "Transpose characters" Ta "" Ta "C-t"
5742 the prompt is shown in the background and the invoking client does not exit
5743 until it is dismissed.
5745 .It Xo Ic confirm-before
5748 .Op Fl t Ar target-client
5751 .D1 Pq alias: Ic confirm
5752 Ask for confirmation before executing
5758 is the prompt to display; otherwise a prompt is constructed from
5760 It may contain the special character sequences supported by the
5765 the prompt is shown in the background and the invoking client does not exit
5766 until it is dismissed.
5768 .It Xo Ic display-menu
5770 .Op Fl c Ar target-client
5771 .Op Fl t Ar target-pane
5773 .Op Fl x Ar position
5774 .Op Fl y Ar position
5780 .D1 Pq alias: Ic menu
5784 gives the target for any commands run from the menu.
5786 A menu is passed as a series of arguments: first the menu item name,
5787 second the key shortcut (or empty for none) and third the command
5788 to run when the menu item is chosen.
5789 The name and command are formats, see the
5794 If the name begins with a hyphen (-), then the item is disabled (shown dim) and
5796 The name may be empty for a separator line, in which case both the key and
5797 command should be omitted.
5800 is a format for the menu title (see
5806 give the position of the menu.
5807 Both may be a row or column number, or one of the following special values:
5808 .Bl -column "XXXXX" "XXXX" -offset indent
5809 .It Sy "Value" Ta Sy "Flag" Ta Sy "Meaning"
5810 .It Li "C" Ta "Both" Ta "The centre of the terminal"
5811 .It Li "R" Ta Fl x Ta "The right side of the terminal"
5812 .It Li "P" Ta "Both" Ta "The bottom left of the pane"
5813 .It Li "M" Ta "Both" Ta "The mouse position"
5814 .It Li "W" Ta "Both" Ta "The window position on the status line"
5815 .It Li "S" Ta Fl y Ta "The line above or below the status line"
5818 Or a format, which is expanded including the following additional variables:
5819 .Bl -column "XXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent
5820 .It Sy "Variable name" Ta Sy "Replaced with"
5821 .It Li "popup_centre_x" Ta "Centered in the client"
5822 .It Li "popup_centre_y" Ta "Centered in the client"
5823 .It Li "popup_height" Ta "Height of menu or popup"
5824 .It Li "popup_mouse_bottom" Ta "Bottom of at the mouse"
5825 .It Li "popup_mouse_centre_x" Ta "Horizontal centre at the mouse"
5826 .It Li "popup_mouse_centre_y" Ta "Vertical centre at the mouse"
5827 .It Li "popup_mouse_top" Ta "Top at the mouse"
5828 .It Li "popup_mouse_x" Ta "Mouse X position"
5829 .It Li "popup_mouse_y" Ta "Mouse Y position"
5830 .It Li "popup_pane_bottom" Ta "Bottom of the pane"
5831 .It Li "popup_pane_left" Ta "Left of the pane"
5832 .It Li "popup_pane_right" Ta "Right of the pane"
5833 .It Li "popup_pane_top" Ta "Top of the pane"
5834 .It Li "popup_status_line_y" Ta "Above or below the status line"
5835 .It Li "popup_width" Ta "Width of menu or popup"
5836 .It Li "popup_window_status_line_x" Ta "At the window position in status line"
5837 .It Li "popup_window_status_line_y" Ta "At the status line showing the window"
5840 Each menu consists of items followed by a key shortcut shown in brackets.
5841 If the menu is too large to fit on the terminal, it is not displayed.
5842 Pressing the key shortcut chooses the corresponding item.
5843 If the mouse is enabled and the menu is opened from a mouse key binding,
5844 releasing the mouse button with an item selected chooses that item and
5845 releasing the mouse button without an item selected closes the menu.
5847 changes this behaviour so that the menu does not close when the mouse button is
5848 released without an item selected the menu is not closed and a mouse button
5849 must be clicked to choose an item.
5851 The following keys are also available:
5852 .Bl -column "Key" "Function" -offset indent
5853 .It Sy "Key" Ta Sy "Function"
5854 .It Li "Enter" Ta "Choose selected item"
5855 .It Li "Up" Ta "Select previous item"
5856 .It Li "Down" Ta "Select next item"
5857 .It Li "q" Ta "Exit menu"
5860 .It Xo Ic display-message
5862 .Op Fl c Ar target-client
5864 .Op Fl t Ar target-pane
5867 .D1 Pq alias: Ic display
5871 is given, the output is printed to stdout, otherwise it is displayed in the
5873 status line for up to
5880 option is used; a delay of zero waits for a key press.
5882 ignores key presses and closes only after the delay expires.
5887 section; information is taken from
5891 is given, otherwise the active pane.
5894 prints verbose logging as the format is parsed and
5896 lists the format variables and their values.
5899 forwards any input read from stdin to the empty pane given by
5902 .It Xo Ic display-popup
5904 .Op Fl b Ar border-lines
5905 .Op Fl c Ar target-client
5906 .Op Fl d Ar start-directory
5907 .Op Fl e Ar environment
5910 .Op Fl S Ar border-style
5911 .Op Fl t Ar target-pane
5914 .Op Fl x Ar position
5915 .Op Fl y Ar position
5916 .Op Ar shell-command
5918 .D1 Pq alias: Ic popup
5919 Display a popup running
5923 A popup is a rectangular box drawn over the top of any panes.
5924 Panes are not updated while a popup is present.
5927 closes the popup automatically when
5932 closes the popup only if
5934 exited with success.
5939 give the position of the popup, they have the same meaning as for the
5945 give the width and height - both may be a percentage (followed by
5947 If omitted, half of the terminal size is used.
5950 does not surround the popup by a border.
5953 sets the type of border line for the popup.
5960 .Ic popup-border-lines
5961 for possible values for
5965 sets the style for the popup and
5967 sets the style for the popup border.
5977 and sets an environment variable for the popup; it may be specified multiple
5981 is a format for the popup title (see
5986 flag closes any popup on the client.
5988 .It Xo Ic show-prompt-history
5989 .Op Fl T Ar prompt-type
5991 .D1 Pq alias: Ic showphist
5992 Display status prompt history for prompt type
5996 is omitted, then show history for all types.
5999 for possible values for
6004 maintains a set of named
6006 Each buffer may be either explicitly or automatically named.
6007 Explicitly named buffers are named when created with the
6011 commands, or by renaming an automatically named buffer with
6014 Automatically named buffers are given a name such as
6020 option is reached, the oldest automatically named buffer is deleted.
6021 Explicitly named buffers are not subject to
6023 and may be deleted with the
6027 Buffers may be added using
6033 commands, and pasted into a window using the
6036 If a buffer command is used and no buffer is specified, the most
6037 recently added automatically named buffer is assumed.
6039 A configurable history buffer is also maintained for each window.
6040 By default, up to 2000 lines are kept; this can be altered with the
6046 The buffer commands are as follows:
6053 .Op Fl K Ar key-format
6054 .Op Fl O Ar sort-order
6055 .Op Fl t Ar target-pane
6058 Put a pane into buffer mode, where a buffer may be chosen interactively from
6060 Each buffer is shown on one line.
6061 A shortcut key is shown on the left in brackets allowing for immediate choice,
6062 or the list may be navigated and an item chosen or otherwise manipulated using
6066 The following keys may be used in buffer mode:
6067 .Bl -column "Key" "Function" -offset indent
6068 .It Sy "Key" Ta Sy "Function"
6069 .It Li "Enter" Ta "Paste selected buffer"
6070 .It Li "Up" Ta "Select previous buffer"
6071 .It Li "Down" Ta "Select next buffer"
6072 .It Li "C-s" Ta "Search by name or content"
6073 .It Li "n" Ta "Repeat last search"
6074 .It Li "t" Ta "Toggle if buffer is tagged"
6075 .It Li "T" Ta "Tag no buffers"
6076 .It Li "C-t" Ta "Tag all buffers"
6077 .It Li "p" Ta "Paste selected buffer"
6078 .It Li "P" Ta "Paste tagged buffers"
6079 .It Li "d" Ta "Delete selected buffer"
6080 .It Li "D" Ta "Delete tagged buffers"
6081 .It Li "e" Ta "Open the buffer in an editor"
6082 .It Li "f" Ta "Enter a format to filter items"
6083 .It Li "O" Ta "Change sort field"
6084 .It Li "r" Ta "Reverse sort order"
6085 .It Li "v" Ta "Toggle preview"
6086 .It Li "q" Ta "Exit mode"
6089 After a buffer is chosen,
6091 is replaced by the buffer name in
6093 and the result executed as a command.
6096 is not given, "paste-buffer -b '%%'" is used.
6099 specifies the initial sort field: one of
6105 reverses the sort order.
6107 specifies an initial filter: the filter is a format - if it evaluates to zero,
6108 the item in the list is not shown, otherwise it is shown.
6109 If a filter would lead to an empty list, it is ignored.
6111 specifies the format for each item in the list and
6113 a format for each shortcut key; both are evaluated once for each line.
6115 starts without the preview.
6116 This command works only if at least one client is attached.
6118 .It Ic clear-history Op Fl t Ar target-pane
6119 .D1 Pq alias: Ic clearhist
6120 Remove and free the history for the specified pane.
6122 .It Ic delete-buffer Op Fl b Ar buffer-name
6123 .D1 Pq alias: Ic deleteb
6124 Delete the buffer named
6126 or the most recently added automatically named buffer if not specified.
6128 .It Xo Ic list-buffers
6132 .D1 Pq alias: Ic lsb
6133 List the global buffers.
6135 specifies the format of each line and
6138 Only buffers for which the filter is true are shown.
6142 .It Xo Ic load-buffer
6144 .Op Fl b Ar buffer-name
6145 .Op Fl t Ar target-client
6149 .D1 Pq alias: Ic loadb
6150 Load the contents of the specified paste buffer from
6154 is given, the buffer is also sent to the clipboard for
6158 escape sequence, if possible.
6160 .It Xo Ic paste-buffer
6162 .Op Fl b Ar buffer-name
6163 .Op Fl s Ar separator
6164 .Op Fl t Ar target-pane
6166 .D1 Pq alias: Ic pasteb
6167 Insert the contents of a paste buffer into the specified pane.
6168 If not specified, paste into the current one.
6171 also delete the paste buffer.
6172 When output, any linefeed (LF) characters in the paste buffer are replaced with
6173 a separator, by default carriage return (CR).
6174 A custom separator may be specified using the
6179 flag means to do no replacement (equivalent to a separator of LF).
6182 is specified, paste bracket control codes are inserted around the
6183 buffer if the application has requested bracketed paste mode.
6185 .It Xo Ic save-buffer
6187 .Op Fl b Ar buffer-name
6190 .D1 Pq alias: Ic saveb
6191 Save the contents of the specified paste buffer to
6195 option appends to rather than overwriting the file.
6196 .It Xo Ic set-buffer
6198 .Op Fl b Ar buffer-name
6199 .Op Fl t Ar target-client
6201 .Op Fl n Ar new-buffer-name
6204 .D1 Pq alias: Ic setb
6205 Set the contents of the specified buffer to
6209 is given, the buffer is also sent to the clipboard for
6213 escape sequence, if possible.
6216 option appends to rather than overwriting the buffer.
6219 option renames the buffer to
6220 .Ar new-buffer-name .
6222 .It Xo Ic show-buffer
6223 .Op Fl b Ar buffer-name
6225 .D1 Pq alias: Ic showb
6226 Display the contents of the specified buffer.
6229 Miscellaneous commands are as follows:
6231 .It Ic clock-mode Op Fl t Ar target-pane
6232 Display a large clock.
6236 .Op Fl t Ar target-pane
6237 .Ar shell-command command
6247 returns success or the second
6250 Before being executed,
6252 is expanded using the rules specified in the
6254 section, including those relevant to
6259 is run in the background.
6265 is not executed but considered success if neither empty nor zero (after formats
6269 .D1 Pq alias: Ic lock
6270 Lock each client individually by running the command specified by the
6277 .Op Fl t Ar target-pane
6278 .Op Ar shell-command
6280 .D1 Pq alias: Ic run
6289 command in the background without creating a window.
6290 Before being executed,
6292 is expanded using the rules specified in the
6297 the command is run in the background.
6301 seconds before starting the command.
6304 is not given, any output to stdout is displayed in view mode (in the pane
6307 or the current pane if omitted) after the command finishes.
6308 If the command fails, the exit status is also displayed.
6314 .D1 Pq alias: Ic wait
6315 When used without options, prevents the client from exiting until woken using
6318 with the same channel.
6321 is used, the channel is locked and any clients that try to lock the same
6322 channel are made to wait until the channel is unlocked with
6329 client detaches, it prints a message.
6332 .It detached (from session ...)
6333 The client was detached normally.
6334 .It detached and SIGHUP
6335 The client was detached and its parent sent the
6337 signal (for example with
6345 was unexpectedly destroyed.
6347 The client was killed with
6350 The client is in control mode and became unable to keep up with the data from
6353 The server exited when it had no sessions.
6355 The server exited when it received
6357 .It server exited unexpectedly
6358 The server crashed or otherwise exited without telling the client the reason.
6360 .Sh TERMINFO EXTENSIONS
6362 understands some unofficial extensions to
6364 It is not normally necessary to set these manually, instead the
6365 .Ic terminal-features
6366 option should be used.
6369 An existing extension that tells
6371 the terminal supports default colours.
6375 that the terminal supports the VTE bidirectional text extensions.
6377 Set the cursor colour.
6378 The first takes a single string argument and is used to set the colour;
6379 the second takes no arguments and restores the default cursor colour.
6380 If set, a sequence such as this may be used
6381 to change the cursor colour from inside
6383 .Bd -literal -offset indent
6384 $ printf '\e033]12;red\e033\e\e'
6391 .It Em \&Cmg, \&Clmg, \&Dsmg , \&Enmg
6392 Set, clear, disable or enable DECSLRM margins.
6393 These are set automatically if the terminal reports it is
6396 .It Em \&Dsbp , \&Enbp
6397 Disable and enable bracketed paste.
6398 These are set automatically if the
6400 capability is present.
6401 .It Em \&Dseks , \&Eneks
6402 Disable and enable extended keys.
6403 .It Em \&Dsfcs , \&Enfcs
6404 Disable and enable focus reporting.
6405 These are set automatically if the
6407 capability is present.
6411 that the terminal supports rectangle operations.
6413 Enable the overline attribute.
6415 Set a styled underscore.
6416 The single parameter is one of: 0 for no underscore, 1 for normal
6417 underscore, 2 for double underscore, 3 for curly underscore, 4 for dotted
6418 underscore and 5 for dashed underscore.
6419 .It Em \&Setulc , \&ol
6420 Set the underscore colour or reset to the default.
6421 The argument is (red * 65536) + (green * 256) + blue where each is between 0
6424 Set or reset the cursor style.
6425 If set, a sequence such as this may be used
6426 to change the cursor to an underline:
6427 .Bd -literal -offset indent
6428 $ printf '\e033[4 q'
6433 is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
6435 Set the opening sequence for the working directory notification.
6436 The sequence is terminated using the standard
6440 Start (parameter is 1) or end (parameter is 2) a synchronized update.
6442 Indicate that the terminal supports the
6444 RGB escape sequence (for example, \ee[38;2;255;255;255m).
6446 If supported, this is used for the initialize colour escape sequence (which
6447 may be enabled by adding the
6456 This is equivalent to the
6461 Store the current buffer in the host terminal's selection (clipboard).
6464 option above and the
6468 This is an existing extension capability that tmux uses to mean that the
6469 terminal supports the
6471 title set sequences and to automatically set some of the capabilities above.
6475 offers a textual interface called
6477 This allows applications to communicate with
6479 using a simple text-only protocol.
6481 In control mode, a client sends
6483 commands or command sequences terminated by newlines on standard input.
6484 Each command will produce one block of output on standard output.
6485 An output block consists of a
6487 line followed by the output (which may be empty).
6488 The output block ends with a
6497 have three arguments: an integer time (as seconds from epoch), command number and
6498 flags (currently not used).
6500 .Bd -literal -offset indent
6501 %begin 1363006971 2 1
6502 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
6509 command may be used to set the size of a client in control mode.
6513 outputs notifications.
6514 A notification will never occur inside an output block.
6516 The following notifications are defined:
6518 .It Ic %client-detached Ar client
6519 The client has detached.
6520 .It Ic %client-session-changed Ar client session-id name
6521 The client is now attached to the session with ID
6525 .It Ic %continue Ar pane-id
6526 The pane has been continued after being paused (if the
6531 .It Ic %exit Op Ar reason
6534 client is exiting immediately, either because it is not attached to any session
6535 or an error occurred.
6538 describes why the client exited.
6539 .It Ic %extended-output Ar pane-id Ar age Ar ... \& : Ar value
6546 is the time in milliseconds for which tmux had buffered the output before it was sent.
6547 Any subsequent arguments up until a single
6549 are for future use and should be ignored.
6550 .It Ic %layout-change Ar window-id Ar window-layout Ar window-visible-layout Ar window-flags
6551 The layout of a window with ID
6556 The window's visible layout is
6557 .Ar window-visible-layout
6558 and the window flags are
6560 .It Ic %output Ar pane-id Ar value
6561 A window pane produced output.
6563 escapes non-printable characters and backslash as octal \\xxx.
6564 .It Ic %pane-mode-changed Ar pane-id
6568 .It Ic %pause Ar pane-id
6569 The pane has been paused (if the
6572 .It Ic %session-changed Ar session-id Ar name
6573 The client is now attached to the session with ID
6577 .It Ic %session-renamed Ar name
6578 The current session was renamed to
6580 .It Ic %session-window-changed Ar session-id Ar window-id
6583 changed its active window to the window with ID
6585 .It Ic %sessions-changed
6586 A session was created or destroyed.
6587 .It Xo Ic %subscription-changed
6592 .Ar pane-id ... \& :
6595 The value of the format associated with subscription
6606 are for future use and should be ignored.
6607 .It Ic %unlinked-window-add Ar window-id
6610 was created but is not linked to the current session.
6611 .It Ic %unlinked-window-close Ar window-id
6614 which is not linked to the current session, was closed.
6615 .It Ic %unlinked-window-renamed Ar window-id
6618 which is not linked to the current session, was renamed.
6619 .It Ic %window-add Ar window-id
6622 was linked to the current session.
6623 .It Ic %window-close Ar window-id
6627 .It Ic %window-pane-changed Ar window-id Ar pane-id
6628 The active pane in the window with ID
6630 changed to the pane with ID
6632 .It Ic %window-renamed Ar window-id Ar name
6641 is started, it inspects the following environment variables:
6642 .Bl -tag -width LC_CTYPE
6644 If the command specified in this variable contains the string
6648 is unset, use vi-style key bindings.
6655 The user's login directory.
6658 database is consulted.
6660 The character encoding
6662 It is used for two separate purposes.
6663 For output to the terminal, UTF-8 is used if the
6665 option is given or if
6671 Otherwise, only ASCII characters are written and non-ASCII characters
6672 are replaced with underscores
6676 always runs with a UTF-8 locale.
6677 If en_US.UTF-8 is provided by the operating system, it is used and
6679 is ignored for input.
6684 what the UTF-8 locale is called on the current system.
6685 If the locale specified by
6687 is not available or is not a UTF-8 locale,
6689 exits with an error message.
6691 The date and time format
6693 It is used for locale-dependent
6697 The current working directory to be set in the global environment.
6698 This may be useful if it contains symbolic links.
6699 If the value of the variable does not match the current working
6700 directory, the variable is ignored and the result of
6704 The absolute path to the default shell for new windows.
6709 The parent directory of the directory containing the server sockets.
6714 If the command specified in this variable contains the string
6716 use vi-style key bindings.
6724 .Bl -tag -width "/etc/tmux.confXXX" -compact
6729 .It Pa /etc/tmux.conf
6730 System-wide configuration file.
6738 .Dl $ tmux new-session vi
6740 Most commands have a shorter form, known as an alias.
6741 For new-session, this is
6746 Alternatively, the shortest unambiguous form of a command is accepted.
6747 If there are several options, they are listed:
6748 .Bd -literal -offset indent
6750 ambiguous command: n, could be: new-session, new-window, next-window
6753 Within an active session, a new window may be created by typing
6763 Windows may be navigated with:
6765 (to select window 0),
6767 (to select window 1), and so on;
6769 to select the next window; and
6771 to select the previous window.
6773 A session may be detached using
6775 (or by an external event such as
6777 disconnection) and reattached with:
6779 .Dl $ tmux attach-session
6783 lists the current key bindings in the current window; up and down may be used
6784 to navigate the list or
6788 Commands to be run when the
6790 server is started may be placed in the
6793 Common examples include:
6795 Changing the default prefix key:
6796 .Bd -literal -offset indent
6797 set-option -g prefix C-a
6799 bind-key C-a send-prefix
6802 Turning the status line off, or changing its colour:
6803 .Bd -literal -offset indent
6804 set-option -g status off
6805 set-option -g status-style bg=blue
6808 Setting other options, such as the default command,
6809 or locking after 30 minutes of inactivity:
6810 .Bd -literal -offset indent
6811 set-option -g default-command "exec /bin/ksh"
6812 set-option -g lock-after-time 1800
6815 Creating new key bindings:
6816 .Bd -literal -offset indent
6817 bind-key b set-option status
6818 bind-key / command-prompt "split-window 'exec man %%'"
6819 bind-key S command-prompt "new-window -n %1 'ssh %1'"
6824 .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com