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 Set terminal features for the client.
208 This is a comma-separated list of features.
210 .Ic terminal-features
213 Write UTF-8 output to the terminal even if the first environment
219 that is set does not contain
228 Request verbose logging.
229 Log messages will be saved into
230 .Pa tmux-client-PID.log
232 .Pa tmux-server-PID.log
233 files in the current directory, where
235 is the PID of the server or client process.
238 is specified twice, an additional
240 file is generated with a copy of everything
242 writes to the terminal.
246 signal may be sent to the
248 server process to toggle logging between on (as if
251 .It Ar command Op Ar flags
252 This specifies one of a set of commands used to control
254 as described in the following sections.
255 If no commands are specified, the
259 .Sh DEFAULT KEY BINDINGS
261 may be controlled from an attached client by using a key combination of a
264 (Ctrl-b) by default, followed by a command key.
266 The default command key bindings are:
268 .Bl -tag -width "XXXXXXXXXX" -offset indent -compact
270 Send the prefix key (C-b) through to the application.
272 Rotate the panes in the current window forwards.
278 Break the current pane out of the window.
281 Split the current pane into two, top and bottom.
283 List all paste buffers.
285 Rename the current session.
287 Split the current pane into two, left and right.
289 Kill the current window.
291 Prompt for a window index to select.
293 Switch the attached client to the previous session.
295 Switch the attached client to the next session.
297 Rename the current window.
299 Delete the most recently copied buffer of text.
301 Prompt for an index to move the current window.
303 Select windows 0 to 9.
309 Move to the previously active pane.
311 Choose which buffer to paste interactively from a list.
313 List all key bindings.
315 Choose a client to detach.
317 Switch the attached client back to the last session.
319 Enter copy mode to copy text or view the history.
321 Paste the most recently copied buffer of text.
325 Detach the current client.
327 Prompt to search for text in open windows.
329 Display some information about the current window.
331 Move to the previously selected window.
333 Mark the current pane (see
337 Clear the marked pane.
339 Change to the next window.
341 Select the next pane in the current window.
343 Change to the previous window.
345 Briefly display pane indexes.
347 Force redraw of the attached client.
349 Select a new session for the attached client interactively.
353 Choose the current window interactively.
355 Kill the current pane.
357 Toggle zoom state of the current pane.
359 Swap the current pane with the previous pane.
361 Swap the current pane with the next pane.
363 Show previous messages from
367 Enter copy mode and scroll one page up.
370 Change to the pane above, below, to the left, or to the right of the current
373 Arrange panes in one of the five preset layouts: even-horizontal,
374 even-vertical, main-horizontal, main-vertical, or tiled.
376 Arrange the current window in the next preset layout.
378 Move to the next window with a bell or activity marker.
380 Rotate the panes in the current window backwards.
382 Move to the previous window with a bell or activity marker.
385 Resize the current pane in steps of one cell.
388 Resize the current pane in steps of five cells.
391 Key bindings may be changed with the
396 .Sh COMMAND PARSING AND EXECUTION
398 supports a large number of commands which can be used to control its
400 Each command is named and can accept zero or more flags and arguments.
401 They may be bound to a key with the
403 command or run from the shell prompt, a shell script, a configuration file or
405 For example, the same
407 command run from the shell prompt, from
409 and bound to a key may look like:
410 .Bd -literal -offset indent
411 $ tmux set-option -g status-style bg=cyan
413 set-option -g status-style bg=cyan
415 bind-key C set-option -g status-style bg=cyan
418 Here, the command name is
428 distinguishes between command parsing and execution.
429 In order to execute a command,
431 needs it to be split up into its name and arguments.
432 This is command parsing.
433 If a command is run from the shell, the shell parses it; from inside
435 or from a configuration file,
441 .Bl -dash -offset indent
443 in a configuration file;
445 typed at the command prompt (see
446 .Ic command-prompt ) ;
451 passed as arguments to
457 To execute commands, each client has a
459 A global command queue not attached to any client is used on startup
460 for configuration files like
462 Parsed commands added to the queue are executed in order.
467 parse their argument to create a new command which is inserted immediately
469 This means that arguments can be parsed twice or more - once when the parent
472 is parsed and again when it parses and executes its command.
478 stop execution of subsequent commands on the queue until something happens -
482 until a shell command finishes and
484 until a key is pressed.
485 For example, the following commands:
486 .Bd -literal -offset indent
487 new-session; new-window
488 if-shell "true" "split-window"
507 commands and their arguments.
509 This section describes the syntax of commands parsed by
511 for example in a configuration file or at the command prompt.
512 Note that when commands are entered into the shell, they are parsed by the shell
518 Each command is terminated by a newline or a semicolon (;).
519 Commands separated by semicolons together form a
521 - if a command in the sequence encounters an error, no subsequent commands are
524 It is recommended that a semicolon used as a command separator should be
525 written as an individual token, for example from
527 .Bd -literal -offset indent
528 $ tmux neww \\; splitw
532 .Bd -literal -offset indent
533 $ tmux neww ';' splitw
536 Or from the tmux command prompt:
537 .Bd -literal -offset indent
541 However, a trailing semicolon is also interpreted as a command separator,
545 .Bd -literal -offset indent
546 $ tmux neww\e; splitw
550 .Bd -literal -offset indent
551 $ tmux 'neww;' splitw
554 As in these examples, when running tmux from the shell extra care must be taken
555 to properly quote semicolons:
558 Semicolons that should be interpreted as a command separator
559 should be escaped according to the shell conventions.
562 this typically means quoted (such as
563 .Ql neww ';' splitw )
565 .Ql neww \e\e\e\e; splitw ) .
567 Individual semicolons or trailing semicolons that should be interpreted as
568 arguments should be escaped twice: once according to the shell conventions and
572 .Bd -literal -offset indent
573 $ tmux neww 'foo\e\e;' bar
574 $ tmux neww foo\e\e\e\e; bar
577 Semicolons that are not individual tokens or trailing another token should only
578 be escaped once according to shell conventions; for example:
579 .Bd -literal -offset indent
580 $ tmux neww 'foo-;-bar'
581 $ tmux neww foo-\e\e;-bar
585 Comments are marked by the unquoted # character - any remaining text after a
586 comment is ignored until the end of the line.
588 If the last character of a line is \e, the line is joined with the following
589 line (the \e and the newline are completely removed).
590 This is called line continuation and applies both inside and outside quoted
591 strings and in comments, but not inside braces.
593 Command arguments may be specified as strings surrounded by single (') quotes,
594 double quotes (") or braces ({}).
596 This is required when the argument contains any special character.
597 Single and double quoted strings cannot span multiple lines except with line
599 Braces can span multiple lines.
601 Outside of quotes and inside double quotes, these replacements are performed:
602 .Bl -dash -offset indent
604 Environment variables preceded by $ are replaced with their value from the
605 global environment (see the
606 .Sx GLOBAL AND SESSION ENVIRONMENT
609 A leading ~ or ~user is expanded to the home directory of the current or
612 \euXXXX or \euXXXXXXXX is replaced by the Unicode codepoint corresponding to
613 the given four or eight digit hexadecimal number.
615 When preceded (escaped) by a \e, the following characters are replaced: \ee by
616 the escape character; \er by a carriage return; \en by a newline; and \et by a
619 \eooo is replaced by a character of the octal value ooo.
620 Three octal digits are required, for example \e001.
621 The largest valid character is \e377.
623 Any other characters preceded by \e are replaced by themselves (that is, the \e
624 is removed) and are not treated as having any special meaning - so for example
625 \e; will not mark a command sequence and \e$ will not expand an environment
629 Braces are parsed as a configuration file (so conditions such as
631 are processed) and then converted into a string.
632 They are designed to avoid the need for additional escaping when passing a
635 commands as an argument (for example to
637 These two examples produce an identical command - note that no escaping is
638 needed when using {}:
639 .Bd -literal -offset indent
641 display -p 'brace-dollar-foo: }$foo'
644 if-shell true "display -p 'brace-dollar-foo: }\e$foo'"
647 Braces may be enclosed inside braces, for example:
648 .Bd -literal -offset indent
649 bind x if-shell "true" {
656 Environment variables may be set by using the syntax
659 .Ql HOME=/home/user .
660 Variables set during parsing are added to the global environment.
661 A hidden variable may be set with
664 .Bd -literal -offset indent
668 Hidden variables are not passed to the environment of processes created
671 .Sx GLOBAL AND SESSION ENVIRONMENT
674 Commands may be parsed conditionally by surrounding them with
684 is expanded as a format (see
686 and if it evaluates to false (zero or empty), subsequent text is ignored until
693 .Bd -literal -offset indent
694 %if "#{==:#{host},myhost}"
695 set -g status-style bg=red
696 %elif "#{==:#{host},myotherhost}"
697 set -g status-style bg=green
699 set -g status-style bg=blue
703 Will change the status line to red if running on
707 or blue if running on another host.
708 Conditionals may be given on one line, for example:
709 .Bd -literal -offset indent
710 %if #{==:#{host},myhost} set -g status-style bg=red %endif
713 This section describes the commands supported by
715 Most commands accept the optional
725 These specify the client, session, window or pane which a command should affect.
728 should be the name of the client,
731 file to which the client is connected, for example either of
735 for the client attached to
737 If no client is specified,
739 attempts to work out the client currently in use; if that fails, an error is
741 Clients may be listed with the
746 is tried as, in order:
749 A session ID prefixed with a $.
751 An exact name of a session (as listed by the
755 The start of a session name, for example
757 would match a session named
762 pattern which is matched against the session name.
765 If the session name is prefixed with an
767 only an exact match is accepted (so
769 will only match exactly
774 If a single session is found, it is used as the target session; multiple matches
776 If a session is omitted, the current session is used if available; if no
777 current session is available, the most recently used is chosen.
784 specifies a window in the form
785 .Em session Ns \&: Ns Em window .
787 follows the same rules as for
791 is looked for in order as:
794 A special token, listed below.
796 A window index, for example
798 is window 1 in session
801 A window ID, such as @1.
803 An exact window name, such as
804 .Ql mysession:mywindow .
806 The start of a window name, such as
807 .Ql mysession:mywin .
811 pattern matched against the window name.
816 prefix will do an exact match only.
817 An empty window name specifies the next unused index if appropriate (for
823 otherwise the current window in
827 The following special tokens are available to indicate particular windows.
828 Each has a single-character alternative form.
829 .Bl -column "XXXXXXXXXX" "X"
830 .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
831 .It Li "{start}" Ta "^" Ta "The lowest-numbered window"
832 .It Li "{end}" Ta "$" Ta "The highest-numbered window"
833 .It Li "{last}" Ta "!" Ta "The last (previously current) window"
834 .It Li "{next}" Ta "+" Ta "The next window by number"
835 .It Li "{previous}" Ta "-" Ta "The previous window by number"
843 may be a pane ID or takes a similar form to
845 but with the optional addition of a period followed by a pane index or pane ID,
847 .Ql mysession:mywindow.1 .
848 If the pane index is omitted, the currently active pane in the specified
850 The following special tokens are available for the pane index:
851 .Bl -column "XXXXXXXXXXXXXX" "X"
852 .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
853 .It Li "{last}" Ta "!" Ta "The last (previously active) pane"
854 .It Li "{next}" Ta "+" Ta "The next pane by number"
855 .It Li "{previous}" Ta "-" Ta "The previous pane by number"
856 .It Li "{top}" Ta "" Ta "The top pane"
857 .It Li "{bottom}" Ta "" Ta "The bottom pane"
858 .It Li "{left}" Ta "" Ta "The leftmost pane"
859 .It Li "{right}" Ta "" Ta "The rightmost pane"
860 .It Li "{top-left}" Ta "" Ta "The top-left pane"
861 .It Li "{top-right}" Ta "" Ta "The top-right pane"
862 .It Li "{bottom-left}" Ta "" Ta "The bottom-left pane"
863 .It Li "{bottom-right}" Ta "" Ta "The bottom-right pane"
864 .It Li "{up-of}" Ta "" Ta "The pane above the active pane"
865 .It Li "{down-of}" Ta "" Ta "The pane below the active pane"
866 .It Li "{left-of}" Ta "" Ta "The pane to the left of the active pane"
867 .It Li "{right-of}" Ta "" Ta "The pane to the right of the active pane"
874 may be followed by an offset, for example:
875 .Bd -literal -offset indent
884 may consist entirely of the token
888 to specify the session, window or pane where the most recent mouse event
896 to specify the marked pane (see
900 Sessions, window and panes are each numbered with a unique ID; session IDs are
907 These are unique and are unchanged for the life of the session, window or pane
911 The pane ID is passed to the child process of the pane in the
913 environment variable.
914 IDs may be displayed using the
922 .Ic display-message ,
933 This may be a single argument passed to the shell, for example:
934 .Bd -literal -offset indent
935 new-window 'vi ~/.tmux.conf'
939 .Bd -literal -offset indent
940 /bin/sh -c 'vi ~/.tmux.conf'
952 to be given as multiple arguments and executed directly (without
954 This can avoid issues with shell quoting.
956 .Bd -literal -offset indent
957 $ tmux new-window vi ~/.tmux.conf
962 directly without invoking the shell.
968 command, either passed with the command and arguments separately, for example:
969 .Bd -literal -offset indent
970 bind-key F1 set-option status off
973 Or passed as a single string argument in
976 .Bd -literal -offset indent
977 bind-key F1 { set-option status off }
983 .Bd -literal -offset indent
984 refresh-client -t/dev/ttyp2
986 rename-session -tfirst newname
988 set-option -wt:0 monitor-activity on
990 new-window ; split-window -d
992 bind-key R source-file ~/.tmux.conf \e; \e
993 display-message "source-file done"
998 .Bd -literal -offset indent
999 $ tmux kill-window -t :1
1001 $ tmux new-window \e; split-window -d
1003 $ tmux new-session -d 'vi ~/.tmux.conf' \e; split-window -d \e; attach
1005 .Sh CLIENTS AND SESSIONS
1008 server manages clients, sessions, windows and panes.
1009 Clients are attached to sessions to interact with them, either
1010 when they are created with the
1012 command, or later with the
1015 Each session has one or more windows
1018 Windows may be linked to multiple sessions and are made up of one or
1020 each of which contains a pseudo terminal.
1021 Commands for creating, linking and otherwise manipulating windows
1024 .Sx WINDOWS AND PANES
1027 The following commands are available to manage clients and sessions:
1030 .It Xo Ic attach-session
1032 .Op Fl c Ar working-directory
1034 .Op Fl t Ar target-session
1036 .D1 Pq alias: Ic attach
1039 create a new client in the current terminal and attach it to
1040 .Ar target-session .
1041 If used from inside, switch the current client.
1044 is specified, any other clients attached to the session are detached.
1049 to the parent process of the client as well as
1050 detaching the client, typically causing it to exit.
1052 sets a comma-separated list of client flags.
1056 the client has an independent active pane
1058 the client does not affect the size of other clients
1060 the client does not receive pane output in control mode
1061 .It pause-after=seconds
1062 output is paused once the pane is
1064 behind in control mode
1066 the client is read-only
1068 wait for an empty line input before exiting in control mode
1073 turns a flag off if the client is already attached.
1077 .Ar read-only,ignore-size .
1078 When a client is read-only, only keys bound to the
1082 commands have any effect.
1085 flag allows the active pane to be selected independently of the window's active
1086 pane used by clients without the flag.
1087 This only affects the cursor position and commands issued from the client;
1088 other features such as hooks and styles continue to use the window's active
1091 If no server is started,
1093 will attempt to start it; this will fail unless sessions are created in the
1100 are slightly adjusted: if
1102 needs to select the most recently used session, it will prefer the most
1108 will set the session working directory (used for new windows) to
1109 .Ar working-directory .
1114 .Ic update-environment
1115 option will not be applied.
1117 .It Xo Ic detach-client
1119 .Op Fl E Ar shell-command
1120 .Op Fl s Ar target-session
1121 .Op Fl t Ar target-client
1123 .D1 Pq alias: Ic detach
1124 Detach the current client if bound to a key, the client specified with
1126 or all clients currently attached to the session specified by
1130 option kills all but the client given with
1136 to the parent process of the client, typically causing it
1142 to replace the client.
1144 .It Ic has-session Op Fl t Ar target-session
1145 .D1 Pq alias: Ic has
1146 Report an error and exit with 1 if the specified session does not exist.
1147 If it does exist, exit with 0.
1151 server and clients and destroy all sessions.
1152 .It Xo Ic kill-session
1154 .Op Fl t Ar target-session
1156 Destroy the given session, closing any windows linked to it and no other
1157 sessions, and detaching all clients attached to it.
1160 is given, all sessions but the specified one is killed.
1163 flag clears alerts (bell, activity, or silence) in all windows linked to the
1166 .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.
1174 specifies the format of each line and
1177 Only clients for which the filter is true are shown.
1183 is specified, list only clients connected to that session.
1185 .It Xo Ic list-commands
1189 .D1 Pq alias: Ic lscm
1192 or - if omitted - of all commands supported by
1195 .It Xo Ic list-sessions
1200 List all sessions managed by the server.
1202 specifies the format of each line and
1205 Only sessions for which the filter is true are shown.
1210 .It Ic lock-client Op Fl t Ar target-client
1211 .D1 Pq alias: Ic lockc
1218 .It Ic lock-session Op Fl t Ar target-session
1219 .D1 Pq alias: Ic locks
1220 Lock all clients attached to
1221 .Ar target-session .
1223 .It Xo Ic new-session
1225 .Op Fl c Ar start-directory
1226 .Op Fl e Ar environment
1229 .Op Fl n Ar window-name
1230 .Op Fl s Ar session-name
1231 .Op Fl t Ar group-name
1234 .Op Ar shell-command
1236 .D1 Pq alias: Ic new
1237 Create a new session with name
1240 The new session is attached to the current terminal unless
1246 are the name of and shell command to execute in the initial window.
1249 the initial size comes from the global
1255 can be used to specify a different size.
1257 uses the size of the current client if any.
1264 option is set for the session.
1266 sets a comma-separated list of client flags (see
1267 .Ic attach-session ) .
1269 If run from a terminal, any
1271 special characters are saved and used for new windows in the new session.
1289 .Ic attach-session ,
1295 .Ic attach-session .
1299 is given, it specifies a
1301 Sessions in the same group share the same set of windows - new windows are
1302 linked to all sessions in the group and any windows closed removed from all
1304 The current and previous window and any session options remain independent and
1305 any session in a group may be killed without affecting the others.
1311 the name of an existing group, in which case the new session is added to that
1314 the name of an existing session - the new session is added to the same group
1315 as that session, creating a new group if necessary;
1317 the name for a new group containing only the new session.
1329 option prints information about the new session after it has been created.
1330 By default, it uses the format
1331 .Ql #{session_name}:\&
1332 but a different format may be specified with
1338 .Ic update-environment
1339 option will not be applied.
1343 and sets an environment variable for the newly created session; it may be
1344 specified multiple times.
1346 .It Xo Ic refresh-client
1348 .Op Fl A Ar pane:state
1349 .Op Fl B Ar name:what:format
1352 .Op Fl l Op Ar target-pane
1353 .Op Fl t Ar target-client
1356 .D1 Pq alias: Ic refresh
1357 Refresh the current client if bound to a key, or a single client if one is given
1362 is specified, only update the client's status line.
1371 flags allow the visible portion of a window which is larger than the client
1374 moves the visible part up by
1386 returns to tracking the cursor automatically.
1389 is omitted, 1 is used.
1390 Note that the visible position is a property of the client not of the
1391 window, changing the current window in the attached session will reset
1395 sets the width and height of a control mode client or of a window for a
1396 control mode client,
1401 .Ql window ID:widthxheight ,
1407 allows a control mode client to trigger actions on a pane.
1408 The argument is a pane ID (with leading
1410 a colon, then one of
1419 will not send output from the pane to the client and if all clients have turned
1420 the pane off, will stop reading from the pane.
1424 will return to sending output to the pane if it was paused (manually or with the
1430 will pause the pane.
1432 may be given multiple times for different panes.
1435 sets a subscription to a format for a control mode client.
1436 The argument is split into three items by colons:
1438 is a name for the subscription;
1440 is a type of item to subscribe to;
1443 After a subscription is added, changes to the format are reported with the
1444 .Ic %subscription-changed
1445 notification, at most once a second.
1446 If only the name is given, the subscription is removed.
1448 may be empty to check the format only for the attached session, or one of:
1452 for all panes in the attached session;
1457 for all windows in the attached session.
1460 sets a comma-separated list of client flags, see
1461 .Ic attach-session .
1464 requests the clipboard from the client using the
1469 is given, the clipboard is sent (in encoded form), otherwise it is stored in a
1477 move the visible portion of the window left, right, up or down
1480 if the window is larger than the client.
1482 resets so that the position follows the cursor.
1487 .It Xo Ic rename-session
1488 .Op Fl t Ar target-session
1491 .D1 Pq alias: Ic rename
1492 Rename the session to
1494 .It Xo Ic server-access
1498 Change the access or read/write permission of
1500 The user running the
1502 server (its owner) and the root user cannot be changed and are always
1508 are used to give or revoke access for the specified user.
1509 If the user is already attached, the
1511 flag causes their clients to be detached.
1516 change the permissions for
1519 makes their clients read-only and
1523 lists current access permissions.
1525 By default, the access list is empty and
1527 creates sockets with file system permissions preventing access by any user
1528 other than the owner (and root).
1529 These permissions must be changed manually.
1530 Great care should be taken not to allow access to untrusted users even
1533 .It Xo Ic show-messages
1535 .Op Fl t Ar target-client
1537 .D1 Pq alias: Ic showmsgs
1538 Show server messages or information.
1539 Messages are stored, up to a maximum of the limit set by the
1545 show debugging information about jobs and terminals.
1547 .It Xo Ic source-file
1551 .D1 Pq alias: Ic source
1552 Execute commands from one or more files specified by
1561 is expanded as a format.
1564 is given, no error will be returned if
1569 the file is parsed but no commands are executed.
1571 shows the parsed commands and line numbers if possible.
1574 .D1 Pq alias: Ic start
1577 server, if not already running, without creating any sessions.
1579 Note that as by default the
1581 server will exit with no sessions, this is only useful if a session is created
1585 is turned off, or another command is run as part of the same command sequence.
1587 .Bd -literal -offset indent
1588 $ tmux start \\; show -g
1591 .It Xo Ic suspend-client
1592 .Op Fl t Ar target-client
1594 .D1 Pq alias: Ic suspendc
1595 Suspend a client by sending
1599 .It Xo Ic switch-client
1601 .Op Fl c Ar target-client
1602 .Op Fl t Ar target-session
1603 .Op Fl T Ar key-table
1605 .D1 Pq alias: Ic switchc
1606 Switch the current session for client
1609 .Ar target-session .
1612 may refer to a pane (a target that contains
1617 to change session, window and pane.
1620 keeps the window zoomed if it was zoomed.
1626 is used, the client is moved to the last, next or previous session
1640 .Ic update-environment
1641 option will not be applied.
1644 sets the client's key table; the next key from the client will be interpreted
1647 This may be used to configure multiple prefix keys, or to bind commands to
1649 For example, to make typing
1654 .Bd -literal -offset indent
1655 bind-key -Ttable2 c list-keys
1656 bind-key -Ttable1 b switch-client -Ttable2
1657 bind-key -Troot a switch-client -Ttable1
1660 .Sh WINDOWS AND PANES
1661 Each window displayed by
1663 may be split into one or more
1665 each pane takes up a certain area of the display and is a separate terminal.
1666 A window may be split into panes using the
1669 Windows may be split horizontally (with the
1671 flag) or vertically.
1672 Panes may be resized with the
1680 by default), the current pane may be changed with the
1686 commands may be used to swap panes without changing their position.
1687 Panes are numbered beginning from zero in the order they are created.
1691 pane permits direct access to the terminal contained in the pane.
1692 A pane may also be put into one of several modes:
1693 .Bl -dash -offset indent
1695 Copy mode, which permits a section of a window or its
1696 history to be copied to a
1698 for later insertion into another window.
1699 This mode is entered with the
1704 Copied text can be pasted with the
1709 View mode, which is like copy mode but is entered when a command that produces
1712 is executed from a key binding.
1714 Choose mode, which allows an item to be chosen from a list.
1715 This may be a client, a session or window or pane, or a buffer.
1716 This mode is entered with the
1724 In copy mode an indicator is displayed in the top-right corner of the pane with
1725 the current position and the number of lines in the history.
1727 Commands are sent to copy mode using the
1732 When a key is pressed, copy mode automatically uses one of two key tables,
1740 Key tables may be viewed with the
1744 The following commands are supported in copy mode:
1747 .Ic append-selection
1749 Append the selection to the top paste buffer.
1751 .Ic append-selection-and-cancel
1754 Append the selection to the top paste buffer and exit copy mode.
1756 .Ic back-to-indentation
1760 Move the cursor back to the indentation.
1771 Move to the bottom line.
1783 Clear the current selection.
1785 .Ic copy-end-of-line
1788 Copy from the cursor position to the end of the line.
1790 is used to name the new paste buffer.
1792 .Ic copy-end-of-line-and-cancel
1795 Copy from the cursor position and exit copy mode.
1800 Copy the entire line.
1802 .Ic copy-line-and-cancel
1805 Copy the entire line and exit copy mode.
1810 Copies the current selection.
1812 .Ic copy-selection-and-cancel
1817 Copy the current selection and exit copy mode.
1823 Move the cursor down.
1829 Move the cursor left.
1835 Move the cursor right.
1847 Move the cursor to the end of the line.
1854 Move the cursor to a specific line.
1860 Scroll to the bottom of the history.
1866 Scroll to the top of the history.
1872 Repeat the last jump.
1879 Jump backwards to the specified text.
1886 Jump forward to the specified text.
1892 Jump to the last mark.
1898 Move to the middle line.
1900 .Ic next-matching-bracket
1904 Move to the next matching bracket.
1910 Move to the next paragraph.
1915 Move to the next prompt.
1920 Move to the next word.
1926 Scroll down by one page.
1932 Scroll up by one page.
1934 .Ic previous-matching-bracket
1937 Move to the previous matching bracket.
1939 .Ic previous-paragraph
1943 Move to the previous paragraph.
1948 Move to the previous prompt.
1954 Move to the previous word.
1956 .Ic rectangle-toggle
1960 Toggle rectangle selection mode.
1962 .Ic refresh-from-pane
1966 Refresh the content from the pane.
1972 Repeat the last search.
1978 Search backwards for the specified text.
1984 Search forward for the specified text.
1989 Select the current line.
1993 Select the current word.
1999 Move the cursor to the start of the line.
2005 Move to the top line.
2011 Move to the next prompt.
2017 Move to the previous prompt.
2020 The search commands come in several varieties:
2024 search for a regular expression;
2027 variants search for a plain text string rather than a regular expression;
2029 perform an incremental search and expect to be used with the
2035 repeats the last search and
2037 does the same but reverses the direction (forward becomes backward and backward
2044 move between shell prompts, but require the shell to emit an escape sequence
2045 (\e033]133;A\e033\e\e) to tell
2047 where the prompts are located; if the shell does not do this, these commands
2051 flag jumps to the beginning of the command output instead of the shell prompt.
2053 Copy commands may take an optional buffer prefix argument which is used
2054 to generate the buffer name (the default is
2056 so buffers are named
2060 Pipe commands take a command argument which is the command to which the
2061 selected text is piped.
2063 variants also copy the selection.
2066 variants of some commands exit copy mode after they have completed (for copy
2067 commands) or when the cursor reaches the bottom (for scrolling commands).
2069 variants do not clear the selection.
2071 The next and previous word keys skip over whitespace and treat consecutive
2072 runs of either word separators or other letters as words.
2073 Word separators can be customized with the
2076 Next word moves to the start of the next word, next word end to the end of the
2077 next word and previous word to the start of the previous word.
2078 The three next and previous space keys work similarly but use a space alone as
2082 to the empty string makes next/previous word equivalent to next/previous space.
2084 The jump commands enable quick movement within a line.
2085 For instance, typing
2089 will move the cursor to the next
2091 character on the current line.
2094 will then jump to the next occurrence.
2096 Commands in copy mode may be prefaced by an optional repeat count.
2097 With vi key bindings, a prefix is entered using the number keys; with
2098 emacs, the Alt (meta) key and a number begins prefix entry.
2100 The synopsis for the
2106 .Op Fl s Ar src-pane
2107 .Op Fl t Ar target-pane
2112 option scrolls one page up.
2114 begins a mouse drag (only valid if bound to a mouse key binding, see
2115 .Sx MOUSE SUPPORT ) .
2117 hides the position indicator in the top right.
2119 cancels copy mode and any other modes.
2127 specifies that scrolling to the bottom of the history (to the visible screen)
2128 should exit copy mode.
2129 While in copy mode, pressing a key other than those used for scrolling will
2130 disable this behaviour.
2131 This is intended to allow fast scrolling through a pane's history, for
2133 .Bd -literal -offset indent
2134 bind PageUp copy-mode -eu
2138 A number of preset arrangements of panes are available, these are called
2140 These may be selected with the
2142 command or cycled with
2146 by default); once a layout is chosen, panes within it may be moved and resized
2149 The following layouts are supported:
2151 .It Ic even-horizontal
2152 Panes are spread out evenly from left to right across the window.
2153 .It Ic even-vertical
2154 Panes are spread evenly from top to bottom.
2155 .It Ic main-horizontal
2156 A large (main) pane is shown at the top of the window and the remaining panes
2157 are spread from left to right in the leftover space at the bottom.
2159 .Em main-pane-height
2160 window option to specify the height of the top pane.
2161 .It Ic main-vertical
2164 but the large pane is placed on the left and the others spread from top to
2165 bottom along the right.
2170 Panes are spread out as evenly as possible over the window in both rows and
2176 may be used to apply a previously used layout - the
2178 command displays the layout of each window in a form suitable for use with
2181 .Bd -literal -offset indent
2184 layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
2185 $ tmux select-layout 'bb62,159x48,0,0{79x48,0,0,79x48,80,0}'
2189 automatically adjusts the size of the layout for the current window size.
2190 Note that a layout cannot be applied to a window with more panes than that
2191 from which the layout was originally defined.
2193 Commands related to windows and panes are as follows:
2196 .It Xo Ic break-pane
2199 .Op Fl n Ar window-name
2200 .Op Fl s Ar src-pane
2201 .Op Fl t Ar dst-window
2203 .D1 Pq alias: Ic breakp
2206 off from its containing window to make it the only pane in
2212 the window is moved to the next index after or before (existing windows are
2213 moved if necessary).
2216 is given, the new window does not become the current window.
2219 option prints information about the new window after it has been created.
2220 By default, it uses the format
2221 .Ql #{session_name}:#{window_index}.#{pane_index}
2222 but a different format may be specified with
2225 .It Xo Ic capture-pane
2227 .Op Fl b Ar buffer-name
2228 .Op Fl E Ar end-line
2229 .Op Fl S Ar start-line
2230 .Op Fl t Ar target-pane
2232 .D1 Pq alias: Ic capturep
2233 Capture the contents of a pane.
2236 is given, the output goes to stdout, otherwise to the buffer specified with
2238 or a new buffer if omitted.
2241 is given, the alternate screen is used, and the history is not accessible.
2242 If no alternate screen exists, an error will be returned unless
2247 is given, the output includes escape sequences for text and background
2250 also escapes non-printable characters as octal \exxx.
2252 ignores trailing positions that do not contain a character.
2254 preserves trailing spaces at each line's end and
2256 preserves trailing spaces and joins any wrapped lines;
2261 captures only any output that the pane has received that is the beginning of an
2262 as-yet incomplete escape sequence.
2267 specify the starting and ending line numbers, zero is the first line of the
2268 visible pane and negative numbers are lines in the history.
2272 is the start of the history and to
2274 the end of the visible pane.
2275 The default is to capture only the visible contents of the pane.
2281 .Op Fl K Ar key-format
2282 .Op Fl O Ar sort-order
2283 .Op Fl t Ar target-pane
2286 Put a pane into client mode, allowing a client to be selected interactively from
2288 Each client is shown on one line.
2289 A shortcut key is shown on the left in brackets allowing for immediate choice,
2290 or the list may be navigated and an item chosen or otherwise manipulated using
2294 The following keys may be used in client mode:
2295 .Bl -column "Key" "Function" -offset indent
2296 .It Sy "Key" Ta Sy "Function"
2297 .It Li "Enter" Ta "Choose selected client"
2298 .It Li "Up" Ta "Select previous client"
2299 .It Li "Down" Ta "Select next client"
2300 .It Li "C-s" Ta "Search by name"
2301 .It Li "n" Ta "Repeat last search"
2302 .It Li "t" Ta "Toggle if client is tagged"
2303 .It Li "T" Ta "Tag no clients"
2304 .It Li "C-t" Ta "Tag all clients"
2305 .It Li "d" Ta "Detach selected client"
2306 .It Li "D" Ta "Detach tagged clients"
2307 .It Li "x" Ta "Detach and HUP selected client"
2308 .It Li "X" Ta "Detach and HUP tagged clients"
2309 .It Li "z" Ta "Suspend selected client"
2310 .It Li "Z" Ta "Suspend tagged clients"
2311 .It Li "f" Ta "Enter a format to filter items"
2312 .It Li "O" Ta "Change sort field"
2313 .It Li "r" Ta "Reverse sort order"
2314 .It Li "v" Ta "Toggle preview"
2315 .It Li "q" Ta "Exit mode"
2318 After a client is chosen,
2320 is replaced by the client name in
2322 and the result executed as a command.
2325 is not given, "detach-client -t '%%'" is used.
2328 specifies the initial sort field: one of
2337 reverses the sort order.
2339 specifies an initial filter: the filter is a format - if it evaluates to zero,
2340 the item in the list is not shown, otherwise it is shown.
2341 If a filter would lead to an empty list, it is ignored.
2343 specifies the format for each item in the list and
2345 a format for each shortcut key; both are evaluated once for each line.
2347 starts without the preview.
2348 This command works only if at least one client is attached.
2354 .Op Fl K Ar key-format
2355 .Op Fl O Ar sort-order
2356 .Op Fl t Ar target-pane
2359 Put a pane into tree mode, where a session, window or pane may be chosen
2360 interactively from a tree.
2361 Each session, window or pane is shown on one line.
2362 A shortcut key is shown on the left in brackets allowing for immediate choice,
2363 or the tree may be navigated and an item chosen or otherwise manipulated using
2366 starts with sessions collapsed and
2368 with windows collapsed.
2371 The following keys may be used in tree mode:
2372 .Bl -column "Key" "Function" -offset indent
2373 .It Sy "Key" Ta Sy "Function"
2374 .It Li "Enter" Ta "Choose selected item"
2375 .It Li "Up" Ta "Select previous item"
2376 .It Li "Down" Ta "Select next item"
2377 .It Li "+" Ta "Expand selected item"
2378 .It Li "-" Ta "Collapse selected item"
2379 .It Li "M-+" Ta "Expand all items"
2380 .It Li "M--" Ta "Collapse all items"
2381 .It Li "x" Ta "Kill selected item"
2382 .It Li "X" Ta "Kill tagged items"
2383 .It Li "<" Ta "Scroll list of previews left"
2384 .It Li ">" Ta "Scroll list of previews right"
2385 .It Li "C-s" Ta "Search by name"
2386 .It Li "m" Ta "Set the marked pane"
2387 .It Li "M" Ta "Clear the marked pane"
2388 .It Li "n" Ta "Repeat last search"
2389 .It Li "t" Ta "Toggle if item is tagged"
2390 .It Li "T" Ta "Tag no items"
2391 .It Li "C-t" Ta "Tag all items"
2392 .It Li "\&:" Ta "Run a command for each tagged item"
2393 .It Li "f" Ta "Enter a format to filter items"
2394 .It Li "H" Ta "Jump to the starting pane"
2395 .It Li "O" Ta "Change sort field"
2396 .It Li "r" Ta "Reverse sort order"
2397 .It Li "v" Ta "Toggle preview"
2398 .It Li "q" Ta "Exit mode"
2401 After a session, window or pane is chosen, the first instance of
2403 and all instances of
2405 are replaced by the target in
2407 and the result executed as a command.
2410 is not given, "switch-client -t '%%'" is used.
2413 specifies the initial sort field: one of
2420 reverses the sort order.
2422 specifies an initial filter: the filter is a format - if it evaluates to zero,
2423 the item in the list is not shown, otherwise it is shown.
2424 If a filter would lead to an empty list, it is ignored.
2426 specifies the format for each item in the tree and
2428 a format for each shortcut key; both are evaluated once for each line.
2430 starts without the preview.
2432 includes all sessions in any session groups in the tree rather than only the
2434 This command works only if at least one client is attached.
2440 .Op Fl t Ar target-pane
2443 Put a pane into customize mode, where options and key bindings may be browsed
2444 and modified from a list.
2445 Option values in the list are shown for the active pane in the current window.
2448 The following keys may be used in customize mode:
2449 .Bl -column "Key" "Function" -offset indent
2450 .It Sy "Key" Ta Sy "Function"
2451 .It Li "Enter" Ta "Set pane, window, session or global option value"
2452 .It Li "Up" Ta "Select previous item"
2453 .It Li "Down" Ta "Select next item"
2454 .It Li "+" Ta "Expand selected item"
2455 .It Li "-" Ta "Collapse selected item"
2456 .It Li "M-+" Ta "Expand all items"
2457 .It Li "M--" Ta "Collapse all items"
2458 .It Li "s" Ta "Set option value or key attribute"
2459 .It Li "S" Ta "Set global option value"
2460 .It Li "w" Ta "Set window option value, if option is for pane and window"
2461 .It Li "d" Ta "Set an option or key to the default"
2462 .It Li "D" Ta "Set tagged options and tagged keys to the default"
2463 .It Li "u" Ta "Unset an option (set to default value if global) or unbind a key"
2464 .It Li "U" Ta "Unset tagged options and unbind tagged keys"
2465 .It Li "C-s" Ta "Search by name"
2466 .It Li "n" Ta "Repeat last search"
2467 .It Li "t" Ta "Toggle if item is tagged"
2468 .It Li "T" Ta "Tag no items"
2469 .It Li "C-t" Ta "Tag all items"
2470 .It Li "f" Ta "Enter a format to filter items"
2471 .It Li "v" Ta "Toggle option information"
2472 .It Li "q" Ta "Exit mode"
2476 specifies an initial filter: the filter is a format - if it evaluates to zero,
2477 the item in the list is not shown, otherwise it is shown.
2478 If a filter would lead to an empty list, it is ignored.
2480 specifies the format for each item in the tree.
2482 starts without the option information.
2483 This command works only if at least one client is attached.
2488 .Op Fl d Ar duration
2489 .Op Fl t Ar target-client
2492 .D1 Pq alias: Ic displayp
2493 Display a visible indicator of each pane shown by
2496 .Ic display-panes-colour
2498 .Ic display-panes-active-colour
2500 The indicator is closed when a key is pressed (unless
2504 milliseconds have passed.
2508 .Ic display-panes-time
2510 A duration of zero means the indicator stays until a key is pressed.
2511 While the indicator is on screen, a pane may be chosen with the
2515 keys, which will cause
2517 to be executed as a command with
2519 substituted by the pane ID.
2522 is "select-pane -t '%%'".
2525 other commands are not blocked from running until the indicator is closed.
2527 .It Xo Ic find-window
2529 .Op Fl t Ar target-pane
2532 .D1 Pq alias: Ic findw
2539 in window names, titles, and visible content (but not history).
2540 The flags control matching behavior:
2542 matches only visible window contents,
2544 matches only the window name and
2546 matches only the window title.
2548 makes the search ignore case.
2554 This command works only if at least one client is attached.
2559 .Op Fl s Ar src-pane
2560 .Op Fl t Ar dst-pane
2562 .D1 Pq alias: Ic joinp
2565 but instead of splitting
2567 and creating a new pane, split it and move
2570 This can be used to reverse
2576 to be joined to left of or above
2581 is omitted and a marked pane is present (see
2584 the marked pane is used rather than the current pane.
2588 .Op Fl t Ar target-pane
2590 .D1 Pq alias: Ic killp
2591 Destroy the given pane.
2592 If no panes remain in the containing window, it is also destroyed.
2595 option kills all but the pane given with
2598 .It Xo Ic kill-window
2600 .Op Fl t Ar target-window
2602 .D1 Pq alias: Ic killw
2603 Kill the current window or the window at
2605 removing it from any sessions to which it is linked.
2608 option kills all but the window given with
2613 .Op Fl t Ar target-window
2615 .D1 Pq alias: Ic lastp
2616 Select the last (previously selected) pane.
2618 keeps the window zoomed if it was zoomed.
2622 disables input to the pane.
2624 .It Ic last-window Op Fl t Ar target-session
2625 .D1 Pq alias: Ic last
2626 Select the last (previously selected) window.
2629 is specified, select the last window of the current session.
2631 .It Xo Ic link-window
2633 .Op Fl s Ar src-window
2634 .Op Fl t Ar dst-window
2636 .D1 Pq alias: Ic linkw
2643 is specified and no such window exists, the
2650 the window is moved to the next index after or before
2652 (existing windows are moved if necessary).
2657 exists, it is killed, otherwise an error is generated.
2660 is given, the newly linked window is not selected.
2662 .It Xo Ic list-panes
2668 .D1 Pq alias: Ic lsp
2673 is ignored and all panes on the server are listed.
2678 is a session (or the current session).
2679 If neither is given,
2681 is a window (or the current window).
2683 specifies the format of each line and
2686 Only panes for which the filter is true are shown.
2691 .It Xo Ic list-windows
2695 .Op Fl t Ar target-session
2697 .D1 Pq alias: Ic lsw
2700 is given, list all windows on the server.
2701 Otherwise, list windows in the current session or in
2702 .Ar target-session .
2704 specifies the format of each line and
2707 Only windows for which the filter is true are shown.
2715 .Op Fl s Ar src-pane
2716 .Op Fl t Ar dst-pane
2718 .D1 Pq alias: Ic movep
2722 .It Xo Ic move-window
2724 .Op Fl s Ar src-window
2725 .Op Fl t Ar dst-window
2727 .D1 Pq alias: Ic movew
2730 except the window at
2736 all windows in the session are renumbered in sequential order, respecting
2741 .It Xo Ic new-window
2743 .Op Fl c Ar start-directory
2744 .Op Fl e Ar environment
2746 .Op Fl n Ar window-name
2747 .Op Fl t Ar target-window
2748 .Op Ar shell-command
2750 .D1 Pq alias: Ic neww
2751 Create a new window.
2756 the new window is inserted at the next index after or before the specified
2758 moving windows up if necessary;
2761 is the new window location.
2765 is given, the session does not make the new window the current window.
2767 represents the window to be created; if the target already exists an error is
2770 flag is used, in which case it is destroyed.
2773 is given and a window named
2775 already exists, it is selected (unless
2777 is also given in which case the command does nothing).
2780 is the command to execute.
2783 is not specified, the value of the
2787 specifies the working directory in which the new window is created.
2789 When the shell command completes, the window closes.
2792 option to change this behaviour.
2797 and sets an environment variable for the newly created window; it may be
2798 specified multiple times.
2802 environment variable must be set to
2806 for all programs running
2809 New windows will automatically have
2811 added to their environment, but care must be taken not to reset this in shell
2812 start-up files or by the
2818 option prints information about the new window after it has been created.
2819 By default, it uses the format
2820 .Ql #{session_name}:#{window_index}
2821 but a different format may be specified with
2824 .It Ic next-layout Op Fl t Ar target-window
2825 .D1 Pq alias: Ic nextl
2826 Move a window to the next layout and rearrange the panes to fit.
2828 .It Xo Ic next-window
2830 .Op Fl t Ar target-session
2832 .D1 Pq alias: Ic next
2833 Move to the next window in the session.
2836 is used, move to the next window with an alert.
2840 .Op Fl t Ar target-pane
2841 .Op Ar shell-command
2843 .D1 Pq alias: Ic pipep
2844 Pipe output sent by the program in
2846 to a shell command or vice versa.
2847 A pane may only be connected to one command at a time, any existing pipe is
2853 string may contain the special character sequences supported by the
2858 is given, the current pipe (if any) is closed.
2863 specify which of the
2865 output streams are connected to the pane:
2868 stdout is connected (so anything
2870 prints is written to the pane as if it were typed);
2873 stdin is connected (so any output in the pane is piped to
2874 .Ar shell-command ) .
2875 Both may be used together and if neither are specified,
2881 option only opens a new pipe if no previous pipe exists, allowing a pipe to
2882 be toggled with a single key, for example:
2883 .Bd -literal -offset indent
2884 bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
2887 .It Xo Ic previous-layout
2888 .Op Fl t Ar target-window
2890 .D1 Pq alias: Ic prevl
2891 Move to the previous layout in the session.
2893 .It Xo Ic previous-window
2895 .Op Fl t Ar target-session
2897 .D1 Pq alias: Ic prev
2898 Move to the previous window in the session.
2901 move to the previous window with an alert.
2903 .It Xo Ic rename-window
2904 .Op Fl t Ar target-window
2907 .D1 Pq alias: Ic renamew
2908 Rename the current window, or the window at
2913 .It Xo Ic resize-pane
2915 .Op Fl t Ar target-pane
2920 .D1 Pq alias: Ic resizep
2921 Resize a pane, up, down, left or right by
2937 is given in lines or columns (the default is 1);
2941 may be a given as a number of lines or columns or followed by
2943 for a percentage of the window size (for example
2947 the active pane is toggled between zoomed (occupying the whole of the window)
2948 and unzoomed (its normal position in the layout).
2951 begins mouse resizing (only valid if bound to a mouse key binding, see
2952 .Sx MOUSE SUPPORT ) .
2955 trims all lines below the current cursor position and moves lines out of the
2956 history to replace them.
2958 .It Xo Ic resize-window
2960 .Op Fl t Ar target-window
2965 .D1 Pq alias: Ic resizew
2966 Resize a window, up, down, left or right by
2982 is given in lines or cells (the default is 1).
2984 sets the size of the largest session containing the window;
2986 the size of the smallest.
2987 This command will automatically set
2989 to manual in the window options.
2991 .It Xo Ic respawn-pane
2993 .Op Fl c Ar start-directory
2994 .Op Fl e Ar environment
2995 .Op Fl t Ar target-pane
2996 .Op Ar shell-command
2998 .D1 Pq alias: Ic respawnp
2999 Reactivate a pane in which the command has exited (see the
3004 is not given, the command used when the pane was created or last respawned is
3006 The pane must be already inactive, unless
3008 is given, in which case any existing command is killed.
3010 specifies a new working directory for the pane.
3013 option has the same meaning as for the
3017 .It Xo Ic respawn-window
3019 .Op Fl c Ar start-directory
3020 .Op Fl e Ar environment
3021 .Op Fl t Ar target-window
3022 .Op Ar shell-command
3024 .D1 Pq alias: Ic respawnw
3025 Reactivate a window in which the command has exited (see the
3030 is not given, the command used when the window was created or last respawned is
3032 The window must be already inactive, unless
3034 is given, in which case any existing command is killed.
3036 specifies a new working directory for the window.
3039 option has the same meaning as for the
3043 .It Xo Ic rotate-window
3045 .Op Fl t Ar target-window
3047 .D1 Pq alias: Ic rotatew
3048 Rotate the positions of the panes within a window, either upward (numerically
3051 or downward (numerically higher).
3053 keeps the window zoomed if it was zoomed.
3055 .It Xo Ic select-layout
3057 .Op Fl t Ar target-pane
3060 .D1 Pq alias: Ic selectl
3061 Choose a specific layout for a window.
3064 is not given, the last preset layout used (if any) is reapplied.
3068 are equivalent to the
3074 applies the last set layout if possible (undoes the most recent layout change).
3076 spreads the current pane and any panes next to it out evenly.
3078 .It Xo Ic select-pane
3081 .Op Fl t Ar target-pane
3083 .D1 Pq alias: Ic selectp
3086 the active pane in its window.
3093 is used, respectively the pane below, to the left, to the right, or above the
3094 target pane is used.
3096 keeps the window zoomed if it was zoomed.
3098 is the same as using the
3104 disables input to the pane.
3106 sets the pane title.
3111 are used to set and clear the
3113 There is one marked pane at a time, setting a new marked pane clears the last.
3114 The marked pane is the default target for
3123 .It Xo Ic select-window
3125 .Op Fl t Ar target-window
3127 .D1 Pq alias: Ic selectw
3128 Select the window at
3134 are equivalent to the
3142 is given and the selected window is already the current window,
3143 the command behaves like
3146 .It Xo Ic split-window
3148 .Op Fl c Ar start-directory
3149 .Op Fl e Ar environment
3151 .Op Fl t Ar target-pane
3152 .Op Ar shell-command
3155 .D1 Pq alias: Ic splitw
3156 Create a new pane by splitting
3159 does a horizontal split and
3161 a vertical split; if neither is specified,
3166 option specifies the size of the new pane in lines (for vertical split) or in
3167 columns (for horizontal split);
3171 to specify a percentage of the available space.
3174 option causes the new pane to be created to the left of or above
3178 option creates a new pane spanning the full window height (with
3180 or full window width (with
3182 instead of splitting the active pane.
3184 zooms if the window is not zoomed, or keeps it zoomed if already zoomed.
3188 ('') will create a pane with no command running in it.
3189 Output can be sent to such a pane with the
3196 is not specified or empty)
3197 will create an empty pane and forward any output from stdin to it.
3199 .Bd -literal -offset indent
3200 $ make 2>&1|tmux splitw -dI &
3203 All other options have the same meaning as for the
3209 .Op Fl s Ar src-pane
3210 .Op Fl t Ar dst-pane
3212 .D1 Pq alias: Ic swapp
3216 is used and no source pane is specified with
3219 is swapped with the previous pane (before it numerically);
3221 swaps with the next pane (after it numerically).
3225 not to change the active pane and
3227 keeps the window zoomed if it was zoomed.
3231 is omitted and a marked pane is present (see
3234 the marked pane is used rather than the current pane.
3236 .It Xo Ic swap-window
3238 .Op Fl s Ar src-window
3239 .Op Fl t Ar dst-window
3241 .D1 Pq alias: Ic swapw
3244 except the source and destination windows are swapped.
3245 It is an error if no window exists at
3249 is given, the new window does not become the current window.
3253 is omitted and a marked pane is present (see
3256 the window containing the marked pane is used rather than the current window.
3258 .It Xo Ic unlink-window
3260 .Op Fl t Ar target-window
3262 .D1 Pq alias: Ic unlinkw
3267 is given, a window may be unlinked only if it is linked to multiple sessions -
3268 windows may not be linked to no sessions;
3271 is specified and the window is linked to only one session, it is unlinked and
3276 allows a command to be bound to most keys, with or without a prefix key.
3277 When specifying keys, most represent themselves (for example
3281 Ctrl keys may be prefixed with
3289 In addition, the following special key names are accepted:
3307 .Em NPage/PageDown/PgDn ,
3308 .Em PPage/PageUp/PgUp ,
3312 Note that to bind the
3316 keys, quotation marks are necessary, for example:
3317 .Bd -literal -offset indent
3318 bind-key '"' split-window
3319 bind-key "'" new-window
3322 A command bound to the
3324 key will execute for all keys which do not have a more specific binding.
3326 Commands related to key bindings are as follows:
3332 .Op Fl T Ar key-table
3333 .Ar key command Op Ar argument ...
3335 .D1 Pq alias: Ic bind
3340 Keys are bound in a key table.
3341 By default (without -T), the key is bound in
3345 This table is used for keys pressed after the prefix key (for example,
3354 creates a new window).
3357 table is used for keys pressed without the prefix key: binding
3363 table (not recommended) means a plain
3365 will create a new window.
3370 Keys may also be bound in custom key tables and the
3373 command used to switch to them from a key binding.
3376 flag indicates this key may repeat, see the
3380 attaches a note to the key (shown with
3384 To view the default bindings and possible commands, see the
3390 .Op Fl P Ar prefix-string Fl T Ar key-table
3393 .D1 Pq alias: Ic lsk
3395 There are two forms: the default lists keys as
3399 lists only keys with attached notes and shows only the key and note for each
3402 With the default form, all key tables are listed by default.
3409 form, only keys in the
3413 key tables are listed by default;
3415 also lists only keys in
3418 specifies a prefix to print before each key and
3420 lists only the first matching key.
3422 lists the command for keys that do not have a note rather than skipping them.
3426 .Op Fl c Ar target-client
3427 .Op Fl N Ar repeat-count
3428 .Op Fl t Ar target-pane
3431 .D1 Pq alias: Ic send
3432 Send a key or keys to a window or client.
3435 is the name of the key (such as
3439 to send; if the string is not recognised as a key, it is sent as a series of
3443 is given, keys are sent to
3445 so they are looked up in the client's key table, rather than to
3447 All arguments are sent sequentially from first to last.
3448 If no keys are given and the command is bound to a key, then that key is used.
3452 flag disables key name lookup and processes the keys as literal UTF-8
3456 flag expects each key to be a hexadecimal number for an ASCII character.
3460 flag causes the terminal state to be reset.
3463 passes through a mouse event (only valid if bound to a mouse key binding, see
3464 .Sx MOUSE SUPPORT ) .
3467 is used to send a command into copy mode - see
3469 .Sx WINDOWS AND PANES
3472 specifies a repeat count and
3474 expands formats in arguments where appropriate.
3475 .It Xo Ic send-prefix
3477 .Op Fl t Ar target-pane
3479 Send the prefix key, or with
3481 the secondary prefix key, to a window as if it was pressed.
3483 .It Xo Ic unbind-key
3485 .Op Fl T Ar key-table
3488 .D1 Pq alias: Ic unbind
3489 Unbind the command bound to
3498 is present, all key bindings are removed.
3501 option prevents errors being returned.
3504 The appearance and behaviour of
3506 may be modified by changing the value of various options.
3507 There are four types of option:
3508 .Em server options ,
3509 .Em session options ,
3510 .Em window options ,
3516 server has a set of global server options which do not apply to any particular
3517 window or session or pane.
3518 These are altered with the
3521 command, or displayed with the
3526 In addition, each individual session may have a set of session options, and
3527 there is a separate set of global session options.
3528 Sessions which do not have a particular option configured inherit the value
3529 from the global session options.
3530 Session options are set or unset with the
3532 command and may be listed with the
3535 The available server and session options are listed under the
3539 Similarly, a set of window options is attached to each window and a set of pane
3540 options to each pane.
3541 Pane options inherit from window options.
3542 This means any pane option may be set as a window option to apply the option to
3543 all panes in the window without the option set, for example these commands will
3544 set the background colour to red for all panes except pane 0:
3545 .Bd -literal -offset indent
3546 set -w window-style bg=red
3547 set -pt:.0 window-style bg=blue
3550 There is also a set of global window options from which any unset window or
3551 pane options are inherited.
3552 Window and pane options are altered with
3557 commands and displayed with
3564 also supports user options which are prefixed with a
3566 User options may have any name, so long as they are prefixed with
3568 and be set to any string.
3570 .Bd -literal -offset indent
3571 $ tmux set -wq @foo "abc123"
3572 $ tmux show -wv @foo
3576 Commands which set options are as follows:
3579 .It Xo Ic set-option
3581 .Op Fl t Ar target-pane
3584 .D1 Pq alias: Ic set
3585 Set a pane option with
3587 a window option with
3589 a server option with
3591 otherwise a session option.
3592 If the option is not a user option,
3596 may be unnecessary -
3598 will infer the type from the option name, assuming
3603 is given, the global session or window option is set.
3606 expands formats in the option value.
3609 flag unsets an option, so a session inherits the option from the global
3612 restores a global option to the default).
3614 unsets an option (like
3616 but if the option is a pane option also unsets the option on any panes in the
3619 depends on the option and may be a number, a string, or a flag (on, off, or
3624 flag prevents setting an option that is already set and the
3626 flag suppresses errors about unknown or ambiguous options.
3630 and if the option expects a string or a style,
3632 is appended to the existing setting.
3634 .Bd -literal -offset indent
3635 set -g status-left "foo"
3636 set -ag status-left "bar"
3642 .Bd -literal -offset indent
3643 set -g status-style "bg=red"
3644 set -ag status-style "fg=blue"
3647 Will result in a red background
3652 the result would be the default background and a blue foreground.
3654 .It Xo Ic show-options
3656 .Op Fl t Ar target-pane
3659 .D1 Pq alias: Ic show
3660 Show the pane options (or a single option if
3664 the window options with
3666 the server options with
3668 otherwise the session options.
3669 If the option is not a user option,
3673 may be unnecessary -
3675 will infer the type from the option name, assuming
3678 Global session or window options are listed if
3682 shows only the option value, not the name.
3685 is set, no error will be returned if
3689 includes hooks (omitted by default).
3691 includes options inherited from a parent set of options, such options are
3692 marked with an asterisk.
3695 Available server options are:
3697 .It Ic backspace Ar key
3701 .It Ic buffer-limit Ar number
3702 Set the number of buffers; as new buffers are added to the top of the stack,
3703 old ones are removed from the bottom if necessary to maintain this maximum
3705 .It Xo Ic command-alias[]
3708 This is an array of custom aliases for commands.
3709 If an unknown command matches
3715 .Dl set -s command-alias[100] zoom='resize-pane -Z'
3723 .Dl resize-pane -Z -t:.1
3725 Note that aliases are expanded when a command is parsed rather than when it is
3726 executed, so binding an alias with
3728 will bind the expanded form.
3729 .It Ic default-terminal Ar terminal
3730 Set the default terminal for new windows created in this session - the
3731 default value of the
3733 environment variable.
3736 to work correctly, this
3741 or a derivative of them.
3742 .It Ic copy-command Ar shell-command
3743 Give the command to pipe to if the
3745 copy mode command is used without arguments.
3746 .It Ic escape-time Ar time
3747 Set the time in milliseconds for which
3749 waits after an escape is input to determine if it is part of a function or meta
3751 The default is 500 milliseconds.
3752 .It Ic editor Ar shell-command
3753 Set the command used when
3756 .It Xo Ic exit-empty
3759 If enabled (the default), the server will exit when there are no active
3761 .It Xo Ic exit-unattached
3764 If enabled, the server will exit when there are no attached clients.
3765 .It Xo Ic extended-keys
3766 .Op Ic on | off | always
3772 the escape sequence to enable extended keys is sent to the terminal, if
3774 knows that it is supported.
3776 always recognises extended keys itself.
3780 will only forward extended keys to applications when they request them; if
3783 will always forward the keys.
3784 .It Xo Ic focus-events
3787 When enabled, focus events are requested from the terminal if supported and
3788 passed through to applications running in
3790 Attached clients should be detached and attached again after changing this
3792 .It Ic history-file Ar path
3793 If not empty, a file to which
3795 will write command prompt history on exit and load it from on start.
3796 .It Ic message-limit Ar number
3797 Set the number of error or information messages to save in the message log for
3799 .It Ic prompt-history-limit Ar number
3800 Set the number of history items to save in the history file for each type of
3802 .It Xo Ic set-clipboard
3803 .Op Ic on | external | off
3805 Attempt to set the terminal clipboard content using the
3807 escape sequence, if there is an
3811 description (see the
3812 .Sx TERMINFO EXTENSIONS
3818 will both accept the escape sequence to create a buffer and attempt to set
3819 the terminal clipboard.
3823 will attempt to set the terminal clipboard but ignore attempts
3824 by applications to set
3830 will neither accept the clipboard escape sequence nor attempt to set the
3833 Note that this feature needs to be enabled in
3835 by setting the resource:
3836 .Bd -literal -offset indent
3837 disallowedWindowOps: 20,21,SetXprop
3840 Or changing this property from the
3842 interactive menu when required.
3843 .It Ic terminal-features[] Ar string
3844 Set terminal features for terminal types read from
3847 has a set of named terminal features.
3848 Each will apply appropriate changes to the
3853 can detect features for a few common terminals; this option can be used to
3854 easily tell tmux about features supported by terminals it cannot detect.
3856 .Ic terminal-overrides
3857 option allows individual
3859 capabilities to be set instead,
3860 .Ic terminal-features
3861 is intended for classes of functionality supported in a standard way but not
3864 Care must be taken to configure this only with features the terminal actually
3867 This is an array option where each entry is a colon-separated string made up
3868 of a terminal type pattern (matched using
3870 followed by a list of terminal features.
3871 The available features are:
3874 Supports 256 colours with the SGR escape sequences.
3876 Allows setting the system clipboard.
3878 Allows setting the cursor colour.
3880 Allows setting the cursor style.
3882 Supports extended keys.
3884 Supports focus reporting.
3886 Supports OSC 8 hyperlinks.
3888 Ignore function keys from
3894 Supports DECSLRM margins.
3900 Supports the OSC 7 working directory extension.
3902 Supports the overline SGR attribute.
3904 Supports the DECFRA rectangle fill escape sequence.
3906 Supports RGB colour with the SGR escape sequences.
3908 Supports SIXEL graphics.
3910 Supports the strikethrough SGR escape sequence.
3912 Supports synchronized updates.
3918 Allows underscore style and colour to be set.
3920 .It Ic terminal-overrides[] Ar string
3921 Allow terminal descriptions read using
3924 Each entry is a colon-separated string made up of a terminal type pattern
3931 For example, to set the
3936 for all terminal types matching
3939 .Dl "rxvt*:clear=\ee[H\ee[2J"
3941 The terminal entry value is passed through
3943 before interpretation.
3944 .It Ic user-keys[] Ar key
3945 Set list of user-defined key escape sequences.
3946 Each item is associated with a key named
3952 .Bd -literal -offset indent
3953 set -s user-keys[0] "\ee[5;30012~"
3954 bind User0 resize-pane -L 3
3958 Available session options are:
3960 .It Xo Ic activity-action
3961 .Op Ic any | none | current | other
3963 Set action on window activity when
3964 .Ic monitor-activity
3967 means activity in any window linked to a session causes a bell or message
3969 .Ic visual-activity )
3970 in the current window of that session,
3972 means all activity is ignored (equivalent to
3973 .Ic monitor-activity
3976 means only activity in windows other than the current window are ignored and
3978 means activity in the current window is ignored but not those in other windows.
3979 .It Ic assume-paste-time Ar milliseconds
3980 If keys are entered faster than one in
3982 they are assumed to have been pasted rather than typed and
3984 key bindings are not processed.
3985 The default is one millisecond and zero disables.
3986 .It Ic base-index Ar index
3987 Set the base index from which an unused index should be searched when a new
3989 The default is zero.
3990 .It Xo Ic bell-action
3991 .Op Ic any | none | current | other
3993 Set action on a bell in a window when
3996 The values are the same as those for
3997 .Ic activity-action .
3998 .It Ic default-command Ar shell-command
3999 Set the command used for new windows (if not specified when the window is
4005 The default is an empty string, which instructs
4007 to create a login shell using the value of the
4010 .It Ic default-shell Ar path
4011 Specify the default shell.
4012 This is used as the login shell for new windows when the
4014 option is set to empty, and must be the full path of the executable.
4017 tries to set a default value from the first suitable of the
4019 environment variable, the shell returned by
4023 This option should be configured when
4025 is used as a login shell.
4026 .It Ic default-size Ar XxY
4027 Set the default size of new windows when the
4029 option is set to manual or when a session is created with
4032 The value is the width and height separated by an
4035 The default is 80x24.
4036 .It Xo Ic destroy-unattached
4039 If enabled and the session is no longer attached to any clients, it is
4041 .It Xo Ic detach-on-destroy
4042 .Op Ic off | on | no-detached
4044 If on (the default), the client is detached when the session it is attached to
4046 If off, the client is switched to the most recently active of the remaining
4050 the client is detached only if there are no detached sessions; if detached
4051 sessions exist, the client is switched to the most recently active.
4052 .It Ic display-panes-active-colour Ar colour
4053 Set the colour used by the
4055 command to show the indicator for the active pane.
4056 .It Ic display-panes-colour Ar colour
4057 Set the colour used by the
4059 command to show the indicators for inactive panes.
4060 .It Ic display-panes-time Ar time
4061 Set the time in milliseconds for which the indicators shown by the
4064 .It Ic display-time Ar time
4065 Set the amount of time for which status line messages and other on-screen
4066 indicators are displayed.
4067 If set to 0, messages and indicators are displayed until a key is pressed.
4070 .It Ic history-limit Ar lines
4071 Set the maximum number of lines held in window history.
4072 This setting applies only to new windows - existing window histories are not
4073 resized and retain the limit at the point they were created.
4074 .It Ic key-table Ar key-table
4075 Set the default key table to
4079 .It Ic lock-after-time Ar number
4080 Lock the session (like the
4084 seconds of inactivity.
4085 The default is not to lock (set to 0).
4086 .It Ic lock-command Ar shell-command
4087 Command to run when locking each client.
4088 The default is to run
4092 .It Ic menu-style Ar style
4096 section on how to specify
4098 Attributes are ignored.
4099 .It Ic menu-selected-style Ar style
4100 Set the selected menu item style.
4103 section on how to specify
4105 Attributes are ignored.
4106 .It Ic menu-border-style Ar style
4107 Set the menu border style.
4110 section on how to specify
4112 Attributes are ignored.
4113 .It Ic menu-border-lines Ar type
4114 Set the type of characters used for drawing menu borders.
4116 .Ic popup-border-lines
4117 for possible values for
4119 .It Ic message-command-style Ar style
4120 Set status line message command style.
4121 This is used for the command prompt with
4123 keys when in command mode.
4129 .It Xo Ic message-line
4130 .Op Ic 0 | 1 | 2 | 3 | 4
4132 Set line on which status line messages and the command prompt are shown.
4133 .It Ic message-style Ar style
4134 Set status line message style.
4135 This is used for messages and for the command prompt.
4146 captures the mouse and allows mouse events to be bound as key bindings.
4149 section for details.
4150 .It Ic prefix Ar key
4151 Set the key accepted as a prefix key.
4152 In addition to the standard keys described under
4155 can be set to the special key
4158 .It Ic prefix2 Ar key
4159 Set a secondary key accepted as a prefix key.
4165 .It Xo Ic renumber-windows
4168 If on, when a window is closed in a session, automatically renumber the other
4169 windows in numerical order.
4172 option if it has been set.
4173 If off, do not renumber the windows.
4174 .It Ic repeat-time Ar time
4175 Allow multiple commands to be entered without pressing the prefix-key again
4178 milliseconds (the default is 500).
4179 Whether a key repeats may be set when it is bound using the
4183 Repeat is enabled for the default keys bound to the
4186 .It Xo Ic set-titles
4189 Attempt to set the client terminal title using the
4194 entries if they exist.
4196 automatically sets these to the \ee]0;...\e007 sequence if
4197 the terminal appears to be
4199 This option is off by default.
4200 .It Ic set-titles-string Ar string
4201 String used to set the client terminal title if
4204 Formats are expanded, see the
4207 .It Xo Ic silence-action
4208 .Op Ic any | none | current | other
4210 Set action on window silence when
4213 The values are the same as those for
4214 .Ic activity-action .
4216 .Op Ic off | on | 2 | 3 | 4 | 5
4218 Show or hide the status line or specify its size.
4221 gives a status line one row in height;
4228 .It Ic status-format[] Ar format
4229 Specify the format to be used for each line of the status line.
4230 The default builds the top status line from the various individual status
4232 .It Ic status-interval Ar interval
4233 Update the status line every
4236 By default, updates will occur every 15 seconds.
4237 A setting of zero disables redrawing at interval.
4238 .It Xo Ic status-justify
4239 .Op Ic left | centre | right | absolute-centre
4241 Set the position of the window list in the status line: left, centre or right.
4242 centre puts the window list in the relative centre of the available free space;
4243 absolute-centre uses the centre of the entire horizontal space.
4244 .It Xo Ic status-keys
4247 Use vi or emacs-style
4248 key bindings in the status line, for example at the command prompt.
4249 The default is emacs, unless the
4253 environment variables are set and contain the string
4255 .It Ic status-left Ar string
4258 (by default the session name) to the left of the status line.
4260 will be passed through
4268 For details on how the names and titles can be set see the
4269 .Sx "NAMES AND TITLES"
4273 .Bd -literal -offset indent
4274 #(sysctl vm.loadavg)
4275 #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
4280 .It Ic status-left-length Ar length
4283 of the left component of the status line.
4285 .It Ic status-left-style Ar style
4286 Set the style of the left part of the status line.
4292 .It Xo Ic status-position
4295 Set the position of the status line.
4296 .It Ic status-right Ar string
4299 to the right of the status line.
4300 By default, the current pane title in double quotes, the date and the time
4307 and character pairs are replaced.
4308 .It Ic status-right-length Ar length
4311 of the right component of the status line.
4313 .It Ic status-right-style Ar style
4314 Set the style of the right part of the status line.
4320 .It Ic status-style Ar style
4321 Set status line style.
4327 .It Ic update-environment[] Ar variable
4328 Set list of environment variables to be copied into the session environment
4329 when a new session is created or an existing session is attached.
4330 Any variables that do not exist in the source environment are set to be
4331 removed from the session environment (as if
4336 .It Xo Ic visual-activity
4337 .Op Ic on | off | both
4339 If on, display a message instead of sending a bell when activity occurs in a
4340 window for which the
4341 .Ic monitor-activity
4342 window option is enabled.
4343 If set to both, a bell and a message are produced.
4344 .It Xo Ic visual-bell
4345 .Op Ic on | off | both
4347 If on, a message is shown on a bell in a window for which the
4349 window option is enabled instead of it being passed through to the
4350 terminal (which normally makes a sound).
4351 If set to both, a bell and a message are produced.
4355 .It Xo Ic visual-silence
4356 .Op Ic on | off | both
4360 is enabled, prints a message after the interval has expired on a given window
4361 instead of sending a bell.
4362 If set to both, a bell and a message are produced.
4363 .It Ic word-separators Ar string
4364 Sets the session's conception of what characters are considered word
4365 separators, for the purposes of the next and previous word commands in
4369 Available window options are:
4371 .Bl -tag -width Ds -compact
4372 .It Xo Ic aggressive-resize
4375 Aggressively resize the chosen window.
4378 will resize the window to the size of the smallest or largest session
4381 option) for which it is the current window, rather than the session to
4382 which it is attached.
4383 The window may resize when the current window is changed on another
4384 session; this option is good for full-screen programs which support
4386 and poor for interactive programs such as shells.
4388 .It Xo Ic automatic-rename
4391 Control automatic window renaming.
4392 When this setting is enabled,
4394 will rename the window automatically using the format specified by
4395 .Ic automatic-rename-format .
4396 This flag is automatically disabled for an individual window when a name
4397 is specified at creation with
4403 or with a terminal escape sequence.
4404 It may be switched off globally with:
4405 .Bd -literal -offset indent
4406 set-option -wg automatic-rename off
4409 .It Ic automatic-rename-format Ar format
4413 .Ic automatic-rename
4416 .It Ic clock-mode-colour Ar colour
4419 .It Xo Ic clock-mode-style
4422 Set clock hour format.
4424 .It Ic fill-character Ar character
4425 Set the character used to fill areas of the terminal unused by a window.
4427 .It Ic main-pane-height Ar height
4428 .It Ic main-pane-width Ar width
4429 Set the width or height of the main (left or top) pane in the
4436 this is a percentage of the window size.
4438 .It Ic copy-mode-match-style Ar style
4439 Set the style of search matches in copy mode.
4446 .It Ic copy-mode-mark-style Ar style
4447 Set the style of the line containing the mark in copy mode.
4454 .It Ic copy-mode-current-match-style Ar style
4455 Set the style of the current search match in copy mode.
4465 Use vi or emacs-style key bindings in copy mode.
4466 The default is emacs, unless
4473 .It Ic mode-style Ar style
4474 Set window modes style.
4481 .It Xo Ic monitor-activity
4484 Monitor for activity in the window.
4485 Windows with activity are highlighted in the status line.
4487 .It Xo Ic monitor-bell
4490 Monitor for a bell in the window.
4491 Windows with a bell are highlighted in the status line.
4493 .It Xo Ic monitor-silence
4496 Monitor for silence (no activity) in the window within
4499 Windows that have been silent for the interval are highlighted in the
4501 An interval of zero disables the monitoring.
4503 .It Ic other-pane-height Ar height
4504 Set the height of the other panes (not the main pane) in the
4507 If this option is set to 0 (the default), it will have no effect.
4509 .Ic main-pane-height
4511 .Ic other-pane-height
4512 options are set, the main pane will grow taller to make the other panes the
4513 specified height, but will never shrink to do so.
4516 this is a percentage of the window size.
4518 .It Ic other-pane-width Ar width
4520 .Ic other-pane-height ,
4521 but set the width of other panes in the
4525 .It Ic pane-active-border-style Ar style
4526 Set the pane border style for the currently active pane.
4532 Attributes are ignored.
4534 .It Ic pane-base-index Ar index
4537 but set the starting index for pane numbers.
4539 .It Ic pane-border-format Ar format
4540 Set the text shown in pane border status lines.
4542 .It Xo Ic pane-border-indicators
4543 .Op Ic off | colour | arrows | both
4545 Indicate active pane by colouring only half of the border in windows with
4546 exactly two panes, by displaying arrow markers, by drawing both or neither.
4548 .It Ic pane-border-lines Ar type
4549 Set the type of characters used for drawing pane borders.
4554 single lines using ACS or UTF-8 characters
4556 double lines using UTF-8 characters
4558 heavy lines using UTF-8 characters
4560 simple ASCII characters
4568 will fall back to standard ACS line drawing when UTF-8 is not supported.
4570 .It Xo Ic pane-border-status
4571 .Op Ic off | top | bottom
4573 Turn pane border status lines off or set their position.
4575 .It Ic pane-border-style Ar style
4576 Set the pane border style for panes aside from the active pane.
4582 Attributes are ignored.
4584 .It Ic popup-style Ar style
4585 Set the popup style.
4588 section on how to specify
4590 Attributes are ignored.
4592 .It Ic popup-border-style Ar style
4593 Set the popup border style.
4596 section on how to specify
4598 Attributes are ignored.
4600 .It Ic popup-border-lines Ar type
4601 Set the type of characters used for drawing popup borders.
4606 single lines using ACS or UTF-8 characters (default)
4608 variation of single with rounded corners using UTF-8 characters
4610 double lines using UTF-8 characters
4612 heavy lines using UTF-8 characters
4614 simple ASCII characters
4616 simple ASCII space character
4624 will fall back to standard ACS line drawing when UTF-8 is not supported.
4626 .It Ic window-status-activity-style Ar style
4627 Set status line style for windows with an activity alert.
4634 .It Ic window-status-bell-style Ar style
4635 Set status line style for windows with a bell alert.
4642 .It Ic window-status-current-format Ar string
4644 .Ar window-status-format ,
4645 but is the format used when the window is the current window.
4647 .It Ic window-status-current-style Ar style
4648 Set status line style for the currently active window.
4655 .It Ic window-status-format Ar string
4656 Set the format in which the window is displayed in the status line window list.
4663 .It Ic window-status-last-style Ar style
4664 Set status line style for the last active window.
4671 .It Ic window-status-separator Ar string
4672 Sets the separator drawn between windows in the status line.
4673 The default is a single space character.
4675 .It Ic window-status-style Ar style
4676 Set status line style for a single window.
4683 .It Xo Ic window-size
4684 .Ar largest | Ar smallest | Ar manual | Ar latest
4688 determines the window size.
4691 the size of the largest attached session is used; if
4693 the size of the smallest.
4696 the size of a new window is set from the
4698 option and windows are resized automatically.
4702 uses the size of the client that had the most recent activity.
4706 .Ic aggressive-resize
4709 .It Xo Ic wrap-search
4712 If this option is set, searches will wrap around the end of the pane contents.
4716 Available pane options are:
4718 .Bl -tag -width Ds -compact
4719 .It Xo Ic allow-passthrough
4720 .Op Ic on | off | all
4722 Allow programs in the pane to bypass
4724 using a terminal escape sequence (\eePtmux;...\ee\e\e).
4727 passthrough sequences will be allowed only if the pane is visible.
4730 they will be allowed even if the pane is invisible.
4732 .It Xo Ic allow-rename
4735 Allow programs in the pane to change the window name using a terminal escape
4736 sequence (\eek...\ee\e\e).
4738 .It Xo Ic alternate-screen
4741 This option configures whether programs running inside the pane may use the
4742 terminal alternate screen feature, which allows the
4748 The alternate screen feature preserves the contents of the window when an
4749 interactive application starts and restores it on exit, so that any output
4750 visible before the application starts reappears unchanged after it exits.
4752 .It Ic cursor-colour Ar colour
4753 Set the colour of the cursor.
4755 .It Ic pane-colours[] Ar colour
4756 The default colour palette.
4757 Each entry in the array defines the colour
4759 uses when the colour with that index is requested.
4760 The index may be from zero to 255.
4762 .It Ic cursor-style Ar style
4763 Set the style of the cursor.
4764 Available styles are:
4766 .Ic blinking-block ,
4768 .Ic blinking-underline ,
4773 .It Xo Ic remain-on-exit
4774 .Op Ic on | off | failed
4776 A pane with this flag set is not destroyed when the program running in it
4780 then only when the program exit status is not zero.
4781 The pane may be reactivated with the
4785 .It Ic remain-on-exit-format Ar string
4786 Set the text shown at the bottom of exited panes when
4790 .It Xo Ic scroll-on-clear
4793 When the entire screen is cleared and this option is on, scroll the contents of
4794 the screen into history before clearing it.
4796 .It Xo Ic synchronize-panes
4799 Duplicate input to all other panes in the same window where this option is also
4800 on (only for panes that are not in any mode).
4802 .It Ic window-active-style Ar style
4803 Set the pane style when it is the active pane.
4810 .It Ic window-style Ar style
4820 allows commands to run on various triggers, called
4826 hook and there are a number of hooks not associated with commands.
4828 Hooks are stored as array options, members of the array are executed in
4829 order when the hook is triggered.
4830 Like options different hooks may be global or belong to a session, window or
4832 Hooks may be configured with the
4836 commands and displayed with
4841 The following two commands are equivalent:
4842 .Bd -literal -offset indent.
4843 set-hook -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4844 set-option -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4847 Setting a hook without specifying an array index clears the hook and sets the
4848 first member of the array.
4851 hook is run after it completes, except when the command is run as part of a hook
4853 They are named with an
4856 For example, the following command adds a hook to select the even-vertical
4859 .Bd -literal -offset indent
4860 set-hook -g after-split-window "selectl even-vertical"
4863 All the notifications listed in the
4865 section are hooks (without any arguments), except
4867 The following additional hooks are available:
4868 .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXX"
4870 Run when a window has activity.
4872 .Ic monitor-activity .
4874 Run when a window has received a bell.
4878 Run when a window has been silent.
4880 .Ic monitor-silence .
4882 Run when a client becomes the latest active client of its session.
4884 Run when a client is attached.
4886 Run when a client is detached
4888 Run when focus enters a client
4889 .It client-focus-out
4890 Run when focus exits a client
4892 Run when a client is resized.
4893 .It client-session-changed
4894 Run when a client's attached session is changed.
4896 Run when the program running in a pane exits, but
4898 is on so the pane has not closed.
4900 Run when the program running in a pane exits.
4902 Run when the focus enters a pane, if the
4906 Run when the focus exits a pane, if the
4909 .It pane-set-clipboard
4910 Run when the terminal clipboard is set using the
4914 Run when a new session created.
4916 Run when a session closed.
4918 Run when a session is renamed.
4920 Run when a window is linked into a session.
4922 Run when a window is renamed.
4924 Run when a window is resized.
4925 This may be after the
4929 Run when a window is unlinked from a session.
4932 Hooks are managed with these commands:
4936 .Op Fl t Ar target-pane
4948 The flags are the same as for
4956 .It Xo Ic show-hooks
4958 .Op Fl t Ar target-pane
4961 The flags are the same as for
4967 option is on (the default is off),
4969 allows mouse events to be bound as keys.
4970 The name of each key is made up of a mouse event (such as
4972 and a location suffix, one of the following:
4973 .Bl -column "XXXXXXXXXXXXX" -offset indent
4974 .It Li "Pane" Ta "the contents of a pane"
4975 .It Li "Border" Ta "a pane border"
4976 .It Li "Status" Ta "the status line window list"
4977 .It Li "StatusLeft" Ta "the left part of the status line"
4978 .It Li "StatusRight" Ta "the right part of the status line"
4979 .It Li "StatusDefault" Ta "any other part of the status line"
4982 The following mouse events are available:
4983 .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
4984 .It Li "WheelUp" Ta "WheelDown" Ta ""
4985 .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
4986 .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
4987 .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
4988 .It Li "SecondClick1" Ta "SecondClick2" Ta "SecondClick3"
4989 .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3"
4990 .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3"
4995 events are fired for the second click of a double click, even if there may be a
4996 third click which will fire
5001 Each should be suffixed with a location, for example
5002 .Ql MouseDown1Status .
5012 in commands bound to mouse key bindings.
5013 It resolves to the window or pane over which the mouse event took place
5014 (for example, the window in the status line over which button 1 was released
5017 binding, or the pane over which the wheel was scrolled for a
5024 flag may be used to forward a mouse event to a pane.
5026 The default key bindings allow the mouse to be used to select and resize panes,
5027 to copy text and to change window using the status line.
5028 These take effect if the
5030 option is turned on.
5032 Certain commands accept the
5037 This is a string which controls the output format of the command.
5038 Format variables are enclosed in
5043 .Ql #{session_name} .
5044 The possible variables are listed in the table below, or the name of a
5046 option may be used for an option's value.
5047 Some variables have a shorter alias such as
5050 is replaced by a single
5060 Conditionals are available by prefixing with
5062 and separating two alternatives with a comma;
5063 if the specified variable exists and is not zero, the first alternative
5064 is chosen, otherwise the second is used.
5066 .Ql #{?session_attached,attached,not attached}
5067 will include the string
5069 if the session is attached and the string
5071 if it is unattached, or
5072 .Ql #{?automatic-rename,yes,no}
5076 .Ic automatic-rename
5080 Conditionals can be nested arbitrarily.
5081 Inside a conditional,
5089 unless they are part of a
5093 .Bd -literal -offset indent
5094 #{?pane_in_mode,#[fg=white#,bg=red],#[fg=red#,bg=white]}#W .
5097 String comparisons may be expressed by prefixing two comma-separated
5108 .Ql #{==:#{host},myhost}
5118 evaluate to true if either or both of two comma-separated alternatives are
5120 .Ql #{||:#{pane_in_mode},#{alternate_on}} .
5126 or regular expression comparison.
5127 The first argument is the pattern and the second the string to compare.
5128 An optional argument specifies flags:
5130 means the pattern is a regular expression instead of the default
5134 means to ignore case.
5136 .Ql #{m:*foo*,#{host}}
5138 .Ql #{m/ri:^A,MYVAR} .
5141 performs a search for an
5143 pattern or regular expression in the pane content and evaluates to zero if not
5144 found, or a line number if found.
5149 flag means search for a regular expression and
5155 Numeric operators may be performed by prefixing two comma-separated alternatives
5161 flag may be given after the operator to use floating point numbers, otherwise
5163 This may be followed by a number giving the number of decimal places to use for
5165 The available operators are:
5182 in formats which are also expanded by
5184 and numeric comparison operators
5193 .Ql #{e|*|f|4:5.5,3}
5194 multiplies 5.5 by 3 for a result with four decimal places and
5196 returns the modulus of 7 and 3.
5198 replaces a numeric argument by its ASCII equivalent, so
5205 colour by its six-digit hexadecimal RGB value.
5207 A limit may be placed on the length of the resultant string by prefixing it
5210 a number and a colon.
5211 Positive numbers count from the start of the string and negative from the end,
5213 .Ql #{=5:pane_title}
5214 will include at most the first five characters of the pane title, or
5215 .Ql #{=-5:pane_title}
5216 the last five characters.
5217 A suffix or prefix may be given as a second argument - if provided then it is
5218 appended or prepended to the string if the length has been trimmed, for example
5219 .Ql #{=/5/...:pane_title}
5222 if the pane title is more than five characters.
5225 pads the string to a given width, for example
5226 .Ql #{p10:pane_title}
5227 will result in a width of at least 10 characters.
5228 A positive width pads on the left, a negative on the right.
5230 expands to the length of the variable and
5232 to its width when displayed, for example
5233 .Ql #{n:window_name} .
5235 Prefixing a time variable with
5237 will convert it to a string, so if
5238 .Ql #{window_activity}
5241 .Ql #{t:window_activity}
5243 .Ql Sun Oct 25 09:25:02 2015 .
5247 will use shorter but less accurate time format for times in the past.
5248 A custom format may be given using an
5254 if the format is separately being passed through
5259 .Ql #{t/f/%%H#:%%M:window_activity} ,
5271 of the variable respectively.
5275 special characters or with a
5277 suffix, escape hash characters (so
5282 will expand the format twice, for example
5283 .Ql #{E:status-left}
5284 is the result of expanding the content of the
5286 option rather than the option itself.
5298 will loop over each session, window, pane or client and insert the format once
5300 For windows and panes, two comma-separated formats may be given:
5301 the second is used for the current window or active pane.
5302 For example, to get a list of windows formatted like the status line:
5303 .Bd -literal -offset indent
5304 #{W:#{E:window-status-format} ,#{E:window-status-current-format} }
5308 checks if a window (without any suffix or with the
5310 suffix) or a session (with the
5312 suffix) name exists, for example
5314 is replaced with 1 if a window named
5318 A prefix of the form
5325 The first argument may be an extended regular expression and a final argument
5328 to ignore case, for example
5329 .Ql s/a(.)/\e1x/i:\&
5334 A different delimiter character may also be used, to avoid collisions with
5335 literal slashes in the pattern.
5344 In addition, the last line of a shell command's output may be inserted using
5348 will insert the system's uptime.
5349 When constructing formats,
5353 commands to finish; instead, the previous result from running the same command
5354 is used, or a placeholder if the command has not been run before.
5355 If the command hasn't exited, the most recent line of output will be used, but
5356 the status line will not be updated more than once a second.
5357 Commands are executed using
5361 global environment set (see the
5362 .Sx GLOBAL AND SESSION ENVIRONMENT
5367 specifies that a string should be interpreted literally and not expanded.
5369 .Ql #{l:#{?pane_in_mode,yes,no}}
5371 .Ql #{?pane_in_mode,yes,no} .
5373 The following variables are available, where appropriate:
5374 .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
5375 .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
5376 .It Li "active_window_index" Ta "" Ta "Index of active window in session"
5377 .It Li "alternate_on" Ta "" Ta "1 if pane is in alternate screen"
5378 .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
5379 .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
5380 .It Li "buffer_created" Ta "" Ta "Time buffer created"
5381 .It Li "buffer_name" Ta "" Ta "Name of buffer"
5382 .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
5383 .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
5384 .It Li "client_activity" Ta "" Ta "Time client last had activity"
5385 .It Li "client_cell_height" Ta "" Ta "Height of each client cell in pixels"
5386 .It Li "client_cell_width" Ta "" Ta "Width of each client cell in pixels"
5387 .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
5388 .It Li "client_created" Ta "" Ta "Time client created"
5389 .It Li "client_discarded" Ta "" Ta "Bytes discarded when client behind"
5390 .It Li "client_flags" Ta "" Ta "List of client flags"
5391 .It Li "client_height" Ta "" Ta "Height of client"
5392 .It Li "client_key_table" Ta "" Ta "Current key table"
5393 .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
5394 .It Li "client_name" Ta "" Ta "Name of client"
5395 .It Li "client_pid" Ta "" Ta "PID of client process"
5396 .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
5397 .It Li "client_readonly" Ta "" Ta "1 if client is read-only"
5398 .It Li "client_session" Ta "" Ta "Name of the client's session"
5399 .It Li "client_termfeatures" Ta "" Ta "Terminal features of client, if any"
5400 .It Li "client_termname" Ta "" Ta "Terminal name of client"
5401 .It Li "client_termtype" Ta "" Ta "Terminal type of client, if available"
5402 .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
5403 .It Li "client_uid" Ta "" Ta "UID of client process"
5404 .It Li "client_user" Ta "" Ta "User of client process"
5405 .It Li "client_utf8" Ta "" Ta "1 if client supports UTF-8"
5406 .It Li "client_width" Ta "" Ta "Width of client"
5407 .It Li "client_written" Ta "" Ta "Bytes written to client"
5408 .It Li "command" Ta "" Ta "Name of command in use, if any"
5409 .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
5410 .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
5411 .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
5412 .It Li "config_files" Ta "" Ta "List of configuration files loaded"
5413 .It Li "copy_cursor_line" Ta "" Ta "Line the cursor is on in copy mode"
5414 .It Li "copy_cursor_word" Ta "" Ta "Word under cursor in copy mode"
5415 .It Li "copy_cursor_x" Ta "" Ta "Cursor X position in copy mode"
5416 .It Li "copy_cursor_y" Ta "" Ta "Cursor Y position in copy mode"
5417 .It Li "current_file" Ta "" Ta "Current configuration file"
5418 .It Li "cursor_character" Ta "" Ta "Character at cursor in pane"
5419 .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
5420 .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
5421 .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
5422 .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
5423 .It Li "history_limit" Ta "" Ta "Maximum window history lines"
5424 .It Li "history_size" Ta "" Ta "Size of history in lines"
5425 .It Li "hook" Ta "" Ta "Name of running hook, if any"
5426 .It Li "hook_client" Ta "" Ta "Name of client where hook was run, if any"
5427 .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
5428 .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
5429 .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
5430 .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
5431 .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
5432 .It Li "host" Ta "#H" Ta "Hostname of local host"
5433 .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
5434 .It Li "insert_flag" Ta "" Ta "Pane insert flag"
5435 .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
5436 .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
5437 .It Li "last_window_index" Ta "" Ta "Index of last window in session"
5438 .It Li "line" Ta "" Ta "Line number in the list"
5439 .It Li "mouse_all_flag" Ta "" Ta "Pane mouse all flag"
5440 .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
5441 .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
5442 .It Li "mouse_hyperlink" Ta "" Ta "Hyperlink under mouse, if any"
5443 .It Li "mouse_line" Ta "" Ta "Line under mouse, if any"
5444 .It Li "mouse_sgr_flag" Ta "" Ta "Pane mouse SGR flag"
5445 .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
5446 .It Li "mouse_utf8_flag" Ta "" Ta "Pane mouse UTF-8 flag"
5447 .It Li "mouse_word" Ta "" Ta "Word under mouse, if any"
5448 .It Li "mouse_x" Ta "" Ta "Mouse X position, if any"
5449 .It Li "mouse_y" Ta "" Ta "Mouse Y position, if any"
5450 .It Li "next_session_id" Ta "" Ta "Unique session ID for next new session"
5451 .It Li "origin_flag" Ta "" Ta "Pane origin flag"
5452 .It Li "pane_active" Ta "" Ta "1 if active pane"
5453 .It Li "pane_at_bottom" Ta "" Ta "1 if pane is at the bottom of window"
5454 .It Li "pane_at_left" Ta "" Ta "1 if pane is at the left of window"
5455 .It Li "pane_at_right" Ta "" Ta "1 if pane is at the right of window"
5456 .It Li "pane_at_top" Ta "" Ta "1 if pane is at the top of window"
5457 .It Li "pane_bg" Ta "" Ta "Pane background colour"
5458 .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
5459 .It Li "pane_current_command" Ta "" Ta "Current command if available"
5460 .It Li "pane_current_path" Ta "" Ta "Current path if available"
5461 .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
5462 .It Li "pane_dead_signal" Ta "" Ta "Exit signal of process in dead pane"
5463 .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
5464 .It Li "pane_dead_time" Ta "" Ta "Exit time of process in dead pane"
5465 .It Li "pane_fg" Ta "" Ta "Pane foreground colour"
5466 .It Li "pane_format" Ta "" Ta "1 if format is for a pane"
5467 .It Li "pane_height" Ta "" Ta "Height of pane"
5468 .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
5469 .It Li "pane_in_mode" Ta "" Ta "1 if pane is in a mode"
5470 .It Li "pane_index" Ta "#P" Ta "Index of pane"
5471 .It Li "pane_input_off" Ta "" Ta "1 if input to pane is disabled"
5472 .It Li "pane_last" Ta "" Ta "1 if last pane"
5473 .It Li "pane_left" Ta "" Ta "Left of pane"
5474 .It Li "pane_marked" Ta "" Ta "1 if this is the marked pane"
5475 .It Li "pane_marked_set" Ta "" Ta "1 if a marked pane is set"
5476 .It Li "pane_mode" Ta "" Ta "Name of pane mode, if any"
5477 .It Li "pane_path" Ta "" Ta "Path of pane (can be set by application)"
5478 .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
5479 .It Li "pane_pipe" Ta "" Ta "1 if pane is being piped"
5480 .It Li "pane_right" Ta "" Ta "Right of pane"
5481 .It Li "pane_search_string" Ta "" Ta "Last search string in copy mode"
5482 .It Li "pane_start_command" Ta "" Ta "Command pane started with"
5483 .It Li "pane_start_path" Ta "" Ta "Path pane started with"
5484 .It Li "pane_synchronized" Ta "" Ta "1 if pane is synchronized"
5485 .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
5486 .It Li "pane_title" Ta "#T" Ta "Title of pane (can be set by application)"
5487 .It Li "pane_top" Ta "" Ta "Top of pane"
5488 .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
5489 .It Li "pane_unseen_changes" Ta "" Ta "1 if there were changes in pane while in mode"
5490 .It Li "pane_width" Ta "" Ta "Width of pane"
5491 .It Li "pid" Ta "" Ta "Server PID"
5492 .It Li "rectangle_toggle" Ta "" Ta "1 if rectangle selection is activated"
5493 .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
5494 .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
5495 .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
5496 .It Li "search_match" Ta "" Ta "Search match if any"
5497 .It Li "search_present" Ta "" Ta "1 if search started in copy mode"
5498 .It Li "selection_active" Ta "" Ta "1 if selection started and changes with the cursor in copy mode"
5499 .It Li "selection_end_x" Ta "" Ta "X position of the end of the selection"
5500 .It Li "selection_end_y" Ta "" Ta "Y position of the end of the selection"
5501 .It Li "selection_present" Ta "" Ta "1 if selection started in copy mode"
5502 .It Li "selection_start_x" Ta "" Ta "X position of the start of the selection"
5503 .It Li "selection_start_y" Ta "" Ta "Y position of the start of the selection"
5504 .It Li "server_sessions" Ta "" Ta "Number of sessions"
5505 .It Li "session_activity" Ta "" Ta "Time of session last activity"
5506 .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
5507 .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
5508 .It Li "session_attached_list" Ta "" Ta "List of clients session is attached to"
5509 .It Li "session_created" Ta "" Ta "Time session created"
5510 .It Li "session_format" Ta "" Ta "1 if format is for a session"
5511 .It Li "session_group" Ta "" Ta "Name of session group"
5512 .It Li "session_group_attached" Ta "" Ta "Number of clients sessions in group are attached to"
5513 .It Li "session_group_attached_list" Ta "" Ta "List of clients sessions in group are attached to"
5514 .It Li "session_group_list" Ta "" Ta "List of sessions in group"
5515 .It Li "session_group_many_attached" Ta "" Ta "1 if multiple clients attached to sessions in group"
5516 .It Li "session_group_size" Ta "" Ta "Size of session group"
5517 .It Li "session_grouped" Ta "" Ta "1 if session in a group"
5518 .It Li "session_id" Ta "" Ta "Unique session ID"
5519 .It Li "session_last_attached" Ta "" Ta "Time session last attached"
5520 .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
5521 .It Li "session_marked" Ta "" Ta "1 if this session contains the marked pane"
5522 .It Li "session_name" Ta "#S" Ta "Name of session"
5523 .It Li "session_path" Ta "" Ta "Working directory of session"
5524 .It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
5525 .It Li "session_windows" Ta "" Ta "Number of windows in session"
5526 .It Li "socket_path" Ta "" Ta "Server socket path"
5527 .It Li "start_time" Ta "" Ta "Server start time"
5528 .It Li "uid" Ta "" Ta "Server UID"
5529 .It Li "user" Ta "" Ta "Server user"
5530 .It Li "version" Ta "" Ta "Server version"
5531 .It Li "window_active" Ta "" Ta "1 if window active"
5532 .It Li "window_active_clients" Ta "" Ta "Number of clients viewing this window"
5533 .It Li "window_active_clients_list" Ta "" Ta "List of clients viewing this window"
5534 .It Li "window_active_sessions" Ta "" Ta "Number of sessions on which this window is active"
5535 .It Li "window_active_sessions_list" Ta "" Ta "List of sessions on which this window is active"
5536 .It Li "window_activity" Ta "" Ta "Time of window last activity"
5537 .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
5538 .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
5539 .It Li "window_bigger" Ta "" Ta "1 if window is larger than client"
5540 .It Li "window_cell_height" Ta "" Ta "Height of each cell in pixels"
5541 .It Li "window_cell_width" Ta "" Ta "Width of each cell in pixels"
5542 .It Li "window_end_flag" Ta "" Ta "1 if window has the highest index"
5543 .It Li "window_flags" Ta "#F" Ta "Window flags with # escaped as ##"
5544 .It Li "window_format" Ta "" Ta "1 if format is for a window"
5545 .It Li "window_height" Ta "" Ta "Height of window"
5546 .It Li "window_id" Ta "" Ta "Unique window ID"
5547 .It Li "window_index" Ta "#I" Ta "Index of window"
5548 .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
5549 .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
5550 .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
5551 .It Li "window_linked_sessions" Ta "" Ta "Number of sessions this window is linked to"
5552 .It Li "window_linked_sessions_list" Ta "" Ta "List of sessions this window is linked to"
5553 .It Li "window_marked_flag" Ta "" Ta "1 if window contains the marked pane"
5554 .It Li "window_name" Ta "#W" Ta "Name of window"
5555 .It Li "window_offset_x" Ta "" Ta "X offset into window if larger than client"
5556 .It Li "window_offset_y" Ta "" Ta "Y offset into window if larger than client"
5557 .It Li "window_panes" Ta "" Ta "Number of panes in window"
5558 .It Li "window_raw_flags" Ta "" Ta "Window flags with nothing escaped"
5559 .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
5560 .It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
5561 .It Li "window_start_flag" Ta "" Ta "1 if window has the lowest index"
5562 .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
5563 .It Li "window_width" Ta "" Ta "Width of window"
5564 .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
5565 .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
5569 offers various options to specify the colour and attributes of aspects of the
5570 interface, for example
5572 for the status line.
5573 In addition, embedded styles may be specified in format options, such as
5575 by enclosing them in
5580 A style may be the single term
5582 to specify the default style (which may come from an option, for example
5584 in the status line) or a space
5585 or comma separated list of the following:
5588 Set the foreground colour.
5589 The colour is one of:
5598 if supported the bright variants
5605 from the 256-colour set;
5607 for the default colour;
5609 for the terminal default colour; or a hexadecimal RGB string such as
5612 Set the background colour.
5614 Set the underscore colour.
5616 Set no attributes (turn off any active attributes).
5629 .Ic double-underscore ,
5630 .Ic curly-underscore ,
5631 .Ic dotted-underscore ,
5632 .Ic dashed-underscore
5635 Any of the attributes may be prefixed with
5639 is the terminal alternate character set.
5640 .It Xo Ic align=left
5646 Align text to the left, centre or right of the available space if appropriate.
5648 Fill the available space with a background colour if appropriate.
5651 .Ic list=left-marker ,
5652 .Ic list=right-marker ,
5655 Mark the position of the various window list components in the
5659 marks the start of the list;
5661 is the part of the list that should be kept in focus if the entire list won't
5662 fit in the available space (typically the current window);
5663 .Ic list=left-marker
5665 .Ic list=right-marker
5666 mark the text to be used to mark that text has been trimmed from the left or
5667 right of the list if there is not enough space.
5668 .It Xo Ic push-default ,
5671 Store the current colours and attributes as the default or reset to the previous
5675 affects any subsequent use of the
5679 Only one default may be pushed (each
5681 replaces the previous saved default).
5682 .It Xo Ic range=left ,
5684 .Ic range=window|X ,
5693 are the text used for the
5699 is the range for a window passed to the
5707 .Bd -literal -offset indent
5708 fg=yellow bold underscore blink
5709 bg=black,fg=default,noreverse
5711 .Sh NAMES AND TITLES
5713 distinguishes between names and titles.
5714 Windows and sessions have names, which may be used to specify them in targets
5715 and are displayed in the status line and various lists: the name is the
5717 identifier for a window or session.
5718 Only panes have titles.
5719 A pane's title is typically set by the program running inside the pane using
5720 an escape sequence (like it would set the
5724 Windows themselves do not have titles - a window's title is the title of its
5727 itself may set the title of the terminal in which the client is running, see
5732 A session's name is set with the
5737 A window's name is set with one of:
5740 A command argument (such as
5747 An escape sequence (if the
5749 option is turned on):
5750 .Bd -literal -offset indent
5751 $ printf '\e033kWINDOW_NAME\e033\e\e'
5754 Automatic renaming, which sets the name to the active command in the window's
5757 .Ic automatic-rename
5761 When a pane is first created, its title is the hostname.
5762 A pane's title can be set via the title setting escape sequence, for example:
5763 .Bd -literal -offset indent
5764 $ printf '\e033]2;My Title\e033\e\e'
5767 It can also be modified with the
5771 .Sh GLOBAL AND SESSION ENVIRONMENT
5772 When the server is started,
5774 copies the environment into the
5775 .Em global environment ;
5776 in addition, each session has a
5777 .Em session environment .
5778 When a window is created, the session and global environments are merged.
5779 If a variable exists in both, the value from the session environment is used.
5780 The result is the initial environment passed to the new process.
5783 .Ic update-environment
5784 session option may be used to update the session environment from the client
5785 when a new session is created or an old reattached.
5787 also initialises the
5789 variable with some internal information to allow commands to be executed
5790 from inside, and the
5792 variable with the correct terminal setting of
5795 Variables in both session and global environments may be marked as hidden.
5796 Hidden variables are not passed into the environment of new processes and
5797 instead can only be used by tmux itself (for example in formats, see the
5801 Commands to alter and view the environment are:
5804 .It Xo Ic set-environment
5806 .Op Fl t Ar target-session
5807 .Ar name Op Ar value
5809 .D1 Pq alias: Ic setenv
5810 Set or unset an environment variable.
5813 is used, the change is made in the global environment; otherwise, it is applied
5814 to the session environment for
5815 .Ar target-session .
5820 is expanded as a format.
5823 flag unsets a variable.
5825 indicates the variable is to be removed from the environment before starting a
5828 marks the variable as hidden.
5830 .It Xo Ic show-environment
5832 .Op Fl t Ar target-session
5835 .D1 Pq alias: Ic showenv
5836 Display the environment for
5838 or the global environment with
5842 is omitted, all variables are shown.
5843 Variables removed from the environment are prefixed with
5847 is used, the output is formatted as a set of Bourne shell commands.
5849 shows hidden variables (omitted by default).
5853 includes an optional status line which is displayed in the bottom line of each
5856 By default, the status line is enabled and one line in height (it may be
5857 disabled or made multiple lines with the
5859 session option) and contains, from left-to-right: the name of the current
5860 session in square brackets; the window list; the title of the active pane
5861 in double quotes; and the time and date.
5863 Each line of the status line is configured with the
5866 The default is made of three parts: configurable left and right sections (which
5867 may contain dynamic content such as the time or output from a shell command,
5870 .Ic status-left-length ,
5873 .Ic status-right-length
5874 options below), and a central window list.
5875 By default, the window list shows the index, name and (if any) flag of the
5876 windows present in the current session in ascending numerical order.
5877 It may be customised with the
5878 .Ar window-status-format
5880 .Ar window-status-current-format
5882 The flag is one of the following symbols appended to the window name:
5883 .Bl -column "Symbol" "Meaning" -offset indent
5884 .It Sy "Symbol" Ta Sy "Meaning"
5885 .It Li "*" Ta "Denotes the current window."
5886 .It Li "-" Ta "Marks the last window (previously selected)."
5887 .It Li "#" Ta "Window activity is monitored and activity has been detected."
5888 .It Li "\&!" Ta "Window bells are monitored and a bell has occurred in the window."
5889 .It Li "~" Ta "The window has been silent for the monitor-silence interval."
5890 .It Li "M" Ta "The window contains the marked pane."
5891 .It Li "Z" Ta "The window's active pane is zoomed."
5894 The # symbol relates to the
5895 .Ic monitor-activity
5897 The window name is printed in inverted colours if an alert (bell, activity or
5898 silence) is present.
5900 The colour and attributes of the status line may be configured, the entire
5901 status line using the
5903 session option and individual windows using the
5904 .Ic window-status-style
5907 The status line is automatically refreshed at interval if it has changed, the
5908 interval may be controlled with the
5912 Commands related to the status line are as follows:
5915 .It Xo Ic clear-prompt-history
5916 .Op Fl T Ar prompt-type
5918 .D1 Pq alias: Ic clearphist
5919 Clear status prompt history for prompt type
5923 is omitted, then clear history for all types.
5926 for possible values for
5928 .It Xo Ic command-prompt
5932 .Op Fl t Ar target-client
5933 .Op Fl T Ar prompt-type
5936 Open the command prompt in a client.
5937 This may be used from inside
5939 to execute commands interactively.
5943 is specified, it is used as the command.
5947 is expanded as a format.
5951 is a comma-separated list of the initial text for each prompt.
5956 is a comma-separated list of prompts which are displayed in order; otherwise
5957 a single prompt is displayed, constructed from
5959 if it is present, or
5963 Before the command is executed, the first occurrence of the string
5965 and all occurrences of
5967 are replaced by the response to the first prompt, all
5969 are replaced with the response to the second prompt, and so on for further
5971 Up to nine prompt responses may be replaced
5980 but any quotation marks are escaped.
5983 makes the prompt only accept one key press, in this case the resulting input
5984 is a single character.
5988 but the key press is translated to a key name.
5990 makes the prompt only accept numeric key presses.
5992 executes the command every time the prompt input changes instead of when the
5993 user exits the command prompt.
5999 This affects what completions are offered when
6002 Available types are:
6009 The following keys have a special meaning in the command prompt, depending
6013 .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
6014 .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
6015 .It Li "Cancel command prompt" Ta "q" Ta "Escape"
6016 .It Li "Delete from cursor to start of word" Ta "" Ta "C-w"
6017 .It Li "Delete entire command" Ta "d" Ta "C-u"
6018 .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
6019 .It Li "Execute command" Ta "Enter" Ta "Enter"
6020 .It Li "Get next command from history" Ta "" Ta "Down"
6021 .It Li "Get previous command from history" Ta "" Ta "Up"
6022 .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
6023 .It Li "Look for completions" Ta "Tab" Ta "Tab"
6024 .It Li "Move cursor left" Ta "h" Ta "Left"
6025 .It Li "Move cursor right" Ta "l" Ta "Right"
6026 .It Li "Move cursor to end" Ta "$" Ta "C-e"
6027 .It Li "Move cursor to next word" Ta "w" Ta "M-f"
6028 .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
6029 .It Li "Move cursor to start" Ta "0" Ta "C-a"
6030 .It Li "Transpose characters" Ta "" Ta "C-t"
6035 the prompt is shown in the background and the invoking client does not exit
6036 until it is dismissed.
6038 .It Xo Ic confirm-before
6040 .Op Fl c Ar confirm-key
6042 .Op Fl t Ar target-client
6045 .D1 Pq alias: Ic confirm
6046 Ask for confirmation before executing
6052 is the prompt to display; otherwise a prompt is constructed from
6054 It may contain the special character sequences supported by the
6059 the prompt is shown in the background and the invoking client does not exit
6060 until it is dismissed.
6062 changes the default behaviour (if Enter alone is pressed) of the prompt to
6065 changes the confirmation key to
6070 .It Xo Ic display-menu
6072 .Op Fl b Ar border-lines
6073 .Op Fl c Ar target-client
6074 .Op Fl C Ar starting-choice
6075 .Op Fl H Ar selected-style
6077 .Op Fl S Ar border-style
6078 .Op Fl t Ar target-pane
6080 .Op Fl x Ar position
6081 .Op Fl y Ar position
6084 .Ar command Op Ar argument ...
6086 .D1 Pq alias: Ic menu
6090 gives the target for any commands run from the menu.
6092 A menu is passed as a series of arguments: first the menu item name,
6093 second the key shortcut (or empty for none) and third the command
6094 to run when the menu item is chosen.
6095 The name and command are formats, see the
6100 If the name begins with a hyphen (-), then the item is disabled (shown dim) and
6102 The name may be empty for a separator line, in which case both the key and
6103 command should be omitted.
6106 sets the type of characters used for drawing menu borders.
6108 .Ic popup-border-lines
6109 for possible values for
6113 sets the style for the selected menu item (see
6117 sets the style for the menu and
6119 sets the style for the menu border (see
6123 is a format for the menu title (see
6127 sets the menu item selected by default, if the menu is not bound to a mouse key
6133 give the position of the menu.
6134 Both may be a row or column number, or one of the following special values:
6135 .Bl -column "XXXXX" "XXXX" -offset indent
6136 .It Sy "Value" Ta Sy "Flag" Ta Sy "Meaning"
6137 .It Li "C" Ta "Both" Ta "The centre of the terminal"
6138 .It Li "R" Ta Fl x Ta "The right side of the terminal"
6139 .It Li "P" Ta "Both" Ta "The bottom left of the pane"
6140 .It Li "M" Ta "Both" Ta "The mouse position"
6141 .It Li "W" Ta "Both" Ta "The window position on the status line"
6142 .It Li "S" Ta Fl y Ta "The line above or below the status line"
6145 Or a format, which is expanded including the following additional variables:
6146 .Bl -column "XXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent
6147 .It Sy "Variable name" Ta Sy "Replaced with"
6148 .It Li "popup_centre_x" Ta "Centered in the client"
6149 .It Li "popup_centre_y" Ta "Centered in the client"
6150 .It Li "popup_height" Ta "Height of menu or popup"
6151 .It Li "popup_mouse_bottom" Ta "Bottom of at the mouse"
6152 .It Li "popup_mouse_centre_x" Ta "Horizontal centre at the mouse"
6153 .It Li "popup_mouse_centre_y" Ta "Vertical centre at the mouse"
6154 .It Li "popup_mouse_top" Ta "Top at the mouse"
6155 .It Li "popup_mouse_x" Ta "Mouse X position"
6156 .It Li "popup_mouse_y" Ta "Mouse Y position"
6157 .It Li "popup_pane_bottom" Ta "Bottom of the pane"
6158 .It Li "popup_pane_left" Ta "Left of the pane"
6159 .It Li "popup_pane_right" Ta "Right of the pane"
6160 .It Li "popup_pane_top" Ta "Top of the pane"
6161 .It Li "popup_status_line_y" Ta "Above or below the status line"
6162 .It Li "popup_width" Ta "Width of menu or popup"
6163 .It Li "popup_window_status_line_x" Ta "At the window position in status line"
6164 .It Li "popup_window_status_line_y" Ta "At the status line showing the window"
6167 Each menu consists of items followed by a key shortcut shown in brackets.
6168 If the menu is too large to fit on the terminal, it is not displayed.
6169 Pressing the key shortcut chooses the corresponding item.
6170 If the mouse is enabled and the menu is opened from a mouse key binding,
6171 releasing the mouse button with an item selected chooses that item and
6172 releasing the mouse button without an item selected closes the menu.
6174 changes this behaviour so that the menu does not close when the mouse button is
6175 released without an item selected the menu is not closed and a mouse button
6176 must be clicked to choose an item.
6178 The following keys are also available:
6179 .Bl -column "Key" "Function" -offset indent
6180 .It Sy "Key" Ta Sy "Function"
6181 .It Li "Enter" Ta "Choose selected item"
6182 .It Li "Up" Ta "Select previous item"
6183 .It Li "Down" Ta "Select next item"
6184 .It Li "q" Ta "Exit menu"
6187 .It Xo Ic display-message
6189 .Op Fl c Ar target-client
6191 .Op Fl t Ar target-pane
6194 .D1 Pq alias: Ic display
6198 is given, the output is printed to stdout, otherwise it is displayed in the
6200 status line for up to
6207 option is used; a delay of zero waits for a key press.
6209 ignores key presses and closes only after the delay expires.
6214 is printed unchanged.
6215 Otherwise, the format of
6219 section; information is taken from
6223 is given, otherwise the active pane.
6226 prints verbose logging as the format is parsed and
6228 lists the format variables and their values.
6231 forwards any input read from stdin to the empty pane given by
6234 .It Xo Ic display-popup
6236 .Op Fl b Ar border-lines
6237 .Op Fl c Ar target-client
6238 .Op Fl d Ar start-directory
6239 .Op Fl e Ar environment
6241 .Op Fl s Ar border-style
6243 .Op Fl t Ar target-pane
6246 .Op Fl x Ar position
6247 .Op Fl y Ar position
6248 .Op Ar shell-command
6250 .D1 Pq alias: Ic popup
6251 Display a popup running
6255 A popup is a rectangular box drawn over the top of any panes.
6256 Panes are not updated while a popup is present.
6259 closes the popup automatically when
6264 closes the popup only if
6266 exited with success.
6271 give the position of the popup, they have the same meaning as for the
6277 give the width and height - both may be a percentage (followed by
6279 If omitted, half of the terminal size is used.
6282 does not surround the popup by a border.
6285 sets the type of characters used for drawing popup borders.
6292 .Ic popup-border-lines
6293 for possible values for
6297 sets the style for the popup and
6299 sets the style for the popup border (see
6305 and sets an environment variable for the popup; it may be specified multiple
6309 is a format for the popup title (see
6314 flag closes any popup on the client.
6316 .It Xo Ic show-prompt-history
6317 .Op Fl T Ar prompt-type
6319 .D1 Pq alias: Ic showphist
6320 Display status prompt history for prompt type
6324 is omitted, then show history for all types.
6327 for possible values for
6332 maintains a set of named
6334 Each buffer may be either explicitly or automatically named.
6335 Explicitly named buffers are named when created with the
6339 commands, or by renaming an automatically named buffer with
6342 Automatically named buffers are given a name such as
6348 option is reached, the oldest automatically named buffer is deleted.
6349 Explicitly named buffers are not subject to
6351 and may be deleted with the
6355 Buffers may be added using
6361 commands, and pasted into a window using the
6364 If a buffer command is used and no buffer is specified, the most
6365 recently added automatically named buffer is assumed.
6367 A configurable history buffer is also maintained for each window.
6368 By default, up to 2000 lines are kept; this can be altered with the
6374 The buffer commands are as follows:
6381 .Op Fl K Ar key-format
6382 .Op Fl O Ar sort-order
6383 .Op Fl t Ar target-pane
6386 Put a pane into buffer mode, where a buffer may be chosen interactively from
6388 Each buffer is shown on one line.
6389 A shortcut key is shown on the left in brackets allowing for immediate choice,
6390 or the list may be navigated and an item chosen or otherwise manipulated using
6394 The following keys may be used in buffer mode:
6395 .Bl -column "Key" "Function" -offset indent
6396 .It Sy "Key" Ta Sy "Function"
6397 .It Li "Enter" Ta "Paste selected buffer"
6398 .It Li "Up" Ta "Select previous buffer"
6399 .It Li "Down" Ta "Select next buffer"
6400 .It Li "C-s" Ta "Search by name or content"
6401 .It Li "n" Ta "Repeat last search"
6402 .It Li "t" Ta "Toggle if buffer is tagged"
6403 .It Li "T" Ta "Tag no buffers"
6404 .It Li "C-t" Ta "Tag all buffers"
6405 .It Li "p" Ta "Paste selected buffer"
6406 .It Li "P" Ta "Paste tagged buffers"
6407 .It Li "d" Ta "Delete selected buffer"
6408 .It Li "D" Ta "Delete tagged buffers"
6409 .It Li "e" Ta "Open the buffer in an editor"
6410 .It Li "f" Ta "Enter a format to filter items"
6411 .It Li "O" Ta "Change sort field"
6412 .It Li "r" Ta "Reverse sort order"
6413 .It Li "v" Ta "Toggle preview"
6414 .It Li "q" Ta "Exit mode"
6417 After a buffer is chosen,
6419 is replaced by the buffer name in
6421 and the result executed as a command.
6424 is not given, "paste-buffer -b '%%'" is used.
6427 specifies the initial sort field: one of
6434 reverses the sort order.
6436 specifies an initial filter: the filter is a format - if it evaluates to zero,
6437 the item in the list is not shown, otherwise it is shown.
6438 If a filter would lead to an empty list, it is ignored.
6440 specifies the format for each item in the list and
6442 a format for each shortcut key; both are evaluated once for each line.
6444 starts without the preview.
6445 This command works only if at least one client is attached.
6447 .It Xo Ic clear-history
6449 .Op Fl t Ar target-pane
6451 .D1 Pq alias: Ic clearhist
6452 Remove and free the history for the specified pane.
6454 also removes all hyperlinks.
6456 .It Ic delete-buffer Op Fl b Ar buffer-name
6457 .D1 Pq alias: Ic deleteb
6458 Delete the buffer named
6460 or the most recently added automatically named buffer if not specified.
6462 .It Xo Ic list-buffers
6466 .D1 Pq alias: Ic lsb
6467 List the global buffers.
6469 specifies the format of each line and
6472 Only buffers for which the filter is true are shown.
6476 .It Xo Ic load-buffer
6478 .Op Fl b Ar buffer-name
6479 .Op Fl t Ar target-client
6483 .D1 Pq alias: Ic loadb
6484 Load the contents of the specified paste buffer from
6488 is given, the buffer is also sent to the clipboard for
6492 escape sequence, if possible.
6494 .It Xo Ic paste-buffer
6496 .Op Fl b Ar buffer-name
6497 .Op Fl s Ar separator
6498 .Op Fl t Ar target-pane
6500 .D1 Pq alias: Ic pasteb
6501 Insert the contents of a paste buffer into the specified pane.
6502 If not specified, paste into the current one.
6505 also delete the paste buffer.
6506 When output, any linefeed (LF) characters in the paste buffer are replaced with
6507 a separator, by default carriage return (CR).
6508 A custom separator may be specified using the
6513 flag means to do no replacement (equivalent to a separator of LF).
6516 is specified, paste bracket control codes are inserted around the
6517 buffer if the application has requested bracketed paste mode.
6519 .It Xo Ic save-buffer
6521 .Op Fl b Ar buffer-name
6524 .D1 Pq alias: Ic saveb
6525 Save the contents of the specified paste buffer to
6529 option appends to rather than overwriting the file.
6530 .It Xo Ic set-buffer
6532 .Op Fl b Ar buffer-name
6533 .Op Fl t Ar target-client
6535 .Op Fl n Ar new-buffer-name
6538 .D1 Pq alias: Ic setb
6539 Set the contents of the specified buffer to
6543 is given, the buffer is also sent to the clipboard for
6547 escape sequence, if possible.
6550 option appends to rather than overwriting the buffer.
6553 option renames the buffer to
6554 .Ar new-buffer-name .
6556 .It Xo Ic show-buffer
6557 .Op Fl b Ar buffer-name
6559 .D1 Pq alias: Ic showb
6560 Display the contents of the specified buffer.
6563 Miscellaneous commands are as follows:
6565 .It Ic clock-mode Op Fl t Ar target-pane
6566 Display a large clock.
6570 .Op Fl t Ar target-pane
6571 .Ar shell-command command
6581 returns success or the second
6584 Before being executed,
6586 is expanded using the rules specified in the
6588 section, including those relevant to
6593 is run in the background.
6599 is not executed but considered success if neither empty nor zero (after formats
6603 .D1 Pq alias: Ic lock
6604 Lock each client individually by running the command specified by the
6611 .Op Fl t Ar target-pane
6612 .Op Ar shell-command
6614 .D1 Pq alias: Ic run
6623 command in the background without creating a window.
6624 Before being executed,
6626 is expanded using the rules specified in the
6631 the command is run in the background.
6635 seconds before starting the command.
6638 is not given, any output to stdout is displayed in view mode (in the pane
6641 or the current pane if omitted) after the command finishes.
6642 If the command fails, the exit status is also displayed.
6648 .D1 Pq alias: Ic wait
6649 When used without options, prevents the client from exiting until woken using
6652 with the same channel.
6655 is used, the channel is locked and any clients that try to lock the same
6656 channel are made to wait until the channel is unlocked with
6663 client detaches, it prints a message.
6666 .It detached (from session ...)
6667 The client was detached normally.
6668 .It detached and SIGHUP
6669 The client was detached and its parent sent the
6671 signal (for example with
6679 was unexpectedly destroyed.
6681 The client was killed with
6684 The client is in control mode and became unable to keep up with the data from
6687 The server exited when it had no sessions.
6689 The server exited when it received
6691 .It server exited unexpectedly
6692 The server crashed or otherwise exited without telling the client the reason.
6694 .Sh TERMINFO EXTENSIONS
6696 understands some unofficial extensions to
6698 It is not normally necessary to set these manually, instead the
6699 .Ic terminal-features
6700 option should be used.
6703 An existing extension that tells
6705 the terminal supports default colours.
6709 that the terminal supports the VTE bidirectional text extensions.
6711 Set the cursor colour.
6712 The first takes a single string argument and is used to set the colour;
6713 the second takes no arguments and restores the default cursor colour.
6714 If set, a sequence such as this may be used
6715 to change the cursor colour from inside
6717 .Bd -literal -offset indent
6718 $ printf '\e033]12;red\e033\e\e'
6725 .It Em \&Cmg, \&Clmg, \&Dsmg , \&Enmg
6726 Set, clear, disable or enable DECSLRM margins.
6727 These are set automatically if the terminal reports it is
6730 .It Em \&Dsbp , \&Enbp
6731 Disable and enable bracketed paste.
6732 These are set automatically if the
6734 capability is present.
6735 .It Em \&Dseks , \&Eneks
6736 Disable and enable extended keys.
6737 .It Em \&Dsfcs , \&Enfcs
6738 Disable and enable focus reporting.
6739 These are set automatically if the
6741 capability is present.
6743 Set or clear a hyperlink annotation.
6747 that the terminal does not use bright colors for bold display.
6751 that the terminal supports rectangle operations.
6753 Enable the overline attribute.
6755 Set a styled underscore.
6756 The single parameter is one of: 0 for no underscore, 1 for normal
6757 underscore, 2 for double underscore, 3 for curly underscore, 4 for dotted
6758 underscore and 5 for dashed underscore.
6759 .It Em \&Setulc , \&ol
6760 Set the underscore colour or reset to the default.
6761 The argument is (red * 65536) + (green * 256) + blue where each is between 0
6764 Set or reset the cursor style.
6765 If set, a sequence such as this may be used
6766 to change the cursor to an underline:
6767 .Bd -literal -offset indent
6768 $ printf '\e033[4 q'
6773 is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
6775 Set the opening sequence for the working directory notification.
6776 The sequence is terminated using the standard
6780 Indicates that the terminal supports SIXEL.
6782 Start (parameter is 1) or end (parameter is 2) a synchronized update.
6784 Indicate that the terminal supports the
6786 RGB escape sequence (for example, \ee[38;2;255;255;255m).
6788 If supported, this is used for the initialize colour escape sequence (which
6789 may be enabled by adding the
6798 This is equivalent to the
6803 Store the current buffer in the host terminal's selection (clipboard).
6806 option above and the
6810 This is an existing extension capability that tmux uses to mean that the
6811 terminal supports the
6813 title set sequences and to automatically set some of the capabilities above.
6817 offers a textual interface called
6819 This allows applications to communicate with
6821 using a simple text-only protocol.
6823 In control mode, a client sends
6825 commands or command sequences terminated by newlines on standard input.
6826 Each command will produce one block of output on standard output.
6827 An output block consists of a
6829 line followed by the output (which may be empty).
6830 The output block ends with a
6839 have three arguments: an integer time (as seconds from epoch), command number
6840 and flags (currently not used).
6842 .Bd -literal -offset indent
6843 %begin 1363006971 2 1
6844 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
6851 command may be used to set the size of a client in control mode.
6855 outputs notifications.
6856 A notification will never occur inside an output block.
6858 The following notifications are defined:
6860 .It Ic %client-detached Ar client
6861 The client has detached.
6862 .It Ic %client-session-changed Ar client session-id name
6863 The client is now attached to the session with ID
6867 .It Ic %config-error Ar error
6868 An error has happened in a configuration file.
6869 .It Ic %continue Ar pane-id
6870 The pane has been continued after being paused (if the
6875 .It Ic %exit Op Ar reason
6878 client is exiting immediately, either because it is not attached to any session
6879 or an error occurred.
6882 describes why the client exited.
6883 .It Ic %extended-output Ar pane-id Ar age Ar ... \& : Ar value
6890 is the time in milliseconds for which tmux had buffered the output before it
6892 Any subsequent arguments up until a single
6894 are for future use and should be ignored.
6895 .It Xo Ic %layout-change
6898 .Ar window-visible-layout
6901 The layout of a window with ID
6906 The window's visible layout is
6907 .Ar window-visible-layout
6908 and the window flags are
6910 .It Ic %message Ar message
6911 A message sent with the
6914 .It Ic %output Ar pane-id Ar value
6915 A window pane produced output.
6917 escapes non-printable characters and backslash as octal \\xxx.
6918 .It Ic %pane-mode-changed Ar pane-id
6922 .It Ic %paste-buffer-changed Ar name
6926 .It Ic %paste-buffer-deleted Ar name
6930 .It Ic %pause Ar pane-id
6931 The pane has been paused (if the
6934 .It Ic %session-changed Ar session-id Ar name
6935 The client is now attached to the session with ID
6939 .It Ic %session-renamed Ar name
6940 The current session was renamed to
6942 .It Ic %session-window-changed Ar session-id Ar window-id
6945 changed its active window to the window with ID
6947 .It Ic %sessions-changed
6948 A session was created or destroyed.
6949 .It Xo Ic %subscription-changed
6954 .Ar pane-id ... \& :
6957 The value of the format associated with subscription
6968 are for future use and should be ignored.
6969 .It Ic %unlinked-window-add Ar window-id
6972 was created but is not linked to the current session.
6973 .It Ic %unlinked-window-close Ar window-id
6976 which is not linked to the current session, was closed.
6977 .It Ic %unlinked-window-renamed Ar window-id
6980 which is not linked to the current session, was renamed.
6981 .It Ic %window-add Ar window-id
6984 was linked to the current session.
6985 .It Ic %window-close Ar window-id
6989 .It Ic %window-pane-changed Ar window-id Ar pane-id
6990 The active pane in the window with ID
6992 changed to the pane with ID
6994 .It Ic %window-renamed Ar window-id Ar name
7003 is started, it inspects the following environment variables:
7004 .Bl -tag -width LC_CTYPE
7006 If the command specified in this variable contains the string
7010 is unset, use vi-style key bindings.
7017 The user's login directory.
7020 database is consulted.
7022 The character encoding
7024 It is used for two separate purposes.
7025 For output to the terminal, UTF-8 is used if the
7027 option is given or if
7033 Otherwise, only ASCII characters are written and non-ASCII characters
7034 are replaced with underscores
7038 always runs with a UTF-8 locale.
7039 If en_US.UTF-8 is provided by the operating system, it is used and
7041 is ignored for input.
7046 what the UTF-8 locale is called on the current system.
7047 If the locale specified by
7049 is not available or is not a UTF-8 locale,
7051 exits with an error message.
7053 The date and time format
7055 It is used for locale-dependent
7059 The current working directory to be set in the global environment.
7060 This may be useful if it contains symbolic links.
7061 If the value of the variable does not match the current working
7062 directory, the variable is ignored and the result of
7066 The absolute path to the default shell for new windows.
7071 The parent directory of the directory containing the server sockets.
7076 If the command specified in this variable contains the string
7078 use vi-style key bindings.
7086 .Bl -tag -width "/etc/tmux.confXXX" -compact
7091 .It Pa /etc/tmux.conf
7092 System-wide configuration file.
7100 .Dl $ tmux new-session vi
7102 Most commands have a shorter form, known as an alias.
7103 For new-session, this is
7108 Alternatively, the shortest unambiguous form of a command is accepted.
7109 If there are several options, they are listed:
7110 .Bd -literal -offset indent
7112 ambiguous command: n, could be: new-session, new-window, next-window
7115 Within an active session, a new window may be created by typing
7125 Windows may be navigated with:
7127 (to select window 0),
7129 (to select window 1), and so on;
7131 to select the next window; and
7133 to select the previous window.
7135 A session may be detached using
7137 (or by an external event such as
7139 disconnection) and reattached with:
7141 .Dl $ tmux attach-session
7145 lists the current key bindings in the current window; up and down may be used
7146 to navigate the list or
7150 Commands to be run when the
7152 server is started may be placed in the
7155 Common examples include:
7157 Changing the default prefix key:
7158 .Bd -literal -offset indent
7159 set-option -g prefix C-a
7161 bind-key C-a send-prefix
7164 Turning the status line off, or changing its colour:
7165 .Bd -literal -offset indent
7166 set-option -g status off
7167 set-option -g status-style bg=blue
7170 Setting other options, such as the default command,
7171 or locking after 30 minutes of inactivity:
7172 .Bd -literal -offset indent
7173 set-option -g default-command "exec /bin/ksh"
7174 set-option -g lock-after-time 1800
7177 Creating new key bindings:
7178 .Bd -literal -offset indent
7179 bind-key b set-option status
7180 bind-key / command-prompt "split-window 'exec man %%'"
7181 bind-key S command-prompt "new-window -n %1 'ssh %1'"
7186 .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com