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 t Ar target-client
1349 .D1 Pq alias: Ic refresh
1350 Refresh the current client if bound to a key, or a single client if one is given
1355 is specified, only update the client's status line.
1364 flags allow the visible portion of a window which is larger than the client
1367 moves the visible part up by
1379 returns to tracking the cursor automatically.
1382 is omitted, 1 is used.
1383 Note that the visible position is a property of the client not of the
1384 window, changing the current window in the attached session will reset
1388 sets the width and height of a control mode client or of a window for a
1389 control mode client,
1394 .Ql window ID:widthxheight ,
1400 allows a control mode client to trigger actions on a pane.
1401 The argument is a pane ID (with leading
1403 a colon, then one of
1412 will not send output from the pane to the client and if all clients have turned
1413 the pane off, will stop reading from the pane.
1417 will return to sending output to the pane if it was paused (manually or with the
1423 will pause the pane.
1425 may be given multiple times for different panes.
1428 sets a subscription to a format for a control mode client.
1429 The argument is split into three items by colons:
1431 is a name for the subscription;
1433 is a type of item to subscribe to;
1436 After a subscription is added, changes to the format are reported with the
1437 .Ic %subscription-changed
1438 notification, at most once a second.
1439 If only the name is given, the subscription is removed.
1441 may be empty to check the format only for the attached session, or one of:
1445 for all panes in the attached session;
1450 for all windows in the attached session.
1453 sets a comma-separated list of client flags, see
1454 .Ic attach-session .
1457 requests the clipboard from the client using the
1459 escape sequence and stores it in a new paste buffer.
1466 move the visible portion of the window left, right, up or down
1469 if the window is larger than the client.
1471 resets so that the position follows the cursor.
1476 .It Xo Ic rename-session
1477 .Op Fl t Ar target-session
1480 .D1 Pq alias: Ic rename
1481 Rename the session to
1484 .It Xo Ic show-messages
1486 .Op Fl t Ar target-client
1488 .D1 Pq alias: Ic showmsgs
1489 Show server messages or information.
1490 Messages are stored, up to a maximum of the limit set by the
1496 show debugging information about jobs and terminals.
1498 .It Xo Ic source-file
1503 .D1 Pq alias: Ic source
1504 Execute commands from one or more files specified by
1513 is expanded as a format.
1516 is given, no error will be returned if
1521 the file is parsed but no commands are executed.
1523 shows the parsed commands and line numbers if possible.
1526 .D1 Pq alias: Ic start
1529 server, if not already running, without creating any sessions.
1531 Note that as by default the
1533 server will exit with no sessions, this is only useful if a session is created in
1536 is turned off, or another command is run as part of the same command sequence.
1538 .Bd -literal -offset indent
1539 $ tmux start \\; show -g
1542 .It Xo Ic suspend-client
1543 .Op Fl t Ar target-client
1545 .D1 Pq alias: Ic suspendc
1546 Suspend a client by sending
1550 .It Xo Ic switch-client
1552 .Op Fl c Ar target-client
1553 .Op Fl t Ar target-session
1554 .Op Fl T Ar key-table
1556 .D1 Pq alias: Ic switchc
1557 Switch the current session for client
1560 .Ar target-session .
1563 may refer to a pane (a target that contains
1568 to change session, window and pane.
1571 keeps the window zoomed if it was zoomed.
1577 is used, the client is moved to the last, next or previous session
1591 .Ic update-environment
1592 option will not be applied.
1595 sets the client's key table; the next key from the client will be interpreted
1598 This may be used to configure multiple prefix keys, or to bind commands to
1600 For example, to make typing
1605 .Bd -literal -offset indent
1606 bind-key -Ttable2 c list-keys
1607 bind-key -Ttable1 b switch-client -Ttable2
1608 bind-key -Troot a switch-client -Ttable1
1611 .Sh WINDOWS AND PANES
1612 Each window displayed by
1614 may be split into one or more
1616 each pane takes up a certain area of the display and is a separate terminal.
1617 A window may be split into panes using the
1620 Windows may be split horizontally (with the
1622 flag) or vertically.
1623 Panes may be resized with the
1631 by default), the current pane may be changed with the
1637 commands may be used to swap panes without changing their position.
1638 Panes are numbered beginning from zero in the order they are created.
1642 pane permits direct access to the terminal contained in the pane.
1643 A pane may also be put into one of several modes:
1644 .Bl -dash -offset indent
1646 Copy mode, which permits a section of a window or its
1647 history to be copied to a
1649 for later insertion into another window.
1650 This mode is entered with the
1655 Copied text can be pasted with the
1660 View mode, which is like copy mode but is entered when a command that produces
1663 is executed from a key binding.
1665 Choose mode, which allows an item to be chosen from a list.
1666 This may be a client, a session or window or pane, or a buffer.
1667 This mode is entered with the
1675 In copy mode an indicator is displayed in the top-right corner of the pane with
1676 the current position and the number of lines in the history.
1678 Commands are sent to copy mode using the
1683 When a key is pressed, copy mode automatically uses one of two key tables,
1691 Key tables may be viewed with the
1695 The following commands are supported in copy mode:
1696 .Bl -column "CommandXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXXXXXXXX" "emacs" -offset indent
1697 .It Sy "Command" Ta Sy "vi" Ta Sy "emacs"
1698 .It Li "append-selection" Ta "" Ta ""
1699 .It Li "append-selection-and-cancel" Ta "A" Ta ""
1700 .It Li "back-to-indentation" Ta "^" Ta "M-m"
1701 .It Li "begin-selection" Ta "Space" Ta "C-Space"
1702 .It Li "bottom-line" Ta "L" Ta ""
1703 .It Li "cancel" Ta "q" Ta "Escape"
1704 .It Li "clear-selection" Ta "Escape" Ta "C-g"
1705 .It Li "copy-end-of-line [<prefix>]" Ta "" Ta ""
1706 .It Li "copy-end-of-line-and-cancel [<prefix>]" Ta "" Ta ""
1707 .It Li "copy-pipe-end-of-line [<command>] [<prefix>]" Ta "" Ta ""
1708 .It Li "copy-pipe-end-of-line-and-cancel [<command>] [<prefix>]" Ta "D" Ta "C-k"
1709 .It Li "copy-line [<prefix>]" Ta "" Ta ""
1710 .It Li "copy-line-and-cancel [<prefix>]" Ta "" Ta ""
1711 .It Li "copy-pipe-line [<command>] [<prefix>]" Ta "" Ta ""
1712 .It Li "copy-pipe-line-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1713 .It Li "copy-pipe [<command>] [<prefix>]" Ta "" Ta ""
1714 .It Li "copy-pipe-no-clear [<command>] [<prefix>]" Ta "" Ta ""
1715 .It Li "copy-pipe-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1716 .It Li "copy-selection [<prefix>]" Ta "" Ta ""
1717 .It Li "copy-selection-no-clear [<prefix>]" Ta "" Ta ""
1718 .It Li "copy-selection-and-cancel [<prefix>]" Ta "Enter" Ta "M-w"
1719 .It Li "cursor-down" Ta "j" Ta "Down"
1720 .It Li "cursor-down-and-cancel" Ta "" Ta ""
1721 .It Li "cursor-left" Ta "h" Ta "Left"
1722 .It Li "cursor-right" Ta "l" Ta "Right"
1723 .It Li "cursor-up" Ta "k" Ta "Up"
1724 .It Li "end-of-line" Ta "$" Ta "C-e"
1725 .It Li "goto-line <line>" Ta ":" Ta "g"
1726 .It Li "halfpage-down" Ta "C-d" Ta "M-Down"
1727 .It Li "halfpage-down-and-cancel" Ta "" Ta ""
1728 .It Li "halfpage-up" Ta "C-u" Ta "M-Up"
1729 .It Li "history-bottom" Ta "G" Ta "M->"
1730 .It Li "history-top" Ta "g" Ta "M-<"
1731 .It Li "jump-again" Ta ";" Ta ";"
1732 .It Li "jump-backward <to>" Ta "F" Ta "F"
1733 .It Li "jump-forward <to>" Ta "f" Ta "f"
1734 .It Li "jump-reverse" Ta "," Ta ","
1735 .It Li "jump-to-backward <to>" Ta "T" Ta ""
1736 .It Li "jump-to-forward <to>" Ta "t" Ta ""
1737 .It Li "jump-to-mark" Ta "M-x" Ta "M-x"
1738 .It Li "middle-line" Ta "M" Ta "M-r"
1739 .It Li "next-matching-bracket" Ta "%" Ta "M-C-f"
1740 .It Li "next-paragraph" Ta "}" Ta "M-}"
1741 .It Li "next-space" Ta "W" Ta ""
1742 .It Li "next-space-end" Ta "E" Ta ""
1743 .It Li "next-word" Ta "w" Ta ""
1744 .It Li "next-word-end" Ta "e" Ta "M-f"
1745 .It Li "other-end" Ta "o" Ta ""
1746 .It Li "page-down" Ta "C-f" Ta "PageDown"
1747 .It Li "page-down-and-cancel" Ta "" Ta ""
1748 .It Li "page-up" Ta "C-b" Ta "PageUp"
1749 .It Li "pipe [<command>] [<prefix>]" Ta "" Ta ""
1750 .It Li "pipe-no-clear [<command>] [<prefix>]" Ta "" Ta ""
1751 .It Li "pipe-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1752 .It Li "previous-matching-bracket" Ta "" Ta "M-C-b"
1753 .It Li "previous-paragraph" Ta "{" Ta "M-{"
1754 .It Li "previous-space" Ta "B" Ta ""
1755 .It Li "previous-word" Ta "b" Ta "M-b"
1756 .It Li "rectangle-on" Ta "" Ta ""
1757 .It Li "rectangle-off" Ta "" Ta ""
1758 .It Li "rectangle-toggle" Ta "v" Ta "R"
1759 .It Li "refresh-from-pane" Ta "r" Ta "r"
1760 .It Li "scroll-down" Ta "C-e" Ta "C-Down"
1761 .It Li "scroll-down-and-cancel" Ta "" Ta ""
1762 .It Li "scroll-up" Ta "C-y" Ta "C-Up"
1763 .It Li "search-again" Ta "n" Ta "n"
1764 .It Li "search-backward <for>" Ta "?" Ta ""
1765 .It Li "search-backward-incremental <for>" Ta "" Ta "C-r"
1766 .It Li "search-backward-text <for>" Ta "" Ta ""
1767 .It Li "search-forward <for>" Ta "/" Ta ""
1768 .It Li "search-forward-incremental <for>" Ta "" Ta "C-s"
1769 .It Li "search-forward-text <for>" Ta "" Ta ""
1770 .It Li "search-reverse" Ta "N" Ta "N"
1771 .It Li "select-line" Ta "V" Ta ""
1772 .It Li "select-word" Ta "" Ta ""
1773 .It Li "set-mark" Ta "X" Ta "X"
1774 .It Li "start-of-line" Ta "0" Ta "C-a"
1775 .It Li "stop-selection" Ta "" Ta ""
1776 .It Li "top-line" Ta "H" Ta "M-R"
1779 The search commands come in several varieties:
1783 search for a regular expression;
1786 variants search for a plain text string rather than a regular expression;
1788 perform an incremental search and expect to be used with the
1794 repeats the last search and
1796 does the same but reverses the direction (forward becomes backward and backward
1799 Copy commands may take an optional buffer prefix argument which is used
1800 to generate the buffer name (the default is
1802 so buffers are named
1806 Pipe commands take a command argument which is the command to which the
1807 selected text is piped.
1809 variants also copy the selection.
1812 variants of some commands exit copy mode after they have completed (for copy
1813 commands) or when the cursor reaches the bottom (for scrolling commands).
1815 variants do not clear the selection.
1817 The next and previous word keys skip over whitespace and treat consecutive
1818 runs of either word separators or other letters as words.
1819 Word separators can be customized with the
1822 Next word moves to the start of the next word, next word end to the end of the
1823 next word and previous word to the start of the previous word.
1824 The three next and previous space keys work similarly but use a space alone as
1828 to the empty string makes next/previous word equivalent to next/previous space.
1830 The jump commands enable quick movement within a line.
1831 For instance, typing
1835 will move the cursor to the next
1837 character on the current line.
1840 will then jump to the next occurrence.
1842 Commands in copy mode may be prefaced by an optional repeat count.
1843 With vi key bindings, a prefix is entered using the number keys; with
1844 emacs, the Alt (meta) key and a number begins prefix entry.
1846 The synopsis for the
1852 .Op Fl s Ar src-pane
1853 .Op Fl t Ar target-pane
1858 option scrolls one page up.
1860 begins a mouse drag (only valid if bound to a mouse key binding, see
1861 .Sx MOUSE SUPPORT ) .
1863 hides the position indicator in the top right.
1865 cancels copy mode and any other modes.
1873 specifies that scrolling to the bottom of the history (to the visible screen)
1874 should exit copy mode.
1875 While in copy mode, pressing a key other than those used for scrolling will
1876 disable this behaviour.
1877 This is intended to allow fast scrolling through a pane's history, for
1879 .Bd -literal -offset indent
1880 bind PageUp copy-mode -eu
1884 A number of preset arrangements of panes are available, these are called layouts.
1885 These may be selected with the
1887 command or cycled with
1891 by default); once a layout is chosen, panes within it may be moved and resized
1894 The following layouts are supported:
1896 .It Ic even-horizontal
1897 Panes are spread out evenly from left to right across the window.
1898 .It Ic even-vertical
1899 Panes are spread evenly from top to bottom.
1900 .It Ic main-horizontal
1901 A large (main) pane is shown at the top of the window and the remaining panes
1902 are spread from left to right in the leftover space at the bottom.
1904 .Em main-pane-height
1905 window option to specify the height of the top pane.
1906 .It Ic main-vertical
1909 but the large pane is placed on the left and the others spread from top to
1910 bottom along the right.
1915 Panes are spread out as evenly as possible over the window in both rows and
1921 may be used to apply a previously used layout - the
1923 command displays the layout of each window in a form suitable for use with
1926 .Bd -literal -offset indent
1929 layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1930 $ tmux select-layout bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1934 automatically adjusts the size of the layout for the current window size.
1935 Note that a layout cannot be applied to a window with more panes than that
1936 from which the layout was originally defined.
1938 Commands related to windows and panes are as follows:
1941 .It Xo Ic break-pane
1944 .Op Fl n Ar window-name
1945 .Op Fl s Ar src-pane
1946 .Op Fl t Ar dst-window
1948 .D1 Pq alias: Ic breakp
1951 off from its containing window to make it the only pane in
1957 the window is moved to the next index after or before (existing windows are
1958 moved if necessary).
1961 is given, the new window does not become the current window.
1964 option prints information about the new window after it has been created.
1965 By default, it uses the format
1966 .Ql #{session_name}:#{window_index}.#{pane_index}
1967 but a different format may be specified with
1970 .It Xo Ic capture-pane
1972 .Op Fl b Ar buffer-name
1973 .Op Fl E Ar end-line
1974 .Op Fl S Ar start-line
1975 .Op Fl t Ar target-pane
1977 .D1 Pq alias: Ic capturep
1978 Capture the contents of a pane.
1981 is given, the output goes to stdout, otherwise to the buffer specified with
1983 or a new buffer if omitted.
1986 is given, the alternate screen is used, and the history is not accessible.
1987 If no alternate screen exists, an error will be returned unless
1992 is given, the output includes escape sequences for text and background
1995 also escapes non-printable characters as octal \exxx.
1997 preserves trailing spaces at each line's end and
1999 preserves trailing spaces and joins any wrapped lines.
2001 captures only any output that the pane has received that is the beginning of an
2002 as-yet incomplete escape sequence.
2007 specify the starting and ending line numbers, zero is the first line of the
2008 visible pane and negative numbers are lines in the history.
2012 is the start of the history and to
2014 the end of the visible pane.
2015 The default is to capture only the visible contents of the pane.
2021 .Op Fl K Ar key-format
2022 .Op Fl O Ar sort-order
2023 .Op Fl t Ar target-pane
2026 Put a pane into client mode, allowing a client to be selected interactively from
2028 Each client is shown on one line.
2029 A shortcut key is shown on the left in brackets allowing for immediate choice,
2030 or the list may be navigated and an item chosen or otherwise manipulated using
2034 The following keys may be used in client mode:
2035 .Bl -column "Key" "Function" -offset indent
2036 .It Sy "Key" Ta Sy "Function"
2037 .It Li "Enter" Ta "Choose selected client"
2038 .It Li "Up" Ta "Select previous client"
2039 .It Li "Down" Ta "Select next client"
2040 .It Li "C-s" Ta "Search by name"
2041 .It Li "n" Ta "Repeat last search"
2042 .It Li "t" Ta "Toggle if client is tagged"
2043 .It Li "T" Ta "Tag no clients"
2044 .It Li "C-t" Ta "Tag all clients"
2045 .It Li "d" Ta "Detach selected client"
2046 .It Li "D" Ta "Detach tagged clients"
2047 .It Li "x" Ta "Detach and HUP selected client"
2048 .It Li "X" Ta "Detach and HUP tagged clients"
2049 .It Li "z" Ta "Suspend selected client"
2050 .It Li "Z" Ta "Suspend tagged clients"
2051 .It Li "f" Ta "Enter a format to filter items"
2052 .It Li "O" Ta "Change sort field"
2053 .It Li "r" Ta "Reverse sort order"
2054 .It Li "v" Ta "Toggle preview"
2055 .It Li "q" Ta "Exit mode"
2058 After a client is chosen,
2060 is replaced by the client name in
2062 and the result executed as a command.
2065 is not given, "detach-client -t '%%'" is used.
2068 specifies the initial sort field: one of
2075 reverses the sort order.
2077 specifies an initial filter: the filter is a format - if it evaluates to zero,
2078 the item in the list is not shown, otherwise it is shown.
2079 If a filter would lead to an empty list, it is ignored.
2081 specifies the format for each item in the list and
2083 a format for each shortcut key; both are evaluated once for each line.
2085 starts without the preview.
2086 This command works only if at least one client is attached.
2092 .Op Fl K Ar key-format
2093 .Op Fl O Ar sort-order
2094 .Op Fl t Ar target-pane
2097 Put a pane into tree mode, where a session, window or pane may be chosen
2098 interactively from a tree.
2099 Each session, window or pane is shown on one line.
2100 A shortcut key is shown on the left in brackets allowing for immediate choice,
2101 or the tree may be navigated and an item chosen or otherwise manipulated using
2104 starts with sessions collapsed and
2106 with windows collapsed.
2109 The following keys may be used in tree mode:
2110 .Bl -column "Key" "Function" -offset indent
2111 .It Sy "Key" Ta Sy "Function"
2112 .It Li "Enter" Ta "Choose selected item"
2113 .It Li "Up" Ta "Select previous item"
2114 .It Li "Down" Ta "Select next item"
2115 .It Li "+" Ta "Expand selected item"
2116 .It Li "-" Ta "Collapse selected item"
2117 .It Li "M-+" Ta "Expand all items"
2118 .It Li "M--" Ta "Collapse all items"
2119 .It Li "x" Ta "Kill selected item"
2120 .It Li "X" Ta "Kill tagged items"
2121 .It Li "<" Ta "Scroll list of previews left"
2122 .It Li ">" Ta "Scroll list of previews right"
2123 .It Li "C-s" Ta "Search by name"
2124 .It Li "m" Ta "Set the marked pane"
2125 .It Li "M" Ta "Clear the marked pane"
2126 .It Li "n" Ta "Repeat last search"
2127 .It Li "t" Ta "Toggle if item is tagged"
2128 .It Li "T" Ta "Tag no items"
2129 .It Li "C-t" Ta "Tag all items"
2130 .It Li "\&:" Ta "Run a command for each tagged item"
2131 .It Li "f" Ta "Enter a format to filter items"
2132 .It Li "H" Ta "Jump to the starting pane"
2133 .It Li "O" Ta "Change sort field"
2134 .It Li "r" Ta "Reverse sort order"
2135 .It Li "v" Ta "Toggle preview"
2136 .It Li "q" Ta "Exit mode"
2139 After a session, window or pane is chosen, the first instance of
2141 and all instances of
2143 are replaced by the target in
2145 and the result executed as a command.
2148 is not given, "switch-client -t '%%'" is used.
2151 specifies the initial sort field: one of
2157 reverses the sort order.
2159 specifies an initial filter: the filter is a format - if it evaluates to zero,
2160 the item in the list is not shown, otherwise it is shown.
2161 If a filter would lead to an empty list, it is ignored.
2163 specifies the format for each item in the tree and
2165 a format for each shortcut key; both are evaluated once for each line.
2167 starts without the preview.
2169 includes all sessions in any session groups in the tree rather than only the
2171 This command works only if at least one client is attached.
2177 .Op Fl t Ar target-pane
2180 Put a pane into customize mode, where options and key bindings may be browsed
2181 and modified from a list.
2182 Option values in the list are shown for the active pane in the current window.
2185 The following keys may be used in customize mode:
2186 .Bl -column "Key" "Function" -offset indent
2187 .It Sy "Key" Ta Sy "Function"
2188 .It Li "Enter" Ta "Set pane, window, session or global option value"
2189 .It Li "Up" Ta "Select previous item"
2190 .It Li "Down" Ta "Select next item"
2191 .It Li "+" Ta "Expand selected item"
2192 .It Li "-" Ta "Collapse selected item"
2193 .It Li "M-+" Ta "Expand all items"
2194 .It Li "M--" Ta "Collapse all items"
2195 .It Li "s" Ta "Set option value or key attribute"
2196 .It Li "S" Ta "Set global option value"
2197 .It Li "w" Ta "Set window option value, if option is for pane and window"
2198 .It Li "d" Ta "Set an option or key to the default"
2199 .It Li "D" Ta "Set tagged options and tagged keys to the default"
2200 .It Li "u" Ta "Unset an option (set to default value if global) or unbind a key"
2201 .It Li "U" Ta "Unset tagged options and unbind tagged keys"
2202 .It Li "C-s" Ta "Search by name"
2203 .It Li "n" Ta "Repeat last search"
2204 .It Li "t" Ta "Toggle if item is tagged"
2205 .It Li "T" Ta "Tag no items"
2206 .It Li "C-t" Ta "Tag all items"
2207 .It Li "f" Ta "Enter a format to filter items"
2208 .It Li "v" Ta "Toggle option information"
2209 .It Li "q" Ta "Exit mode"
2213 specifies an initial filter: the filter is a format - if it evaluates to zero,
2214 the item in the list is not shown, otherwise it is shown.
2215 If a filter would lead to an empty list, it is ignored.
2217 specifies the format for each item in the tree.
2219 starts without the option information.
2220 This command works only if at least one client is attached.
2225 .Op Fl d Ar duration
2226 .Op Fl t Ar target-client
2229 .D1 Pq alias: Ic displayp
2230 Display a visible indicator of each pane shown by
2233 .Ic display-panes-colour
2235 .Ic display-panes-active-colour
2237 The indicator is closed when a key is pressed (unless
2241 milliseconds have passed.
2245 .Ic display-panes-time
2247 A duration of zero means the indicator stays until a key is pressed.
2248 While the indicator is on screen, a pane may be chosen with the
2252 keys, which will cause
2254 to be executed as a command with
2256 substituted by the pane ID.
2259 is "select-pane -t '%%'".
2262 other commands are not blocked from running until the indicator is closed.
2264 .It Xo Ic find-window
2266 .Op Fl t Ar target-pane
2269 .D1 Pq alias: Ic findw
2276 in window names, titles, and visible content (but not history).
2277 The flags control matching behavior:
2279 matches only visible window contents,
2281 matches only the window name and
2283 matches only the window title.
2285 makes the search ignore case.
2291 This command works only if at least one client is attached.
2296 .Op Fl s Ar src-pane
2297 .Op Fl t Ar dst-pane
2299 .D1 Pq alias: Ic joinp
2302 but instead of splitting
2304 and creating a new pane, split it and move
2307 This can be used to reverse
2313 to be joined to left of or above
2318 is omitted and a marked pane is present (see
2321 the marked pane is used rather than the current pane.
2325 .Op Fl t Ar target-pane
2327 .D1 Pq alias: Ic killp
2328 Destroy the given pane.
2329 If no panes remain in the containing window, it is also destroyed.
2332 option kills all but the pane given with
2335 .It Xo Ic kill-window
2337 .Op Fl t Ar target-window
2339 .D1 Pq alias: Ic killw
2340 Kill the current window or the window at
2342 removing it from any sessions to which it is linked.
2345 option kills all but the window given with
2350 .Op Fl t Ar target-window
2352 .D1 Pq alias: Ic lastp
2353 Select the last (previously selected) pane.
2355 keeps the window zoomed if it was zoomed.
2359 disables input to the pane.
2361 .It Ic last-window Op Fl t Ar target-session
2362 .D1 Pq alias: Ic last
2363 Select the last (previously selected) window.
2366 is specified, select the last window of the current session.
2368 .It Xo Ic link-window
2370 .Op Fl s Ar src-window
2371 .Op Fl t Ar dst-window
2373 .D1 Pq alias: Ic linkw
2380 is specified and no such window exists, the
2387 the window is moved to the next index after or before
2389 (existing windows are moved if necessary).
2394 exists, it is killed, otherwise an error is generated.
2397 is given, the newly linked window is not selected.
2399 .It Xo Ic list-panes
2405 .D1 Pq alias: Ic lsp
2410 is ignored and all panes on the server are listed.
2415 is a session (or the current session).
2416 If neither is given,
2418 is a window (or the current window).
2420 specifies the format of each line and
2423 Only panes for which the filter is true are shown.
2428 .It Xo Ic list-windows
2432 .Op Fl t Ar target-session
2434 .D1 Pq alias: Ic lsw
2437 is given, list all windows on the server.
2438 Otherwise, list windows in the current session or in
2439 .Ar target-session .
2441 specifies the format of each line and
2444 Only windows for which the filter is true are shown.
2452 .Op Fl s Ar src-pane
2453 .Op Fl t Ar dst-pane
2455 .D1 Pq alias: Ic movep
2459 .It Xo Ic move-window
2461 .Op Fl s Ar src-window
2462 .Op Fl t Ar dst-window
2464 .D1 Pq alias: Ic movew
2467 except the window at
2473 all windows in the session are renumbered in sequential order, respecting
2478 .It Xo Ic new-window
2480 .Op Fl c Ar start-directory
2481 .Op Fl e Ar environment
2483 .Op Fl n Ar window-name
2484 .Op Fl t Ar target-window
2485 .Op Ar shell-command
2487 .D1 Pq alias: Ic neww
2488 Create a new window.
2493 the new window is inserted at the next index after or before the specified
2495 moving windows up if necessary;
2498 is the new window location.
2502 is given, the session does not make the new window the current window.
2504 represents the window to be created; if the target already exists an error is
2507 flag is used, in which case it is destroyed.
2510 is given and a window named
2512 already exists, it is selected (unless
2514 is also given in which case the command does nothing).
2517 is the command to execute.
2520 is not specified, the value of the
2524 specifies the working directory in which the new window is created.
2526 When the shell command completes, the window closes.
2529 option to change this behaviour.
2534 and sets an environment variable for the newly created window; it may be
2535 specified multiple times.
2539 environment variable must be set to
2543 for all programs running
2546 New windows will automatically have
2548 added to their environment, but care must be taken not to reset this in shell
2549 start-up files or by the
2555 option prints information about the new window after it has been created.
2556 By default, it uses the format
2557 .Ql #{session_name}:#{window_index}
2558 but a different format may be specified with
2561 .It Ic next-layout Op Fl t Ar target-window
2562 .D1 Pq alias: Ic nextl
2563 Move a window to the next layout and rearrange the panes to fit.
2565 .It Xo Ic next-window
2567 .Op Fl t Ar target-session
2569 .D1 Pq alias: Ic next
2570 Move to the next window in the session.
2573 is used, move to the next window with an alert.
2577 .Op Fl t Ar target-pane
2578 .Op Ar shell-command
2580 .D1 Pq alias: Ic pipep
2581 Pipe output sent by the program in
2583 to a shell command or vice versa.
2584 A pane may only be connected to one command at a time, any existing pipe is
2590 string may contain the special character sequences supported by the
2595 is given, the current pipe (if any) is closed.
2600 specify which of the
2602 output streams are connected to the pane:
2605 stdout is connected (so anything
2607 prints is written to the pane as if it were typed);
2610 stdin is connected (so any output in the pane is piped to
2611 .Ar shell-command ) .
2612 Both may be used together and if neither are specified,
2618 option only opens a new pipe if no previous pipe exists, allowing a pipe to
2619 be toggled with a single key, for example:
2620 .Bd -literal -offset indent
2621 bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
2624 .It Xo Ic previous-layout
2625 .Op Fl t Ar target-window
2627 .D1 Pq alias: Ic prevl
2628 Move to the previous layout in the session.
2630 .It Xo Ic previous-window
2632 .Op Fl t Ar target-session
2634 .D1 Pq alias: Ic prev
2635 Move to the previous window in the session.
2638 move to the previous window with an alert.
2640 .It Xo Ic rename-window
2641 .Op Fl t Ar target-window
2644 .D1 Pq alias: Ic renamew
2645 Rename the current window, or the window at
2650 .It Xo Ic resize-pane
2652 .Op Fl t Ar target-pane
2657 .D1 Pq alias: Ic resizep
2658 Resize a pane, up, down, left or right by
2674 is given in lines or columns (the default is 1);
2678 may be a given as a number of lines or columns or followed by
2680 for a percentage of the window size (for example
2684 the active pane is toggled between zoomed (occupying the whole of the window)
2685 and unzoomed (its normal position in the layout).
2688 begins mouse resizing (only valid if bound to a mouse key binding, see
2689 .Sx MOUSE SUPPORT ) .
2692 trims all lines below the current cursor position and moves lines out of the
2693 history to replace them.
2695 .It Xo Ic resize-window
2697 .Op Fl t Ar target-window
2702 .D1 Pq alias: Ic resizew
2703 Resize a window, up, down, left or right by
2719 is given in lines or cells (the default is 1).
2721 sets the size of the largest session containing the window;
2723 the size of the smallest.
2724 This command will automatically set
2726 to manual in the window options.
2728 .It Xo Ic respawn-pane
2730 .Op Fl c Ar start-directory
2731 .Op Fl e Ar environment
2732 .Op Fl t Ar target-pane
2733 .Op Ar shell-command
2735 .D1 Pq alias: Ic respawnp
2736 Reactivate a pane in which the command has exited (see the
2741 is not given, the command used when the pane was created or last respawned is
2743 The pane must be already inactive, unless
2745 is given, in which case any existing command is killed.
2747 specifies a new working directory for the pane.
2750 option has the same meaning as for the
2754 .It Xo Ic respawn-window
2756 .Op Fl c Ar start-directory
2757 .Op Fl e Ar environment
2758 .Op Fl t Ar target-window
2759 .Op Ar shell-command
2761 .D1 Pq alias: Ic respawnw
2762 Reactivate a window in which the command has exited (see the
2767 is not given, the command used when the window was created or last respawned is
2769 The window must be already inactive, unless
2771 is given, in which case any existing command is killed.
2773 specifies a new working directory for the window.
2776 option has the same meaning as for the
2780 .It Xo Ic rotate-window
2782 .Op Fl t Ar target-window
2784 .D1 Pq alias: Ic rotatew
2785 Rotate the positions of the panes within a window, either upward (numerically
2788 or downward (numerically higher).
2790 keeps the window zoomed if it was zoomed.
2792 .It Xo Ic select-layout
2794 .Op Fl t Ar target-pane
2797 .D1 Pq alias: Ic selectl
2798 Choose a specific layout for a window.
2801 is not given, the last preset layout used (if any) is reapplied.
2805 are equivalent to the
2811 applies the last set layout if possible (undoes the most recent layout change).
2813 spreads the current pane and any panes next to it out evenly.
2815 .It Xo Ic select-pane
2818 .Op Fl t Ar target-pane
2820 .D1 Pq alias: Ic selectp
2823 the active pane in its window.
2830 is used, respectively the pane below, to the left, to the right, or above the
2831 target pane is used.
2833 keeps the window zoomed if it was zoomed.
2835 is the same as using the
2841 disables input to the pane.
2843 sets the pane title.
2848 are used to set and clear the
2850 There is one marked pane at a time, setting a new marked pane clears the last.
2851 The marked pane is the default target for
2860 .It Xo Ic select-window
2862 .Op Fl t Ar target-window
2864 .D1 Pq alias: Ic selectw
2865 Select the window at
2871 are equivalent to the
2879 is given and the selected window is already the current window,
2880 the command behaves like
2883 .It Xo Ic split-window
2885 .Op Fl c Ar start-directory
2886 .Op Fl e Ar environment
2888 .Op Fl t Ar target-pane
2889 .Op Ar shell-command
2892 .D1 Pq alias: Ic splitw
2893 Create a new pane by splitting
2896 does a horizontal split and
2898 a vertical split; if neither is specified,
2903 option specifies the size of the new pane in lines (for vertical split) or in
2904 columns (for horizontal split);
2908 to specify a percentage of the available space.
2911 option causes the new pane to be created to the left of or above
2915 option creates a new pane spanning the full window height (with
2917 or full window width (with
2919 instead of splitting the active pane.
2921 zooms if the window is not zoomed, or keeps it zoomed if already zoomed.
2925 ('') will create a pane with no command running in it.
2926 Output can be sent to such a pane with the
2933 is not specified or empty)
2934 will create an empty pane and forward any output from stdin to it.
2936 .Bd -literal -offset indent
2937 $ make 2>&1|tmux splitw -dI &
2940 All other options have the same meaning as for the
2946 .Op Fl s Ar src-pane
2947 .Op Fl t Ar dst-pane
2949 .D1 Pq alias: Ic swapp
2953 is used and no source pane is specified with
2956 is swapped with the previous pane (before it numerically);
2958 swaps with the next pane (after it numerically).
2962 not to change the active pane and
2964 keeps the window zoomed if it was zoomed.
2968 is omitted and a marked pane is present (see
2971 the marked pane is used rather than the current pane.
2973 .It Xo Ic swap-window
2975 .Op Fl s Ar src-window
2976 .Op Fl t Ar dst-window
2978 .D1 Pq alias: Ic swapw
2981 except the source and destination windows are swapped.
2982 It is an error if no window exists at
2986 is given, the new window does not become the current window.
2990 is omitted and a marked pane is present (see
2993 the window containing the marked pane is used rather than the current window.
2995 .It Xo Ic unlink-window
2997 .Op Fl t Ar target-window
2999 .D1 Pq alias: Ic unlinkw
3004 is given, a window may be unlinked only if it is linked to multiple sessions -
3005 windows may not be linked to no sessions;
3008 is specified and the window is linked to only one session, it is unlinked and
3013 allows a command to be bound to most keys, with or without a prefix key.
3014 When specifying keys, most represent themselves (for example
3018 Ctrl keys may be prefixed with
3026 In addition, the following special key names are accepted:
3044 .Em NPage/PageDown/PgDn ,
3045 .Em PPage/PageUp/PgUp ,
3049 Note that to bind the
3053 keys, quotation marks are necessary, for example:
3054 .Bd -literal -offset indent
3055 bind-key '"' split-window
3056 bind-key "'" new-window
3059 A command bound to the
3061 key will execute for all keys which do not have a more specific binding.
3063 Commands related to key bindings are as follows:
3069 .Op Fl T Ar key-table
3070 .Ar key command Op Ar arguments
3072 .D1 Pq alias: Ic bind
3077 Keys are bound in a key table.
3078 By default (without -T), the key is bound in
3082 This table is used for keys pressed after the prefix key (for example,
3091 creates a new window).
3094 table is used for keys pressed without the prefix key: binding
3100 table (not recommended) means a plain
3102 will create a new window.
3107 Keys may also be bound in custom key tables and the
3110 command used to switch to them from a key binding.
3113 flag indicates this key may repeat, see the
3117 attaches a note to the key (shown with
3121 To view the default bindings and possible commands, see the
3127 .Op Fl P Ar prefix-string Fl T Ar key-table
3130 .D1 Pq alias: Ic lsk
3132 There are two forms: the default lists keys as
3136 lists only keys with attached notes and shows only the key and note for each
3139 With the default form, all key tables are listed by default.
3146 form, only keys in the
3150 key tables are listed by default;
3152 also lists only keys in
3155 specifies a prefix to print before each key and
3157 lists only the first matching key.
3159 lists the command for keys that do not have a note rather than skipping them.
3163 .Op Fl N Ar repeat-count
3164 .Op Fl t Ar target-pane
3167 .D1 Pq alias: Ic send
3168 Send a key or keys to a window.
3171 is the name of the key (such as
3175 to send; if the string is not recognised as a key, it is sent as a series of
3177 All arguments are sent sequentially from first to last.
3178 If no keys are given and the command is bound to a key, then that key is used.
3182 flag disables key name lookup and processes the keys as literal UTF-8
3186 flag expects each key to be a hexadecimal number for an ASCII character.
3190 flag causes the terminal state to be reset.
3193 passes through a mouse event (only valid if bound to a mouse key binding, see
3194 .Sx MOUSE SUPPORT ) .
3197 is used to send a command into copy mode - see
3199 .Sx WINDOWS AND PANES
3202 specifies a repeat count and
3204 expands formats in arguments where appropriate.
3205 .It Xo Ic send-prefix
3207 .Op Fl t Ar target-pane
3209 Send the prefix key, or with
3211 the secondary prefix key, to a window as if it was pressed.
3213 .It Xo Ic unbind-key
3215 .Op Fl T Ar key-table
3218 .D1 Pq alias: Ic unbind
3219 Unbind the command bound to
3228 is present, all key bindings are removed.
3231 option prevents errors being returned.
3234 The appearance and behaviour of
3236 may be modified by changing the value of various options.
3237 There are four types of option:
3238 .Em server options ,
3239 .Em session options ,
3240 .Em window options ,
3246 server has a set of global server options which do not apply to any particular
3247 window or session or pane.
3248 These are altered with the
3251 command, or displayed with the
3256 In addition, each individual session may have a set of session options, and
3257 there is a separate set of global session options.
3258 Sessions which do not have a particular option configured inherit the value
3259 from the global session options.
3260 Session options are set or unset with the
3262 command and may be listed with the
3265 The available server and session options are listed under the
3269 Similarly, a set of window options is attached to each window and a set of pane
3270 options to each pane.
3271 Pane options inherit from window options.
3272 This means any pane option may be set as a window option to apply the option to
3273 all panes in the window without the option set, for example these commands will
3274 set the background colour to red for all panes except pane 0:
3275 .Bd -literal -offset indent
3276 set -w window-style bg=red
3277 set -pt:.0 window-style bg=blue
3280 There is also a set of global window options from which any unset window or
3281 pane options are inherited.
3282 Window and pane options are altered with
3287 commands and displayed with
3294 also supports user options which are prefixed with a
3296 User options may have any name, so long as they are prefixed with
3298 and be set to any string.
3300 .Bd -literal -offset indent
3301 $ tmux set -wq @foo "abc123"
3302 $ tmux show -wv @foo
3306 Commands which set options are as follows:
3309 .It Xo Ic set-option
3311 .Op Fl t Ar target-pane
3314 .D1 Pq alias: Ic set
3315 Set a pane option with
3317 a window option with
3319 a server option with
3321 otherwise a session option.
3322 If the option is not a user option,
3326 may be unnecessary -
3328 will infer the type from the option name, assuming
3333 is given, the global session or window option is set.
3336 expands formats in the option value.
3339 flag unsets an option, so a session inherits the option from the global
3342 restores a global option to the default).
3344 unsets an option (like
3346 but if the option is a pane option also unsets the option on any panes in the
3349 depends on the option and may be a number, a string, or a flag (on, off, or
3354 flag prevents setting an option that is already set and the
3356 flag suppresses errors about unknown or ambiguous options.
3360 and if the option expects a string or a style,
3362 is appended to the existing setting.
3364 .Bd -literal -offset indent
3365 set -g status-left "foo"
3366 set -ag status-left "bar"
3372 .Bd -literal -offset indent
3373 set -g status-style "bg=red"
3374 set -ag status-style "fg=blue"
3377 Will result in a red background
3382 the result would be the default background and a blue foreground.
3384 .It Xo Ic show-options
3386 .Op Fl t Ar target-pane
3389 .D1 Pq alias: Ic show
3390 Show the pane options (or a single option if
3394 the window options with
3396 the server options with
3398 otherwise the session options.
3399 If the option is not a user option,
3403 may be unnecessary -
3405 will infer the type from the option name, assuming
3408 Global session or window options are listed if
3412 shows only the option value, not the name.
3415 is set, no error will be returned if
3419 includes hooks (omitted by default).
3421 includes options inherited from a parent set of options, such options are
3422 marked with an asterisk.
3425 Available server options are:
3427 .It Ic backspace Ar key
3431 .It Ic buffer-limit Ar number
3432 Set the number of buffers; as new buffers are added to the top of the stack,
3433 old ones are removed from the bottom if necessary to maintain this maximum
3435 .It Xo Ic command-alias[]
3438 This is an array of custom aliases for commands.
3439 If an unknown command matches
3445 .Dl set -s command-alias[100] zoom='resize-pane -Z'
3453 .Dl resize-pane -Z -t:.1
3455 Note that aliases are expanded when a command is parsed rather than when it is
3456 executed, so binding an alias with
3458 will bind the expanded form.
3459 .It Ic default-terminal Ar terminal
3460 Set the default terminal for new windows created in this session - the
3461 default value of the
3463 environment variable.
3466 to work correctly, this
3471 or a derivative of them.
3472 .It Ic copy-command Ar shell-command
3473 Give the command to pipe to if the
3475 copy mode command is used without arguments.
3476 .It Ic escape-time Ar time
3477 Set the time in milliseconds for which
3479 waits after an escape is input to determine if it is part of a function or meta
3481 The default is 500 milliseconds.
3482 .It Ic editor Ar shell-command
3483 Set the command used when
3486 .It Xo Ic exit-empty
3489 If enabled (the default), the server will exit when there are no active
3491 .It Xo Ic exit-unattached
3494 If enabled, the server will exit when there are no attached clients.
3495 .It Xo Ic extended-keys
3496 .Op Ic on | off | always
3502 the escape sequence to enable extended keys is sent to the terminal, if
3504 knows that it is supported.
3506 always recognises extended keys itself.
3510 will only forward extended keys to applications when they request them; if
3513 will always forward the keys.
3514 .It Xo Ic focus-events
3517 When enabled, focus events are requested from the terminal if supported and
3518 passed through to applications running in
3520 Attached clients should be detached and attached again after changing this
3522 .It Ic history-file Ar path
3523 If not empty, a file to which
3525 will write command prompt history on exit and load it from on start.
3526 .It Ic message-limit Ar number
3527 Set the number of error or information messages to save in the message log for
3529 .It Ic prompt-history-limit Ar number
3530 Set the number of history items to save in the history file for each type of
3532 .It Xo Ic set-clipboard
3533 .Op Ic on | external | off
3535 Attempt to set the terminal clipboard content using the
3537 escape sequence, if there is an
3541 description (see the
3542 .Sx TERMINFO EXTENSIONS
3548 will both accept the escape sequence to create a buffer and attempt to set
3549 the terminal clipboard.
3553 will attempt to set the terminal clipboard but ignore attempts
3554 by applications to set
3560 will neither accept the clipboard escape sequence nor attempt to set the
3563 Note that this feature needs to be enabled in
3565 by setting the resource:
3566 .Bd -literal -offset indent
3567 disallowedWindowOps: 20,21,SetXprop
3570 Or changing this property from the
3572 interactive menu when required.
3573 .It Ic terminal-features[] Ar string
3574 Set terminal features for terminal types read from
3577 has a set of named terminal features.
3578 Each will apply appropriate changes to the
3583 can detect features for a few common terminals; this option can be used to
3584 easily tell tmux about features supported by terminals it cannot detect.
3586 .Ic terminal-overrides
3587 option allows individual
3589 capabilities to be set instead,
3590 .Ic terminal-features
3591 is intended for classes of functionality supported in a standard way but not
3594 Care must be taken to configure this only with features the terminal actually
3597 This is an array option where each entry is a colon-separated string made up
3598 of a terminal type pattern (matched using
3600 followed by a list of terminal features.
3601 The available features are:
3604 Supports 256 colours with the SGR escape sequences.
3606 Allows setting the system clipboard.
3608 Allows setting the cursor colour.
3610 Allows setting the cursor style.
3612 Supports extended keys.
3614 Supports focus reporting.
3616 Supports DECSLRM margins.
3622 Supports the overline SGR attribute.
3624 Supports the DECFRA rectangle fill escape sequence.
3626 Supports RGB colour with the SGR escape sequences.
3628 Supports the strikethrough SGR escape sequence.
3630 Supports synchronized updates.
3636 Allows underscore style and colour to be set.
3638 .It Ic terminal-overrides[] Ar string
3639 Allow terminal descriptions read using
3642 Each entry is a colon-separated string made up of a terminal type pattern
3649 For example, to set the
3654 for all terminal types matching
3657 .Dl "rxvt*:clear=\ee[H\ee[2J"
3659 The terminal entry value is passed through
3661 before interpretation.
3662 .It Ic user-keys[] Ar key
3663 Set list of user-defined key escape sequences.
3664 Each item is associated with a key named
3670 .Bd -literal -offset indent
3671 set -s user-keys[0] "\ee[5;30012~"
3672 bind User0 resize-pane -L 3
3676 Available session options are:
3678 .It Xo Ic activity-action
3679 .Op Ic any | none | current | other
3681 Set action on window activity when
3682 .Ic monitor-activity
3685 means activity in any window linked to a session causes a bell or message
3687 .Ic visual-activity )
3688 in the current window of that session,
3690 means all activity is ignored (equivalent to
3691 .Ic monitor-activity
3694 means only activity in windows other than the current window are ignored and
3696 means activity in the current window is ignored but not those in other windows.
3697 .It Ic assume-paste-time Ar milliseconds
3698 If keys are entered faster than one in
3700 they are assumed to have been pasted rather than typed and
3702 key bindings are not processed.
3703 The default is one millisecond and zero disables.
3704 .It Ic base-index Ar index
3705 Set the base index from which an unused index should be searched when a new
3707 The default is zero.
3708 .It Xo Ic bell-action
3709 .Op Ic any | none | current | other
3711 Set action on a bell in a window when
3714 The values are the same as those for
3715 .Ic activity-action .
3716 .It Ic default-command Ar shell-command
3717 Set the command used for new windows (if not specified when the window is
3723 The default is an empty string, which instructs
3725 to create a login shell using the value of the
3728 .It Ic default-shell Ar path
3729 Specify the default shell.
3730 This is used as the login shell for new windows when the
3732 option is set to empty, and must be the full path of the executable.
3735 tries to set a default value from the first suitable of the
3737 environment variable, the shell returned by
3741 This option should be configured when
3743 is used as a login shell.
3744 .It Ic default-size Ar XxY
3745 Set the default size of new windows when the
3747 option is set to manual or when a session is created with
3750 The value is the width and height separated by an
3753 The default is 80x24.
3754 .It Xo Ic destroy-unattached
3757 If enabled and the session is no longer attached to any clients, it is
3759 .It Xo Ic detach-on-destroy
3760 .Op Ic off | on | no-detached
3762 If on (the default), the client is detached when the session it is attached to
3764 If off, the client is switched to the most recently active of the remaining
3768 the client is detached only if there are no detached sessions; if detached
3769 sessions exist, the client is switched to the most recently active.
3770 .It Ic display-panes-active-colour Ar colour
3771 Set the colour used by the
3773 command to show the indicator for the active pane.
3774 .It Ic display-panes-colour Ar colour
3775 Set the colour used by the
3777 command to show the indicators for inactive panes.
3778 .It Ic display-panes-time Ar time
3779 Set the time in milliseconds for which the indicators shown by the
3782 .It Ic display-time Ar time
3783 Set the amount of time for which status line messages and other on-screen
3784 indicators are displayed.
3785 If set to 0, messages and indicators are displayed until a key is pressed.
3788 .It Ic history-limit Ar lines
3789 Set the maximum number of lines held in window history.
3790 This setting applies only to new windows - existing window histories are not
3791 resized and retain the limit at the point they were created.
3792 .It Ic key-table Ar key-table
3793 Set the default key table to
3797 .It Ic lock-after-time Ar number
3798 Lock the session (like the
3802 seconds of inactivity.
3803 The default is not to lock (set to 0).
3804 .It Ic lock-command Ar shell-command
3805 Command to run when locking each client.
3806 The default is to run
3810 .It Ic message-command-style Ar style
3811 Set status line message command style.
3812 This is used for the command prompt with
3814 keys when in command mode.
3820 .It Ic message-style Ar style
3821 Set status line message style.
3822 This is used for messages and for the command prompt.
3833 captures the mouse and allows mouse events to be bound as key bindings.
3836 section for details.
3837 .It Ic prefix Ar key
3838 Set the key accepted as a prefix key.
3839 In addition to the standard keys described under
3842 can be set to the special key
3845 .It Ic prefix2 Ar key
3846 Set a secondary key accepted as a prefix key.
3852 .It Xo Ic renumber-windows
3855 If on, when a window is closed in a session, automatically renumber the other
3856 windows in numerical order.
3859 option if it has been set.
3860 If off, do not renumber the windows.
3861 .It Ic repeat-time Ar time
3862 Allow multiple commands to be entered without pressing the prefix-key again
3865 milliseconds (the default is 500).
3866 Whether a key repeats may be set when it is bound using the
3870 Repeat is enabled for the default keys bound to the
3873 .It Xo Ic set-titles
3876 Attempt to set the client terminal title using the
3881 entries if they exist.
3883 automatically sets these to the \ee]0;...\e007 sequence if
3884 the terminal appears to be
3886 This option is off by default.
3887 .It Ic set-titles-string Ar string
3888 String used to set the client terminal title if
3891 Formats are expanded, see the
3894 .It Xo Ic silence-action
3895 .Op Ic any | none | current | other
3897 Set action on window silence when
3900 The values are the same as those for
3901 .Ic activity-action .
3903 .Op Ic off | on | 2 | 3 | 4 | 5
3905 Show or hide the status line or specify its size.
3908 gives a status line one row in height;
3915 .It Ic status-format[] Ar format
3916 Specify the format to be used for each line of the status line.
3917 The default builds the top status line from the various individual status
3919 .It Ic status-interval Ar interval
3920 Update the status line every
3923 By default, updates will occur every 15 seconds.
3924 A setting of zero disables redrawing at interval.
3925 .It Xo Ic status-justify
3926 .Op Ic left | centre | right | absolute-centre
3928 Set the position of the window list in the status line: left, centre or right.
3929 centre puts the window list in the relative centre of the available free space;
3930 absolute-centre uses the centre of the entire horizontal space.
3931 .It Xo Ic status-keys
3934 Use vi or emacs-style
3935 key bindings in the status line, for example at the command prompt.
3936 The default is emacs, unless the
3940 environment variables are set and contain the string
3942 .It Ic status-left Ar string
3945 (by default the session name) to the left of the status line.
3947 will be passed through
3955 For details on how the names and titles can be set see the
3956 .Sx "NAMES AND TITLES"
3960 .Bd -literal -offset indent
3961 #(sysctl vm.loadavg)
3962 #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
3967 .It Ic status-left-length Ar length
3970 of the left component of the status line.
3972 .It Ic status-left-style Ar style
3973 Set the style of the left part of the status line.
3979 .It Xo Ic status-position
3982 Set the position of the status line.
3983 .It Ic status-right Ar string
3986 to the right of the status line.
3987 By default, the current pane title in double quotes, the date and the time
3994 and character pairs are replaced.
3995 .It Ic status-right-length Ar length
3998 of the right component of the status line.
4000 .It Ic status-right-style Ar style
4001 Set the style of the right part of the status line.
4007 .It Ic status-style Ar style
4008 Set status line style.
4014 .It Ic update-environment[] Ar variable
4015 Set list of environment variables to be copied into the session environment
4016 when a new session is created or an existing session is attached.
4017 Any variables that do not exist in the source environment are set to be
4018 removed from the session environment (as if
4023 .It Xo Ic visual-activity
4024 .Op Ic on | off | both
4026 If on, display a message instead of sending a bell when activity occurs in a
4027 window for which the
4028 .Ic monitor-activity
4029 window option is enabled.
4030 If set to both, a bell and a message are produced.
4031 .It Xo Ic visual-bell
4032 .Op Ic on | off | both
4034 If on, a message is shown on a bell in a window for which the
4036 window option is enabled instead of it being passed through to the
4037 terminal (which normally makes a sound).
4038 If set to both, a bell and a message are produced.
4042 .It Xo Ic visual-silence
4043 .Op Ic on | off | both
4047 is enabled, prints a message after the interval has expired on a given window
4048 instead of sending a bell.
4049 If set to both, a bell and a message are produced.
4050 .It Ic word-separators Ar string
4051 Sets the session's conception of what characters are considered word
4052 separators, for the purposes of the next and previous word commands in
4056 Available window options are:
4058 .Bl -tag -width Ds -compact
4059 .It Xo Ic aggressive-resize
4062 Aggressively resize the chosen window.
4065 will resize the window to the size of the smallest or largest session
4068 option) for which it is the current window, rather than the session to
4069 which it is attached.
4070 The window may resize when the current window is changed on another
4071 session; this option is good for full-screen programs which support
4073 and poor for interactive programs such as shells.
4075 .It Xo Ic automatic-rename
4078 Control automatic window renaming.
4079 When this setting is enabled,
4081 will rename the window automatically using the format specified by
4082 .Ic automatic-rename-format .
4083 This flag is automatically disabled for an individual window when a name
4084 is specified at creation with
4090 or with a terminal escape sequence.
4091 It may be switched off globally with:
4092 .Bd -literal -offset indent
4093 set-option -wg automatic-rename off
4096 .It Ic automatic-rename-format Ar format
4100 .Ic automatic-rename
4103 .It Ic clock-mode-colour Ar colour
4106 .It Xo Ic clock-mode-style
4109 Set clock hour format.
4111 .It Ic main-pane-height Ar height
4112 .It Ic main-pane-width Ar width
4113 Set the width or height of the main (left or top) pane in the
4120 this is a percentage of the window size.
4122 .It Ic copy-mode-match-style Ar style
4123 Set the style of search matches in copy mode.
4130 .It Ic copy-mode-mark-style Ar style
4131 Set the style of the line containing the mark in copy mode.
4138 .It Ic copy-mode-current-match-style Ar style
4139 Set the style of the current search match in copy mode.
4149 Use vi or emacs-style key bindings in copy mode.
4150 The default is emacs, unless
4157 .It Ic mode-style Ar style
4158 Set window modes style.
4165 .It Xo Ic monitor-activity
4168 Monitor for activity in the window.
4169 Windows with activity are highlighted in the status line.
4171 .It Xo Ic monitor-bell
4174 Monitor for a bell in the window.
4175 Windows with a bell are highlighted in the status line.
4177 .It Xo Ic monitor-silence
4180 Monitor for silence (no activity) in the window within
4183 Windows that have been silent for the interval are highlighted in the
4185 An interval of zero disables the monitoring.
4187 .It Ic other-pane-height Ar height
4188 Set the height of the other panes (not the main pane) in the
4191 If this option is set to 0 (the default), it will have no effect.
4193 .Ic main-pane-height
4195 .Ic other-pane-height
4196 options are set, the main pane will grow taller to make the other panes the
4197 specified height, but will never shrink to do so.
4200 this is a percentage of the window size.
4202 .It Ic other-pane-width Ar width
4204 .Ic other-pane-height ,
4205 but set the width of other panes in the
4209 .It Ic pane-active-border-style Ar style
4210 Set the pane border style for the currently active pane.
4216 Attributes are ignored.
4218 .It Ic pane-base-index Ar index
4221 but set the starting index for pane numbers.
4223 .It Ic pane-border-format Ar format
4224 Set the text shown in pane border status lines.
4226 .It Ic pane-border-lines Ar type
4227 Set the type of characters used for drawing pane borders.
4232 single lines using ACS or UTF-8 characters
4234 double lines using UTF-8 characters
4236 heavy lines using UTF-8 characters
4238 simple ASCII characters
4246 will fall back to standard ACS line drawing when UTF-8 is not supported.
4248 .It Xo Ic pane-border-status
4249 .Op Ic off | top | bottom
4251 Turn pane border status lines off or set their position.
4253 .It Ic pane-border-style Ar style
4254 Set the pane border style for panes aside from the active pane.
4260 Attributes are ignored.
4262 .It Ic popup-style Ar style
4263 Set the popup style.
4269 Attributes are ignored.
4271 .It Ic popup-border-style Ar style
4272 Set the popup border style.
4278 Attributes are ignored.
4280 .It Ic popup-border-lines Ar type
4281 Set the type of characters used for drawing popup borders.
4286 single lines using ACS or UTF-8 characters (default)
4288 variation of single with rounded corners using UTF-8 characters
4290 double lines using UTF-8 characters
4292 heavy lines using UTF-8 characters
4294 simple ASCII characters
4296 simple ASCII space character
4304 will fall back to standard ACS line drawing when UTF-8 is not supported.
4306 .It Ic window-status-activity-style Ar style
4307 Set status line style for windows with an activity alert.
4314 .It Ic window-status-bell-style Ar style
4315 Set status line style for windows with a bell alert.
4322 .It Ic window-status-current-format Ar string
4324 .Ar window-status-format ,
4325 but is the format used when the window is the current window.
4327 .It Ic window-status-current-style Ar style
4328 Set status line style for the currently active window.
4335 .It Ic window-status-format Ar string
4336 Set the format in which the window is displayed in the status line window list.
4343 .It Ic window-status-last-style Ar style
4344 Set status line style for the last active window.
4351 .It Ic window-status-separator Ar string
4352 Sets the separator drawn between windows in the status line.
4353 The default is a single space character.
4355 .It Ic window-status-style Ar style
4356 Set status line style for a single window.
4363 .It Xo Ic window-size
4364 .Ar largest | Ar smallest | Ar manual | Ar latest
4368 determines the window size.
4371 the size of the largest attached session is used; if
4373 the size of the smallest.
4376 the size of a new window is set from the
4378 option and windows are resized automatically.
4382 uses the size of the client that had the most recent activity.
4386 .Ic aggressive-resize
4389 .It Xo Ic wrap-search
4392 If this option is set, searches will wrap around the end of the pane contents.
4396 Available pane options are:
4398 .Bl -tag -width Ds -compact
4399 .It Xo Ic allow-rename
4402 Allow programs in the pane to change the window name using a terminal escape
4403 sequence (\eek...\ee\e\e).
4405 .It Xo Ic alternate-screen
4408 This option configures whether programs running inside the pane may use the
4409 terminal alternate screen feature, which allows the
4415 The alternate screen feature preserves the contents of the window when an
4416 interactive application starts and restores it on exit, so that any output
4417 visible before the application starts reappears unchanged after it exits.
4419 .It Ic cursor-colour Ar colour
4420 Set the colour of the cursor.
4422 .It Ic pane-colours[] Ar colour
4423 The default colour palette.
4424 Each entry in the array defines the colour
4426 uses when the colour with that index is requested.
4427 The index may be from zero to 255.
4429 .It Ic cursor-style Ar style
4430 Set the style of the cursor.
4431 Available styles are:
4433 .Ic blinking-block ,
4435 .Ic blinking-underline ,
4440 .It Xo Ic remain-on-exit
4441 .Op Ic on | off | failed
4443 A pane with this flag set is not destroyed when the program running in it
4447 then only when the program exit status is not zero.
4448 The pane may be reactivated with the
4452 .It Xo Ic synchronize-panes
4455 Duplicate input to all other panes in the same window where this option is also
4456 on (only for panes that are not in any mode).
4458 .It Ic window-active-style Ar style
4459 Set the pane style when it is the active pane.
4466 .It Ic window-style Ar style
4476 allows commands to run on various triggers, called
4482 hook and there are a number of hooks not associated with commands.
4484 Hooks are stored as array options, members of the array are executed in
4485 order when the hook is triggered.
4486 Like options different hooks may be global or belong to a session, window or pane.
4487 Hooks may be configured with the
4491 commands and displayed with
4496 The following two commands are equivalent:
4497 .Bd -literal -offset indent.
4498 set-hook -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4499 set-option -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4502 Setting a hook without specifying an array index clears the hook and sets the
4503 first member of the array.
4506 hook is run after it completes, except when the command is run as part of a hook
4508 They are named with an
4511 For example, the following command adds a hook to select the even-vertical
4514 .Bd -literal -offset indent
4515 set-hook -g after-split-window "selectl even-vertical"
4518 All the notifications listed in the
4520 section are hooks (without any arguments), except
4522 The following additional hooks are available:
4523 .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXX"
4525 Run when a window has activity.
4527 .Ic monitor-activity .
4529 Run when a window has received a bell.
4533 Run when a window has been silent.
4535 .Ic monitor-silence .
4537 Run when a client becomes the latest active client of its session.
4539 Run when a client is attached.
4541 Run when a client is detached
4543 Run when focus enters a client
4544 .It client-focus-out
4545 Run when focus exits a client
4547 Run when a client is resized.
4548 .It client-session-changed
4549 Run when a client's attached session is changed.
4551 Run when the program running in a pane exits, but
4553 is on so the pane has not closed.
4555 Run when the program running in a pane exits.
4557 Run when the focus enters a pane, if the
4561 Run when the focus exits a pane, if the
4564 .It pane-set-clipboard
4565 Run when the terminal clipboard is set using the
4569 Run when a new session created.
4571 Run when a session closed.
4573 Run when a session is renamed.
4575 Run when a window is linked into a session.
4577 Run when a window is renamed.
4579 Run when a window is unlinked from a session.
4582 Hooks are managed with these commands:
4586 .Op Fl t Ar target-pane
4598 The flags are the same as for
4606 .It Xo Ic show-hooks
4608 .Op Fl t Ar target-pane
4611 The flags are the same as for
4617 option is on (the default is off),
4619 allows mouse events to be bound as keys.
4620 The name of each key is made up of a mouse event (such as
4622 and a location suffix, one of the following:
4623 .Bl -column "XXXXXXXXXXXXX" -offset indent
4624 .It Li "Pane" Ta "the contents of a pane"
4625 .It Li "Border" Ta "a pane border"
4626 .It Li "Status" Ta "the status line window list"
4627 .It Li "StatusLeft" Ta "the left part of the status line"
4628 .It Li "StatusRight" Ta "the right part of the status line"
4629 .It Li "StatusDefault" Ta "any other part of the status line"
4632 The following mouse events are available:
4633 .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
4634 .It Li "WheelUp" Ta "WheelDown" Ta ""
4635 .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
4636 .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
4637 .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
4638 .It Li "SecondClick1" Ta "SecondClick2" Ta "SecondClick3"
4639 .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3"
4640 .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3"
4645 events are fired for the second click of a double click, even if there may be a
4646 third click which will fire
4651 Each should be suffixed with a location, for example
4652 .Ql MouseDown1Status .
4662 in commands bound to mouse key bindings.
4663 It resolves to the window or pane over which the mouse event took place
4664 (for example, the window in the status line over which button 1 was released for a
4666 binding, or the pane over which the wheel was scrolled for a
4673 flag may be used to forward a mouse event to a pane.
4675 The default key bindings allow the mouse to be used to select and resize panes,
4676 to copy text and to change window using the status line.
4677 These take effect if the
4679 option is turned on.
4681 Certain commands accept the
4686 This is a string which controls the output format of the command.
4687 Format variables are enclosed in
4692 .Ql #{session_name} .
4693 The possible variables are listed in the table below, or the name of a
4695 option may be used for an option's value.
4696 Some variables have a shorter alias such as
4699 is replaced by a single
4709 Conditionals are available by prefixing with
4711 and separating two alternatives with a comma;
4712 if the specified variable exists and is not zero, the first alternative
4713 is chosen, otherwise the second is used.
4715 .Ql #{?session_attached,attached,not attached}
4716 will include the string
4718 if the session is attached and the string
4720 if it is unattached, or
4721 .Ql #{?automatic-rename,yes,no}
4725 .Ic automatic-rename
4729 Conditionals can be nested arbitrarily.
4730 Inside a conditional,
4738 unless they are part of a
4742 .Bd -literal -offset indent
4743 #{?pane_in_mode,#[fg=white#,bg=red],#[fg=red#,bg=white]}#W .
4746 String comparisons may be expressed by prefixing two comma-separated
4757 .Ql #{==:#{host},myhost}
4767 evaluate to true if either or both of two comma-separated alternatives are
4769 .Ql #{||:#{pane_in_mode},#{alternate_on}} .
4775 or regular expression comparison.
4776 The first argument is the pattern and the second the string to compare.
4777 An optional argument specifies flags:
4779 means the pattern is a regular expression instead of the default
4783 means to ignore case.
4785 .Ql #{m:*foo*,#{host}}
4787 .Ql #{m/ri:^A,MYVAR} .
4790 performs a search for an
4792 pattern or regular expression in the pane content and evaluates to zero if not
4793 found, or a line number if found.
4798 flag means search for a regular expression and
4804 Numeric operators may be performed by prefixing two comma-separated alternatives with an
4809 flag may be given after the operator to use floating point numbers, otherwise integers are used.
4810 This may be followed by a number giving the number of decimal places to use for the result.
4811 The available operators are:
4828 in formats which are also expanded by
4830 and numeric comparison operators
4839 .Ql #{e|*|f|4:5.5,3}
4840 multiplies 5.5 by 3 for a result with four decimal places and
4842 returns the modulus of 7 and 3.
4844 replaces a numeric argument by its ASCII equivalent, so
4851 colour by its six-digit hexadecimal RGB value.
4853 A limit may be placed on the length of the resultant string by prefixing it
4856 a number and a colon.
4857 Positive numbers count from the start of the string and negative from the end,
4859 .Ql #{=5:pane_title}
4860 will include at most the first five characters of the pane title, or
4861 .Ql #{=-5:pane_title}
4862 the last five characters.
4863 A suffix or prefix may be given as a second argument - if provided then it is
4864 appended or prepended to the string if the length has been trimmed, for example
4865 .Ql #{=/5/...:pane_title}
4868 if the pane title is more than five characters.
4871 pads the string to a given width, for example
4872 .Ql #{p10:pane_title}
4873 will result in a width of at least 10 characters.
4874 A positive width pads on the left, a negative on the right.
4876 expands to the length of the variable and
4878 to its width when displayed, for example
4879 .Ql #{n:window_name} .
4881 Prefixing a time variable with
4883 will convert it to a string, so if
4884 .Ql #{window_activity}
4887 .Ql #{t:window_activity}
4889 .Ql Sun Oct 25 09:25:02 2015 .
4893 will use shorter but less accurate time format for times in the past.
4894 A custom format may be given using an
4900 if the format is separately being passed through
4905 .Ql #{t/f/%%H#:%%M:window_activity} ,
4917 of the variable respectively.
4921 special characters or with a
4923 suffix, escape hash characters (so
4928 will expand the format twice, for example
4929 .Ql #{E:status-left}
4930 is the result of expanding the content of the
4932 option rather than the option itself.
4943 will loop over each session, window or pane and insert the format once
4945 For windows and panes, two comma-separated formats may be given:
4946 the second is used for the current window or active pane.
4947 For example, to get a list of windows formatted like the status line:
4948 .Bd -literal -offset indent
4949 #{W:#{E:window-status-format} ,#{E:window-status-current-format} }
4953 checks if a window (without any suffix or with the
4955 suffix) or a session (with the
4957 suffix) name exists, for example
4959 is replaced with 1 if a window named
4963 A prefix of the form
4970 The first argument may be an extended regular expression and a final argument may be
4972 to ignore case, for example
4973 .Ql s/a(.)/\e1x/i:\&
4979 In addition, the last line of a shell command's output may be inserted using
4983 will insert the system's uptime.
4984 When constructing formats,
4988 commands to finish; instead, the previous result from running the same command is used,
4989 or a placeholder if the command has not been run before.
4990 If the command hasn't exited, the most recent line of output will be used, but the status
4991 line will not be updated more than once a second.
4992 Commands are executed with the
4994 global environment set (see the
4995 .Sx GLOBAL AND SESSION ENVIRONMENT
5000 specifies that a string should be interpreted literally and not expanded.
5002 .Ql #{l:#{?pane_in_mode,yes,no}}
5004 .Ql #{?pane_in_mode,yes,no} .
5006 The following variables are available, where appropriate:
5007 .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
5008 .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
5009 .It Li "active_window_index" Ta "" Ta "Index of active window in session"
5010 .It Li "alternate_on" Ta "" Ta "1 if pane is in alternate screen"
5011 .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
5012 .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
5013 .It Li "buffer_created" Ta "" Ta "Time buffer created"
5014 .It Li "buffer_name" Ta "" Ta "Name of buffer"
5015 .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
5016 .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
5017 .It Li "client_activity" Ta "" Ta "Time client last had activity"
5018 .It Li "client_cell_height" Ta "" Ta "Height of each client cell in pixels"
5019 .It Li "client_cell_width" Ta "" Ta "Width of each client cell in pixels"
5020 .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
5021 .It Li "client_created" Ta "" Ta "Time client created"
5022 .It Li "client_discarded" Ta "" Ta "Bytes discarded when client behind"
5023 .It Li "client_flags" Ta "" Ta "List of client flags"
5024 .It Li "client_height" Ta "" Ta "Height of client"
5025 .It Li "client_key_table" Ta "" Ta "Current key table"
5026 .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
5027 .It Li "client_name" Ta "" Ta "Name of client"
5028 .It Li "client_pid" Ta "" Ta "PID of client process"
5029 .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
5030 .It Li "client_readonly" Ta "" Ta "1 if client is readonly"
5031 .It Li "client_session" Ta "" Ta "Name of the client's session"
5032 .It Li "client_termfeatures" Ta "" Ta "Terminal features of client, if any"
5033 .It Li "client_termname" Ta "" Ta "Terminal name of client"
5034 .It Li "client_termtype" Ta "" Ta "Terminal type of client, if available"
5035 .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
5036 .It Li "client_utf8" Ta "" Ta "1 if client supports UTF-8"
5037 .It Li "client_width" Ta "" Ta "Width of client"
5038 .It Li "client_written" Ta "" Ta "Bytes written to client"
5039 .It Li "command" Ta "" Ta "Name of command in use, if any"
5040 .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
5041 .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
5042 .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
5043 .It Li "config_files" Ta "" Ta "List of configuration files loaded"
5044 .It Li "copy_cursor_line" Ta "" Ta "Line the cursor is on in copy mode"
5045 .It Li "copy_cursor_word" Ta "" Ta "Word under cursor in copy mode"
5046 .It Li "copy_cursor_x" Ta "" Ta "Cursor X position in copy mode"
5047 .It Li "copy_cursor_y" Ta "" Ta "Cursor Y position in copy mode"
5048 .It Li "current_file" Ta "" Ta "Current configuration file"
5049 .It Li "cursor_character" Ta "" Ta "Character at cursor in pane"
5050 .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
5051 .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
5052 .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
5053 .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
5054 .It Li "history_limit" Ta "" Ta "Maximum window history lines"
5055 .It Li "history_size" Ta "" Ta "Size of history in lines"
5056 .It Li "hook" Ta "" Ta "Name of running hook, if any"
5057 .It Li "hook_client" Ta "" Ta "Name of client where hook was run, if any"
5058 .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
5059 .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
5060 .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
5061 .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
5062 .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
5063 .It Li "host" Ta "#H" Ta "Hostname of local host"
5064 .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
5065 .It Li "insert_flag" Ta "" Ta "Pane insert flag"
5066 .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
5067 .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
5068 .It Li "last_window_index" Ta "" Ta "Index of last window in session"
5069 .It Li "line" Ta "" Ta "Line number in the list"
5070 .It Li "mouse_all_flag" Ta "" Ta "Pane mouse all flag"
5071 .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
5072 .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
5073 .It Li "mouse_line" Ta "" Ta "Line under mouse, if any"
5074 .It Li "mouse_sgr_flag" Ta "" Ta "Pane mouse SGR flag"
5075 .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
5076 .It Li "mouse_utf8_flag" Ta "" Ta "Pane mouse UTF-8 flag"
5077 .It Li "mouse_word" Ta "" Ta "Word under mouse, if any"
5078 .It Li "mouse_x" Ta "" Ta "Mouse X position, if any"
5079 .It Li "mouse_y" Ta "" Ta "Mouse Y position, if any"
5080 .It Li "origin_flag" Ta "" Ta "Pane origin flag"
5081 .It Li "pane_active" Ta "" Ta "1 if active pane"
5082 .It Li "pane_at_bottom" Ta "" Ta "1 if pane is at the bottom of window"
5083 .It Li "pane_at_left" Ta "" Ta "1 if pane is at the left of window"
5084 .It Li "pane_at_right" Ta "" Ta "1 if pane is at the right of window"
5085 .It Li "pane_at_top" Ta "" Ta "1 if pane is at the top of window"
5086 .It Li "pane_bg" Ta "" Ta "Pane background colour"
5087 .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
5088 .It Li "pane_current_command" Ta "" Ta "Current command if available"
5089 .It Li "pane_current_path" Ta "" Ta "Current path if available"
5090 .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
5091 .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
5092 .It Li "pane_fg" Ta "" Ta "Pane foreground colour"
5093 .It Li "pane_format" Ta "" Ta "1 if format is for a pane"
5094 .It Li "pane_height" Ta "" Ta "Height of pane"
5095 .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
5096 .It Li "pane_in_mode" Ta "" Ta "1 if pane is in a mode"
5097 .It Li "pane_index" Ta "#P" Ta "Index of pane"
5098 .It Li "pane_input_off" Ta "" Ta "1 if input to pane is disabled"
5099 .It Li "pane_last" Ta "" Ta "1 if last pane"
5100 .It Li "pane_left" Ta "" Ta "Left of pane"
5101 .It Li "pane_marked" Ta "" Ta "1 if this is the marked pane"
5102 .It Li "pane_marked_set" Ta "" Ta "1 if a marked pane is set"
5103 .It Li "pane_mode" Ta "" Ta "Name of pane mode, if any"
5104 .It Li "pane_path" Ta "" Ta "Path of pane (can be set by application)"
5105 .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
5106 .It Li "pane_pipe" Ta "" Ta "1 if pane is being piped"
5107 .It Li "pane_right" Ta "" Ta "Right of pane"
5108 .It Li "pane_search_string" Ta "" Ta "Last search string in copy mode"
5109 .It Li "pane_start_command" Ta "" Ta "Command pane started with"
5110 .It Li "pane_synchronized" Ta "" Ta "1 if pane is synchronized"
5111 .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
5112 .It Li "pane_title" Ta "#T" Ta "Title of pane (can be set by application)"
5113 .It Li "pane_top" Ta "" Ta "Top of pane"
5114 .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
5115 .It Li "pane_width" Ta "" Ta "Width of pane"
5116 .It Li "pid" Ta "" Ta "Server PID"
5117 .It Li "rectangle_toggle" Ta "" Ta "1 if rectangle selection is activated"
5118 .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
5119 .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
5120 .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
5121 .It Li "search_match" Ta "" Ta "Search match if any"
5122 .It Li "search_present" Ta "" Ta "1 if search started in copy mode"
5123 .It Li "selection_active" Ta "" Ta "1 if selection started and changes with the cursor in copy mode"
5124 .It Li "selection_end_x" Ta "" Ta "X position of the end of the selection"
5125 .It Li "selection_end_y" Ta "" Ta "Y position of the end of the selection"
5126 .It Li "selection_present" Ta "" Ta "1 if selection started in copy mode"
5127 .It Li "selection_start_x" Ta "" Ta "X position of the start of the selection"
5128 .It Li "selection_start_y" Ta "" Ta "Y position of the start of the selection"
5129 .It Li "session_activity" Ta "" Ta "Time of session last activity"
5130 .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
5131 .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
5132 .It Li "session_attached_list" Ta "" Ta "List of clients session is attached to"
5133 .It Li "session_created" Ta "" Ta "Time session created"
5134 .It Li "session_format" Ta "" Ta "1 if format is for a session"
5135 .It Li "session_group" Ta "" Ta "Name of session group"
5136 .It Li "session_group_attached" Ta "" Ta "Number of clients sessions in group are attached to"
5137 .It Li "session_group_attached_list" Ta "" Ta "List of clients sessions in group are attached to"
5138 .It Li "session_group_list" Ta "" Ta "List of sessions in group"
5139 .It Li "session_group_many_attached" Ta "" Ta "1 if multiple clients attached to sessions in group"
5140 .It Li "session_group_size" Ta "" Ta "Size of session group"
5141 .It Li "session_grouped" Ta "" Ta "1 if session in a group"
5142 .It Li "session_id" Ta "" Ta "Unique session ID"
5143 .It Li "session_last_attached" Ta "" Ta "Time session last attached"
5144 .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
5145 .It Li "session_marked" Ta "" Ta "1 if this session contains the marked pane"
5146 .It Li "session_name" Ta "#S" Ta "Name of session"
5147 .It Li "session_path" Ta "" Ta "Working directory of session"
5148 .It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
5149 .It Li "session_windows" Ta "" Ta "Number of windows in session"
5150 .It Li "socket_path" Ta "" Ta "Server socket path"
5151 .It Li "start_time" Ta "" Ta "Server start time"
5152 .It Li "version" Ta "" Ta "Server version"
5153 .It Li "window_active" Ta "" Ta "1 if window active"
5154 .It Li "window_active_clients" Ta "" Ta "Number of clients viewing this window"
5155 .It Li "window_active_clients_list" Ta "" Ta "List of clients viewing this window"
5156 .It Li "window_active_sessions" Ta "" Ta "Number of sessions on which this window is active"
5157 .It Li "window_active_sessions_list" Ta "" Ta "List of sessions on which this window is active"
5158 .It Li "window_activity" Ta "" Ta "Time of window last activity"
5159 .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
5160 .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
5161 .It Li "window_bigger" Ta "" Ta "1 if window is larger than client"
5162 .It Li "window_cell_height" Ta "" Ta "Height of each cell in pixels"
5163 .It Li "window_cell_width" Ta "" Ta "Width of each cell in pixels"
5164 .It Li "window_end_flag" Ta "" Ta "1 if window has the highest index"
5165 .It Li "window_flags" Ta "#F" Ta "Window flags with # escaped as ##"
5166 .It Li "window_raw_flags" Ta "" Ta "Window flags with nothing escaped"
5167 .It Li "window_format" Ta "" Ta "1 if format is for a window"
5168 .It Li "window_height" Ta "" Ta "Height of window"
5169 .It Li "window_id" Ta "" Ta "Unique window ID"
5170 .It Li "window_index" Ta "#I" Ta "Index of window"
5171 .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
5172 .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
5173 .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
5174 .It Li "window_linked_sessions" Ta "" Ta "Number of sessions this window is linked to"
5175 .It Li "window_linked_sessions_list" Ta "" Ta "List of sessions this window is linked to"
5176 .It Li "window_marked_flag" Ta "" Ta "1 if window contains the marked pane"
5177 .It Li "window_name" Ta "#W" Ta "Name of window"
5178 .It Li "window_offset_x" Ta "" Ta "X offset into window if larger than client"
5179 .It Li "window_offset_y" Ta "" Ta "Y offset into window if larger than client"
5180 .It Li "window_panes" Ta "" Ta "Number of panes in window"
5181 .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
5182 .It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
5183 .It Li "window_start_flag" Ta "" Ta "1 if window has the lowest index"
5184 .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
5185 .It Li "window_width" Ta "" Ta "Width of window"
5186 .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
5187 .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
5191 offers various options to specify the colour and attributes of aspects of the
5192 interface, for example
5194 for the status line.
5195 In addition, embedded styles may be specified in format options, such as
5197 by enclosing them in
5202 A style may be the single term
5204 to specify the default style (which may come from an option, for example
5206 in the status line) or a space
5207 or comma separated list of the following:
5210 Set the foreground colour.
5211 The colour is one of:
5220 if supported the bright variants
5227 from the 256-colour set;
5229 for the default colour;
5231 for the terminal default colour; or a hexadecimal RGB string such as
5234 Set the background colour.
5236 Set no attributes (turn off any active attributes).
5249 .Ic double-underscore ,
5250 .Ic curly-underscore ,
5251 .Ic dotted-underscore ,
5252 .Ic dashed-underscore
5255 Any of the attributes may be prefixed with
5259 is the terminal alternate character set.
5260 .It Xo Ic align=left
5266 Align text to the left, centre or right of the available space if appropriate.
5268 Fill the available space with a background colour if appropriate.
5271 .Ic list=left-marker ,
5272 .Ic list=right-marker ,
5275 Mark the position of the various window list components in the
5279 marks the start of the list;
5281 is the part of the list that should be kept in focus if the entire list won't fit
5282 in the available space (typically the current window);
5283 .Ic list=left-marker
5285 .Ic list=right-marker
5286 mark the text to be used to mark that text has been trimmed from the left or
5287 right of the list if there is not enough space.
5288 .It Xo Ic push-default ,
5291 Store the current colours and attributes as the default or reset to the previous
5295 affects any subsequent use of the
5299 Only one default may be pushed (each
5301 replaces the previous saved default).
5302 .It Xo Ic range=left ,
5304 .Ic range=window|X ,
5313 are the text used for the
5319 is the range for a window passed to the
5327 .Bd -literal -offset indent
5328 fg=yellow bold underscore blink
5329 bg=black,fg=default,noreverse
5331 .Sh NAMES AND TITLES
5333 distinguishes between names and titles.
5334 Windows and sessions have names, which may be used to specify them in targets
5335 and are displayed in the status line and various lists: the name is the
5337 identifier for a window or session.
5338 Only panes have titles.
5339 A pane's title is typically set by the program running inside the pane using
5340 an escape sequence (like it would set the
5344 Windows themselves do not have titles - a window's title is the title of its
5347 itself may set the title of the terminal in which the client is running, see
5352 A session's name is set with the
5357 A window's name is set with one of:
5360 A command argument (such as
5367 An escape sequence (if the
5369 option is turned on):
5370 .Bd -literal -offset indent
5371 $ printf '\e033kWINDOW_NAME\e033\e\e'
5374 Automatic renaming, which sets the name to the active command in the window's
5377 .Ic automatic-rename
5381 When a pane is first created, its title is the hostname.
5382 A pane's title can be set via the title setting escape sequence, for example:
5383 .Bd -literal -offset indent
5384 $ printf '\e033]2;My Title\e033\e\e'
5387 It can also be modified with the
5391 .Sh GLOBAL AND SESSION ENVIRONMENT
5392 When the server is started,
5394 copies the environment into the
5395 .Em global environment ;
5396 in addition, each session has a
5397 .Em session environment .
5398 When a window is created, the session and global environments are merged.
5399 If a variable exists in both, the value from the session environment is used.
5400 The result is the initial environment passed to the new process.
5403 .Ic update-environment
5404 session option may be used to update the session environment from the client
5405 when a new session is created or an old reattached.
5407 also initialises the
5409 variable with some internal information to allow commands to be executed
5410 from inside, and the
5412 variable with the correct terminal setting of
5415 Variables in both session and global environments may be marked as hidden.
5416 Hidden variables are not passed into the environment of new processes and
5417 instead can only be used by tmux itself (for example in formats, see the
5421 Commands to alter and view the environment are:
5424 .It Xo Ic set-environment
5426 .Op Fl t Ar target-session
5427 .Ar name Op Ar value
5429 .D1 Pq alias: Ic setenv
5430 Set or unset an environment variable.
5433 is used, the change is made in the global environment; otherwise, it is applied
5434 to the session environment for
5435 .Ar target-session .
5440 is expanded as a format.
5443 flag unsets a variable.
5445 indicates the variable is to be removed from the environment before starting a
5448 marks the variable as hidden.
5450 .It Xo Ic show-environment
5452 .Op Fl t Ar target-session
5455 .D1 Pq alias: Ic showenv
5456 Display the environment for
5458 or the global environment with
5462 is omitted, all variables are shown.
5463 Variables removed from the environment are prefixed with
5467 is used, the output is formatted as a set of Bourne shell commands.
5469 shows hidden variables (omitted by default).
5473 includes an optional status line which is displayed in the bottom line of each
5476 By default, the status line is enabled and one line in height (it may be
5477 disabled or made multiple lines with the
5479 session option) and contains, from left-to-right: the name of the current
5480 session in square brackets; the window list; the title of the active pane
5481 in double quotes; and the time and date.
5483 Each line of the status line is configured with the
5486 The default is made of three parts: configurable left and right sections (which
5487 may contain dynamic content such as the time or output from a shell command,
5490 .Ic status-left-length ,
5493 .Ic status-right-length
5494 options below), and a central window list.
5495 By default, the window list shows the index, name and (if any) flag of the
5496 windows present in the current session in ascending numerical order.
5497 It may be customised with the
5498 .Ar window-status-format
5500 .Ar window-status-current-format
5502 The flag is one of the following symbols appended to the window name:
5503 .Bl -column "Symbol" "Meaning" -offset indent
5504 .It Sy "Symbol" Ta Sy "Meaning"
5505 .It Li "*" Ta "Denotes the current window."
5506 .It Li "-" Ta "Marks the last window (previously selected)."
5507 .It Li "#" Ta "Window activity is monitored and activity has been detected."
5508 .It Li "\&!" Ta "Window bells are monitored and a bell has occurred in the window."
5509 .It Li "~" Ta "The window has been silent for the monitor-silence interval."
5510 .It Li "M" Ta "The window contains the marked pane."
5511 .It Li "Z" Ta "The window's active pane is zoomed."
5514 The # symbol relates to the
5515 .Ic monitor-activity
5517 The window name is printed in inverted colours if an alert (bell, activity or
5518 silence) is present.
5520 The colour and attributes of the status line may be configured, the entire
5521 status line using the
5523 session option and individual windows using the
5524 .Ic window-status-style
5527 The status line is automatically refreshed at interval if it has changed, the
5528 interval may be controlled with the
5532 Commands related to the status line are as follows:
5535 .It Xo Ic clear-prompt-history
5536 .Op Fl T Ar prompt-type
5538 .D1 Pq alias: Ic clrphist
5539 Clear status prompt history for prompt type
5543 is omitted, then clear history for all types.
5546 for possible values for
5548 .It Xo Ic command-prompt
5552 .Op Fl t Ar target-client
5553 .Op Fl T Ar prompt-type
5556 Open the command prompt in a client.
5557 This may be used from inside
5559 to execute commands interactively.
5563 is specified, it is used as the command.
5567 is expanded as a format.
5571 is a comma-separated list of the initial text for each prompt.
5576 is a comma-separated list of prompts which are displayed in order; otherwise
5577 a single prompt is displayed, constructed from
5579 if it is present, or
5583 Before the command is executed, the first occurrence of the string
5585 and all occurrences of
5587 are replaced by the response to the first prompt, all
5589 are replaced with the response to the second prompt, and so on for further
5591 Up to nine prompt responses may be replaced
5600 but any quotation marks are escaped.
5603 makes the prompt only accept one key press, in this case the resulting input
5604 is a single character.
5608 but the key press is translated to a key name.
5610 makes the prompt only accept numeric key presses.
5612 executes the command every time the prompt input changes instead of when the
5613 user exits the command prompt.
5619 This affects what completions are offered when
5622 Available types are:
5629 The following keys have a special meaning in the command prompt, depending
5633 .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
5634 .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
5635 .It Li "Cancel command prompt" Ta "q" Ta "Escape"
5636 .It Li "Delete from cursor to start of word" Ta "" Ta "C-w"
5637 .It Li "Delete entire command" Ta "d" Ta "C-u"
5638 .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
5639 .It Li "Execute command" Ta "Enter" Ta "Enter"
5640 .It Li "Get next command from history" Ta "" Ta "Down"
5641 .It Li "Get previous command from history" Ta "" Ta "Up"
5642 .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
5643 .It Li "Look for completions" Ta "Tab" Ta "Tab"
5644 .It Li "Move cursor left" Ta "h" Ta "Left"
5645 .It Li "Move cursor right" Ta "l" Ta "Right"
5646 .It Li "Move cursor to end" Ta "$" Ta "C-e"
5647 .It Li "Move cursor to next word" Ta "w" Ta "M-f"
5648 .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
5649 .It Li "Move cursor to start" Ta "0" Ta "C-a"
5650 .It Li "Transpose characters" Ta "" Ta "C-t"
5655 the prompt is shown in the background and the invoking client does not exit
5656 until it is dismissed.
5658 .It Xo Ic confirm-before
5661 .Op Fl t Ar target-client
5664 .D1 Pq alias: Ic confirm
5665 Ask for confirmation before executing
5671 is the prompt to display; otherwise a prompt is constructed from
5673 It may contain the special character sequences supported by the
5678 the prompt is shown in the background and the invoking client does not exit
5679 until it is dismissed.
5681 .It Xo Ic display-menu
5683 .Op Fl c Ar target-client
5684 .Op Fl t Ar target-pane
5686 .Op Fl x Ar position
5687 .Op Fl y Ar position
5693 .D1 Pq alias: Ic menu
5697 gives the target for any commands run from the menu.
5699 A menu is passed as a series of arguments: first the menu item name,
5700 second the key shortcut (or empty for none) and third the command
5701 to run when the menu item is chosen.
5702 The name and command are formats, see the
5707 If the name begins with a hyphen (-), then the item is disabled (shown dim) and
5709 The name may be empty for a separator line, in which case both the key and
5710 command should be omitted.
5713 is a format for the menu title (see
5719 give the position of the menu.
5720 Both may be a row or column number, or one of the following special values:
5721 .Bl -column "XXXXX" "XXXX" -offset indent
5722 .It Sy "Value" Ta Sy "Flag" Ta Sy "Meaning"
5723 .It Li "C" Ta "Both" Ta "The centre of the terminal"
5724 .It Li "R" Ta Fl x Ta "The right side of the terminal"
5725 .It Li "P" Ta "Both" Ta "The bottom left of the pane"
5726 .It Li "M" Ta "Both" Ta "The mouse position"
5727 .It Li "W" Ta "Both" Ta "The window position on the status line"
5728 .It Li "S" Ta Fl y Ta "The line above or below the status line"
5731 Or a format, which is expanded including the following additional variables:
5732 .Bl -column "XXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent
5733 .It Sy "Variable name" Ta Sy "Replaced with"
5734 .It Li "popup_centre_x" Ta "Centered in the client"
5735 .It Li "popup_centre_y" Ta "Centered in the client"
5736 .It Li "popup_height" Ta "Height of menu or popup"
5737 .It Li "popup_mouse_bottom" Ta "Bottom of at the mouse"
5738 .It Li "popup_mouse_centre_x" Ta "Horizontal centre at the mouse"
5739 .It Li "popup_mouse_centre_y" Ta "Vertical centre at the mouse"
5740 .It Li "popup_mouse_top" Ta "Top at the mouse"
5741 .It Li "popup_mouse_x" Ta "Mouse X position"
5742 .It Li "popup_mouse_y" Ta "Mouse Y position"
5743 .It Li "popup_pane_bottom" Ta "Bottom of the pane"
5744 .It Li "popup_pane_left" Ta "Left of the pane"
5745 .It Li "popup_pane_right" Ta "Right of the pane"
5746 .It Li "popup_pane_top" Ta "Top of the pane"
5747 .It Li "popup_status_line_y" Ta "Above or below the status line"
5748 .It Li "popup_width" Ta "Width of menu or popup"
5749 .It Li "popup_window_status_line_x" Ta "At the window position in status line"
5750 .It Li "popup_window_status_line_y" Ta "At the status line showing the window"
5753 Each menu consists of items followed by a key shortcut shown in brackets.
5754 If the menu is too large to fit on the terminal, it is not displayed.
5755 Pressing the key shortcut chooses the corresponding item.
5756 If the mouse is enabled and the menu is opened from a mouse key binding,
5757 releasing the mouse button with an item selected chooses that item and
5758 releasing the mouse button without an item selected closes the menu.
5760 changes this behaviour so that the menu does not close when the mouse button is
5761 released without an item selected the menu is not closed and a mouse button
5762 must be clicked to choose an item.
5764 The following keys are also available:
5765 .Bl -column "Key" "Function" -offset indent
5766 .It Sy "Key" Ta Sy "Function"
5767 .It Li "Enter" Ta "Choose selected item"
5768 .It Li "Up" Ta "Select previous item"
5769 .It Li "Down" Ta "Select next item"
5770 .It Li "q" Ta "Exit menu"
5773 .It Xo Ic display-message
5775 .Op Fl c Ar target-client
5777 .Op Fl t Ar target-pane
5780 .D1 Pq alias: Ic display
5784 is given, the output is printed to stdout, otherwise it is displayed in the
5786 status line for up to
5793 option is used; a delay of zero waits for a key press.
5795 ignores key presses and closes only after the delay expires.
5800 section; information is taken from
5804 is given, otherwise the active pane.
5807 prints verbose logging as the format is parsed and
5809 lists the format variables and their values.
5812 forwards any input read from stdin to the empty pane given by
5815 .It Xo Ic display-popup
5817 .Op Fl b Ar border-lines
5818 .Op Fl c Ar target-client
5819 .Op Fl d Ar start-directory
5820 .Op Fl e Ar environment
5823 .Op Fl S Ar border-style
5824 .Op Fl t Ar target-pane
5827 .Op Fl x Ar position
5828 .Op Fl y Ar position
5829 .Op Ar shell-command
5831 .D1 Pq alias: Ic popup
5832 Display a popup running
5836 A popup is a rectangular box drawn over the top of any panes.
5837 Panes are not updated while a popup is present.
5840 closes the popup automatically when
5845 closes the popup only if
5847 exited with success.
5852 give the position of the popup, they have the same meaning as for the
5858 give the width and height - both may be a percentage (followed by
5860 If omitted, half of the terminal size is used.
5863 does not surround the popup by a border.
5866 sets the type of border line for the popup.
5873 .Ic popup-border-lines
5874 for possible values for
5878 sets the style for the popup and
5880 sets the style for the popup border.
5890 and sets an environment variable for the popup; it may be specified multiple
5894 is a format for the popup title (see
5899 flag closes any popup on the client.
5901 .It Xo Ic show-prompt-history
5902 .Op Fl T Ar prompt-type
5904 .D1 Pq alias: Ic showphist
5905 Display status prompt history for prompt type
5909 is omitted, then show history for all types.
5912 for possible values for
5917 maintains a set of named
5919 Each buffer may be either explicitly or automatically named.
5920 Explicitly named buffers are named when created with the
5924 commands, or by renaming an automatically named buffer with
5927 Automatically named buffers are given a name such as
5933 option is reached, the oldest automatically named buffer is deleted.
5934 Explicitly named buffers are not subject to
5936 and may be deleted with the
5940 Buffers may be added using
5946 commands, and pasted into a window using the
5949 If a buffer command is used and no buffer is specified, the most
5950 recently added automatically named buffer is assumed.
5952 A configurable history buffer is also maintained for each window.
5953 By default, up to 2000 lines are kept; this can be altered with the
5959 The buffer commands are as follows:
5966 .Op Fl K Ar key-format
5967 .Op Fl O Ar sort-order
5968 .Op Fl t Ar target-pane
5971 Put a pane into buffer mode, where a buffer may be chosen interactively from
5973 Each buffer is shown on one line.
5974 A shortcut key is shown on the left in brackets allowing for immediate choice,
5975 or the list may be navigated and an item chosen or otherwise manipulated using
5979 The following keys may be used in buffer mode:
5980 .Bl -column "Key" "Function" -offset indent
5981 .It Sy "Key" Ta Sy "Function"
5982 .It Li "Enter" Ta "Paste selected buffer"
5983 .It Li "Up" Ta "Select previous buffer"
5984 .It Li "Down" Ta "Select next buffer"
5985 .It Li "C-s" Ta "Search by name or content"
5986 .It Li "n" Ta "Repeat last search"
5987 .It Li "t" Ta "Toggle if buffer is tagged"
5988 .It Li "T" Ta "Tag no buffers"
5989 .It Li "C-t" Ta "Tag all buffers"
5990 .It Li "p" Ta "Paste selected buffer"
5991 .It Li "P" Ta "Paste tagged buffers"
5992 .It Li "d" Ta "Delete selected buffer"
5993 .It Li "D" Ta "Delete tagged buffers"
5994 .It Li "e" Ta "Open the buffer in an editor"
5995 .It Li "f" Ta "Enter a format to filter items"
5996 .It Li "O" Ta "Change sort field"
5997 .It Li "r" Ta "Reverse sort order"
5998 .It Li "v" Ta "Toggle preview"
5999 .It Li "q" Ta "Exit mode"
6002 After a buffer is chosen,
6004 is replaced by the buffer name in
6006 and the result executed as a command.
6009 is not given, "paste-buffer -b '%%'" is used.
6012 specifies the initial sort field: one of
6018 reverses the sort order.
6020 specifies an initial filter: the filter is a format - if it evaluates to zero,
6021 the item in the list is not shown, otherwise it is shown.
6022 If a filter would lead to an empty list, it is ignored.
6024 specifies the format for each item in the list and
6026 a format for each shortcut key; both are evaluated once for each line.
6028 starts without the preview.
6029 This command works only if at least one client is attached.
6031 .It Ic clear-history Op Fl t Ar target-pane
6032 .D1 Pq alias: Ic clearhist
6033 Remove and free the history for the specified pane.
6035 .It Ic delete-buffer Op Fl b Ar buffer-name
6036 .D1 Pq alias: Ic deleteb
6037 Delete the buffer named
6039 or the most recently added automatically named buffer if not specified.
6041 .It Xo Ic list-buffers
6045 .D1 Pq alias: Ic lsb
6046 List the global buffers.
6048 specifies the format of each line and
6051 Only buffers for which the filter is true are shown.
6055 .It Xo Ic load-buffer
6057 .Op Fl b Ar buffer-name
6058 .Op Fl t Ar target-client
6062 .D1 Pq alias: Ic loadb
6063 Load the contents of the specified paste buffer from
6067 is given, the buffer is also sent to the clipboard for
6071 escape sequence, if possible.
6073 .It Xo Ic paste-buffer
6075 .Op Fl b Ar buffer-name
6076 .Op Fl s Ar separator
6077 .Op Fl t Ar target-pane
6079 .D1 Pq alias: Ic pasteb
6080 Insert the contents of a paste buffer into the specified pane.
6081 If not specified, paste into the current one.
6084 also delete the paste buffer.
6085 When output, any linefeed (LF) characters in the paste buffer are replaced with
6086 a separator, by default carriage return (CR).
6087 A custom separator may be specified using the
6092 flag means to do no replacement (equivalent to a separator of LF).
6095 is specified, paste bracket control codes are inserted around the
6096 buffer if the application has requested bracketed paste mode.
6098 .It Xo Ic save-buffer
6100 .Op Fl b Ar buffer-name
6103 .D1 Pq alias: Ic saveb
6104 Save the contents of the specified paste buffer to
6108 option appends to rather than overwriting the file.
6109 .It Xo Ic set-buffer
6111 .Op Fl b Ar buffer-name
6112 .Op Fl t Ar target-client
6114 .Op Fl n Ar new-buffer-name
6117 .D1 Pq alias: Ic setb
6118 Set the contents of the specified buffer to
6122 is given, the buffer is also sent to the clipboard for
6126 escape sequence, if possible.
6129 option appends to rather than overwriting the buffer.
6132 option renames the buffer to
6133 .Ar new-buffer-name .
6135 .It Xo Ic show-buffer
6136 .Op Fl b Ar buffer-name
6138 .D1 Pq alias: Ic showb
6139 Display the contents of the specified buffer.
6142 Miscellaneous commands are as follows:
6144 .It Ic clock-mode Op Fl t Ar target-pane
6145 Display a large clock.
6149 .Op Fl t Ar target-pane
6150 .Ar shell-command command
6158 returns success or the second
6161 Before being executed,
6163 is expanded using the rules specified in the
6165 section, including those relevant to
6170 is run in the background.
6176 is not executed but considered success if neither empty nor zero (after formats
6180 .D1 Pq alias: Ic lock
6181 Lock each client individually by running the command specified by the
6188 .Op Fl t Ar target-pane
6189 .Op Ar shell-command
6191 .D1 Pq alias: Ic run
6198 command in the background without creating a window.
6199 Before being executed,
6201 is expanded using the rules specified in the
6206 the command is run in the background.
6210 seconds before starting the command.
6213 is not given, any output to stdout is displayed in view mode (in the pane
6216 or the current pane if omitted) after the command finishes.
6217 If the command fails, the exit status is also displayed.
6223 .D1 Pq alias: Ic wait
6224 When used without options, prevents the client from exiting until woken using
6227 with the same channel.
6230 is used, the channel is locked and any clients that try to lock the same
6231 channel are made to wait until the channel is unlocked with
6238 client detaches, it prints a message.
6241 .It detached (from session ...)
6242 The client was detached normally.
6243 .It detached and SIGHUP
6244 The client was detached and its parent sent the
6246 signal (for example with
6254 was unexpectedly destroyed.
6256 The client was killed with
6259 The client is in control mode and became unable to keep up with the data from
6262 The server exited when it had no sessions.
6264 The server exited when it received
6266 .It server exited unexpectedly
6267 The server crashed or otherwise exited without telling the client the reason.
6269 .Sh TERMINFO EXTENSIONS
6271 understands some unofficial extensions to
6273 It is not normally necessary to set these manually, instead the
6274 .Ic terminal-features
6275 option should be used.
6278 An existing extension that tells
6280 the terminal supports default colours.
6284 that the terminal supports the VTE bidirectional text extensions.
6286 Set the cursor colour.
6287 The first takes a single string argument and is used to set the colour;
6288 the second takes no arguments and restores the default cursor colour.
6289 If set, a sequence such as this may be used
6290 to change the cursor colour from inside
6292 .Bd -literal -offset indent
6293 $ printf '\e033]12;red\e033\e\e'
6300 .It Em \&Cmg, \&Clmg, \&Dsmg , \&Enmg
6301 Set, clear, disable or enable DECSLRM margins.
6302 These are set automatically if the terminal reports it is
6305 .It Em \&Dsbp , \&Enbp
6306 Disable and enable bracketed paste.
6307 These are set automatically if the
6309 capability is present.
6310 .It Em \&Dseks , \&Eneks
6311 Disable and enable extended keys.
6312 .It Em \&Dsfcs , \&Enfcs
6313 Disable and enable focus reporting.
6314 These are set automatically if the
6316 capability is present.
6320 that the terminal supports rectangle operations.
6322 Enable the overline attribute.
6324 Set a styled underscore.
6325 The single parameter is one of: 0 for no underscore, 1 for normal
6326 underscore, 2 for double underscore, 3 for curly underscore, 4 for dotted
6327 underscore and 5 for dashed underscore.
6328 .It Em \&Setulc , \&ol
6329 Set the underscore colour or reset to the default.
6330 The argument is (red * 65536) + (green * 256) + blue where each is between 0
6333 Set or reset the cursor style.
6334 If set, a sequence such as this may be used
6335 to change the cursor to an underline:
6336 .Bd -literal -offset indent
6337 $ printf '\e033[4 q'
6342 is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
6344 Start (parameter is 1) or end (parameter is 2) a synchronized update.
6346 Indicate that the terminal supports the
6348 RGB escape sequence (for example, \ee[38;2;255;255;255m).
6350 If supported, this is used for the initialize colour escape sequence (which
6351 may be enabled by adding the
6360 This is equivalent to the
6365 Store the current buffer in the host terminal's selection (clipboard).
6368 option above and the
6372 This is an existing extension capability that tmux uses to mean that the
6373 terminal supports the
6375 title set sequences and to automatically set some of the capabilities above.
6379 offers a textual interface called
6381 This allows applications to communicate with
6383 using a simple text-only protocol.
6385 In control mode, a client sends
6387 commands or command sequences terminated by newlines on standard input.
6388 Each command will produce one block of output on standard output.
6389 An output block consists of a
6391 line followed by the output (which may be empty).
6392 The output block ends with a
6401 have three arguments: an integer time (as seconds from epoch), command number and
6402 flags (currently not used).
6404 .Bd -literal -offset indent
6405 %begin 1363006971 2 1
6406 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
6413 command may be used to set the size of a client in control mode.
6417 outputs notifications.
6418 A notification will never occur inside an output block.
6420 The following notifications are defined:
6422 .It Ic %client-detached Ar client
6423 The client has detached.
6424 .It Ic %client-session-changed Ar client session-id name
6425 The client is now attached to the session with ID
6429 .It Ic %continue Ar pane-id
6430 The pane has been continued after being paused (if the
6435 .It Ic %exit Op Ar reason
6438 client is exiting immediately, either because it is not attached to any session
6439 or an error occurred.
6442 describes why the client exited.
6443 .It Ic %extended-output Ar pane-id Ar age Ar ... \& : Ar value
6450 is the time in milliseconds for which tmux had buffered the output before it was sent.
6451 Any subsequent arguments up until a single
6453 are for future use and should be ignored.
6454 .It Ic %layout-change Ar window-id Ar window-layout Ar window-visible-layout Ar window-flags
6455 The layout of a window with ID
6460 The window's visible layout is
6461 .Ar window-visible-layout
6462 and the window flags are
6464 .It Ic %output Ar pane-id Ar value
6465 A window pane produced output.
6467 escapes non-printable characters and backslash as octal \\xxx.
6468 .It Ic %pane-mode-changed Ar pane-id
6472 .It Ic %pause Ar pane-id
6473 The pane has been paused (if the
6476 .It Ic %session-changed Ar session-id Ar name
6477 The client is now attached to the session with ID
6481 .It Ic %session-renamed Ar name
6482 The current session was renamed to
6484 .It Ic %session-window-changed Ar session-id Ar window-id
6487 changed its active window to the window with ID
6489 .It Ic %sessions-changed
6490 A session was created or destroyed.
6491 .It Xo Ic %subscription-changed
6496 .Ar pane-id ... \& :
6499 The value of the format associated with subscription
6510 are for future use and should be ignored.
6511 .It Ic %unlinked-window-add Ar window-id
6514 was created but is not linked to the current session.
6515 .It Ic %unlinked-window-close Ar window-id
6518 which is not linked to the current session, was closed.
6519 .It Ic %unlinked-window-renamed Ar window-id
6522 which is not linked to the current session, was renamed.
6523 .It Ic %window-add Ar window-id
6526 was linked to the current session.
6527 .It Ic %window-close Ar window-id
6531 .It Ic %window-pane-changed Ar window-id Ar pane-id
6532 The active pane in the window with ID
6534 changed to the pane with ID
6536 .It Ic %window-renamed Ar window-id Ar name
6545 is started, it inspects the following environment variables:
6546 .Bl -tag -width LC_CTYPE
6548 If the command specified in this variable contains the string
6552 is unset, use vi-style key bindings.
6559 The user's login directory.
6562 database is consulted.
6564 The character encoding
6566 It is used for two separate purposes.
6567 For output to the terminal, UTF-8 is used if the
6569 option is given or if
6575 Otherwise, only ASCII characters are written and non-ASCII characters
6576 are replaced with underscores
6580 always runs with a UTF-8 locale.
6581 If en_US.UTF-8 is provided by the operating system it is used and
6583 is ignored for input.
6588 what the UTF-8 locale is called on the current system.
6589 If the locale specified by
6591 is not available or is not a UTF-8 locale,
6593 exits with an error message.
6595 The date and time format
6597 It is used for locale-dependent
6601 The current working directory to be set in the global environment.
6602 This may be useful if it contains symbolic links.
6603 If the value of the variable does not match the current working
6604 directory, the variable is ignored and the result of
6608 The absolute path to the default shell for new windows.
6613 The parent directory of the directory containing the server sockets.
6618 If the command specified in this variable contains the string
6620 use vi-style key bindings.
6628 .Bl -tag -width "/etc/tmux.confXXX" -compact
6633 .It Pa /etc/tmux.conf
6634 System-wide configuration file.
6642 .Dl $ tmux new-session vi
6644 Most commands have a shorter form, known as an alias.
6645 For new-session, this is
6650 Alternatively, the shortest unambiguous form of a command is accepted.
6651 If there are several options, they are listed:
6652 .Bd -literal -offset indent
6654 ambiguous command: n, could be: new-session, new-window, next-window
6657 Within an active session, a new window may be created by typing
6667 Windows may be navigated with:
6669 (to select window 0),
6671 (to select window 1), and so on;
6673 to select the next window; and
6675 to select the previous window.
6677 A session may be detached using
6679 (or by an external event such as
6681 disconnection) and reattached with:
6683 .Dl $ tmux attach-session
6687 lists the current key bindings in the current window; up and down may be used
6688 to navigate the list or
6692 Commands to be run when the
6694 server is started may be placed in the
6697 Common examples include:
6699 Changing the default prefix key:
6700 .Bd -literal -offset indent
6701 set-option -g prefix C-a
6703 bind-key C-a send-prefix
6706 Turning the status line off, or changing its colour:
6707 .Bd -literal -offset indent
6708 set-option -g status off
6709 set-option -g status-style bg=blue
6712 Setting other options, such as the default command,
6713 or locking after 30 minutes of inactivity:
6714 .Bd -literal -offset indent
6715 set-option -g default-command "exec /bin/ksh"
6716 set-option -g lock-after-time 1800
6719 Creating new key bindings:
6720 .Bd -literal -offset indent
6721 bind-key b set-option status
6722 bind-key / command-prompt "split-window 'exec man %%'"
6723 bind-key S command-prompt "new-window -n %1 'ssh %1'"
6728 .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com