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
1549 .Op Fl t Ar target-pane
1552 .D1 Pq alias: Ic source
1553 Execute commands from one or more files specified by
1562 is expanded as a format.
1565 is given, no error will be returned if
1570 the file is parsed but no commands are executed.
1572 shows the parsed commands and line numbers if possible.
1575 .D1 Pq alias: Ic start
1578 server, if not already running, without creating any sessions.
1580 Note that as by default the
1582 server will exit with no sessions, this is only useful if a session is created
1586 is turned off, or another command is run as part of the same command sequence.
1588 .Bd -literal -offset indent
1589 $ tmux start \\; show -g
1592 .It Xo Ic suspend-client
1593 .Op Fl t Ar target-client
1595 .D1 Pq alias: Ic suspendc
1596 Suspend a client by sending
1600 .It Xo Ic switch-client
1602 .Op Fl c Ar target-client
1603 .Op Fl t Ar target-session
1604 .Op Fl T Ar key-table
1606 .D1 Pq alias: Ic switchc
1607 Switch the current session for client
1610 .Ar target-session .
1613 may refer to a pane (a target that contains
1618 to change session, window and pane.
1621 keeps the window zoomed if it was zoomed.
1627 is used, the client is moved to the last, next or previous session
1641 .Ic update-environment
1642 option will not be applied.
1645 sets the client's key table; the next key from the client will be interpreted
1648 This may be used to configure multiple prefix keys, or to bind commands to
1650 For example, to make typing
1655 .Bd -literal -offset indent
1656 bind-key -Ttable2 c list-keys
1657 bind-key -Ttable1 b switch-client -Ttable2
1658 bind-key -Troot a switch-client -Ttable1
1661 .Sh WINDOWS AND PANES
1662 Each window displayed by
1664 may be split into one or more
1666 each pane takes up a certain area of the display and is a separate terminal.
1667 A window may be split into panes using the
1670 Windows may be split horizontally (with the
1672 flag) or vertically.
1673 Panes may be resized with the
1681 by default), the current pane may be changed with the
1687 commands may be used to swap panes without changing their position.
1688 Panes are numbered beginning from zero in the order they are created.
1692 pane permits direct access to the terminal contained in the pane.
1693 A pane may also be put into one of several modes:
1694 .Bl -dash -offset indent
1696 Copy mode, which permits a section of a window or its
1697 history to be copied to a
1699 for later insertion into another window.
1700 This mode is entered with the
1705 Copied text can be pasted with the
1710 View mode, which is like copy mode but is entered when a command that produces
1713 is executed from a key binding.
1715 Choose mode, which allows an item to be chosen from a list.
1716 This may be a client, a session or window or pane, or a buffer.
1717 This mode is entered with the
1725 In copy mode an indicator is displayed in the top-right corner of the pane with
1726 the current position and the number of lines in the history.
1728 Commands are sent to copy mode using the
1733 When a key is pressed, copy mode automatically uses one of two key tables,
1741 Key tables may be viewed with the
1745 The following commands are supported in copy mode:
1748 .Ic append-selection
1750 Append the selection to the top paste buffer.
1752 .Ic append-selection-and-cancel
1755 Append the selection to the top paste buffer and exit copy mode.
1757 .Ic back-to-indentation
1761 Move the cursor back to the indentation.
1772 Move to the bottom line.
1784 Clear the current selection.
1786 .Ic copy-end-of-line
1789 Copy from the cursor position to the end of the line.
1791 is used to name the new paste buffer.
1793 .Ic copy-end-of-line-and-cancel
1796 Copy from the cursor position and exit copy mode.
1801 Copy the entire line.
1803 .Ic copy-line-and-cancel
1806 Copy the entire line and exit copy mode.
1811 Copies the current selection.
1813 .Ic copy-selection-and-cancel
1818 Copy the current selection and exit copy mode.
1824 Move the cursor down.
1830 Move the cursor left.
1836 Move the cursor right.
1848 Move the cursor to the end of the line.
1855 Move the cursor to a specific line.
1861 Scroll to the bottom of the history.
1867 Scroll to the top of the history.
1873 Repeat the last jump.
1880 Jump backwards to the specified text.
1887 Jump forward to the specified text.
1893 Jump to the last mark.
1899 Move to the middle line.
1901 .Ic next-matching-bracket
1905 Move to the next matching bracket.
1911 Move to the next paragraph.
1916 Move to the next prompt.
1921 Move to the next word.
1927 Scroll down by one page.
1933 Scroll up by one page.
1935 .Ic previous-matching-bracket
1938 Move to the previous matching bracket.
1940 .Ic previous-paragraph
1944 Move to the previous paragraph.
1949 Move to the previous prompt.
1955 Move to the previous word.
1957 .Ic rectangle-toggle
1961 Toggle rectangle selection mode.
1963 .Ic refresh-from-pane
1967 Refresh the content from the pane.
1973 Repeat the last search.
1979 Search backwards for the specified text.
1985 Search forward for the specified text.
1990 Select the current line.
1994 Select the current word.
2000 Move the cursor to the start of the line.
2006 Move to the top line.
2012 Move to the next prompt.
2018 Move to the previous prompt.
2021 The search commands come in several varieties:
2025 search for a regular expression;
2028 variants search for a plain text string rather than a regular expression;
2030 perform an incremental search and expect to be used with the
2036 repeats the last search and
2038 does the same but reverses the direction (forward becomes backward and backward
2045 move between shell prompts, but require the shell to emit an escape sequence
2046 (\e033]133;A\e033\e\e) to tell
2048 where the prompts are located; if the shell does not do this, these commands
2052 flag jumps to the beginning of the command output instead of the shell prompt.
2054 Copy commands may take an optional buffer prefix argument which is used
2055 to generate the buffer name (the default is
2057 so buffers are named
2061 Pipe commands take a command argument which is the command to which the
2062 selected text is piped.
2064 variants also copy the selection.
2067 variants of some commands exit copy mode after they have completed (for copy
2068 commands) or when the cursor reaches the bottom (for scrolling commands).
2070 variants do not clear the selection.
2072 The next and previous word keys skip over whitespace and treat consecutive
2073 runs of either word separators or other letters as words.
2074 Word separators can be customized with the
2077 Next word moves to the start of the next word, next word end to the end of the
2078 next word and previous word to the start of the previous word.
2079 The three next and previous space keys work similarly but use a space alone as
2083 to the empty string makes next/previous word equivalent to next/previous space.
2085 The jump commands enable quick movement within a line.
2086 For instance, typing
2090 will move the cursor to the next
2092 character on the current line.
2095 will then jump to the next occurrence.
2097 Commands in copy mode may be prefaced by an optional repeat count.
2098 With vi key bindings, a prefix is entered using the number keys; with
2099 emacs, the Alt (meta) key and a number begins prefix entry.
2101 The synopsis for the
2107 .Op Fl s Ar src-pane
2108 .Op Fl t Ar target-pane
2113 option scrolls one page up.
2115 begins a mouse drag (only valid if bound to a mouse key binding, see
2116 .Sx MOUSE SUPPORT ) .
2118 hides the position indicator in the top right.
2120 cancels copy mode and any other modes.
2128 specifies that scrolling to the bottom of the history (to the visible screen)
2129 should exit copy mode.
2130 While in copy mode, pressing a key other than those used for scrolling will
2131 disable this behaviour.
2132 This is intended to allow fast scrolling through a pane's history, for
2134 .Bd -literal -offset indent
2135 bind PageUp copy-mode -eu
2139 A number of preset arrangements of panes are available, these are called
2141 These may be selected with the
2143 command or cycled with
2147 by default); once a layout is chosen, panes within it may be moved and resized
2150 The following layouts are supported:
2152 .It Ic even-horizontal
2153 Panes are spread out evenly from left to right across the window.
2154 .It Ic even-vertical
2155 Panes are spread evenly from top to bottom.
2156 .It Ic main-horizontal
2157 A large (main) pane is shown at the top of the window and the remaining panes
2158 are spread from left to right in the leftover space at the bottom.
2160 .Em main-pane-height
2161 window option to specify the height of the top pane.
2162 .It Ic main-vertical
2165 but the large pane is placed on the left and the others spread from top to
2166 bottom along the right.
2171 Panes are spread out as evenly as possible over the window in both rows and
2177 may be used to apply a previously used layout - the
2179 command displays the layout of each window in a form suitable for use with
2182 .Bd -literal -offset indent
2185 layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
2186 $ tmux select-layout 'bb62,159x48,0,0{79x48,0,0,79x48,80,0}'
2190 automatically adjusts the size of the layout for the current window size.
2191 Note that a layout cannot be applied to a window with more panes than that
2192 from which the layout was originally defined.
2194 Commands related to windows and panes are as follows:
2197 .It Xo Ic break-pane
2200 .Op Fl n Ar window-name
2201 .Op Fl s Ar src-pane
2202 .Op Fl t Ar dst-window
2204 .D1 Pq alias: Ic breakp
2207 off from its containing window to make it the only pane in
2213 the window is moved to the next index after or before (existing windows are
2214 moved if necessary).
2217 is given, the new window does not become the current window.
2220 option prints information about the new window after it has been created.
2221 By default, it uses the format
2222 .Ql #{session_name}:#{window_index}.#{pane_index}
2223 but a different format may be specified with
2226 .It Xo Ic capture-pane
2228 .Op Fl b Ar buffer-name
2229 .Op Fl E Ar end-line
2230 .Op Fl S Ar start-line
2231 .Op Fl t Ar target-pane
2233 .D1 Pq alias: Ic capturep
2234 Capture the contents of a pane.
2237 is given, the output goes to stdout, otherwise to the buffer specified with
2239 or a new buffer if omitted.
2242 is given, the alternate screen is used, and the history is not accessible.
2243 If no alternate screen exists, an error will be returned unless
2248 is given, the output includes escape sequences for text and background
2251 also escapes non-printable characters as octal \exxx.
2253 ignores trailing positions that do not contain a character.
2255 preserves trailing spaces at each line's end and
2257 preserves trailing spaces and joins any wrapped lines;
2262 captures only any output that the pane has received that is the beginning of an
2263 as-yet incomplete escape sequence.
2268 specify the starting and ending line numbers, zero is the first line of the
2269 visible pane and negative numbers are lines in the history.
2273 is the start of the history and to
2275 the end of the visible pane.
2276 The default is to capture only the visible contents of the pane.
2282 .Op Fl K Ar key-format
2283 .Op Fl O Ar sort-order
2284 .Op Fl t Ar target-pane
2287 Put a pane into client mode, allowing a client to be selected interactively from
2289 Each client is shown on one line.
2290 A shortcut key is shown on the left in brackets allowing for immediate choice,
2291 or the list may be navigated and an item chosen or otherwise manipulated using
2295 The following keys may be used in client mode:
2296 .Bl -column "Key" "Function" -offset indent
2297 .It Sy "Key" Ta Sy "Function"
2298 .It Li "Enter" Ta "Choose selected client"
2299 .It Li "Up" Ta "Select previous client"
2300 .It Li "Down" Ta "Select next client"
2301 .It Li "C-s" Ta "Search by name"
2302 .It Li "n" Ta "Repeat last search"
2303 .It Li "t" Ta "Toggle if client is tagged"
2304 .It Li "T" Ta "Tag no clients"
2305 .It Li "C-t" Ta "Tag all clients"
2306 .It Li "d" Ta "Detach selected client"
2307 .It Li "D" Ta "Detach tagged clients"
2308 .It Li "x" Ta "Detach and HUP selected client"
2309 .It Li "X" Ta "Detach and HUP tagged clients"
2310 .It Li "z" Ta "Suspend selected client"
2311 .It Li "Z" Ta "Suspend tagged clients"
2312 .It Li "f" Ta "Enter a format to filter items"
2313 .It Li "O" Ta "Change sort field"
2314 .It Li "r" Ta "Reverse sort order"
2315 .It Li "v" Ta "Toggle preview"
2316 .It Li "q" Ta "Exit mode"
2319 After a client is chosen,
2321 is replaced by the client name in
2323 and the result executed as a command.
2326 is not given, "detach-client -t '%%'" is used.
2329 specifies the initial sort field: one of
2338 reverses the sort order.
2340 specifies an initial filter: the filter is a format - if it evaluates to zero,
2341 the item in the list is not shown, otherwise it is shown.
2342 If a filter would lead to an empty list, it is ignored.
2344 specifies the format for each item in the list and
2346 a format for each shortcut key; both are evaluated once for each line.
2348 starts without the preview.
2349 This command works only if at least one client is attached.
2355 .Op Fl K Ar key-format
2356 .Op Fl O Ar sort-order
2357 .Op Fl t Ar target-pane
2360 Put a pane into tree mode, where a session, window or pane may be chosen
2361 interactively from a tree.
2362 Each session, window or pane is shown on one line.
2363 A shortcut key is shown on the left in brackets allowing for immediate choice,
2364 or the tree may be navigated and an item chosen or otherwise manipulated using
2367 starts with sessions collapsed and
2369 with windows collapsed.
2372 The following keys may be used in tree mode:
2373 .Bl -column "Key" "Function" -offset indent
2374 .It Sy "Key" Ta Sy "Function"
2375 .It Li "Enter" Ta "Choose selected item"
2376 .It Li "Up" Ta "Select previous item"
2377 .It Li "Down" Ta "Select next item"
2378 .It Li "+" Ta "Expand selected item"
2379 .It Li "-" Ta "Collapse selected item"
2380 .It Li "M-+" Ta "Expand all items"
2381 .It Li "M--" Ta "Collapse all items"
2382 .It Li "x" Ta "Kill selected item"
2383 .It Li "X" Ta "Kill tagged items"
2384 .It Li "<" Ta "Scroll list of previews left"
2385 .It Li ">" Ta "Scroll list of previews right"
2386 .It Li "C-s" Ta "Search by name"
2387 .It Li "m" Ta "Set the marked pane"
2388 .It Li "M" Ta "Clear the marked pane"
2389 .It Li "n" Ta "Repeat last search"
2390 .It Li "t" Ta "Toggle if item is tagged"
2391 .It Li "T" Ta "Tag no items"
2392 .It Li "C-t" Ta "Tag all items"
2393 .It Li "\&:" Ta "Run a command for each tagged item"
2394 .It Li "f" Ta "Enter a format to filter items"
2395 .It Li "H" Ta "Jump to the starting pane"
2396 .It Li "O" Ta "Change sort field"
2397 .It Li "r" Ta "Reverse sort order"
2398 .It Li "v" Ta "Toggle preview"
2399 .It Li "q" Ta "Exit mode"
2402 After a session, window or pane is chosen, the first instance of
2404 and all instances of
2406 are replaced by the target in
2408 and the result executed as a command.
2411 is not given, "switch-client -t '%%'" is used.
2414 specifies the initial sort field: one of
2421 reverses the sort order.
2423 specifies an initial filter: the filter is a format - if it evaluates to zero,
2424 the item in the list is not shown, otherwise it is shown.
2425 If a filter would lead to an empty list, it is ignored.
2427 specifies the format for each item in the tree and
2429 a format for each shortcut key; both are evaluated once for each line.
2431 starts without the preview.
2433 includes all sessions in any session groups in the tree rather than only the
2435 This command works only if at least one client is attached.
2441 .Op Fl t Ar target-pane
2444 Put a pane into customize mode, where options and key bindings may be browsed
2445 and modified from a list.
2446 Option values in the list are shown for the active pane in the current window.
2449 The following keys may be used in customize mode:
2450 .Bl -column "Key" "Function" -offset indent
2451 .It Sy "Key" Ta Sy "Function"
2452 .It Li "Enter" Ta "Set pane, window, session or global option value"
2453 .It Li "Up" Ta "Select previous item"
2454 .It Li "Down" Ta "Select next item"
2455 .It Li "+" Ta "Expand selected item"
2456 .It Li "-" Ta "Collapse selected item"
2457 .It Li "M-+" Ta "Expand all items"
2458 .It Li "M--" Ta "Collapse all items"
2459 .It Li "s" Ta "Set option value or key attribute"
2460 .It Li "S" Ta "Set global option value"
2461 .It Li "w" Ta "Set window option value, if option is for pane and window"
2462 .It Li "d" Ta "Set an option or key to the default"
2463 .It Li "D" Ta "Set tagged options and tagged keys to the default"
2464 .It Li "u" Ta "Unset an option (set to default value if global) or unbind a key"
2465 .It Li "U" Ta "Unset tagged options and unbind tagged keys"
2466 .It Li "C-s" Ta "Search by name"
2467 .It Li "n" Ta "Repeat last search"
2468 .It Li "t" Ta "Toggle if item is tagged"
2469 .It Li "T" Ta "Tag no items"
2470 .It Li "C-t" Ta "Tag all items"
2471 .It Li "f" Ta "Enter a format to filter items"
2472 .It Li "v" Ta "Toggle option information"
2473 .It Li "q" Ta "Exit mode"
2477 specifies an initial filter: the filter is a format - if it evaluates to zero,
2478 the item in the list is not shown, otherwise it is shown.
2479 If a filter would lead to an empty list, it is ignored.
2481 specifies the format for each item in the tree.
2483 starts without the option information.
2484 This command works only if at least one client is attached.
2489 .Op Fl d Ar duration
2490 .Op Fl t Ar target-client
2493 .D1 Pq alias: Ic displayp
2494 Display a visible indicator of each pane shown by
2497 .Ic display-panes-colour
2499 .Ic display-panes-active-colour
2501 The indicator is closed when a key is pressed (unless
2505 milliseconds have passed.
2509 .Ic display-panes-time
2511 A duration of zero means the indicator stays until a key is pressed.
2512 While the indicator is on screen, a pane may be chosen with the
2516 keys, which will cause
2518 to be executed as a command with
2520 substituted by the pane ID.
2523 is "select-pane -t '%%'".
2526 other commands are not blocked from running until the indicator is closed.
2528 .It Xo Ic find-window
2530 .Op Fl t Ar target-pane
2533 .D1 Pq alias: Ic findw
2540 in window names, titles, and visible content (but not history).
2541 The flags control matching behavior:
2543 matches only visible window contents,
2545 matches only the window name and
2547 matches only the window title.
2549 makes the search ignore case.
2555 This command works only if at least one client is attached.
2560 .Op Fl s Ar src-pane
2561 .Op Fl t Ar dst-pane
2563 .D1 Pq alias: Ic joinp
2566 but instead of splitting
2568 and creating a new pane, split it and move
2571 This can be used to reverse
2577 to be joined to left of or above
2582 is omitted and a marked pane is present (see
2585 the marked pane is used rather than the current pane.
2589 .Op Fl t Ar target-pane
2591 .D1 Pq alias: Ic killp
2592 Destroy the given pane.
2593 If no panes remain in the containing window, it is also destroyed.
2596 option kills all but the pane given with
2599 .It Xo Ic kill-window
2601 .Op Fl t Ar target-window
2603 .D1 Pq alias: Ic killw
2604 Kill the current window or the window at
2606 removing it from any sessions to which it is linked.
2609 option kills all but the window given with
2614 .Op Fl t Ar target-window
2616 .D1 Pq alias: Ic lastp
2617 Select the last (previously selected) pane.
2619 keeps the window zoomed if it was zoomed.
2623 disables input to the pane.
2625 .It Ic last-window Op Fl t Ar target-session
2626 .D1 Pq alias: Ic last
2627 Select the last (previously selected) window.
2630 is specified, select the last window of the current session.
2632 .It Xo Ic link-window
2634 .Op Fl s Ar src-window
2635 .Op Fl t Ar dst-window
2637 .D1 Pq alias: Ic linkw
2644 is specified and no such window exists, the
2651 the window is moved to the next index after or before
2653 (existing windows are moved if necessary).
2658 exists, it is killed, otherwise an error is generated.
2661 is given, the newly linked window is not selected.
2663 .It Xo Ic list-panes
2669 .D1 Pq alias: Ic lsp
2674 is ignored and all panes on the server are listed.
2679 is a session (or the current session).
2680 If neither is given,
2682 is a window (or the current window).
2684 specifies the format of each line and
2687 Only panes for which the filter is true are shown.
2692 .It Xo Ic list-windows
2696 .Op Fl t Ar target-session
2698 .D1 Pq alias: Ic lsw
2701 is given, list all windows on the server.
2702 Otherwise, list windows in the current session or in
2703 .Ar target-session .
2705 specifies the format of each line and
2708 Only windows for which the filter is true are shown.
2716 .Op Fl s Ar src-pane
2717 .Op Fl t Ar dst-pane
2719 .D1 Pq alias: Ic movep
2723 .It Xo Ic move-window
2725 .Op Fl s Ar src-window
2726 .Op Fl t Ar dst-window
2728 .D1 Pq alias: Ic movew
2731 except the window at
2737 all windows in the session are renumbered in sequential order, respecting
2742 .It Xo Ic new-window
2744 .Op Fl c Ar start-directory
2745 .Op Fl e Ar environment
2747 .Op Fl n Ar window-name
2748 .Op Fl t Ar target-window
2749 .Op Ar shell-command
2751 .D1 Pq alias: Ic neww
2752 Create a new window.
2757 the new window is inserted at the next index after or before the specified
2759 moving windows up if necessary;
2762 is the new window location.
2766 is given, the session does not make the new window the current window.
2768 represents the window to be created; if the target already exists an error is
2771 flag is used, in which case it is destroyed.
2774 is given and a window named
2776 already exists, it is selected (unless
2778 is also given in which case the command does nothing).
2781 is the command to execute.
2784 is not specified, the value of the
2788 specifies the working directory in which the new window is created.
2790 When the shell command completes, the window closes.
2793 option to change this behaviour.
2798 and sets an environment variable for the newly created window; it may be
2799 specified multiple times.
2803 environment variable must be set to
2807 for all programs running
2810 New windows will automatically have
2812 added to their environment, but care must be taken not to reset this in shell
2813 start-up files or by the
2819 option prints information about the new window after it has been created.
2820 By default, it uses the format
2821 .Ql #{session_name}:#{window_index}
2822 but a different format may be specified with
2825 .It Ic next-layout Op Fl t Ar target-window
2826 .D1 Pq alias: Ic nextl
2827 Move a window to the next layout and rearrange the panes to fit.
2829 .It Xo Ic next-window
2831 .Op Fl t Ar target-session
2833 .D1 Pq alias: Ic next
2834 Move to the next window in the session.
2837 is used, move to the next window with an alert.
2841 .Op Fl t Ar target-pane
2842 .Op Ar shell-command
2844 .D1 Pq alias: Ic pipep
2845 Pipe output sent by the program in
2847 to a shell command or vice versa.
2848 A pane may only be connected to one command at a time, any existing pipe is
2854 string may contain the special character sequences supported by the
2859 is given, the current pipe (if any) is closed.
2864 specify which of the
2866 output streams are connected to the pane:
2869 stdout is connected (so anything
2871 prints is written to the pane as if it were typed);
2874 stdin is connected (so any output in the pane is piped to
2875 .Ar shell-command ) .
2876 Both may be used together and if neither are specified,
2882 option only opens a new pipe if no previous pipe exists, allowing a pipe to
2883 be toggled with a single key, for example:
2884 .Bd -literal -offset indent
2885 bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
2888 .It Xo Ic previous-layout
2889 .Op Fl t Ar target-window
2891 .D1 Pq alias: Ic prevl
2892 Move to the previous layout in the session.
2894 .It Xo Ic previous-window
2896 .Op Fl t Ar target-session
2898 .D1 Pq alias: Ic prev
2899 Move to the previous window in the session.
2902 move to the previous window with an alert.
2904 .It Xo Ic rename-window
2905 .Op Fl t Ar target-window
2908 .D1 Pq alias: Ic renamew
2909 Rename the current window, or the window at
2914 .It Xo Ic resize-pane
2916 .Op Fl t Ar target-pane
2921 .D1 Pq alias: Ic resizep
2922 Resize a pane, up, down, left or right by
2938 is given in lines or columns (the default is 1);
2942 may be a given as a number of lines or columns or followed by
2944 for a percentage of the window size (for example
2948 the active pane is toggled between zoomed (occupying the whole of the window)
2949 and unzoomed (its normal position in the layout).
2952 begins mouse resizing (only valid if bound to a mouse key binding, see
2953 .Sx MOUSE SUPPORT ) .
2956 trims all lines below the current cursor position and moves lines out of the
2957 history to replace them.
2959 .It Xo Ic resize-window
2961 .Op Fl t Ar target-window
2966 .D1 Pq alias: Ic resizew
2967 Resize a window, up, down, left or right by
2983 is given in lines or cells (the default is 1).
2985 sets the size of the largest session containing the window;
2987 the size of the smallest.
2988 This command will automatically set
2990 to manual in the window options.
2992 .It Xo Ic respawn-pane
2994 .Op Fl c Ar start-directory
2995 .Op Fl e Ar environment
2996 .Op Fl t Ar target-pane
2997 .Op Ar shell-command
2999 .D1 Pq alias: Ic respawnp
3000 Reactivate a pane in which the command has exited (see the
3005 is not given, the command used when the pane was created or last respawned is
3007 The pane must be already inactive, unless
3009 is given, in which case any existing command is killed.
3011 specifies a new working directory for the pane.
3014 option has the same meaning as for the
3018 .It Xo Ic respawn-window
3020 .Op Fl c Ar start-directory
3021 .Op Fl e Ar environment
3022 .Op Fl t Ar target-window
3023 .Op Ar shell-command
3025 .D1 Pq alias: Ic respawnw
3026 Reactivate a window in which the command has exited (see the
3031 is not given, the command used when the window was created or last respawned is
3033 The window must be already inactive, unless
3035 is given, in which case any existing command is killed.
3037 specifies a new working directory for the window.
3040 option has the same meaning as for the
3044 .It Xo Ic rotate-window
3046 .Op Fl t Ar target-window
3048 .D1 Pq alias: Ic rotatew
3049 Rotate the positions of the panes within a window, either upward (numerically
3052 or downward (numerically higher).
3054 keeps the window zoomed if it was zoomed.
3056 .It Xo Ic select-layout
3058 .Op Fl t Ar target-pane
3061 .D1 Pq alias: Ic selectl
3062 Choose a specific layout for a window.
3065 is not given, the last preset layout used (if any) is reapplied.
3069 are equivalent to the
3075 applies the last set layout if possible (undoes the most recent layout change).
3077 spreads the current pane and any panes next to it out evenly.
3079 .It Xo Ic select-pane
3082 .Op Fl t Ar target-pane
3084 .D1 Pq alias: Ic selectp
3087 the active pane in its window.
3094 is used, respectively the pane below, to the left, to the right, or above the
3095 target pane is used.
3097 keeps the window zoomed if it was zoomed.
3099 is the same as using the
3105 disables input to the pane.
3107 sets the pane title.
3112 are used to set and clear the
3114 There is one marked pane at a time, setting a new marked pane clears the last.
3115 The marked pane is the default target for
3124 .It Xo Ic select-window
3126 .Op Fl t Ar target-window
3128 .D1 Pq alias: Ic selectw
3129 Select the window at
3135 are equivalent to the
3143 is given and the selected window is already the current window,
3144 the command behaves like
3147 .It Xo Ic split-window
3149 .Op Fl c Ar start-directory
3150 .Op Fl e Ar environment
3152 .Op Fl t Ar target-pane
3153 .Op Ar shell-command
3156 .D1 Pq alias: Ic splitw
3157 Create a new pane by splitting
3160 does a horizontal split and
3162 a vertical split; if neither is specified,
3167 option specifies the size of the new pane in lines (for vertical split) or in
3168 columns (for horizontal split);
3172 to specify a percentage of the available space.
3175 option causes the new pane to be created to the left of or above
3179 option creates a new pane spanning the full window height (with
3181 or full window width (with
3183 instead of splitting the active pane.
3185 zooms if the window is not zoomed, or keeps it zoomed if already zoomed.
3189 ('') will create a pane with no command running in it.
3190 Output can be sent to such a pane with the
3197 is not specified or empty)
3198 will create an empty pane and forward any output from stdin to it.
3200 .Bd -literal -offset indent
3201 $ make 2>&1|tmux splitw -dI &
3204 All other options have the same meaning as for the
3210 .Op Fl s Ar src-pane
3211 .Op Fl t Ar dst-pane
3213 .D1 Pq alias: Ic swapp
3217 is used and no source pane is specified with
3220 is swapped with the previous pane (before it numerically);
3222 swaps with the next pane (after it numerically).
3226 not to change the active pane and
3228 keeps the window zoomed if it was zoomed.
3232 is omitted and a marked pane is present (see
3235 the marked pane is used rather than the current pane.
3237 .It Xo Ic swap-window
3239 .Op Fl s Ar src-window
3240 .Op Fl t Ar dst-window
3242 .D1 Pq alias: Ic swapw
3245 except the source and destination windows are swapped.
3246 It is an error if no window exists at
3250 is given, the new window does not become the current window.
3254 is omitted and a marked pane is present (see
3257 the window containing the marked pane is used rather than the current window.
3259 .It Xo Ic unlink-window
3261 .Op Fl t Ar target-window
3263 .D1 Pq alias: Ic unlinkw
3268 is given, a window may be unlinked only if it is linked to multiple sessions -
3269 windows may not be linked to no sessions;
3272 is specified and the window is linked to only one session, it is unlinked and
3277 allows a command to be bound to most keys, with or without a prefix key.
3278 When specifying keys, most represent themselves (for example
3282 Ctrl keys may be prefixed with
3290 In addition, the following special key names are accepted:
3308 .Em NPage/PageDown/PgDn ,
3309 .Em PPage/PageUp/PgUp ,
3313 Note that to bind the
3317 keys, quotation marks are necessary, for example:
3318 .Bd -literal -offset indent
3319 bind-key '"' split-window
3320 bind-key "'" new-window
3323 A command bound to the
3325 key will execute for all keys which do not have a more specific binding.
3327 Commands related to key bindings are as follows:
3333 .Op Fl T Ar key-table
3334 .Ar key command Op Ar argument ...
3336 .D1 Pq alias: Ic bind
3341 Keys are bound in a key table.
3342 By default (without -T), the key is bound in
3346 This table is used for keys pressed after the prefix key (for example,
3355 creates a new window).
3358 table is used for keys pressed without the prefix key: binding
3364 table (not recommended) means a plain
3366 will create a new window.
3371 Keys may also be bound in custom key tables and the
3374 command used to switch to them from a key binding.
3377 flag indicates this key may repeat, see the
3381 attaches a note to the key (shown with
3385 To view the default bindings and possible commands, see the
3391 .Op Fl P Ar prefix-string Fl T Ar key-table
3394 .D1 Pq alias: Ic lsk
3396 There are two forms: the default lists keys as
3400 lists only keys with attached notes and shows only the key and note for each
3403 With the default form, all key tables are listed by default.
3410 form, only keys in the
3414 key tables are listed by default;
3416 also lists only keys in
3419 specifies a prefix to print before each key and
3421 lists only the first matching key.
3423 lists the command for keys that do not have a note rather than skipping them.
3427 .Op Fl c Ar target-client
3428 .Op Fl N Ar repeat-count
3429 .Op Fl t Ar target-pane
3432 .D1 Pq alias: Ic send
3433 Send a key or keys to a window or client.
3436 is the name of the key (such as
3440 to send; if the string is not recognised as a key, it is sent as a series of
3444 is given, keys are sent to
3446 so they are looked up in the client's key table, rather than to
3448 All arguments are sent sequentially from first to last.
3449 If no keys are given and the command is bound to a key, then that key is used.
3453 flag disables key name lookup and processes the keys as literal UTF-8
3457 flag expects each key to be a hexadecimal number for an ASCII character.
3461 flag causes the terminal state to be reset.
3464 passes through a mouse event (only valid if bound to a mouse key binding, see
3465 .Sx MOUSE SUPPORT ) .
3468 is used to send a command into copy mode - see
3470 .Sx WINDOWS AND PANES
3473 specifies a repeat count and
3475 expands formats in arguments where appropriate.
3476 .It Xo Ic send-prefix
3478 .Op Fl t Ar target-pane
3480 Send the prefix key, or with
3482 the secondary prefix key, to a window as if it was pressed.
3484 .It Xo Ic unbind-key
3486 .Op Fl T Ar key-table
3489 .D1 Pq alias: Ic unbind
3490 Unbind the command bound to
3499 is present, all key bindings are removed.
3502 option prevents errors being returned.
3505 The appearance and behaviour of
3507 may be modified by changing the value of various options.
3508 There are four types of option:
3509 .Em server options ,
3510 .Em session options ,
3511 .Em window options ,
3517 server has a set of global server options which do not apply to any particular
3518 window or session or pane.
3519 These are altered with the
3522 command, or displayed with the
3527 In addition, each individual session may have a set of session options, and
3528 there is a separate set of global session options.
3529 Sessions which do not have a particular option configured inherit the value
3530 from the global session options.
3531 Session options are set or unset with the
3533 command and may be listed with the
3536 The available server and session options are listed under the
3540 Similarly, a set of window options is attached to each window and a set of pane
3541 options to each pane.
3542 Pane options inherit from window options.
3543 This means any pane option may be set as a window option to apply the option to
3544 all panes in the window without the option set, for example these commands will
3545 set the background colour to red for all panes except pane 0:
3546 .Bd -literal -offset indent
3547 set -w window-style bg=red
3548 set -pt:.0 window-style bg=blue
3551 There is also a set of global window options from which any unset window or
3552 pane options are inherited.
3553 Window and pane options are altered with
3558 commands and displayed with
3565 also supports user options which are prefixed with a
3567 User options may have any name, so long as they are prefixed with
3569 and be set to any string.
3571 .Bd -literal -offset indent
3572 $ tmux set -wq @foo "abc123"
3573 $ tmux show -wv @foo
3577 Commands which set options are as follows:
3580 .It Xo Ic set-option
3582 .Op Fl t Ar target-pane
3585 .D1 Pq alias: Ic set
3586 Set a pane option with
3588 a window option with
3590 a server option with
3592 otherwise a session option.
3593 If the option is not a user option,
3597 may be unnecessary -
3599 will infer the type from the option name, assuming
3604 is given, the global session or window option is set.
3607 expands formats in the option value.
3610 flag unsets an option, so a session inherits the option from the global
3613 restores a global option to the default).
3615 unsets an option (like
3617 but if the option is a pane option also unsets the option on any panes in the
3620 depends on the option and may be a number, a string, or a flag (on, off, or
3625 flag prevents setting an option that is already set and the
3627 flag suppresses errors about unknown or ambiguous options.
3631 and if the option expects a string or a style,
3633 is appended to the existing setting.
3635 .Bd -literal -offset indent
3636 set -g status-left "foo"
3637 set -ag status-left "bar"
3643 .Bd -literal -offset indent
3644 set -g status-style "bg=red"
3645 set -ag status-style "fg=blue"
3648 Will result in a red background
3653 the result would be the default background and a blue foreground.
3655 .It Xo Ic show-options
3657 .Op Fl t Ar target-pane
3660 .D1 Pq alias: Ic show
3661 Show the pane options (or a single option if
3665 the window options with
3667 the server options with
3669 otherwise the session options.
3670 If the option is not a user option,
3674 may be unnecessary -
3676 will infer the type from the option name, assuming
3679 Global session or window options are listed if
3683 shows only the option value, not the name.
3686 is set, no error will be returned if
3690 includes hooks (omitted by default).
3692 includes options inherited from a parent set of options, such options are
3693 marked with an asterisk.
3696 Available server options are:
3698 .It Ic backspace Ar key
3702 .It Ic buffer-limit Ar number
3703 Set the number of buffers; as new buffers are added to the top of the stack,
3704 old ones are removed from the bottom if necessary to maintain this maximum
3706 .It Xo Ic command-alias[]
3709 This is an array of custom aliases for commands.
3710 If an unknown command matches
3716 .Dl set -s command-alias[100] zoom='resize-pane -Z'
3724 .Dl resize-pane -Z -t:.1
3726 Note that aliases are expanded when a command is parsed rather than when it is
3727 executed, so binding an alias with
3729 will bind the expanded form.
3730 .It Ic default-terminal Ar terminal
3731 Set the default terminal for new windows created in this session - the
3732 default value of the
3734 environment variable.
3737 to work correctly, this
3742 or a derivative of them.
3743 .It Ic copy-command Ar shell-command
3744 Give the command to pipe to if the
3746 copy mode command is used without arguments.
3747 .It Ic escape-time Ar time
3748 Set the time in milliseconds for which
3750 waits after an escape is input to determine if it is part of a function or meta
3752 The default is 500 milliseconds.
3753 .It Ic editor Ar shell-command
3754 Set the command used when
3757 .It Xo Ic exit-empty
3760 If enabled (the default), the server will exit when there are no active
3762 .It Xo Ic exit-unattached
3765 If enabled, the server will exit when there are no attached clients.
3766 .It Xo Ic extended-keys
3767 .Op Ic on | off | always
3773 the escape sequence to enable extended keys is sent to the terminal, if
3775 knows that it is supported.
3777 always recognises extended keys itself.
3781 will only forward extended keys to applications when they request them; if
3784 will always forward the keys.
3785 .It Xo Ic focus-events
3788 When enabled, focus events are requested from the terminal if supported and
3789 passed through to applications running in
3791 Attached clients should be detached and attached again after changing this
3793 .It Ic history-file Ar path
3794 If not empty, a file to which
3796 will write command prompt history on exit and load it from on start.
3797 .It Ic message-limit Ar number
3798 Set the number of error or information messages to save in the message log for
3800 .It Ic prompt-history-limit Ar number
3801 Set the number of history items to save in the history file for each type of
3803 .It Xo Ic set-clipboard
3804 .Op Ic on | external | off
3806 Attempt to set the terminal clipboard content using the
3808 escape sequence, if there is an
3812 description (see the
3813 .Sx TERMINFO EXTENSIONS
3819 will both accept the escape sequence to create a buffer and attempt to set
3820 the terminal clipboard.
3824 will attempt to set the terminal clipboard but ignore attempts
3825 by applications to set
3831 will neither accept the clipboard escape sequence nor attempt to set the
3834 Note that this feature needs to be enabled in
3836 by setting the resource:
3837 .Bd -literal -offset indent
3838 disallowedWindowOps: 20,21,SetXprop
3841 Or changing this property from the
3843 interactive menu when required.
3844 .It Ic terminal-features[] Ar string
3845 Set terminal features for terminal types read from
3848 has a set of named terminal features.
3849 Each will apply appropriate changes to the
3854 can detect features for a few common terminals; this option can be used to
3855 easily tell tmux about features supported by terminals it cannot detect.
3857 .Ic terminal-overrides
3858 option allows individual
3860 capabilities to be set instead,
3861 .Ic terminal-features
3862 is intended for classes of functionality supported in a standard way but not
3865 Care must be taken to configure this only with features the terminal actually
3868 This is an array option where each entry is a colon-separated string made up
3869 of a terminal type pattern (matched using
3871 followed by a list of terminal features.
3872 The available features are:
3875 Supports 256 colours with the SGR escape sequences.
3877 Allows setting the system clipboard.
3879 Allows setting the cursor colour.
3881 Allows setting the cursor style.
3883 Supports extended keys.
3885 Supports focus reporting.
3887 Supports OSC 8 hyperlinks.
3889 Ignore function keys from
3895 Supports DECSLRM margins.
3901 Supports the OSC 7 working directory extension.
3903 Supports the overline SGR attribute.
3905 Supports the DECFRA rectangle fill escape sequence.
3907 Supports RGB colour with the SGR escape sequences.
3909 Supports SIXEL graphics.
3911 Supports the strikethrough SGR escape sequence.
3913 Supports synchronized updates.
3919 Allows underscore style and colour to be set.
3921 .It Ic terminal-overrides[] Ar string
3922 Allow terminal descriptions read using
3925 Each entry is a colon-separated string made up of a terminal type pattern
3932 For example, to set the
3937 for all terminal types matching
3940 .Dl "rxvt*:clear=\ee[H\ee[2J"
3942 The terminal entry value is passed through
3944 before interpretation.
3945 .It Ic user-keys[] Ar key
3946 Set list of user-defined key escape sequences.
3947 Each item is associated with a key named
3953 .Bd -literal -offset indent
3954 set -s user-keys[0] "\ee[5;30012~"
3955 bind User0 resize-pane -L 3
3959 Available session options are:
3961 .It Xo Ic activity-action
3962 .Op Ic any | none | current | other
3964 Set action on window activity when
3965 .Ic monitor-activity
3968 means activity in any window linked to a session causes a bell or message
3970 .Ic visual-activity )
3971 in the current window of that session,
3973 means all activity is ignored (equivalent to
3974 .Ic monitor-activity
3977 means only activity in windows other than the current window are ignored and
3979 means activity in the current window is ignored but not those in other windows.
3980 .It Ic assume-paste-time Ar milliseconds
3981 If keys are entered faster than one in
3983 they are assumed to have been pasted rather than typed and
3985 key bindings are not processed.
3986 The default is one millisecond and zero disables.
3987 .It Ic base-index Ar index
3988 Set the base index from which an unused index should be searched when a new
3990 The default is zero.
3991 .It Xo Ic bell-action
3992 .Op Ic any | none | current | other
3994 Set action on a bell in a window when
3997 The values are the same as those for
3998 .Ic activity-action .
3999 .It Ic default-command Ar shell-command
4000 Set the command used for new windows (if not specified when the window is
4006 The default is an empty string, which instructs
4008 to create a login shell using the value of the
4011 .It Ic default-shell Ar path
4012 Specify the default shell.
4013 This is used as the login shell for new windows when the
4015 option is set to empty, and must be the full path of the executable.
4018 tries to set a default value from the first suitable of the
4020 environment variable, the shell returned by
4024 This option should be configured when
4026 is used as a login shell.
4027 .It Ic default-size Ar XxY
4028 Set the default size of new windows when the
4030 option is set to manual or when a session is created with
4033 The value is the width and height separated by an
4036 The default is 80x24.
4037 .It Xo Ic destroy-unattached
4040 If enabled and the session is no longer attached to any clients, it is
4042 .It Xo Ic detach-on-destroy
4043 .Op Ic off | on | no-detached | previous | next
4047 (the default), the client is detached when the session it is attached to
4051 the client is switched to the most recently active of the remaining
4055 the client is detached only if there are no detached sessions; if detached
4056 sessions exist, the client is switched to the most recently active.
4061 the client is switched to the previous or next session in alphabetical order.
4062 .It Ic display-panes-active-colour Ar colour
4063 Set the colour used by the
4065 command to show the indicator for the active pane.
4066 .It Ic display-panes-colour Ar colour
4067 Set the colour used by the
4069 command to show the indicators for inactive panes.
4070 .It Ic display-panes-time Ar time
4071 Set the time in milliseconds for which the indicators shown by the
4074 .It Ic display-time Ar time
4075 Set the amount of time for which status line messages and other on-screen
4076 indicators are displayed.
4077 If set to 0, messages and indicators are displayed until a key is pressed.
4080 .It Ic history-limit Ar lines
4081 Set the maximum number of lines held in window history.
4082 This setting applies only to new windows - existing window histories are not
4083 resized and retain the limit at the point they were created.
4084 .It Ic key-table Ar key-table
4085 Set the default key table to
4089 .It Ic lock-after-time Ar number
4090 Lock the session (like the
4094 seconds of inactivity.
4095 The default is not to lock (set to 0).
4096 .It Ic lock-command Ar shell-command
4097 Command to run when locking each client.
4098 The default is to run
4102 .It Ic menu-style Ar style
4106 section on how to specify
4108 Attributes are ignored.
4109 .It Ic menu-selected-style Ar style
4110 Set the selected menu item style.
4113 section on how to specify
4115 Attributes are ignored.
4116 .It Ic menu-border-style Ar style
4117 Set the menu border style.
4120 section on how to specify
4122 Attributes are ignored.
4123 .It Ic menu-border-lines Ar type
4124 Set the type of characters used for drawing menu borders.
4126 .Ic popup-border-lines
4127 for possible values for
4129 .It Ic message-command-style Ar style
4130 Set status line message command style.
4131 This is used for the command prompt with
4133 keys when in command mode.
4139 .It Xo Ic message-line
4140 .Op Ic 0 | 1 | 2 | 3 | 4
4142 Set line on which status line messages and the command prompt are shown.
4143 .It Ic message-style Ar style
4144 Set status line message style.
4145 This is used for messages and for the command prompt.
4156 captures the mouse and allows mouse events to be bound as key bindings.
4159 section for details.
4160 .It Ic prefix Ar key
4161 Set the key accepted as a prefix key.
4162 In addition to the standard keys described under
4165 can be set to the special key
4168 .It Ic prefix2 Ar key
4169 Set a secondary key accepted as a prefix key.
4175 .It Xo Ic renumber-windows
4178 If on, when a window is closed in a session, automatically renumber the other
4179 windows in numerical order.
4182 option if it has been set.
4183 If off, do not renumber the windows.
4184 .It Ic repeat-time Ar time
4185 Allow multiple commands to be entered without pressing the prefix-key again
4188 milliseconds (the default is 500).
4189 Whether a key repeats may be set when it is bound using the
4193 Repeat is enabled for the default keys bound to the
4196 .It Xo Ic set-titles
4199 Attempt to set the client terminal title using the
4204 entries if they exist.
4206 automatically sets these to the \ee]0;...\e007 sequence if
4207 the terminal appears to be
4209 This option is off by default.
4210 .It Ic set-titles-string Ar string
4211 String used to set the client terminal title if
4214 Formats are expanded, see the
4217 .It Xo Ic silence-action
4218 .Op Ic any | none | current | other
4220 Set action on window silence when
4223 The values are the same as those for
4224 .Ic activity-action .
4226 .Op Ic off | on | 2 | 3 | 4 | 5
4228 Show or hide the status line or specify its size.
4231 gives a status line one row in height;
4238 .It Ic status-format[] Ar format
4239 Specify the format to be used for each line of the status line.
4240 The default builds the top status line from the various individual status
4242 .It Ic status-interval Ar interval
4243 Update the status line every
4246 By default, updates will occur every 15 seconds.
4247 A setting of zero disables redrawing at interval.
4248 .It Xo Ic status-justify
4249 .Op Ic left | centre | right | absolute-centre
4251 Set the position of the window list in the status line: left, centre or right.
4252 centre puts the window list in the relative centre of the available free space;
4253 absolute-centre uses the centre of the entire horizontal space.
4254 .It Xo Ic status-keys
4257 Use vi or emacs-style
4258 key bindings in the status line, for example at the command prompt.
4259 The default is emacs, unless the
4263 environment variables are set and contain the string
4265 .It Ic status-left Ar string
4268 (by default the session name) to the left of the status line.
4270 will be passed through
4278 For details on how the names and titles can be set see the
4279 .Sx "NAMES AND TITLES"
4283 .Bd -literal -offset indent
4284 #(sysctl vm.loadavg)
4285 #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
4290 .It Ic status-left-length Ar length
4293 of the left component of the status line.
4295 .It Ic status-left-style Ar style
4296 Set the style of the left part of the status line.
4302 .It Xo Ic status-position
4305 Set the position of the status line.
4306 .It Ic status-right Ar string
4309 to the right of the status line.
4310 By default, the current pane title in double quotes, the date and the time
4317 and character pairs are replaced.
4318 .It Ic status-right-length Ar length
4321 of the right component of the status line.
4323 .It Ic status-right-style Ar style
4324 Set the style of the right part of the status line.
4330 .It Ic status-style Ar style
4331 Set status line style.
4337 .It Ic update-environment[] Ar variable
4338 Set list of environment variables to be copied into the session environment
4339 when a new session is created or an existing session is attached.
4340 Any variables that do not exist in the source environment are set to be
4341 removed from the session environment (as if
4346 .It Xo Ic visual-activity
4347 .Op Ic on | off | both
4349 If on, display a message instead of sending a bell when activity occurs in a
4350 window for which the
4351 .Ic monitor-activity
4352 window option is enabled.
4353 If set to both, a bell and a message are produced.
4354 .It Xo Ic visual-bell
4355 .Op Ic on | off | both
4357 If on, a message is shown on a bell in a window for which the
4359 window option is enabled instead of it being passed through to the
4360 terminal (which normally makes a sound).
4361 If set to both, a bell and a message are produced.
4365 .It Xo Ic visual-silence
4366 .Op Ic on | off | both
4370 is enabled, prints a message after the interval has expired on a given window
4371 instead of sending a bell.
4372 If set to both, a bell and a message are produced.
4373 .It Ic word-separators Ar string
4374 Sets the session's conception of what characters are considered word
4375 separators, for the purposes of the next and previous word commands in
4379 Available window options are:
4381 .Bl -tag -width Ds -compact
4382 .It Xo Ic aggressive-resize
4385 Aggressively resize the chosen window.
4388 will resize the window to the size of the smallest or largest session
4391 option) for which it is the current window, rather than the session to
4392 which it is attached.
4393 The window may resize when the current window is changed on another
4394 session; this option is good for full-screen programs which support
4396 and poor for interactive programs such as shells.
4398 .It Xo Ic automatic-rename
4401 Control automatic window renaming.
4402 When this setting is enabled,
4404 will rename the window automatically using the format specified by
4405 .Ic automatic-rename-format .
4406 This flag is automatically disabled for an individual window when a name
4407 is specified at creation with
4413 or with a terminal escape sequence.
4414 It may be switched off globally with:
4415 .Bd -literal -offset indent
4416 set-option -wg automatic-rename off
4419 .It Ic automatic-rename-format Ar format
4423 .Ic automatic-rename
4426 .It Ic clock-mode-colour Ar colour
4429 .It Xo Ic clock-mode-style
4432 Set clock hour format.
4434 .It Ic fill-character Ar character
4435 Set the character used to fill areas of the terminal unused by a window.
4437 .It Ic main-pane-height Ar height
4438 .It Ic main-pane-width Ar width
4439 Set the width or height of the main (left or top) pane in the
4446 this is a percentage of the window size.
4448 .It Ic copy-mode-match-style Ar style
4449 Set the style of search matches in copy mode.
4456 .It Ic copy-mode-mark-style Ar style
4457 Set the style of the line containing the mark in copy mode.
4464 .It Ic copy-mode-current-match-style Ar style
4465 Set the style of the current search match in copy mode.
4475 Use vi or emacs-style key bindings in copy mode.
4476 The default is emacs, unless
4483 .It Ic mode-style Ar style
4484 Set window modes style.
4491 .It Xo Ic monitor-activity
4494 Monitor for activity in the window.
4495 Windows with activity are highlighted in the status line.
4497 .It Xo Ic monitor-bell
4500 Monitor for a bell in the window.
4501 Windows with a bell are highlighted in the status line.
4503 .It Xo Ic monitor-silence
4506 Monitor for silence (no activity) in the window within
4509 Windows that have been silent for the interval are highlighted in the
4511 An interval of zero disables the monitoring.
4513 .It Ic other-pane-height Ar height
4514 Set the height of the other panes (not the main pane) in the
4517 If this option is set to 0 (the default), it will have no effect.
4519 .Ic main-pane-height
4521 .Ic other-pane-height
4522 options are set, the main pane will grow taller to make the other panes the
4523 specified height, but will never shrink to do so.
4526 this is a percentage of the window size.
4528 .It Ic other-pane-width Ar width
4530 .Ic other-pane-height ,
4531 but set the width of other panes in the
4535 .It Ic pane-active-border-style Ar style
4536 Set the pane border style for the currently active pane.
4542 Attributes are ignored.
4544 .It Ic pane-base-index Ar index
4547 but set the starting index for pane numbers.
4549 .It Ic pane-border-format Ar format
4550 Set the text shown in pane border status lines.
4552 .It Xo Ic pane-border-indicators
4553 .Op Ic off | colour | arrows | both
4555 Indicate active pane by colouring only half of the border in windows with
4556 exactly two panes, by displaying arrow markers, by drawing both or neither.
4558 .It Ic pane-border-lines Ar type
4559 Set the type of characters used for drawing pane borders.
4564 single lines using ACS or UTF-8 characters
4566 double lines using UTF-8 characters
4568 heavy lines using UTF-8 characters
4570 simple ASCII characters
4578 will fall back to standard ACS line drawing when UTF-8 is not supported.
4580 .It Xo Ic pane-border-status
4581 .Op Ic off | top | bottom
4583 Turn pane border status lines off or set their position.
4585 .It Ic pane-border-style Ar style
4586 Set the pane border style for panes aside from the active pane.
4592 Attributes are ignored.
4594 .It Ic popup-style Ar style
4595 Set the popup style.
4598 section on how to specify
4600 Attributes are ignored.
4602 .It Ic popup-border-style Ar style
4603 Set the popup border style.
4606 section on how to specify
4608 Attributes are ignored.
4610 .It Ic popup-border-lines Ar type
4611 Set the type of characters used for drawing popup borders.
4616 single lines using ACS or UTF-8 characters (default)
4618 variation of single with rounded corners using UTF-8 characters
4620 double lines using UTF-8 characters
4622 heavy lines using UTF-8 characters
4624 simple ASCII characters
4626 simple ASCII space character
4634 will fall back to standard ACS line drawing when UTF-8 is not supported.
4636 .It Ic window-status-activity-style Ar style
4637 Set status line style for windows with an activity alert.
4644 .It Ic window-status-bell-style Ar style
4645 Set status line style for windows with a bell alert.
4652 .It Ic window-status-current-format Ar string
4654 .Ar window-status-format ,
4655 but is the format used when the window is the current window.
4657 .It Ic window-status-current-style Ar style
4658 Set status line style for the currently active window.
4665 .It Ic window-status-format Ar string
4666 Set the format in which the window is displayed in the status line window list.
4673 .It Ic window-status-last-style Ar style
4674 Set status line style for the last active window.
4681 .It Ic window-status-separator Ar string
4682 Sets the separator drawn between windows in the status line.
4683 The default is a single space character.
4685 .It Ic window-status-style Ar style
4686 Set status line style for a single window.
4693 .It Xo Ic window-size
4694 .Ar largest | Ar smallest | Ar manual | Ar latest
4698 determines the window size.
4701 the size of the largest attached session is used; if
4703 the size of the smallest.
4706 the size of a new window is set from the
4708 option and windows are resized automatically.
4712 uses the size of the client that had the most recent activity.
4716 .Ic aggressive-resize
4719 .It Xo Ic wrap-search
4722 If this option is set, searches will wrap around the end of the pane contents.
4726 Available pane options are:
4728 .Bl -tag -width Ds -compact
4729 .It Xo Ic allow-passthrough
4730 .Op Ic on | off | all
4732 Allow programs in the pane to bypass
4734 using a terminal escape sequence (\eePtmux;...\ee\e\e).
4737 passthrough sequences will be allowed only if the pane is visible.
4740 they will be allowed even if the pane is invisible.
4742 .It Xo Ic allow-rename
4745 Allow programs in the pane to change the window name using a terminal escape
4746 sequence (\eek...\ee\e\e).
4748 .It Xo Ic alternate-screen
4751 This option configures whether programs running inside the pane may use the
4752 terminal alternate screen feature, which allows the
4758 The alternate screen feature preserves the contents of the window when an
4759 interactive application starts and restores it on exit, so that any output
4760 visible before the application starts reappears unchanged after it exits.
4762 .It Ic cursor-colour Ar colour
4763 Set the colour of the cursor.
4765 .It Ic pane-colours[] Ar colour
4766 The default colour palette.
4767 Each entry in the array defines the colour
4769 uses when the colour with that index is requested.
4770 The index may be from zero to 255.
4772 .It Ic cursor-style Ar style
4773 Set the style of the cursor.
4774 Available styles are:
4776 .Ic blinking-block ,
4778 .Ic blinking-underline ,
4783 .It Xo Ic remain-on-exit
4784 .Op Ic on | off | failed
4786 A pane with this flag set is not destroyed when the program running in it
4790 then only when the program exit status is not zero.
4791 The pane may be reactivated with the
4795 .It Ic remain-on-exit-format Ar string
4796 Set the text shown at the bottom of exited panes when
4800 .It Xo Ic scroll-on-clear
4803 When the entire screen is cleared and this option is on, scroll the contents of
4804 the screen into history before clearing it.
4806 .It Xo Ic synchronize-panes
4809 Duplicate input to all other panes in the same window where this option is also
4810 on (only for panes that are not in any mode).
4812 .It Ic window-active-style Ar style
4813 Set the pane style when it is the active pane.
4820 .It Ic window-style Ar style
4830 allows commands to run on various triggers, called
4836 hook and there are a number of hooks not associated with commands.
4838 Hooks are stored as array options, members of the array are executed in
4839 order when the hook is triggered.
4840 Like options different hooks may be global or belong to a session, window or
4842 Hooks may be configured with the
4846 commands and displayed with
4851 The following two commands are equivalent:
4852 .Bd -literal -offset indent.
4853 set-hook -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4854 set-option -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4857 Setting a hook without specifying an array index clears the hook and sets the
4858 first member of the array.
4861 hook is run after it completes, except when the command is run as part of a hook
4863 They are named with an
4866 For example, the following command adds a hook to select the even-vertical
4869 .Bd -literal -offset indent
4870 set-hook -g after-split-window "selectl even-vertical"
4873 All the notifications listed in the
4875 section are hooks (without any arguments), except
4877 The following additional hooks are available:
4878 .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXX"
4880 Run when a window has activity.
4882 .Ic monitor-activity .
4884 Run when a window has received a bell.
4888 Run when a window has been silent.
4890 .Ic monitor-silence .
4892 Run when a client becomes the latest active client of its session.
4894 Run when a client is attached.
4896 Run when a client is detached
4898 Run when focus enters a client
4899 .It client-focus-out
4900 Run when focus exits a client
4902 Run when a client is resized.
4903 .It client-session-changed
4904 Run when a client's attached session is changed.
4906 Run when the program running in a pane exits, but
4908 is on so the pane has not closed.
4910 Run when the program running in a pane exits.
4912 Run when the focus enters a pane, if the
4916 Run when the focus exits a pane, if the
4919 .It pane-set-clipboard
4920 Run when the terminal clipboard is set using the
4924 Run when a new session created.
4926 Run when a session closed.
4928 Run when a session is renamed.
4930 Run when a window is linked into a session.
4932 Run when a window is renamed.
4934 Run when a window is resized.
4935 This may be after the
4939 Run when a window is unlinked from a session.
4942 Hooks are managed with these commands:
4946 .Op Fl t Ar target-pane
4958 The flags are the same as for
4966 .It Xo Ic show-hooks
4968 .Op Fl t Ar target-pane
4971 The flags are the same as for
4977 option is on (the default is off),
4979 allows mouse events to be bound as keys.
4980 The name of each key is made up of a mouse event (such as
4982 and a location suffix, one of the following:
4983 .Bl -column "XXXXXXXXXXXXX" -offset indent
4984 .It Li "Pane" Ta "the contents of a pane"
4985 .It Li "Border" Ta "a pane border"
4986 .It Li "Status" Ta "the status line window list"
4987 .It Li "StatusLeft" Ta "the left part of the status line"
4988 .It Li "StatusRight" Ta "the right part of the status line"
4989 .It Li "StatusDefault" Ta "any other part of the status line"
4992 The following mouse events are available:
4993 .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
4994 .It Li "WheelUp" Ta "WheelDown" Ta ""
4995 .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
4996 .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
4997 .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
4998 .It Li "SecondClick1" Ta "SecondClick2" Ta "SecondClick3"
4999 .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3"
5000 .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3"
5005 events are fired for the second click of a double click, even if there may be a
5006 third click which will fire
5011 Each should be suffixed with a location, for example
5012 .Ql MouseDown1Status .
5022 in commands bound to mouse key bindings.
5023 It resolves to the window or pane over which the mouse event took place
5024 (for example, the window in the status line over which button 1 was released
5027 binding, or the pane over which the wheel was scrolled for a
5034 flag may be used to forward a mouse event to a pane.
5036 The default key bindings allow the mouse to be used to select and resize panes,
5037 to copy text and to change window using the status line.
5038 These take effect if the
5040 option is turned on.
5042 Certain commands accept the
5047 This is a string which controls the output format of the command.
5048 Format variables are enclosed in
5053 .Ql #{session_name} .
5054 The possible variables are listed in the table below, or the name of a
5056 option may be used for an option's value.
5057 Some variables have a shorter alias such as
5060 is replaced by a single
5070 Conditionals are available by prefixing with
5072 and separating two alternatives with a comma;
5073 if the specified variable exists and is not zero, the first alternative
5074 is chosen, otherwise the second is used.
5076 .Ql #{?session_attached,attached,not attached}
5077 will include the string
5079 if the session is attached and the string
5081 if it is unattached, or
5082 .Ql #{?automatic-rename,yes,no}
5086 .Ic automatic-rename
5090 Conditionals can be nested arbitrarily.
5091 Inside a conditional,
5099 unless they are part of a
5103 .Bd -literal -offset indent
5104 #{?pane_in_mode,#[fg=white#,bg=red],#[fg=red#,bg=white]}#W .
5107 String comparisons may be expressed by prefixing two comma-separated
5118 .Ql #{==:#{host},myhost}
5128 evaluate to true if either or both of two comma-separated alternatives are
5130 .Ql #{||:#{pane_in_mode},#{alternate_on}} .
5136 or regular expression comparison.
5137 The first argument is the pattern and the second the string to compare.
5138 An optional argument specifies flags:
5140 means the pattern is a regular expression instead of the default
5144 means to ignore case.
5146 .Ql #{m:*foo*,#{host}}
5148 .Ql #{m/ri:^A,MYVAR} .
5151 performs a search for an
5153 pattern or regular expression in the pane content and evaluates to zero if not
5154 found, or a line number if found.
5159 flag means search for a regular expression and
5165 Numeric operators may be performed by prefixing two comma-separated alternatives
5171 flag may be given after the operator to use floating point numbers, otherwise
5173 This may be followed by a number giving the number of decimal places to use for
5175 The available operators are:
5192 in formats which are also expanded by
5194 and numeric comparison operators
5203 .Ql #{e|*|f|4:5.5,3}
5204 multiplies 5.5 by 3 for a result with four decimal places and
5206 returns the modulus of 7 and 3.
5208 replaces a numeric argument by its ASCII equivalent, so
5215 colour by its six-digit hexadecimal RGB value.
5217 A limit may be placed on the length of the resultant string by prefixing it
5220 a number and a colon.
5221 Positive numbers count from the start of the string and negative from the end,
5223 .Ql #{=5:pane_title}
5224 will include at most the first five characters of the pane title, or
5225 .Ql #{=-5:pane_title}
5226 the last five characters.
5227 A suffix or prefix may be given as a second argument - if provided then it is
5228 appended or prepended to the string if the length has been trimmed, for example
5229 .Ql #{=/5/...:pane_title}
5232 if the pane title is more than five characters.
5235 pads the string to a given width, for example
5236 .Ql #{p10:pane_title}
5237 will result in a width of at least 10 characters.
5238 A positive width pads on the left, a negative on the right.
5240 expands to the length of the variable and
5242 to its width when displayed, for example
5243 .Ql #{n:window_name} .
5245 Prefixing a time variable with
5247 will convert it to a string, so if
5248 .Ql #{window_activity}
5251 .Ql #{t:window_activity}
5253 .Ql Sun Oct 25 09:25:02 2015 .
5257 will use shorter but less accurate time format for times in the past.
5258 A custom format may be given using an
5264 if the format is separately being passed through
5269 .Ql #{t/f/%%H#:%%M:window_activity} ,
5281 of the variable respectively.
5285 special characters or with a
5287 suffix, escape hash characters (so
5292 will expand the format twice, for example
5293 .Ql #{E:status-left}
5294 is the result of expanding the content of the
5296 option rather than the option itself.
5308 will loop over each session, window, pane or client and insert the format once
5310 For windows and panes, two comma-separated formats may be given:
5311 the second is used for the current window or active pane.
5312 For example, to get a list of windows formatted like the status line:
5313 .Bd -literal -offset indent
5314 #{W:#{E:window-status-format} ,#{E:window-status-current-format} }
5318 checks if a window (without any suffix or with the
5320 suffix) or a session (with the
5322 suffix) name exists, for example
5324 is replaced with 1 if a window named
5328 A prefix of the form
5335 The first argument may be an extended regular expression and a final argument
5338 to ignore case, for example
5339 .Ql s/a(.)/\e1x/i:\&
5344 A different delimiter character may also be used, to avoid collisions with
5345 literal slashes in the pattern.
5354 In addition, the last line of a shell command's output may be inserted using
5358 will insert the system's uptime.
5359 When constructing formats,
5363 commands to finish; instead, the previous result from running the same command
5364 is used, or a placeholder if the command has not been run before.
5365 If the command hasn't exited, the most recent line of output will be used, but
5366 the status line will not be updated more than once a second.
5367 Commands are executed using
5371 global environment set (see the
5372 .Sx GLOBAL AND SESSION ENVIRONMENT
5377 specifies that a string should be interpreted literally and not expanded.
5379 .Ql #{l:#{?pane_in_mode,yes,no}}
5381 .Ql #{?pane_in_mode,yes,no} .
5383 The following variables are available, where appropriate:
5384 .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
5385 .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
5386 .It Li "active_window_index" Ta "" Ta "Index of active window in session"
5387 .It Li "alternate_on" Ta "" Ta "1 if pane is in alternate screen"
5388 .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
5389 .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
5390 .It Li "buffer_created" Ta "" Ta "Time buffer created"
5391 .It Li "buffer_name" Ta "" Ta "Name of buffer"
5392 .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
5393 .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
5394 .It Li "client_activity" Ta "" Ta "Time client last had activity"
5395 .It Li "client_cell_height" Ta "" Ta "Height of each client cell in pixels"
5396 .It Li "client_cell_width" Ta "" Ta "Width of each client cell in pixels"
5397 .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
5398 .It Li "client_created" Ta "" Ta "Time client created"
5399 .It Li "client_discarded" Ta "" Ta "Bytes discarded when client behind"
5400 .It Li "client_flags" Ta "" Ta "List of client flags"
5401 .It Li "client_height" Ta "" Ta "Height of client"
5402 .It Li "client_key_table" Ta "" Ta "Current key table"
5403 .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
5404 .It Li "client_name" Ta "" Ta "Name of client"
5405 .It Li "client_pid" Ta "" Ta "PID of client process"
5406 .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
5407 .It Li "client_readonly" Ta "" Ta "1 if client is read-only"
5408 .It Li "client_session" Ta "" Ta "Name of the client's session"
5409 .It Li "client_termfeatures" Ta "" Ta "Terminal features of client, if any"
5410 .It Li "client_termname" Ta "" Ta "Terminal name of client"
5411 .It Li "client_termtype" Ta "" Ta "Terminal type of client, if available"
5412 .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
5413 .It Li "client_uid" Ta "" Ta "UID of client process"
5414 .It Li "client_user" Ta "" Ta "User of client process"
5415 .It Li "client_utf8" Ta "" Ta "1 if client supports UTF-8"
5416 .It Li "client_width" Ta "" Ta "Width of client"
5417 .It Li "client_written" Ta "" Ta "Bytes written to client"
5418 .It Li "command" Ta "" Ta "Name of command in use, if any"
5419 .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
5420 .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
5421 .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
5422 .It Li "config_files" Ta "" Ta "List of configuration files loaded"
5423 .It Li "copy_cursor_line" Ta "" Ta "Line the cursor is on in copy mode"
5424 .It Li "copy_cursor_word" Ta "" Ta "Word under cursor in copy mode"
5425 .It Li "copy_cursor_x" Ta "" Ta "Cursor X position in copy mode"
5426 .It Li "copy_cursor_y" Ta "" Ta "Cursor Y position in copy mode"
5427 .It Li "current_file" Ta "" Ta "Current configuration file"
5428 .It Li "cursor_character" Ta "" Ta "Character at cursor in pane"
5429 .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
5430 .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
5431 .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
5432 .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
5433 .It Li "history_limit" Ta "" Ta "Maximum window history lines"
5434 .It Li "history_size" Ta "" Ta "Size of history in lines"
5435 .It Li "hook" Ta "" Ta "Name of running hook, if any"
5436 .It Li "hook_client" Ta "" Ta "Name of client where hook was run, if any"
5437 .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
5438 .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
5439 .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
5440 .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
5441 .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
5442 .It Li "host" Ta "#H" Ta "Hostname of local host"
5443 .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
5444 .It Li "insert_flag" Ta "" Ta "Pane insert flag"
5445 .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
5446 .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
5447 .It Li "last_window_index" Ta "" Ta "Index of last window in session"
5448 .It Li "line" Ta "" Ta "Line number in the list"
5449 .It Li "mouse_all_flag" Ta "" Ta "Pane mouse all flag"
5450 .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
5451 .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
5452 .It Li "mouse_hyperlink" Ta "" Ta "Hyperlink under mouse, if any"
5453 .It Li "mouse_line" Ta "" Ta "Line under mouse, if any"
5454 .It Li "mouse_sgr_flag" Ta "" Ta "Pane mouse SGR flag"
5455 .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
5456 .It Li "mouse_status_line" Ta "" Ta "Status line on which mouse event took place"
5457 .It Li "mouse_status_range" Ta "" Ta "Range type or argument of mouse event on status line"
5458 .It Li "mouse_utf8_flag" Ta "" Ta "Pane mouse UTF-8 flag"
5459 .It Li "mouse_word" Ta "" Ta "Word under mouse, if any"
5460 .It Li "mouse_x" Ta "" Ta "Mouse X position, if any"
5461 .It Li "mouse_y" Ta "" Ta "Mouse Y position, if any"
5462 .It Li "next_session_id" Ta "" Ta "Unique session ID for next new session"
5463 .It Li "origin_flag" Ta "" Ta "Pane origin flag"
5464 .It Li "pane_active" Ta "" Ta "1 if active pane"
5465 .It Li "pane_at_bottom" Ta "" Ta "1 if pane is at the bottom of window"
5466 .It Li "pane_at_left" Ta "" Ta "1 if pane is at the left of window"
5467 .It Li "pane_at_right" Ta "" Ta "1 if pane is at the right of window"
5468 .It Li "pane_at_top" Ta "" Ta "1 if pane is at the top of window"
5469 .It Li "pane_bg" Ta "" Ta "Pane background colour"
5470 .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
5471 .It Li "pane_current_command" Ta "" Ta "Current command if available"
5472 .It Li "pane_current_path" Ta "" Ta "Current path if available"
5473 .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
5474 .It Li "pane_dead_signal" Ta "" Ta "Exit signal of process in dead pane"
5475 .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
5476 .It Li "pane_dead_time" Ta "" Ta "Exit time of process in dead pane"
5477 .It Li "pane_fg" Ta "" Ta "Pane foreground colour"
5478 .It Li "pane_format" Ta "" Ta "1 if format is for a pane"
5479 .It Li "pane_height" Ta "" Ta "Height of pane"
5480 .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
5481 .It Li "pane_in_mode" Ta "" Ta "1 if pane is in a mode"
5482 .It Li "pane_index" Ta "#P" Ta "Index of pane"
5483 .It Li "pane_input_off" Ta "" Ta "1 if input to pane is disabled"
5484 .It Li "pane_last" Ta "" Ta "1 if last pane"
5485 .It Li "pane_left" Ta "" Ta "Left of pane"
5486 .It Li "pane_marked" Ta "" Ta "1 if this is the marked pane"
5487 .It Li "pane_marked_set" Ta "" Ta "1 if a marked pane is set"
5488 .It Li "pane_mode" Ta "" Ta "Name of pane mode, if any"
5489 .It Li "pane_path" Ta "" Ta "Path of pane (can be set by application)"
5490 .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
5491 .It Li "pane_pipe" Ta "" Ta "1 if pane is being piped"
5492 .It Li "pane_right" Ta "" Ta "Right of pane"
5493 .It Li "pane_search_string" Ta "" Ta "Last search string in copy mode"
5494 .It Li "pane_start_command" Ta "" Ta "Command pane started with"
5495 .It Li "pane_start_path" Ta "" Ta "Path pane started with"
5496 .It Li "pane_synchronized" Ta "" Ta "1 if pane is synchronized"
5497 .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
5498 .It Li "pane_title" Ta "#T" Ta "Title of pane (can be set by application)"
5499 .It Li "pane_top" Ta "" Ta "Top of pane"
5500 .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
5501 .It Li "pane_unseen_changes" Ta "" Ta "1 if there were changes in pane while in mode"
5502 .It Li "pane_width" Ta "" Ta "Width of pane"
5503 .It Li "pid" Ta "" Ta "Server PID"
5504 .It Li "rectangle_toggle" Ta "" Ta "1 if rectangle selection is activated"
5505 .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
5506 .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
5507 .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
5508 .It Li "search_match" Ta "" Ta "Search match if any"
5509 .It Li "search_present" Ta "" Ta "1 if search started in copy mode"
5510 .It Li "selection_active" Ta "" Ta "1 if selection started and changes with the cursor in copy mode"
5511 .It Li "selection_end_x" Ta "" Ta "X position of the end of the selection"
5512 .It Li "selection_end_y" Ta "" Ta "Y position of the end of the selection"
5513 .It Li "selection_present" Ta "" Ta "1 if selection started in copy mode"
5514 .It Li "selection_start_x" Ta "" Ta "X position of the start of the selection"
5515 .It Li "selection_start_y" Ta "" Ta "Y position of the start of the selection"
5516 .It Li "server_sessions" Ta "" Ta "Number of sessions"
5517 .It Li "session_activity" Ta "" Ta "Time of session last activity"
5518 .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
5519 .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
5520 .It Li "session_attached_list" Ta "" Ta "List of clients session is attached to"
5521 .It Li "session_created" Ta "" Ta "Time session created"
5522 .It Li "session_format" Ta "" Ta "1 if format is for a session"
5523 .It Li "session_group" Ta "" Ta "Name of session group"
5524 .It Li "session_group_attached" Ta "" Ta "Number of clients sessions in group are attached to"
5525 .It Li "session_group_attached_list" Ta "" Ta "List of clients sessions in group are attached to"
5526 .It Li "session_group_list" Ta "" Ta "List of sessions in group"
5527 .It Li "session_group_many_attached" Ta "" Ta "1 if multiple clients attached to sessions in group"
5528 .It Li "session_group_size" Ta "" Ta "Size of session group"
5529 .It Li "session_grouped" Ta "" Ta "1 if session in a group"
5530 .It Li "session_id" Ta "" Ta "Unique session ID"
5531 .It Li "session_last_attached" Ta "" Ta "Time session last attached"
5532 .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
5533 .It Li "session_marked" Ta "" Ta "1 if this session contains the marked pane"
5534 .It Li "session_name" Ta "#S" Ta "Name of session"
5535 .It Li "session_path" Ta "" Ta "Working directory of session"
5536 .It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
5537 .It Li "session_windows" Ta "" Ta "Number of windows in session"
5538 .It Li "socket_path" Ta "" Ta "Server socket path"
5539 .It Li "start_time" Ta "" Ta "Server start time"
5540 .It Li "uid" Ta "" Ta "Server UID"
5541 .It Li "user" Ta "" Ta "Server user"
5542 .It Li "version" Ta "" Ta "Server version"
5543 .It Li "window_active" Ta "" Ta "1 if window active"
5544 .It Li "window_active_clients" Ta "" Ta "Number of clients viewing this window"
5545 .It Li "window_active_clients_list" Ta "" Ta "List of clients viewing this window"
5546 .It Li "window_active_sessions" Ta "" Ta "Number of sessions on which this window is active"
5547 .It Li "window_active_sessions_list" Ta "" Ta "List of sessions on which this window is active"
5548 .It Li "window_activity" Ta "" Ta "Time of window last activity"
5549 .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
5550 .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
5551 .It Li "window_bigger" Ta "" Ta "1 if window is larger than client"
5552 .It Li "window_cell_height" Ta "" Ta "Height of each cell in pixels"
5553 .It Li "window_cell_width" Ta "" Ta "Width of each cell in pixels"
5554 .It Li "window_end_flag" Ta "" Ta "1 if window has the highest index"
5555 .It Li "window_flags" Ta "#F" Ta "Window flags with # escaped as ##"
5556 .It Li "window_format" Ta "" Ta "1 if format is for a window"
5557 .It Li "window_height" Ta "" Ta "Height of window"
5558 .It Li "window_id" Ta "" Ta "Unique window ID"
5559 .It Li "window_index" Ta "#I" Ta "Index of window"
5560 .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
5561 .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
5562 .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
5563 .It Li "window_linked_sessions" Ta "" Ta "Number of sessions this window is linked to"
5564 .It Li "window_linked_sessions_list" Ta "" Ta "List of sessions this window is linked to"
5565 .It Li "window_marked_flag" Ta "" Ta "1 if window contains the marked pane"
5566 .It Li "window_name" Ta "#W" Ta "Name of window"
5567 .It Li "window_offset_x" Ta "" Ta "X offset into window if larger than client"
5568 .It Li "window_offset_y" Ta "" Ta "Y offset into window if larger than client"
5569 .It Li "window_panes" Ta "" Ta "Number of panes in window"
5570 .It Li "window_raw_flags" Ta "" Ta "Window flags with nothing escaped"
5571 .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
5572 .It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
5573 .It Li "window_start_flag" Ta "" Ta "1 if window has the lowest index"
5574 .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
5575 .It Li "window_width" Ta "" Ta "Width of window"
5576 .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
5577 .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
5581 offers various options to specify the colour and attributes of aspects of the
5582 interface, for example
5584 for the status line.
5585 In addition, embedded styles may be specified in format options, such as
5587 by enclosing them in
5592 A style may be the single term
5594 to specify the default style (which may come from an option, for example
5596 in the status line) or a space
5597 or comma separated list of the following:
5600 Set the foreground colour.
5601 The colour is one of:
5610 if supported the bright variants
5617 from the 256-colour set;
5619 for the default colour;
5621 for the terminal default colour; or a hexadecimal RGB string such as
5624 Set the background colour.
5626 Set the underscore colour.
5628 Set no attributes (turn off any active attributes).
5641 .Ic double-underscore ,
5642 .Ic curly-underscore ,
5643 .Ic dotted-underscore ,
5644 .Ic dashed-underscore
5647 Any of the attributes may be prefixed with
5651 is the terminal alternate character set.
5652 .It Xo Ic align=left
5658 Align text to the left, centre or right of the available space if appropriate.
5660 Fill the available space with a background colour if appropriate.
5663 .Ic list=left-marker ,
5664 .Ic list=right-marker ,
5667 Mark the position of the various window list components in the
5671 marks the start of the list;
5673 is the part of the list that should be kept in focus if the entire list won't
5674 fit in the available space (typically the current window);
5675 .Ic list=left-marker
5677 .Ic list=right-marker
5678 mark the text to be used to mark that text has been trimmed from the left or
5679 right of the list if there is not enough space.
5680 .It Xo Ic push-default ,
5683 Store the current colours and attributes as the default or reset to the previous
5687 affects any subsequent use of the
5691 Only one default may be pushed (each
5693 replaces the previous saved default).
5694 .It Xo Ic range=left ,
5696 .Ic range=session|X ,
5697 .Ic range=window|X ,
5702 Mark a range for mouse events in the
5705 When a mouse event occurs in the
5713 key bindings are triggered.
5715 .Ic range=session|X ,
5719 are ranges for a session, window or pane.
5722 mouse key with the target session, window or pane given by the
5726 is a session ID, window index in the current session or a pane ID.
5728 .Ic mouse_status_range
5729 format variable will be set to
5736 is a user-defined range; it triggers the
5741 will be available in the
5742 .Ic mouse_status_range
5745 must be at most 15 bytes in length.
5749 .Bd -literal -offset indent
5750 fg=yellow bold underscore blink
5751 bg=black,fg=default,noreverse
5753 .Sh NAMES AND TITLES
5755 distinguishes between names and titles.
5756 Windows and sessions have names, which may be used to specify them in targets
5757 and are displayed in the status line and various lists: the name is the
5759 identifier for a window or session.
5760 Only panes have titles.
5761 A pane's title is typically set by the program running inside the pane using
5762 an escape sequence (like it would set the
5766 Windows themselves do not have titles - a window's title is the title of its
5769 itself may set the title of the terminal in which the client is running, see
5774 A session's name is set with the
5779 A window's name is set with one of:
5782 A command argument (such as
5789 An escape sequence (if the
5791 option is turned on):
5792 .Bd -literal -offset indent
5793 $ printf '\e033kWINDOW_NAME\e033\e\e'
5796 Automatic renaming, which sets the name to the active command in the window's
5799 .Ic automatic-rename
5803 When a pane is first created, its title is the hostname.
5804 A pane's title can be set via the title setting escape sequence, for example:
5805 .Bd -literal -offset indent
5806 $ printf '\e033]2;My Title\e033\e\e'
5809 It can also be modified with the
5813 .Sh GLOBAL AND SESSION ENVIRONMENT
5814 When the server is started,
5816 copies the environment into the
5817 .Em global environment ;
5818 in addition, each session has a
5819 .Em session environment .
5820 When a window is created, the session and global environments are merged.
5821 If a variable exists in both, the value from the session environment is used.
5822 The result is the initial environment passed to the new process.
5825 .Ic update-environment
5826 session option may be used to update the session environment from the client
5827 when a new session is created or an old reattached.
5829 also initialises the
5831 variable with some internal information to allow commands to be executed
5832 from inside, and the
5834 variable with the correct terminal setting of
5837 Variables in both session and global environments may be marked as hidden.
5838 Hidden variables are not passed into the environment of new processes and
5839 instead can only be used by tmux itself (for example in formats, see the
5843 Commands to alter and view the environment are:
5846 .It Xo Ic set-environment
5848 .Op Fl t Ar target-session
5849 .Ar name Op Ar value
5851 .D1 Pq alias: Ic setenv
5852 Set or unset an environment variable.
5855 is used, the change is made in the global environment; otherwise, it is applied
5856 to the session environment for
5857 .Ar target-session .
5862 is expanded as a format.
5865 flag unsets a variable.
5867 indicates the variable is to be removed from the environment before starting a
5870 marks the variable as hidden.
5872 .It Xo Ic show-environment
5874 .Op Fl t Ar target-session
5877 .D1 Pq alias: Ic showenv
5878 Display the environment for
5880 or the global environment with
5884 is omitted, all variables are shown.
5885 Variables removed from the environment are prefixed with
5889 is used, the output is formatted as a set of Bourne shell commands.
5891 shows hidden variables (omitted by default).
5895 includes an optional status line which is displayed in the bottom line of each
5898 By default, the status line is enabled and one line in height (it may be
5899 disabled or made multiple lines with the
5901 session option) and contains, from left-to-right: the name of the current
5902 session in square brackets; the window list; the title of the active pane
5903 in double quotes; and the time and date.
5905 Each line of the status line is configured with the
5908 The default is made of three parts: configurable left and right sections (which
5909 may contain dynamic content such as the time or output from a shell command,
5912 .Ic status-left-length ,
5915 .Ic status-right-length
5916 options below), and a central window list.
5917 By default, the window list shows the index, name and (if any) flag of the
5918 windows present in the current session in ascending numerical order.
5919 It may be customised with the
5920 .Ar window-status-format
5922 .Ar window-status-current-format
5924 The flag is one of the following symbols appended to the window name:
5925 .Bl -column "Symbol" "Meaning" -offset indent
5926 .It Sy "Symbol" Ta Sy "Meaning"
5927 .It Li "*" Ta "Denotes the current window."
5928 .It Li "-" Ta "Marks the last window (previously selected)."
5929 .It Li "#" Ta "Window activity is monitored and activity has been detected."
5930 .It Li "\&!" Ta "Window bells are monitored and a bell has occurred in the window."
5931 .It Li "~" Ta "The window has been silent for the monitor-silence interval."
5932 .It Li "M" Ta "The window contains the marked pane."
5933 .It Li "Z" Ta "The window's active pane is zoomed."
5936 The # symbol relates to the
5937 .Ic monitor-activity
5939 The window name is printed in inverted colours if an alert (bell, activity or
5940 silence) is present.
5942 The colour and attributes of the status line may be configured, the entire
5943 status line using the
5945 session option and individual windows using the
5946 .Ic window-status-style
5949 The status line is automatically refreshed at interval if it has changed, the
5950 interval may be controlled with the
5954 Commands related to the status line are as follows:
5957 .It Xo Ic clear-prompt-history
5958 .Op Fl T Ar prompt-type
5960 .D1 Pq alias: Ic clearphist
5961 Clear status prompt history for prompt type
5965 is omitted, then clear history for all types.
5968 for possible values for
5970 .It Xo Ic command-prompt
5974 .Op Fl t Ar target-client
5975 .Op Fl T Ar prompt-type
5978 Open the command prompt in a client.
5979 This may be used from inside
5981 to execute commands interactively.
5985 is specified, it is used as the command.
5989 is expanded as a format.
5993 is a comma-separated list of the initial text for each prompt.
5998 is a comma-separated list of prompts which are displayed in order; otherwise
5999 a single prompt is displayed, constructed from
6001 if it is present, or
6005 Before the command is executed, the first occurrence of the string
6007 and all occurrences of
6009 are replaced by the response to the first prompt, all
6011 are replaced with the response to the second prompt, and so on for further
6013 Up to nine prompt responses may be replaced
6022 but any quotation marks are escaped.
6025 makes the prompt only accept one key press, in this case the resulting input
6026 is a single character.
6030 but the key press is translated to a key name.
6032 makes the prompt only accept numeric key presses.
6034 executes the command every time the prompt input changes instead of when the
6035 user exits the command prompt.
6041 This affects what completions are offered when
6044 Available types are:
6051 The following keys have a special meaning in the command prompt, depending
6055 .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
6056 .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
6057 .It Li "Cancel command prompt" Ta "q" Ta "Escape"
6058 .It Li "Delete from cursor to start of word" Ta "" Ta "C-w"
6059 .It Li "Delete entire command" Ta "d" Ta "C-u"
6060 .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
6061 .It Li "Execute command" Ta "Enter" Ta "Enter"
6062 .It Li "Get next command from history" Ta "" Ta "Down"
6063 .It Li "Get previous command from history" Ta "" Ta "Up"
6064 .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
6065 .It Li "Look for completions" Ta "Tab" Ta "Tab"
6066 .It Li "Move cursor left" Ta "h" Ta "Left"
6067 .It Li "Move cursor right" Ta "l" Ta "Right"
6068 .It Li "Move cursor to end" Ta "$" Ta "C-e"
6069 .It Li "Move cursor to next word" Ta "w" Ta "M-f"
6070 .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
6071 .It Li "Move cursor to start" Ta "0" Ta "C-a"
6072 .It Li "Transpose characters" Ta "" Ta "C-t"
6077 the prompt is shown in the background and the invoking client does not exit
6078 until it is dismissed.
6080 .It Xo Ic confirm-before
6082 .Op Fl c Ar confirm-key
6084 .Op Fl t Ar target-client
6087 .D1 Pq alias: Ic confirm
6088 Ask for confirmation before executing
6094 is the prompt to display; otherwise a prompt is constructed from
6096 It may contain the special character sequences supported by the
6101 the prompt is shown in the background and the invoking client does not exit
6102 until it is dismissed.
6104 changes the default behaviour (if Enter alone is pressed) of the prompt to
6107 changes the confirmation key to
6112 .It Xo Ic display-menu
6114 .Op Fl b Ar border-lines
6115 .Op Fl c Ar target-client
6116 .Op Fl C Ar starting-choice
6117 .Op Fl H Ar selected-style
6119 .Op Fl S Ar border-style
6120 .Op Fl t Ar target-pane
6122 .Op Fl x Ar position
6123 .Op Fl y Ar position
6126 .Ar command Op Ar argument ...
6128 .D1 Pq alias: Ic menu
6132 gives the target for any commands run from the menu.
6134 A menu is passed as a series of arguments: first the menu item name,
6135 second the key shortcut (or empty for none) and third the command
6136 to run when the menu item is chosen.
6137 The name and command are formats, see the
6142 If the name begins with a hyphen (-), then the item is disabled (shown dim) and
6144 The name may be empty for a separator line, in which case both the key and
6145 command should be omitted.
6148 sets the type of characters used for drawing menu borders.
6150 .Ic popup-border-lines
6151 for possible values for
6155 sets the style for the selected menu item (see
6159 sets the style for the menu and
6161 sets the style for the menu border (see
6165 is a format for the menu title (see
6169 sets the menu item selected by default, if the menu is not bound to a mouse key
6175 give the position of the menu.
6176 Both may be a row or column number, or one of the following special values:
6177 .Bl -column "XXXXX" "XXXX" -offset indent
6178 .It Sy "Value" Ta Sy "Flag" Ta Sy "Meaning"
6179 .It Li "C" Ta "Both" Ta "The centre of the terminal"
6180 .It Li "R" Ta Fl x Ta "The right side of the terminal"
6181 .It Li "P" Ta "Both" Ta "The bottom left of the pane"
6182 .It Li "M" Ta "Both" Ta "The mouse position"
6183 .It Li "W" Ta "Both" Ta "The window position on the status line"
6184 .It Li "S" Ta Fl y Ta "The line above or below the status line"
6187 Or a format, which is expanded including the following additional variables:
6188 .Bl -column "XXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent
6189 .It Sy "Variable name" Ta Sy "Replaced with"
6190 .It Li "popup_centre_x" Ta "Centered in the client"
6191 .It Li "popup_centre_y" Ta "Centered in the client"
6192 .It Li "popup_height" Ta "Height of menu or popup"
6193 .It Li "popup_mouse_bottom" Ta "Bottom of at the mouse"
6194 .It Li "popup_mouse_centre_x" Ta "Horizontal centre at the mouse"
6195 .It Li "popup_mouse_centre_y" Ta "Vertical centre at the mouse"
6196 .It Li "popup_mouse_top" Ta "Top at the mouse"
6197 .It Li "popup_mouse_x" Ta "Mouse X position"
6198 .It Li "popup_mouse_y" Ta "Mouse Y position"
6199 .It Li "popup_pane_bottom" Ta "Bottom of the pane"
6200 .It Li "popup_pane_left" Ta "Left of the pane"
6201 .It Li "popup_pane_right" Ta "Right of the pane"
6202 .It Li "popup_pane_top" Ta "Top of the pane"
6203 .It Li "popup_status_line_y" Ta "Above or below the status line"
6204 .It Li "popup_width" Ta "Width of menu or popup"
6205 .It Li "popup_window_status_line_x" Ta "At the window position in status line"
6206 .It Li "popup_window_status_line_y" Ta "At the status line showing the window"
6209 Each menu consists of items followed by a key shortcut shown in brackets.
6210 If the menu is too large to fit on the terminal, it is not displayed.
6211 Pressing the key shortcut chooses the corresponding item.
6212 If the mouse is enabled and the menu is opened from a mouse key binding,
6213 releasing the mouse button with an item selected chooses that item and
6214 releasing the mouse button without an item selected closes the menu.
6216 changes this behaviour so that the menu does not close when the mouse button is
6217 released without an item selected the menu is not closed and a mouse button
6218 must be clicked to choose an item.
6220 The following keys are also available:
6221 .Bl -column "Key" "Function" -offset indent
6222 .It Sy "Key" Ta Sy "Function"
6223 .It Li "Enter" Ta "Choose selected item"
6224 .It Li "Up" Ta "Select previous item"
6225 .It Li "Down" Ta "Select next item"
6226 .It Li "q" Ta "Exit menu"
6229 .It Xo Ic display-message
6231 .Op Fl c Ar target-client
6233 .Op Fl t Ar target-pane
6236 .D1 Pq alias: Ic display
6240 is given, the output is printed to stdout, otherwise it is displayed in the
6242 status line for up to
6249 option is used; a delay of zero waits for a key press.
6251 ignores key presses and closes only after the delay expires.
6256 is printed unchanged.
6257 Otherwise, the format of
6261 section; information is taken from
6265 is given, otherwise the active pane.
6268 prints verbose logging as the format is parsed and
6270 lists the format variables and their values.
6273 forwards any input read from stdin to the empty pane given by
6276 .It Xo Ic display-popup
6278 .Op Fl b Ar border-lines
6279 .Op Fl c Ar target-client
6280 .Op Fl d Ar start-directory
6281 .Op Fl e Ar environment
6283 .Op Fl s Ar border-style
6285 .Op Fl t Ar target-pane
6288 .Op Fl x Ar position
6289 .Op Fl y Ar position
6290 .Op Ar shell-command
6292 .D1 Pq alias: Ic popup
6293 Display a popup running
6297 A popup is a rectangular box drawn over the top of any panes.
6298 Panes are not updated while a popup is present.
6301 closes the popup automatically when
6306 closes the popup only if
6308 exited with success.
6313 give the position of the popup, they have the same meaning as for the
6319 give the width and height - both may be a percentage (followed by
6321 If omitted, half of the terminal size is used.
6324 does not surround the popup by a border.
6327 sets the type of characters used for drawing popup borders.
6334 .Ic popup-border-lines
6335 for possible values for
6339 sets the style for the popup and
6341 sets the style for the popup border (see
6347 and sets an environment variable for the popup; it may be specified multiple
6351 is a format for the popup title (see
6356 flag closes any popup on the client.
6358 .It Xo Ic show-prompt-history
6359 .Op Fl T Ar prompt-type
6361 .D1 Pq alias: Ic showphist
6362 Display status prompt history for prompt type
6366 is omitted, then show history for all types.
6369 for possible values for
6374 maintains a set of named
6376 Each buffer may be either explicitly or automatically named.
6377 Explicitly named buffers are named when created with the
6381 commands, or by renaming an automatically named buffer with
6384 Automatically named buffers are given a name such as
6390 option is reached, the oldest automatically named buffer is deleted.
6391 Explicitly named buffers are not subject to
6393 and may be deleted with the
6397 Buffers may be added using
6403 commands, and pasted into a window using the
6406 If a buffer command is used and no buffer is specified, the most
6407 recently added automatically named buffer is assumed.
6409 A configurable history buffer is also maintained for each window.
6410 By default, up to 2000 lines are kept; this can be altered with the
6416 The buffer commands are as follows:
6423 .Op Fl K Ar key-format
6424 .Op Fl O Ar sort-order
6425 .Op Fl t Ar target-pane
6428 Put a pane into buffer mode, where a buffer may be chosen interactively from
6430 Each buffer is shown on one line.
6431 A shortcut key is shown on the left in brackets allowing for immediate choice,
6432 or the list may be navigated and an item chosen or otherwise manipulated using
6436 The following keys may be used in buffer mode:
6437 .Bl -column "Key" "Function" -offset indent
6438 .It Sy "Key" Ta Sy "Function"
6439 .It Li "Enter" Ta "Paste selected buffer"
6440 .It Li "Up" Ta "Select previous buffer"
6441 .It Li "Down" Ta "Select next buffer"
6442 .It Li "C-s" Ta "Search by name or content"
6443 .It Li "n" Ta "Repeat last search"
6444 .It Li "t" Ta "Toggle if buffer is tagged"
6445 .It Li "T" Ta "Tag no buffers"
6446 .It Li "C-t" Ta "Tag all buffers"
6447 .It Li "p" Ta "Paste selected buffer"
6448 .It Li "P" Ta "Paste tagged buffers"
6449 .It Li "d" Ta "Delete selected buffer"
6450 .It Li "D" Ta "Delete tagged buffers"
6451 .It Li "e" Ta "Open the buffer in an editor"
6452 .It Li "f" Ta "Enter a format to filter items"
6453 .It Li "O" Ta "Change sort field"
6454 .It Li "r" Ta "Reverse sort order"
6455 .It Li "v" Ta "Toggle preview"
6456 .It Li "q" Ta "Exit mode"
6459 After a buffer is chosen,
6461 is replaced by the buffer name in
6463 and the result executed as a command.
6466 is not given, "paste-buffer -b '%%'" is used.
6469 specifies the initial sort field: one of
6476 reverses the sort order.
6478 specifies an initial filter: the filter is a format - if it evaluates to zero,
6479 the item in the list is not shown, otherwise it is shown.
6480 If a filter would lead to an empty list, it is ignored.
6482 specifies the format for each item in the list and
6484 a format for each shortcut key; both are evaluated once for each line.
6486 starts without the preview.
6487 This command works only if at least one client is attached.
6489 .It Xo Ic clear-history
6491 .Op Fl t Ar target-pane
6493 .D1 Pq alias: Ic clearhist
6494 Remove and free the history for the specified pane.
6496 also removes all hyperlinks.
6498 .It Ic delete-buffer Op Fl b Ar buffer-name
6499 .D1 Pq alias: Ic deleteb
6500 Delete the buffer named
6502 or the most recently added automatically named buffer if not specified.
6504 .It Xo Ic list-buffers
6508 .D1 Pq alias: Ic lsb
6509 List the global buffers.
6511 specifies the format of each line and
6514 Only buffers for which the filter is true are shown.
6518 .It Xo Ic load-buffer
6520 .Op Fl b Ar buffer-name
6521 .Op Fl t Ar target-client
6525 .D1 Pq alias: Ic loadb
6526 Load the contents of the specified paste buffer from
6530 is given, the buffer is also sent to the clipboard for
6534 escape sequence, if possible.
6536 .It Xo Ic paste-buffer
6538 .Op Fl b Ar buffer-name
6539 .Op Fl s Ar separator
6540 .Op Fl t Ar target-pane
6542 .D1 Pq alias: Ic pasteb
6543 Insert the contents of a paste buffer into the specified pane.
6544 If not specified, paste into the current one.
6547 also delete the paste buffer.
6548 When output, any linefeed (LF) characters in the paste buffer are replaced with
6549 a separator, by default carriage return (CR).
6550 A custom separator may be specified using the
6555 flag means to do no replacement (equivalent to a separator of LF).
6558 is specified, paste bracket control codes are inserted around the
6559 buffer if the application has requested bracketed paste mode.
6561 .It Xo Ic save-buffer
6563 .Op Fl b Ar buffer-name
6566 .D1 Pq alias: Ic saveb
6567 Save the contents of the specified paste buffer to
6571 option appends to rather than overwriting the file.
6572 .It Xo Ic set-buffer
6574 .Op Fl b Ar buffer-name
6575 .Op Fl t Ar target-client
6577 .Op Fl n Ar new-buffer-name
6580 .D1 Pq alias: Ic setb
6581 Set the contents of the specified buffer to
6585 is given, the buffer is also sent to the clipboard for
6589 escape sequence, if possible.
6592 option appends to rather than overwriting the buffer.
6595 option renames the buffer to
6596 .Ar new-buffer-name .
6598 .It Xo Ic show-buffer
6599 .Op Fl b Ar buffer-name
6601 .D1 Pq alias: Ic showb
6602 Display the contents of the specified buffer.
6605 Miscellaneous commands are as follows:
6607 .It Ic clock-mode Op Fl t Ar target-pane
6608 Display a large clock.
6612 .Op Fl t Ar target-pane
6613 .Ar shell-command command
6623 returns success or the second
6626 Before being executed,
6628 is expanded using the rules specified in the
6630 section, including those relevant to
6635 is run in the background.
6641 is not executed but considered success if neither empty nor zero (after formats
6645 .D1 Pq alias: Ic lock
6646 Lock each client individually by running the command specified by the
6652 .Op Fl c Ar start-directory
6654 .Op Fl t Ar target-pane
6655 .Op Ar shell-command
6657 .D1 Pq alias: Ic run
6666 command in the background without creating a window.
6667 Before being executed,
6669 is expanded using the rules specified in the
6674 the command is run in the background.
6678 seconds before starting the command.
6681 is given, the current working directory is set to
6682 .Ar start-directory .
6685 is not given, any output to stdout is displayed in view mode (in the pane
6688 or the current pane if omitted) after the command finishes.
6689 If the command fails, the exit status is also displayed.
6695 .D1 Pq alias: Ic wait
6696 When used without options, prevents the client from exiting until woken using
6699 with the same channel.
6702 is used, the channel is locked and any clients that try to lock the same
6703 channel are made to wait until the channel is unlocked with
6710 client detaches, it prints a message.
6713 .It detached (from session ...)
6714 The client was detached normally.
6715 .It detached and SIGHUP
6716 The client was detached and its parent sent the
6718 signal (for example with
6726 was unexpectedly destroyed.
6728 The client was killed with
6731 The client is in control mode and became unable to keep up with the data from
6734 The server exited when it had no sessions.
6736 The server exited when it received
6738 .It server exited unexpectedly
6739 The server crashed or otherwise exited without telling the client the reason.
6741 .Sh TERMINFO EXTENSIONS
6743 understands some unofficial extensions to
6745 It is not normally necessary to set these manually, instead the
6746 .Ic terminal-features
6747 option should be used.
6750 An existing extension that tells
6752 the terminal supports default colours.
6756 that the terminal supports the VTE bidirectional text extensions.
6758 Set the cursor colour.
6759 The first takes a single string argument and is used to set the colour;
6760 the second takes no arguments and restores the default cursor colour.
6761 If set, a sequence such as this may be used
6762 to change the cursor colour from inside
6764 .Bd -literal -offset indent
6765 $ printf '\e033]12;red\e033\e\e'
6772 .It Em \&Cmg, \&Clmg, \&Dsmg , \&Enmg
6773 Set, clear, disable or enable DECSLRM margins.
6774 These are set automatically if the terminal reports it is
6777 .It Em \&Dsbp , \&Enbp
6778 Disable and enable bracketed paste.
6779 These are set automatically if the
6781 capability is present.
6782 .It Em \&Dseks , \&Eneks
6783 Disable and enable extended keys.
6784 .It Em \&Dsfcs , \&Enfcs
6785 Disable and enable focus reporting.
6786 These are set automatically if the
6788 capability is present.
6790 Set or clear a hyperlink annotation.
6794 that the terminal does not use bright colors for bold display.
6798 that the terminal supports rectangle operations.
6800 Enable the overline attribute.
6802 Set a styled underscore.
6803 The single parameter is one of: 0 for no underscore, 1 for normal
6804 underscore, 2 for double underscore, 3 for curly underscore, 4 for dotted
6805 underscore and 5 for dashed underscore.
6806 .It Em \&Setulc , \&Setulc1, \&ol
6807 Set the underscore colour or reset to the default.
6809 is for RGB colours and
6811 for ANSI or 256 colours.
6814 argument is (red * 65536) + (green * 256) + blue where each is between 0
6817 Set or reset the cursor style.
6818 If set, a sequence such as this may be used
6819 to change the cursor to an underline:
6820 .Bd -literal -offset indent
6821 $ printf '\e033[4 q'
6826 is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
6828 Set the opening sequence for the working directory notification.
6829 The sequence is terminated using the standard
6833 Indicates that the terminal supports SIXEL.
6835 Start (parameter is 1) or end (parameter is 2) a synchronized update.
6837 Indicate that the terminal supports the
6839 RGB escape sequence (for example, \ee[38;2;255;255;255m).
6841 If supported, this is used for the initialize colour escape sequence (which
6842 may be enabled by adding the
6851 This is equivalent to the
6856 Store the current buffer in the host terminal's selection (clipboard).
6859 option above and the
6863 This is an existing extension capability that tmux uses to mean that the
6864 terminal supports the
6866 title set sequences and to automatically set some of the capabilities above.
6870 offers a textual interface called
6872 This allows applications to communicate with
6874 using a simple text-only protocol.
6876 In control mode, a client sends
6878 commands or command sequences terminated by newlines on standard input.
6879 Each command will produce one block of output on standard output.
6880 An output block consists of a
6882 line followed by the output (which may be empty).
6883 The output block ends with a
6892 have three arguments: an integer time (as seconds from epoch), command number
6893 and flags (currently not used).
6895 .Bd -literal -offset indent
6896 %begin 1363006971 2 1
6897 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
6904 command may be used to set the size of a client in control mode.
6908 outputs notifications.
6909 A notification will never occur inside an output block.
6911 The following notifications are defined:
6913 .It Ic %client-detached Ar client
6914 The client has detached.
6915 .It Ic %client-session-changed Ar client session-id name
6916 The client is now attached to the session with ID
6920 .It Ic %config-error Ar error
6921 An error has happened in a configuration file.
6922 .It Ic %continue Ar pane-id
6923 The pane has been continued after being paused (if the
6928 .It Ic %exit Op Ar reason
6931 client is exiting immediately, either because it is not attached to any session
6932 or an error occurred.
6935 describes why the client exited.
6936 .It Ic %extended-output Ar pane-id Ar age Ar ... \& : Ar value
6943 is the time in milliseconds for which tmux had buffered the output before it
6945 Any subsequent arguments up until a single
6947 are for future use and should be ignored.
6948 .It Xo Ic %layout-change
6951 .Ar window-visible-layout
6954 The layout of a window with ID
6959 The window's visible layout is
6960 .Ar window-visible-layout
6961 and the window flags are
6963 .It Ic %message Ar message
6964 A message sent with the
6967 .It Ic %output Ar pane-id Ar value
6968 A window pane produced output.
6970 escapes non-printable characters and backslash as octal \\xxx.
6971 .It Ic %pane-mode-changed Ar pane-id
6975 .It Ic %paste-buffer-changed Ar name
6979 .It Ic %paste-buffer-deleted Ar name
6983 .It Ic %pause Ar pane-id
6984 The pane has been paused (if the
6987 .It Ic %session-changed Ar session-id Ar name
6988 The client is now attached to the session with ID
6992 .It Ic %session-renamed Ar name
6993 The current session was renamed to
6995 .It Ic %session-window-changed Ar session-id Ar window-id
6998 changed its active window to the window with ID
7000 .It Ic %sessions-changed
7001 A session was created or destroyed.
7002 .It Xo Ic %subscription-changed
7007 .Ar pane-id ... \& :
7010 The value of the format associated with subscription
7021 are for future use and should be ignored.
7022 .It Ic %unlinked-window-add Ar window-id
7025 was created but is not linked to the current session.
7026 .It Ic %unlinked-window-close Ar window-id
7029 which is not linked to the current session, was closed.
7030 .It Ic %unlinked-window-renamed Ar window-id
7033 which is not linked to the current session, was renamed.
7034 .It Ic %window-add Ar window-id
7037 was linked to the current session.
7038 .It Ic %window-close Ar window-id
7042 .It Ic %window-pane-changed Ar window-id Ar pane-id
7043 The active pane in the window with ID
7045 changed to the pane with ID
7047 .It Ic %window-renamed Ar window-id Ar name
7056 is started, it inspects the following environment variables:
7057 .Bl -tag -width LC_CTYPE
7059 If the command specified in this variable contains the string
7063 is unset, use vi-style key bindings.
7070 The user's login directory.
7073 database is consulted.
7075 The character encoding
7077 It is used for two separate purposes.
7078 For output to the terminal, UTF-8 is used if the
7080 option is given or if
7086 Otherwise, only ASCII characters are written and non-ASCII characters
7087 are replaced with underscores
7091 always runs with a UTF-8 locale.
7092 If en_US.UTF-8 is provided by the operating system, it is used and
7094 is ignored for input.
7099 what the UTF-8 locale is called on the current system.
7100 If the locale specified by
7102 is not available or is not a UTF-8 locale,
7104 exits with an error message.
7106 The date and time format
7108 It is used for locale-dependent
7112 The current working directory to be set in the global environment.
7113 This may be useful if it contains symbolic links.
7114 If the value of the variable does not match the current working
7115 directory, the variable is ignored and the result of
7119 The absolute path to the default shell for new windows.
7124 The parent directory of the directory containing the server sockets.
7129 If the command specified in this variable contains the string
7131 use vi-style key bindings.
7139 .Bl -tag -width "/etc/tmux.confXXX" -compact
7144 .It Pa /etc/tmux.conf
7145 System-wide configuration file.
7153 .Dl $ tmux new-session vi
7155 Most commands have a shorter form, known as an alias.
7156 For new-session, this is
7161 Alternatively, the shortest unambiguous form of a command is accepted.
7162 If there are several options, they are listed:
7163 .Bd -literal -offset indent
7165 ambiguous command: n, could be: new-session, new-window, next-window
7168 Within an active session, a new window may be created by typing
7178 Windows may be navigated with:
7180 (to select window 0),
7182 (to select window 1), and so on;
7184 to select the next window; and
7186 to select the previous window.
7188 A session may be detached using
7190 (or by an external event such as
7192 disconnection) and reattached with:
7194 .Dl $ tmux attach-session
7198 lists the current key bindings in the current window; up and down may be used
7199 to navigate the list or
7203 Commands to be run when the
7205 server is started may be placed in the
7208 Common examples include:
7210 Changing the default prefix key:
7211 .Bd -literal -offset indent
7212 set-option -g prefix C-a
7214 bind-key C-a send-prefix
7217 Turning the status line off, or changing its colour:
7218 .Bd -literal -offset indent
7219 set-option -g status off
7220 set-option -g status-style bg=blue
7223 Setting other options, such as the default command,
7224 or locking after 30 minutes of inactivity:
7225 .Bd -literal -offset indent
7226 set-option -g default-command "exec /bin/ksh"
7227 set-option -g lock-after-time 1800
7230 Creating new key bindings:
7231 .Bd -literal -offset indent
7232 bind-key b set-option status
7233 bind-key / command-prompt "split-window 'exec man %%'"
7234 bind-key S command-prompt "new-window -n %1 'ssh %1'"
7239 .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com