3 .\" Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
14 .\" IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
15 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 .Nd terminal multiplexer
27 .Op Fl c Ar shell-command
29 .Op Fl L Ar socket-name
30 .Op Fl S Ar socket-path
32 .Op Ar command Op Ar flags
36 is a terminal multiplexer:
37 it enables a number of terminals to be created, accessed, and
38 controlled from a single screen.
40 may be detached from a screen
41 and continue running in the background,
42 then later reattached.
46 is started, it creates a new
50 and displays it on screen.
51 A status line at the bottom of the screen
52 shows information on the current session
53 and is used to enter interactive commands.
55 A session is a single collection of
57 under the management of
59 Each session has one or more
61 A window occupies the entire screen
62 and may be split into rectangular panes,
63 each of which is a separate pseudo terminal
66 manual page documents the technical details of pseudo terminals).
69 instances may connect to the same session,
70 and any number of windows may be present in the same session.
71 Once all sessions are killed,
75 Each session is persistent and will survive accidental disconnection
78 connection timeout) or intentional detaching (with the
82 may be reattached using:
88 a session is displayed on screen by a
90 and all sessions are managed by a single
92 The server and each client are separate processes which communicate through a
96 The options are as follows:
97 .Bl -tag -width "XXXXXXXXXXXX"
101 to assume the terminal supports 256 colours.
102 This is equivalent to
105 Start in control mode (see the
111 .It Fl c Ar shell-command
114 using the default shell.
117 server will be started to retrieve the
120 This option is for compatibility with
124 is used as a login shell.
135 may not be specified.
137 Specify an alternative configuration file.
140 loads the system configuration file from
142 if present, then looks for a user configuration file at
145 The configuration file is a set of
147 commands which are executed in sequence when the server is first started.
149 loads configuration files once when the server process has started.
152 command may be used to load a file later.
155 shows any error messages from commands in configuration files in the first
156 session created, and continues to process the rest of the configuration file.
157 .It Fl L Ar socket-name
159 stores the server socket in a directory under
164 The default socket is named
166 This option allows a different socket name to be specified, allowing several
172 a full path is not necessary: the sockets are all created in a directory
174 under the directory given by
180 directory is created by
182 and must not be world readable, writable or executable.
184 If the socket is accidentally removed, the
186 signal may be sent to the
188 server process to recreate it (note that this will fail if any parent
189 directories are missing).
191 Behave as a login shell.
192 This flag currently has no effect and is for compatibility with other shells
193 when using tmux as a login shell.
195 Do not start the server even if the command would normally do so (for example
199 .It Fl S Ar socket-path
200 Specify a full alternative path to the server socket.
203 is specified, the default socket directory is not used and any
207 Set terminal features for the client.
208 This is a comma-separated list of features.
210 .Ic terminal-features
213 Write UTF-8 output to the terminal even if the first environment
219 that is set does not contain
228 Request verbose logging.
229 Log messages will be saved into
230 .Pa tmux-client-PID.log
232 .Pa tmux-server-PID.log
233 files in the current directory, where
235 is the PID of the server or client process.
238 is specified twice, an additional
240 file is generated with a copy of everything
242 writes to the terminal.
246 signal may be sent to the
248 server process to toggle logging between on (as if
251 .It Ar command Op Ar flags
252 This specifies one of a set of commands used to control
254 as described in the following sections.
255 If no commands are specified, the
259 .Sh DEFAULT KEY BINDINGS
261 may be controlled from an attached client by using a key combination of a
264 (Ctrl-b) by default, followed by a command key.
266 The default command key bindings are:
268 .Bl -tag -width "XXXXXXXXXX" -offset indent -compact
270 Send the prefix key (C-b) through to the application.
272 Rotate the panes in the current window forwards.
278 Break the current pane out of the window.
281 Split the current pane into two, top and bottom.
283 List all paste buffers.
285 Rename the current session.
287 Split the current pane into two, left and right.
289 Kill the current window.
291 Prompt for a window index to select.
293 Switch the attached client to the previous session.
295 Switch the attached client to the next session.
297 Rename the current window.
299 Delete the most recently copied buffer of text.
301 Prompt for an index to move the current window.
303 Select windows 0 to 9.
309 Move to the previously active pane.
311 Choose which buffer to paste interactively from a list.
313 List all key bindings.
315 Choose a client to detach.
317 Switch the attached client back to the last session.
319 Enter copy mode to copy text or view the history.
321 Paste the most recently copied buffer of text.
325 Detach the current client.
327 Prompt to search for text in open windows.
329 Display some information about the current window.
331 Move to the previously selected window.
333 Mark the current pane (see
337 Clear the marked pane.
339 Change to the next window.
341 Select the next pane in the current window.
343 Change to the previous window.
345 Briefly display pane indexes.
347 Force redraw of the attached client.
349 Select a new session for the attached client interactively.
353 Choose the current window interactively.
355 Kill the current pane.
357 Toggle zoom state of the current pane.
359 Swap the current pane with the previous pane.
361 Swap the current pane with the next pane.
363 Show previous messages from
367 Enter copy mode and scroll one page up.
370 Change to the pane above, below, to the left, or to the right of the current
373 Arrange panes in one of the five preset layouts: even-horizontal,
374 even-vertical, main-horizontal, main-vertical, or tiled.
376 Arrange the current window in the next preset layout.
378 Move to the next window with a bell or activity marker.
380 Rotate the panes in the current window backwards.
382 Move to the previous window with a bell or activity marker.
385 Resize the current pane in steps of one cell.
388 Resize the current pane in steps of five cells.
391 Key bindings may be changed with the
396 .Sh COMMAND PARSING AND EXECUTION
398 supports a large number of commands which can be used to control its
400 Each command is named and can accept zero or more flags and arguments.
401 They may be bound to a key with the
403 command or run from the shell prompt, a shell script, a configuration file or
405 For example, the same
407 command run from the shell prompt, from
409 and bound to a key may look like:
410 .Bd -literal -offset indent
411 $ tmux set-option -g status-style bg=cyan
413 set-option -g status-style bg=cyan
415 bind-key C set-option -g status-style bg=cyan
418 Here, the command name is
428 distinguishes between command parsing and execution.
429 In order to execute a command,
431 needs it to be split up into its name and arguments.
432 This is command parsing.
433 If a command is run from the shell, the shell parses it; from inside
435 or from a configuration file,
441 .Bl -dash -offset indent
443 in a configuration file;
445 typed at the command prompt (see
446 .Ic command-prompt ) ;
451 passed as arguments to
457 To execute commands, each client has a
459 A global command queue not attached to any client is used on startup
460 for configuration files like
462 Parsed commands added to the queue are executed in order.
467 parse their argument to create a new command which is inserted immediately
469 This means that arguments can be parsed twice or more - once when the parent
472 is parsed and again when it parses and executes its command.
478 stop execution of subsequent commands on the queue until something happens -
482 until a shell command finishes and
484 until a key is pressed.
485 For example, the following commands:
486 .Bd -literal -offset indent
487 new-session; new-window
488 if-shell "true" "split-window"
507 commands and their arguments.
509 This section describes the syntax of commands parsed by
511 for example in a configuration file or at the command prompt.
512 Note that when commands are entered into the shell, they are parsed by the shell
518 Each command is terminated by a newline or a semicolon (;).
519 Commands separated by semicolons together form a
521 - if a command in the sequence encounters an error, no subsequent commands are
524 It is recommended that a semicolon used as a command separator should be
525 written as an individual token, for example from
527 .Bd -literal -offset indent
528 $ tmux neww \\; splitw
532 .Bd -literal -offset indent
533 $ tmux neww ';' splitw
536 Or from the tmux command prompt:
537 .Bd -literal -offset indent
541 However, a trailing semicolon is also interpreted as a command separator,
545 .Bd -literal -offset indent
546 $ tmux neww\e; splitw
550 .Bd -literal -offset indent
551 $ tmux 'neww;' splitw
554 As in these examples, when running tmux from the shell extra care must be taken
555 to properly quote semicolons:
558 Semicolons that should be interpreted as a command separator
559 should be escaped according to the shell conventions.
562 this typically means quoted (such as
563 .Ql neww ';' splitw )
565 .Ql neww \e\e\e\e; splitw ) .
567 Individual semicolons or trailing semicolons that should be interpreted as
568 arguments should be escaped twice: once according to the shell conventions and
572 .Bd -literal -offset indent
573 $ tmux neww 'foo\e\e;' bar
574 $ tmux neww foo\e\e\e\e; bar
577 Semicolons that are not individual tokens or trailing another token should only
578 be escaped once according to shell conventions; for example:
579 .Bd -literal -offset indent
580 $ tmux neww 'foo-;-bar'
581 $ tmux neww foo-\e\e;-bar
585 Comments are marked by the unquoted # character - any remaining text after a
586 comment is ignored until the end of the line.
588 If the last character of a line is \e, the line is joined with the following
589 line (the \e and the newline are completely removed).
590 This is called line continuation and applies both inside and outside quoted
591 strings and in comments, but not inside braces.
593 Command arguments may be specified as strings surrounded by single (') quotes,
594 double quotes (") or braces ({}).
596 This is required when the argument contains any special character.
597 Single and double quoted strings cannot span multiple lines except with line
599 Braces can span multiple lines.
601 Outside of quotes and inside double quotes, these replacements are performed:
602 .Bl -dash -offset indent
604 Environment variables preceded by $ are replaced with their value from the
605 global environment (see the
606 .Sx GLOBAL AND SESSION ENVIRONMENT
609 A leading ~ or ~user is expanded to the home directory of the current or
612 \euXXXX or \euXXXXXXXX is replaced by the Unicode codepoint corresponding to
613 the given four or eight digit hexadecimal number.
615 When preceded (escaped) by a \e, the following characters are replaced: \ee by
616 the escape character; \er by a carriage return; \en by a newline; and \et by a
619 \eooo is replaced by a character of the octal value ooo.
620 Three octal digits are required, for example \e001.
621 The largest valid character is \e377.
623 Any other characters preceded by \e are replaced by themselves (that is, the \e
624 is removed) and are not treated as having any special meaning - so for example
625 \e; will not mark a command sequence and \e$ will not expand an environment
629 Braces are parsed as a configuration file (so conditions such as
631 are processed) and then converted into a string.
632 They are designed to avoid the need for additional escaping when passing a
635 commands as an argument (for example to
637 These two examples produce an identical command - note that no escaping is
638 needed when using {}:
639 .Bd -literal -offset indent
641 display -p 'brace-dollar-foo: }$foo'
644 if-shell true "display -p 'brace-dollar-foo: }\e$foo'"
647 Braces may be enclosed inside braces, for example:
648 .Bd -literal -offset indent
649 bind x if-shell "true" {
656 Environment variables may be set by using the syntax
659 .Ql HOME=/home/user .
660 Variables set during parsing are added to the global environment.
661 A hidden variable may be set with
664 .Bd -literal -offset indent
668 Hidden variables are not passed to the environment of processes created
671 .Sx GLOBAL AND SESSION ENVIRONMENT
674 Commands may be parsed conditionally by surrounding them with
684 is expanded as a format (see
686 and if it evaluates to false (zero or empty), subsequent text is ignored until
693 .Bd -literal -offset indent
694 %if "#{==:#{host},myhost}"
695 set -g status-style bg=red
696 %elif "#{==:#{host},myotherhost}"
697 set -g status-style bg=green
699 set -g status-style bg=blue
703 Will change the status line to red if running on
707 or blue if running on another host.
708 Conditionals may be given on one line, for example:
709 .Bd -literal -offset indent
710 %if #{==:#{host},myhost} set -g status-style bg=red %endif
713 This section describes the commands supported by
715 Most commands accept the optional
725 These specify the client, session, window or pane which a command should affect.
728 should be the name of the client,
731 file to which the client is connected, for example either of
735 for the client attached to
737 If no client is specified,
739 attempts to work out the client currently in use; if that fails, an error is
741 Clients may be listed with the
746 is tried as, in order:
749 A session ID prefixed with a $.
751 An exact name of a session (as listed by the
755 The start of a session name, for example
757 would match a session named
762 pattern which is matched against the session name.
765 If the session name is prefixed with an
767 only an exact match is accepted (so
769 will only match exactly
774 If a single session is found, it is used as the target session; multiple matches
776 If a session is omitted, the current session is used if available; if no
777 current session is available, the most recently used is chosen.
784 specifies a window in the form
785 .Em session Ns \&: Ns Em window .
787 follows the same rules as for
791 is looked for in order as:
794 A special token, listed below.
796 A window index, for example
798 is window 1 in session
801 A window ID, such as @1.
803 An exact window name, such as
804 .Ql mysession:mywindow .
806 The start of a window name, such as
807 .Ql mysession:mywin .
811 pattern matched against the window name.
816 prefix will do an exact match only.
817 An empty window name specifies the next unused index if appropriate (for
823 otherwise the current window in
827 The following special tokens are available to indicate particular windows.
828 Each has a single-character alternative form.
829 .Bl -column "XXXXXXXXXX" "X"
830 .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
831 .It Li "{start}" Ta "^" Ta "The lowest-numbered window"
832 .It Li "{end}" Ta "$" Ta "The highest-numbered window"
833 .It Li "{last}" Ta "!" Ta "The last (previously current) window"
834 .It Li "{next}" Ta "+" Ta "The next window by number"
835 .It Li "{previous}" Ta "-" Ta "The previous window by number"
843 may be a pane ID or takes a similar form to
845 but with the optional addition of a period followed by a pane index or pane ID,
847 .Ql mysession:mywindow.1 .
848 If the pane index is omitted, the currently active pane in the specified
850 The following special tokens are available for the pane index:
851 .Bl -column "XXXXXXXXXXXXXX" "X"
852 .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
853 .It Li "{last}" Ta "!" Ta "The last (previously active) pane"
854 .It Li "{next}" Ta "+" Ta "The next pane by number"
855 .It Li "{previous}" Ta "-" Ta "The previous pane by number"
856 .It Li "{top}" Ta "" Ta "The top pane"
857 .It Li "{bottom}" Ta "" Ta "The bottom pane"
858 .It Li "{left}" Ta "" Ta "The leftmost pane"
859 .It Li "{right}" Ta "" Ta "The rightmost pane"
860 .It Li "{top-left}" Ta "" Ta "The top-left pane"
861 .It Li "{top-right}" Ta "" Ta "The top-right pane"
862 .It Li "{bottom-left}" Ta "" Ta "The bottom-left pane"
863 .It Li "{bottom-right}" Ta "" Ta "The bottom-right pane"
864 .It Li "{up-of}" Ta "" Ta "The pane above the active pane"
865 .It Li "{down-of}" Ta "" Ta "The pane below the active pane"
866 .It Li "{left-of}" Ta "" Ta "The pane to the left of the active pane"
867 .It Li "{right-of}" Ta "" Ta "The pane to the right of the active pane"
874 may be followed by an offset, for example:
875 .Bd -literal -offset indent
884 may consist entirely of the token
888 to specify the session, window or pane where the most recent mouse event
896 to specify the marked pane (see
900 Sessions, window and panes are each numbered with a unique ID; session IDs are
907 These are unique and are unchanged for the life of the session, window or pane
911 The pane ID is passed to the child process of the pane in the
913 environment variable.
914 IDs may be displayed using the
922 .Ic display-message ,
933 This may be a single argument passed to the shell, for example:
934 .Bd -literal -offset indent
935 new-window 'vi ~/.tmux.conf'
939 .Bd -literal -offset indent
940 /bin/sh -c 'vi ~/.tmux.conf'
952 to be given as multiple arguments and executed directly (without
954 This can avoid issues with shell quoting.
956 .Bd -literal -offset indent
957 $ tmux new-window vi ~/.tmux.conf
962 directly without invoking the shell.
968 command, either passed with the command and arguments separately, for example:
969 .Bd -literal -offset indent
970 bind-key F1 set-option status off
973 Or passed as a single string argument in
976 .Bd -literal -offset indent
977 bind-key F1 { set-option status off }
983 .Bd -literal -offset indent
984 refresh-client -t/dev/ttyp2
986 rename-session -tfirst newname
988 set-option -wt:0 monitor-activity on
990 new-window ; split-window -d
992 bind-key R source-file ~/.tmux.conf \e; \e
993 display-message "source-file done"
998 .Bd -literal -offset indent
999 $ tmux kill-window -t :1
1001 $ tmux new-window \e; split-window -d
1003 $ tmux new-session -d 'vi ~/.tmux.conf' \e; split-window -d \e; attach
1005 .Sh CLIENTS AND SESSIONS
1008 server manages clients, sessions, windows and panes.
1009 Clients are attached to sessions to interact with them, either
1010 when they are created with the
1012 command, or later with the
1015 Each session has one or more windows
1018 Windows may be linked to multiple sessions and are made up of one or
1020 each of which contains a pseudo terminal.
1021 Commands for creating, linking and otherwise manipulating windows
1024 .Sx WINDOWS AND PANES
1027 The following commands are available to manage clients and sessions:
1030 .It Xo Ic attach-session
1032 .Op Fl c Ar working-directory
1034 .Op Fl t Ar target-session
1036 .D1 Pq alias: Ic attach
1039 create a new client in the current terminal and attach it to
1040 .Ar target-session .
1041 If used from inside, switch the current client.
1044 is specified, any other clients attached to the session are detached.
1049 to the parent process of the client as well as
1050 detaching the client, typically causing it to exit.
1052 sets a comma-separated list of client flags.
1056 the client has an independent active pane
1058 the client does not affect the size of other clients
1060 the client does not receive pane output in control mode
1061 .It pause-after=seconds
1062 output is paused once the pane is
1064 behind in control mode
1066 the client is read-only
1068 wait for an empty line input before exiting in control mode
1073 turns a flag off if the client is already attached.
1077 .Ar read-only,ignore-size .
1078 When a client is read-only, only keys bound to the
1082 commands have any effect.
1085 flag allows the active pane to be selected independently of the window's active
1086 pane used by clients without the flag.
1087 This only affects the cursor position and commands issued from the client;
1088 other features such as hooks and styles continue to use the window's active
1091 If no server is started,
1093 will attempt to start it; this will fail unless sessions are created in the
1100 are slightly adjusted: if
1102 needs to select the most recently used session, it will prefer the most
1108 will set the session working directory (used for new windows) to
1109 .Ar working-directory .
1114 .Ic update-environment
1115 option will not be applied.
1117 .It Xo Ic detach-client
1119 .Op Fl E Ar shell-command
1120 .Op Fl s Ar target-session
1121 .Op Fl t Ar target-client
1123 .D1 Pq alias: Ic detach
1124 Detach the current client if bound to a key, the client specified with
1126 or all clients currently attached to the session specified by
1130 option kills all but the client given with
1136 to the parent process of the client, typically causing it
1142 to replace the client.
1144 .It Ic has-session Op Fl t Ar target-session
1145 .D1 Pq alias: Ic has
1146 Report an error and exit with 1 if the specified session does not exist.
1147 If it does exist, exit with 0.
1151 server and clients and destroy all sessions.
1152 .It Xo Ic kill-session
1154 .Op Fl t Ar target-session
1156 Destroy the given session, closing any windows linked to it and no other
1157 sessions, and detaching all clients attached to it.
1160 is given, all sessions but the specified one is killed.
1163 flag clears alerts (bell, activity, or silence) in all windows linked to the
1166 .It Xo Ic list-clients
1169 .Op Fl t Ar target-session
1171 .D1 Pq alias: Ic lsc
1172 List all clients attached to the server.
1174 specifies the format of each line and
1177 Only clients for which the filter is true are shown.
1183 is specified, list only clients connected to that session.
1185 .It Xo Ic list-commands
1189 .D1 Pq alias: Ic lscm
1192 or - if omitted - of all commands supported by
1195 .It Xo Ic list-sessions
1200 List all sessions managed by the server.
1202 specifies the format of each line and
1205 Only sessions for which the filter is true are shown.
1210 .It Ic lock-client Op Fl t Ar target-client
1211 .D1 Pq alias: Ic lockc
1218 .It Ic lock-session Op Fl t Ar target-session
1219 .D1 Pq alias: Ic locks
1220 Lock all clients attached to
1221 .Ar target-session .
1223 .It Xo Ic new-session
1225 .Op Fl c Ar start-directory
1226 .Op Fl e Ar environment
1229 .Op Fl n Ar window-name
1230 .Op Fl s Ar session-name
1231 .Op Fl t Ar group-name
1234 .Op Ar shell-command
1236 .D1 Pq alias: Ic new
1237 Create a new session with name
1240 The new session is attached to the current terminal unless
1246 are the name of and shell command to execute in the initial window.
1249 the initial size comes from the global
1255 can be used to specify a different size.
1257 uses the size of the current client if any.
1264 option is set for the session.
1266 sets a comma-separated list of client flags (see
1267 .Ic attach-session ) .
1269 If run from a terminal, any
1271 special characters are saved and used for new windows in the new session.
1289 .Ic attach-session ,
1295 .Ic attach-session .
1299 is given, it specifies a
1301 Sessions in the same group share the same set of windows - new windows are
1302 linked to all sessions in the group and any windows closed removed from all
1304 The current and previous window and any session options remain independent and
1305 any session in a group may be killed without affecting the others.
1311 the name of an existing group, in which case the new session is added to that
1314 the name of an existing session - the new session is added to the same group
1315 as that session, creating a new group if necessary;
1317 the name for a new group containing only the new session.
1329 option prints information about the new session after it has been created.
1330 By default, it uses the format
1331 .Ql #{session_name}:\&
1332 but a different format may be specified with
1338 .Ic update-environment
1339 option will not be applied.
1343 and sets an environment variable for the newly created session; it may be
1344 specified multiple times.
1346 .It Xo Ic refresh-client
1348 .Op Fl A Ar pane:state
1349 .Op Fl B Ar name:what:format
1352 .Op Fl l Op Ar target-pane
1353 .Op Fl t Ar target-client
1356 .D1 Pq alias: Ic refresh
1357 Refresh the current client if bound to a key, or a single client if one is given
1362 is specified, only update the client's status line.
1371 flags allow the visible portion of a window which is larger than the client
1374 moves the visible part up by
1386 returns to tracking the cursor automatically.
1389 is omitted, 1 is used.
1390 Note that the visible position is a property of the client not of the
1391 window, changing the current window in the attached session will reset
1395 sets the width and height of a control mode client or of a window for a
1396 control mode client,
1401 .Ql window ID:widthxheight ,
1407 allows a control mode client to trigger actions on a pane.
1408 The argument is a pane ID (with leading
1410 a colon, then one of
1419 will not send output from the pane to the client and if all clients have turned
1420 the pane off, will stop reading from the pane.
1424 will return to sending output to the pane if it was paused (manually or with the
1430 will pause the pane.
1432 may be given multiple times for different panes.
1435 sets a subscription to a format for a control mode client.
1436 The argument is split into three items by colons:
1438 is a name for the subscription;
1440 is a type of item to subscribe to;
1443 After a subscription is added, changes to the format are reported with the
1444 .Ic %subscription-changed
1445 notification, at most once a second.
1446 If only the name is given, the subscription is removed.
1448 may be empty to check the format only for the attached session, or one of:
1452 for all panes in the attached session;
1457 for all windows in the attached session.
1460 sets a comma-separated list of client flags, see
1461 .Ic attach-session .
1464 requests the clipboard from the client using the
1469 is given, the clipboard is sent (in encoded form), otherwise it is stored in a
1477 move the visible portion of the window left, right, up or down
1480 if the window is larger than the client.
1482 resets so that the position follows the cursor.
1487 .It Xo Ic rename-session
1488 .Op Fl t Ar target-session
1491 .D1 Pq alias: Ic rename
1492 Rename the session to
1494 .It Xo Ic server-access
1498 Change the access or read/write permission of
1500 The user running the
1502 server (its owner) and the root user cannot be changed and are always
1508 are used to give or revoke access for the specified user.
1509 If the user is already attached, the
1511 flag causes their clients to be detached.
1516 change the permissions for
1519 makes their clients read-only and
1523 lists current access permissions.
1525 By default, the access list is empty and
1527 creates sockets with file system permissions preventing access by any user
1528 other than the owner (and root).
1529 These permissions must be changed manually.
1530 Great care should be taken not to allow access to untrusted users even
1533 .It Xo Ic show-messages
1535 .Op Fl t Ar target-client
1537 .D1 Pq alias: Ic showmsgs
1538 Show server messages or information.
1539 Messages are stored, up to a maximum of the limit set by the
1545 show debugging information about jobs and terminals.
1547 .It Xo Ic source-file
1551 .D1 Pq alias: Ic source
1552 Execute commands from one or more files specified by
1561 is expanded as a format.
1564 is given, no error will be returned if
1569 the file is parsed but no commands are executed.
1571 shows the parsed commands and line numbers if possible.
1574 .D1 Pq alias: Ic start
1577 server, if not already running, without creating any sessions.
1579 Note that as by default the
1581 server will exit with no sessions, this is only useful if a session is created
1585 is turned off, or another command is run as part of the same command sequence.
1587 .Bd -literal -offset indent
1588 $ tmux start \\; show -g
1591 .It Xo Ic suspend-client
1592 .Op Fl t Ar target-client
1594 .D1 Pq alias: Ic suspendc
1595 Suspend a client by sending
1599 .It Xo Ic switch-client
1601 .Op Fl c Ar target-client
1602 .Op Fl t Ar target-session
1603 .Op Fl T Ar key-table
1605 .D1 Pq alias: Ic switchc
1606 Switch the current session for client
1609 .Ar target-session .
1612 may refer to a pane (a target that contains
1617 to change session, window and pane.
1620 keeps the window zoomed if it was zoomed.
1626 is used, the client is moved to the last, next or previous session
1640 .Ic update-environment
1641 option will not be applied.
1644 sets the client's key table; the next key from the client will be interpreted
1647 This may be used to configure multiple prefix keys, or to bind commands to
1649 For example, to make typing
1654 .Bd -literal -offset indent
1655 bind-key -Ttable2 c list-keys
1656 bind-key -Ttable1 b switch-client -Ttable2
1657 bind-key -Troot a switch-client -Ttable1
1660 .Sh WINDOWS AND PANES
1661 Each window displayed by
1663 may be split into one or more
1665 each pane takes up a certain area of the display and is a separate terminal.
1666 A window may be split into panes using the
1669 Windows may be split horizontally (with the
1671 flag) or vertically.
1672 Panes may be resized with the
1680 by default), the current pane may be changed with the
1686 commands may be used to swap panes without changing their position.
1687 Panes are numbered beginning from zero in the order they are created.
1691 pane permits direct access to the terminal contained in the pane.
1692 A pane may also be put into one of several modes:
1693 .Bl -dash -offset indent
1695 Copy mode, which permits a section of a window or its
1696 history to be copied to a
1698 for later insertion into another window.
1699 This mode is entered with the
1704 Copied text can be pasted with the
1709 View mode, which is like copy mode but is entered when a command that produces
1712 is executed from a key binding.
1714 Choose mode, which allows an item to be chosen from a list.
1715 This may be a client, a session or window or pane, or a buffer.
1716 This mode is entered with the
1724 In copy mode an indicator is displayed in the top-right corner of the pane with
1725 the current position and the number of lines in the history.
1727 Commands are sent to copy mode using the
1732 When a key is pressed, copy mode automatically uses one of two key tables,
1740 Key tables may be viewed with the
1744 The following commands are supported in copy mode:
1745 .Bl -column "CommandXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXXXXXXXX" "emacs" -offset indent
1746 .It Sy "Command" Ta Sy "vi" Ta Sy "emacs"
1747 .It Li "append-selection" Ta "" Ta ""
1748 .It Li "append-selection-and-cancel" Ta "A" Ta ""
1749 .It Li "back-to-indentation" Ta "^" Ta "M-m"
1750 .It Li "begin-selection" Ta "Space" Ta "C-Space"
1751 .It Li "bottom-line" Ta "L" Ta ""
1752 .It Li "cancel" Ta "q" Ta "Escape"
1753 .It Li "clear-selection" Ta "Escape" Ta "C-g"
1754 .It Li "copy-end-of-line [<prefix>]" Ta "" Ta ""
1755 .It Li "copy-end-of-line-and-cancel [<prefix>]" Ta "" Ta ""
1756 .It Li "copy-pipe-end-of-line [<command>] [<prefix>]" Ta "" Ta ""
1757 .It Li "copy-pipe-end-of-line-and-cancel [<command>] [<prefix>]" Ta "D" Ta "C-k"
1758 .It Li "copy-line [<prefix>]" Ta "" Ta ""
1759 .It Li "copy-line-and-cancel [<prefix>]" Ta "" Ta ""
1760 .It Li "copy-pipe-line [<command>] [<prefix>]" Ta "" Ta ""
1761 .It Li "copy-pipe-line-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1762 .It Li "copy-pipe [<command>] [<prefix>]" Ta "" Ta ""
1763 .It Li "copy-pipe-no-clear [<command>] [<prefix>]" Ta "" Ta ""
1764 .It Li "copy-pipe-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1765 .It Li "copy-selection [<prefix>]" Ta "" Ta ""
1766 .It Li "copy-selection-no-clear [<prefix>]" Ta "" Ta ""
1767 .It Li "copy-selection-and-cancel [<prefix>]" Ta "Enter" Ta "M-w"
1768 .It Li "cursor-down" Ta "j" Ta "Down"
1769 .It Li "cursor-down-and-cancel" Ta "" Ta ""
1770 .It Li "cursor-left" Ta "h" Ta "Left"
1771 .It Li "cursor-right" Ta "l" Ta "Right"
1772 .It Li "cursor-up" Ta "k" Ta "Up"
1773 .It Li "end-of-line" Ta "$" Ta "C-e"
1774 .It Li "goto-line <line>" Ta ":" Ta "g"
1775 .It Li "halfpage-down" Ta "C-d" Ta "M-Down"
1776 .It Li "halfpage-down-and-cancel" Ta "" Ta ""
1777 .It Li "halfpage-up" Ta "C-u" Ta "M-Up"
1778 .It Li "history-bottom" Ta "G" Ta "M->"
1779 .It Li "history-top" Ta "g" Ta "M-<"
1780 .It Li "jump-again" Ta ";" Ta ";"
1781 .It Li "jump-backward <to>" Ta "F" Ta "F"
1782 .It Li "jump-forward <to>" Ta "f" Ta "f"
1783 .It Li "jump-reverse" Ta "," Ta ","
1784 .It Li "jump-to-backward <to>" Ta "T" Ta ""
1785 .It Li "jump-to-forward <to>" Ta "t" Ta ""
1786 .It Li "jump-to-mark" Ta "M-x" Ta "M-x"
1787 .It Li "middle-line" Ta "M" Ta "M-r"
1788 .It Li "next-matching-bracket" Ta "%" Ta "M-C-f"
1789 .It Li "next-paragraph" Ta "}" Ta "M-}"
1790 .It Li "next-space" Ta "W" Ta ""
1791 .It Li "next-space-end" Ta "E" Ta ""
1792 .It Li "next-word" Ta "w" Ta ""
1793 .It Li "next-word-end" Ta "e" Ta "M-f"
1794 .It Li "other-end" Ta "o" Ta ""
1795 .It Li "page-down" Ta "C-f" Ta "PageDown"
1796 .It Li "page-down-and-cancel" Ta "" Ta ""
1797 .It Li "page-up" Ta "C-b" Ta "PageUp"
1798 .It Li "pipe [<command>] [<prefix>]" Ta "" Ta ""
1799 .It Li "pipe-no-clear [<command>] [<prefix>]" Ta "" Ta ""
1800 .It Li "pipe-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1801 .It Li "previous-matching-bracket" Ta "" Ta "M-C-b"
1802 .It Li "previous-paragraph" Ta "{" Ta "M-{"
1803 .It Li "previous-space" Ta "B" Ta ""
1804 .It Li "previous-word" Ta "b" Ta "M-b"
1805 .It Li "rectangle-on" Ta "" Ta ""
1806 .It Li "rectangle-off" Ta "" Ta ""
1807 .It Li "rectangle-toggle" Ta "v" Ta "R"
1808 .It Li "refresh-from-pane" Ta "r" Ta "r"
1809 .It Li "scroll-down" Ta "C-e" Ta "C-Down"
1810 .It Li "scroll-down-and-cancel" Ta "" Ta ""
1811 .It Li "scroll-up" Ta "C-y" Ta "C-Up"
1812 .It Li "search-again" Ta "n" Ta "n"
1813 .It Li "search-backward <for>" Ta "?" Ta ""
1814 .It Li "search-backward-incremental <for>" Ta "" Ta "C-r"
1815 .It Li "search-backward-text <for>" Ta "" Ta ""
1816 .It Li "search-forward <for>" Ta "/" Ta ""
1817 .It Li "search-forward-incremental <for>" Ta "" Ta "C-s"
1818 .It Li "search-forward-text <for>" Ta "" Ta ""
1819 .It Li "scroll-bottom" Ta "" Ta ""
1820 .It Li "scroll-middle" Ta "z" Ta ""
1821 .It Li "scroll-top" Ta "" Ta ""
1822 .It Li "search-reverse" Ta "N" Ta "N"
1823 .It Li "select-line" Ta "V" Ta ""
1824 .It Li "select-word" Ta "" Ta ""
1825 .It Li "set-mark" Ta "X" Ta "X"
1826 .It Li "start-of-line" Ta "0" Ta "C-a"
1827 .It Li "stop-selection" Ta "" Ta ""
1828 .It Li "toggle-position" Ta "P" Ta "P"
1829 .It Li "top-line" Ta "H" Ta "M-R"
1832 The search commands come in several varieties:
1836 search for a regular expression;
1839 variants search for a plain text string rather than a regular expression;
1841 perform an incremental search and expect to be used with the
1847 repeats the last search and
1849 does the same but reverses the direction (forward becomes backward and backward
1852 Copy commands may take an optional buffer prefix argument which is used
1853 to generate the buffer name (the default is
1855 so buffers are named
1859 Pipe commands take a command argument which is the command to which the
1860 selected text is piped.
1862 variants also copy the selection.
1865 variants of some commands exit copy mode after they have completed (for copy
1866 commands) or when the cursor reaches the bottom (for scrolling commands).
1868 variants do not clear the selection.
1870 The next and previous word keys skip over whitespace and treat consecutive
1871 runs of either word separators or other letters as words.
1872 Word separators can be customized with the
1875 Next word moves to the start of the next word, next word end to the end of the
1876 next word and previous word to the start of the previous word.
1877 The three next and previous space keys work similarly but use a space alone as
1881 to the empty string makes next/previous word equivalent to next/previous space.
1883 The jump commands enable quick movement within a line.
1884 For instance, typing
1888 will move the cursor to the next
1890 character on the current line.
1893 will then jump to the next occurrence.
1895 Commands in copy mode may be prefaced by an optional repeat count.
1896 With vi key bindings, a prefix is entered using the number keys; with
1897 emacs, the Alt (meta) key and a number begins prefix entry.
1899 The synopsis for the
1905 .Op Fl s Ar src-pane
1906 .Op Fl t Ar target-pane
1911 option scrolls one page up.
1913 begins a mouse drag (only valid if bound to a mouse key binding, see
1914 .Sx MOUSE SUPPORT ) .
1916 hides the position indicator in the top right.
1918 cancels copy mode and any other modes.
1926 specifies that scrolling to the bottom of the history (to the visible screen)
1927 should exit copy mode.
1928 While in copy mode, pressing a key other than those used for scrolling will
1929 disable this behaviour.
1930 This is intended to allow fast scrolling through a pane's history, for
1932 .Bd -literal -offset indent
1933 bind PageUp copy-mode -eu
1937 A number of preset arrangements of panes are available, these are called
1939 These may be selected with the
1941 command or cycled with
1945 by default); once a layout is chosen, panes within it may be moved and resized
1948 The following layouts are supported:
1950 .It Ic even-horizontal
1951 Panes are spread out evenly from left to right across the window.
1952 .It Ic even-vertical
1953 Panes are spread evenly from top to bottom.
1954 .It Ic main-horizontal
1955 A large (main) pane is shown at the top of the window and the remaining panes
1956 are spread from left to right in the leftover space at the bottom.
1958 .Em main-pane-height
1959 window option to specify the height of the top pane.
1960 .It Ic main-vertical
1963 but the large pane is placed on the left and the others spread from top to
1964 bottom along the right.
1969 Panes are spread out as evenly as possible over the window in both rows and
1975 may be used to apply a previously used layout - the
1977 command displays the layout of each window in a form suitable for use with
1980 .Bd -literal -offset indent
1983 layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1984 $ tmux select-layout 'bb62,159x48,0,0{79x48,0,0,79x48,80,0}'
1988 automatically adjusts the size of the layout for the current window size.
1989 Note that a layout cannot be applied to a window with more panes than that
1990 from which the layout was originally defined.
1992 Commands related to windows and panes are as follows:
1995 .It Xo Ic break-pane
1998 .Op Fl n Ar window-name
1999 .Op Fl s Ar src-pane
2000 .Op Fl t Ar dst-window
2002 .D1 Pq alias: Ic breakp
2005 off from its containing window to make it the only pane in
2011 the window is moved to the next index after or before (existing windows are
2012 moved if necessary).
2015 is given, the new window does not become the current window.
2018 option prints information about the new window after it has been created.
2019 By default, it uses the format
2020 .Ql #{session_name}:#{window_index}.#{pane_index}
2021 but a different format may be specified with
2024 .It Xo Ic capture-pane
2026 .Op Fl b Ar buffer-name
2027 .Op Fl E Ar end-line
2028 .Op Fl S Ar start-line
2029 .Op Fl t Ar target-pane
2031 .D1 Pq alias: Ic capturep
2032 Capture the contents of a pane.
2035 is given, the output goes to stdout, otherwise to the buffer specified with
2037 or a new buffer if omitted.
2040 is given, the alternate screen is used, and the history is not accessible.
2041 If no alternate screen exists, an error will be returned unless
2046 is given, the output includes escape sequences for text and background
2049 also escapes non-printable characters as octal \exxx.
2051 ignores trailing positions that do not contain a character.
2053 preserves trailing spaces at each line's end and
2055 preserves trailing spaces and joins any wrapped lines;
2060 captures only any output that the pane has received that is the beginning of an
2061 as-yet incomplete escape sequence.
2066 specify the starting and ending line numbers, zero is the first line of the
2067 visible pane and negative numbers are lines in the history.
2071 is the start of the history and to
2073 the end of the visible pane.
2074 The default is to capture only the visible contents of the pane.
2080 .Op Fl K Ar key-format
2081 .Op Fl O Ar sort-order
2082 .Op Fl t Ar target-pane
2085 Put a pane into client mode, allowing a client to be selected interactively from
2087 Each client is shown on one line.
2088 A shortcut key is shown on the left in brackets allowing for immediate choice,
2089 or the list may be navigated and an item chosen or otherwise manipulated using
2093 The following keys may be used in client mode:
2094 .Bl -column "Key" "Function" -offset indent
2095 .It Sy "Key" Ta Sy "Function"
2096 .It Li "Enter" Ta "Choose selected client"
2097 .It Li "Up" Ta "Select previous client"
2098 .It Li "Down" Ta "Select next client"
2099 .It Li "C-s" Ta "Search by name"
2100 .It Li "n" Ta "Repeat last search"
2101 .It Li "t" Ta "Toggle if client is tagged"
2102 .It Li "T" Ta "Tag no clients"
2103 .It Li "C-t" Ta "Tag all clients"
2104 .It Li "d" Ta "Detach selected client"
2105 .It Li "D" Ta "Detach tagged clients"
2106 .It Li "x" Ta "Detach and HUP selected client"
2107 .It Li "X" Ta "Detach and HUP tagged clients"
2108 .It Li "z" Ta "Suspend selected client"
2109 .It Li "Z" Ta "Suspend tagged clients"
2110 .It Li "f" Ta "Enter a format to filter items"
2111 .It Li "O" Ta "Change sort field"
2112 .It Li "r" Ta "Reverse sort order"
2113 .It Li "v" Ta "Toggle preview"
2114 .It Li "q" Ta "Exit mode"
2117 After a client is chosen,
2119 is replaced by the client name in
2121 and the result executed as a command.
2124 is not given, "detach-client -t '%%'" is used.
2127 specifies the initial sort field: one of
2136 reverses the sort order.
2138 specifies an initial filter: the filter is a format - if it evaluates to zero,
2139 the item in the list is not shown, otherwise it is shown.
2140 If a filter would lead to an empty list, it is ignored.
2142 specifies the format for each item in the list and
2144 a format for each shortcut key; both are evaluated once for each line.
2146 starts without the preview.
2147 This command works only if at least one client is attached.
2153 .Op Fl K Ar key-format
2154 .Op Fl O Ar sort-order
2155 .Op Fl t Ar target-pane
2158 Put a pane into tree mode, where a session, window or pane may be chosen
2159 interactively from a tree.
2160 Each session, window or pane is shown on one line.
2161 A shortcut key is shown on the left in brackets allowing for immediate choice,
2162 or the tree may be navigated and an item chosen or otherwise manipulated using
2165 starts with sessions collapsed and
2167 with windows collapsed.
2170 The following keys may be used in tree mode:
2171 .Bl -column "Key" "Function" -offset indent
2172 .It Sy "Key" Ta Sy "Function"
2173 .It Li "Enter" Ta "Choose selected item"
2174 .It Li "Up" Ta "Select previous item"
2175 .It Li "Down" Ta "Select next item"
2176 .It Li "+" Ta "Expand selected item"
2177 .It Li "-" Ta "Collapse selected item"
2178 .It Li "M-+" Ta "Expand all items"
2179 .It Li "M--" Ta "Collapse all items"
2180 .It Li "x" Ta "Kill selected item"
2181 .It Li "X" Ta "Kill tagged items"
2182 .It Li "<" Ta "Scroll list of previews left"
2183 .It Li ">" Ta "Scroll list of previews right"
2184 .It Li "C-s" Ta "Search by name"
2185 .It Li "m" Ta "Set the marked pane"
2186 .It Li "M" Ta "Clear the marked pane"
2187 .It Li "n" Ta "Repeat last search"
2188 .It Li "t" Ta "Toggle if item is tagged"
2189 .It Li "T" Ta "Tag no items"
2190 .It Li "C-t" Ta "Tag all items"
2191 .It Li "\&:" Ta "Run a command for each tagged item"
2192 .It Li "f" Ta "Enter a format to filter items"
2193 .It Li "H" Ta "Jump to the starting pane"
2194 .It Li "O" Ta "Change sort field"
2195 .It Li "r" Ta "Reverse sort order"
2196 .It Li "v" Ta "Toggle preview"
2197 .It Li "q" Ta "Exit mode"
2200 After a session, window or pane is chosen, the first instance of
2202 and all instances of
2204 are replaced by the target in
2206 and the result executed as a command.
2209 is not given, "switch-client -t '%%'" is used.
2212 specifies the initial sort field: one of
2219 reverses the sort order.
2221 specifies an initial filter: the filter is a format - if it evaluates to zero,
2222 the item in the list is not shown, otherwise it is shown.
2223 If a filter would lead to an empty list, it is ignored.
2225 specifies the format for each item in the tree and
2227 a format for each shortcut key; both are evaluated once for each line.
2229 starts without the preview.
2231 includes all sessions in any session groups in the tree rather than only the
2233 This command works only if at least one client is attached.
2239 .Op Fl t Ar target-pane
2242 Put a pane into customize mode, where options and key bindings may be browsed
2243 and modified from a list.
2244 Option values in the list are shown for the active pane in the current window.
2247 The following keys may be used in customize mode:
2248 .Bl -column "Key" "Function" -offset indent
2249 .It Sy "Key" Ta Sy "Function"
2250 .It Li "Enter" Ta "Set pane, window, session or global option value"
2251 .It Li "Up" Ta "Select previous item"
2252 .It Li "Down" Ta "Select next item"
2253 .It Li "+" Ta "Expand selected item"
2254 .It Li "-" Ta "Collapse selected item"
2255 .It Li "M-+" Ta "Expand all items"
2256 .It Li "M--" Ta "Collapse all items"
2257 .It Li "s" Ta "Set option value or key attribute"
2258 .It Li "S" Ta "Set global option value"
2259 .It Li "w" Ta "Set window option value, if option is for pane and window"
2260 .It Li "d" Ta "Set an option or key to the default"
2261 .It Li "D" Ta "Set tagged options and tagged keys to the default"
2262 .It Li "u" Ta "Unset an option (set to default value if global) or unbind a key"
2263 .It Li "U" Ta "Unset tagged options and unbind tagged keys"
2264 .It Li "C-s" Ta "Search by name"
2265 .It Li "n" Ta "Repeat last search"
2266 .It Li "t" Ta "Toggle if item is tagged"
2267 .It Li "T" Ta "Tag no items"
2268 .It Li "C-t" Ta "Tag all items"
2269 .It Li "f" Ta "Enter a format to filter items"
2270 .It Li "v" Ta "Toggle option information"
2271 .It Li "q" Ta "Exit mode"
2275 specifies an initial filter: the filter is a format - if it evaluates to zero,
2276 the item in the list is not shown, otherwise it is shown.
2277 If a filter would lead to an empty list, it is ignored.
2279 specifies the format for each item in the tree.
2281 starts without the option information.
2282 This command works only if at least one client is attached.
2287 .Op Fl d Ar duration
2288 .Op Fl t Ar target-client
2291 .D1 Pq alias: Ic displayp
2292 Display a visible indicator of each pane shown by
2295 .Ic display-panes-colour
2297 .Ic display-panes-active-colour
2299 The indicator is closed when a key is pressed (unless
2303 milliseconds have passed.
2307 .Ic display-panes-time
2309 A duration of zero means the indicator stays until a key is pressed.
2310 While the indicator is on screen, a pane may be chosen with the
2314 keys, which will cause
2316 to be executed as a command with
2318 substituted by the pane ID.
2321 is "select-pane -t '%%'".
2324 other commands are not blocked from running until the indicator is closed.
2326 .It Xo Ic find-window
2328 .Op Fl t Ar target-pane
2331 .D1 Pq alias: Ic findw
2338 in window names, titles, and visible content (but not history).
2339 The flags control matching behavior:
2341 matches only visible window contents,
2343 matches only the window name and
2345 matches only the window title.
2347 makes the search ignore case.
2353 This command works only if at least one client is attached.
2358 .Op Fl s Ar src-pane
2359 .Op Fl t Ar dst-pane
2361 .D1 Pq alias: Ic joinp
2364 but instead of splitting
2366 and creating a new pane, split it and move
2369 This can be used to reverse
2375 to be joined to left of or above
2380 is omitted and a marked pane is present (see
2383 the marked pane is used rather than the current pane.
2387 .Op Fl t Ar target-pane
2389 .D1 Pq alias: Ic killp
2390 Destroy the given pane.
2391 If no panes remain in the containing window, it is also destroyed.
2394 option kills all but the pane given with
2397 .It Xo Ic kill-window
2399 .Op Fl t Ar target-window
2401 .D1 Pq alias: Ic killw
2402 Kill the current window or the window at
2404 removing it from any sessions to which it is linked.
2407 option kills all but the window given with
2412 .Op Fl t Ar target-window
2414 .D1 Pq alias: Ic lastp
2415 Select the last (previously selected) pane.
2417 keeps the window zoomed if it was zoomed.
2421 disables input to the pane.
2423 .It Ic last-window Op Fl t Ar target-session
2424 .D1 Pq alias: Ic last
2425 Select the last (previously selected) window.
2428 is specified, select the last window of the current session.
2430 .It Xo Ic link-window
2432 .Op Fl s Ar src-window
2433 .Op Fl t Ar dst-window
2435 .D1 Pq alias: Ic linkw
2442 is specified and no such window exists, the
2449 the window is moved to the next index after or before
2451 (existing windows are moved if necessary).
2456 exists, it is killed, otherwise an error is generated.
2459 is given, the newly linked window is not selected.
2461 .It Xo Ic list-panes
2467 .D1 Pq alias: Ic lsp
2472 is ignored and all panes on the server are listed.
2477 is a session (or the current session).
2478 If neither is given,
2480 is a window (or the current window).
2482 specifies the format of each line and
2485 Only panes for which the filter is true are shown.
2490 .It Xo Ic list-windows
2494 .Op Fl t Ar target-session
2496 .D1 Pq alias: Ic lsw
2499 is given, list all windows on the server.
2500 Otherwise, list windows in the current session or in
2501 .Ar target-session .
2503 specifies the format of each line and
2506 Only windows for which the filter is true are shown.
2514 .Op Fl s Ar src-pane
2515 .Op Fl t Ar dst-pane
2517 .D1 Pq alias: Ic movep
2521 .It Xo Ic move-window
2523 .Op Fl s Ar src-window
2524 .Op Fl t Ar dst-window
2526 .D1 Pq alias: Ic movew
2529 except the window at
2535 all windows in the session are renumbered in sequential order, respecting
2540 .It Xo Ic new-window
2542 .Op Fl c Ar start-directory
2543 .Op Fl e Ar environment
2545 .Op Fl n Ar window-name
2546 .Op Fl t Ar target-window
2547 .Op Ar shell-command
2549 .D1 Pq alias: Ic neww
2550 Create a new window.
2555 the new window is inserted at the next index after or before the specified
2557 moving windows up if necessary;
2560 is the new window location.
2564 is given, the session does not make the new window the current window.
2566 represents the window to be created; if the target already exists an error is
2569 flag is used, in which case it is destroyed.
2572 is given and a window named
2574 already exists, it is selected (unless
2576 is also given in which case the command does nothing).
2579 is the command to execute.
2582 is not specified, the value of the
2586 specifies the working directory in which the new window is created.
2588 When the shell command completes, the window closes.
2591 option to change this behaviour.
2596 and sets an environment variable for the newly created window; it may be
2597 specified multiple times.
2601 environment variable must be set to
2605 for all programs running
2608 New windows will automatically have
2610 added to their environment, but care must be taken not to reset this in shell
2611 start-up files or by the
2617 option prints information about the new window after it has been created.
2618 By default, it uses the format
2619 .Ql #{session_name}:#{window_index}
2620 but a different format may be specified with
2623 .It Ic next-layout Op Fl t Ar target-window
2624 .D1 Pq alias: Ic nextl
2625 Move a window to the next layout and rearrange the panes to fit.
2627 .It Xo Ic next-window
2629 .Op Fl t Ar target-session
2631 .D1 Pq alias: Ic next
2632 Move to the next window in the session.
2635 is used, move to the next window with an alert.
2639 .Op Fl t Ar target-pane
2640 .Op Ar shell-command
2642 .D1 Pq alias: Ic pipep
2643 Pipe output sent by the program in
2645 to a shell command or vice versa.
2646 A pane may only be connected to one command at a time, any existing pipe is
2652 string may contain the special character sequences supported by the
2657 is given, the current pipe (if any) is closed.
2662 specify which of the
2664 output streams are connected to the pane:
2667 stdout is connected (so anything
2669 prints is written to the pane as if it were typed);
2672 stdin is connected (so any output in the pane is piped to
2673 .Ar shell-command ) .
2674 Both may be used together and if neither are specified,
2680 option only opens a new pipe if no previous pipe exists, allowing a pipe to
2681 be toggled with a single key, for example:
2682 .Bd -literal -offset indent
2683 bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
2686 .It Xo Ic previous-layout
2687 .Op Fl t Ar target-window
2689 .D1 Pq alias: Ic prevl
2690 Move to the previous layout in the session.
2692 .It Xo Ic previous-window
2694 .Op Fl t Ar target-session
2696 .D1 Pq alias: Ic prev
2697 Move to the previous window in the session.
2700 move to the previous window with an alert.
2702 .It Xo Ic rename-window
2703 .Op Fl t Ar target-window
2706 .D1 Pq alias: Ic renamew
2707 Rename the current window, or the window at
2712 .It Xo Ic resize-pane
2714 .Op Fl t Ar target-pane
2719 .D1 Pq alias: Ic resizep
2720 Resize a pane, up, down, left or right by
2736 is given in lines or columns (the default is 1);
2740 may be a given as a number of lines or columns or followed by
2742 for a percentage of the window size (for example
2746 the active pane is toggled between zoomed (occupying the whole of the window)
2747 and unzoomed (its normal position in the layout).
2750 begins mouse resizing (only valid if bound to a mouse key binding, see
2751 .Sx MOUSE SUPPORT ) .
2754 trims all lines below the current cursor position and moves lines out of the
2755 history to replace them.
2757 .It Xo Ic resize-window
2759 .Op Fl t Ar target-window
2764 .D1 Pq alias: Ic resizew
2765 Resize a window, up, down, left or right by
2781 is given in lines or cells (the default is 1).
2783 sets the size of the largest session containing the window;
2785 the size of the smallest.
2786 This command will automatically set
2788 to manual in the window options.
2790 .It Xo Ic respawn-pane
2792 .Op Fl c Ar start-directory
2793 .Op Fl e Ar environment
2794 .Op Fl t Ar target-pane
2795 .Op Ar shell-command
2797 .D1 Pq alias: Ic respawnp
2798 Reactivate a pane in which the command has exited (see the
2803 is not given, the command used when the pane was created or last respawned is
2805 The pane must be already inactive, unless
2807 is given, in which case any existing command is killed.
2809 specifies a new working directory for the pane.
2812 option has the same meaning as for the
2816 .It Xo Ic respawn-window
2818 .Op Fl c Ar start-directory
2819 .Op Fl e Ar environment
2820 .Op Fl t Ar target-window
2821 .Op Ar shell-command
2823 .D1 Pq alias: Ic respawnw
2824 Reactivate a window in which the command has exited (see the
2829 is not given, the command used when the window was created or last respawned is
2831 The window must be already inactive, unless
2833 is given, in which case any existing command is killed.
2835 specifies a new working directory for the window.
2838 option has the same meaning as for the
2842 .It Xo Ic rotate-window
2844 .Op Fl t Ar target-window
2846 .D1 Pq alias: Ic rotatew
2847 Rotate the positions of the panes within a window, either upward (numerically
2850 or downward (numerically higher).
2852 keeps the window zoomed if it was zoomed.
2854 .It Xo Ic select-layout
2856 .Op Fl t Ar target-pane
2859 .D1 Pq alias: Ic selectl
2860 Choose a specific layout for a window.
2863 is not given, the last preset layout used (if any) is reapplied.
2867 are equivalent to the
2873 applies the last set layout if possible (undoes the most recent layout change).
2875 spreads the current pane and any panes next to it out evenly.
2877 .It Xo Ic select-pane
2880 .Op Fl t Ar target-pane
2882 .D1 Pq alias: Ic selectp
2885 the active pane in its window.
2892 is used, respectively the pane below, to the left, to the right, or above the
2893 target pane is used.
2895 keeps the window zoomed if it was zoomed.
2897 is the same as using the
2903 disables input to the pane.
2905 sets the pane title.
2910 are used to set and clear the
2912 There is one marked pane at a time, setting a new marked pane clears the last.
2913 The marked pane is the default target for
2922 .It Xo Ic select-window
2924 .Op Fl t Ar target-window
2926 .D1 Pq alias: Ic selectw
2927 Select the window at
2933 are equivalent to the
2941 is given and the selected window is already the current window,
2942 the command behaves like
2945 .It Xo Ic split-window
2947 .Op Fl c Ar start-directory
2948 .Op Fl e Ar environment
2950 .Op Fl t Ar target-pane
2951 .Op Ar shell-command
2954 .D1 Pq alias: Ic splitw
2955 Create a new pane by splitting
2958 does a horizontal split and
2960 a vertical split; if neither is specified,
2965 option specifies the size of the new pane in lines (for vertical split) or in
2966 columns (for horizontal split);
2970 to specify a percentage of the available space.
2973 option causes the new pane to be created to the left of or above
2977 option creates a new pane spanning the full window height (with
2979 or full window width (with
2981 instead of splitting the active pane.
2983 zooms if the window is not zoomed, or keeps it zoomed if already zoomed.
2987 ('') will create a pane with no command running in it.
2988 Output can be sent to such a pane with the
2995 is not specified or empty)
2996 will create an empty pane and forward any output from stdin to it.
2998 .Bd -literal -offset indent
2999 $ make 2>&1|tmux splitw -dI &
3002 All other options have the same meaning as for the
3008 .Op Fl s Ar src-pane
3009 .Op Fl t Ar dst-pane
3011 .D1 Pq alias: Ic swapp
3015 is used and no source pane is specified with
3018 is swapped with the previous pane (before it numerically);
3020 swaps with the next pane (after it numerically).
3024 not to change the active pane and
3026 keeps the window zoomed if it was zoomed.
3030 is omitted and a marked pane is present (see
3033 the marked pane is used rather than the current pane.
3035 .It Xo Ic swap-window
3037 .Op Fl s Ar src-window
3038 .Op Fl t Ar dst-window
3040 .D1 Pq alias: Ic swapw
3043 except the source and destination windows are swapped.
3044 It is an error if no window exists at
3048 is given, the new window does not become the current window.
3052 is omitted and a marked pane is present (see
3055 the window containing the marked pane is used rather than the current window.
3057 .It Xo Ic unlink-window
3059 .Op Fl t Ar target-window
3061 .D1 Pq alias: Ic unlinkw
3066 is given, a window may be unlinked only if it is linked to multiple sessions -
3067 windows may not be linked to no sessions;
3070 is specified and the window is linked to only one session, it is unlinked and
3075 allows a command to be bound to most keys, with or without a prefix key.
3076 When specifying keys, most represent themselves (for example
3080 Ctrl keys may be prefixed with
3088 In addition, the following special key names are accepted:
3106 .Em NPage/PageDown/PgDn ,
3107 .Em PPage/PageUp/PgUp ,
3111 Note that to bind the
3115 keys, quotation marks are necessary, for example:
3116 .Bd -literal -offset indent
3117 bind-key '"' split-window
3118 bind-key "'" new-window
3121 A command bound to the
3123 key will execute for all keys which do not have a more specific binding.
3125 Commands related to key bindings are as follows:
3131 .Op Fl T Ar key-table
3132 .Ar key command Op Ar argument ...
3134 .D1 Pq alias: Ic bind
3139 Keys are bound in a key table.
3140 By default (without -T), the key is bound in
3144 This table is used for keys pressed after the prefix key (for example,
3153 creates a new window).
3156 table is used for keys pressed without the prefix key: binding
3162 table (not recommended) means a plain
3164 will create a new window.
3169 Keys may also be bound in custom key tables and the
3172 command used to switch to them from a key binding.
3175 flag indicates this key may repeat, see the
3179 attaches a note to the key (shown with
3183 To view the default bindings and possible commands, see the
3189 .Op Fl P Ar prefix-string Fl T Ar key-table
3192 .D1 Pq alias: Ic lsk
3194 There are two forms: the default lists keys as
3198 lists only keys with attached notes and shows only the key and note for each
3201 With the default form, all key tables are listed by default.
3208 form, only keys in the
3212 key tables are listed by default;
3214 also lists only keys in
3217 specifies a prefix to print before each key and
3219 lists only the first matching key.
3221 lists the command for keys that do not have a note rather than skipping them.
3225 .Op Fl c Ar target-client
3226 .Op Fl N Ar repeat-count
3227 .Op Fl t Ar target-pane
3230 .D1 Pq alias: Ic send
3231 Send a key or keys to a window or client.
3234 is the name of the key (such as
3238 to send; if the string is not recognised as a key, it is sent as a series of
3242 is given, keys are sent to
3244 so they are looked up in the client's key table, rather than to
3246 All arguments are sent sequentially from first to last.
3247 If no keys are given and the command is bound to a key, then that key is used.
3251 flag disables key name lookup and processes the keys as literal UTF-8
3255 flag expects each key to be a hexadecimal number for an ASCII character.
3259 flag causes the terminal state to be reset.
3262 passes through a mouse event (only valid if bound to a mouse key binding, see
3263 .Sx MOUSE SUPPORT ) .
3266 is used to send a command into copy mode - see
3268 .Sx WINDOWS AND PANES
3271 specifies a repeat count and
3273 expands formats in arguments where appropriate.
3274 .It Xo Ic send-prefix
3276 .Op Fl t Ar target-pane
3278 Send the prefix key, or with
3280 the secondary prefix key, to a window as if it was pressed.
3282 .It Xo Ic unbind-key
3284 .Op Fl T Ar key-table
3287 .D1 Pq alias: Ic unbind
3288 Unbind the command bound to
3297 is present, all key bindings are removed.
3300 option prevents errors being returned.
3303 The appearance and behaviour of
3305 may be modified by changing the value of various options.
3306 There are four types of option:
3307 .Em server options ,
3308 .Em session options ,
3309 .Em window options ,
3315 server has a set of global server options which do not apply to any particular
3316 window or session or pane.
3317 These are altered with the
3320 command, or displayed with the
3325 In addition, each individual session may have a set of session options, and
3326 there is a separate set of global session options.
3327 Sessions which do not have a particular option configured inherit the value
3328 from the global session options.
3329 Session options are set or unset with the
3331 command and may be listed with the
3334 The available server and session options are listed under the
3338 Similarly, a set of window options is attached to each window and a set of pane
3339 options to each pane.
3340 Pane options inherit from window options.
3341 This means any pane option may be set as a window option to apply the option to
3342 all panes in the window without the option set, for example these commands will
3343 set the background colour to red for all panes except pane 0:
3344 .Bd -literal -offset indent
3345 set -w window-style bg=red
3346 set -pt:.0 window-style bg=blue
3349 There is also a set of global window options from which any unset window or
3350 pane options are inherited.
3351 Window and pane options are altered with
3356 commands and displayed with
3363 also supports user options which are prefixed with a
3365 User options may have any name, so long as they are prefixed with
3367 and be set to any string.
3369 .Bd -literal -offset indent
3370 $ tmux set -wq @foo "abc123"
3371 $ tmux show -wv @foo
3375 Commands which set options are as follows:
3378 .It Xo Ic set-option
3380 .Op Fl t Ar target-pane
3383 .D1 Pq alias: Ic set
3384 Set a pane option with
3386 a window option with
3388 a server option with
3390 otherwise a session option.
3391 If the option is not a user option,
3395 may be unnecessary -
3397 will infer the type from the option name, assuming
3402 is given, the global session or window option is set.
3405 expands formats in the option value.
3408 flag unsets an option, so a session inherits the option from the global
3411 restores a global option to the default).
3413 unsets an option (like
3415 but if the option is a pane option also unsets the option on any panes in the
3418 depends on the option and may be a number, a string, or a flag (on, off, or
3423 flag prevents setting an option that is already set and the
3425 flag suppresses errors about unknown or ambiguous options.
3429 and if the option expects a string or a style,
3431 is appended to the existing setting.
3433 .Bd -literal -offset indent
3434 set -g status-left "foo"
3435 set -ag status-left "bar"
3441 .Bd -literal -offset indent
3442 set -g status-style "bg=red"
3443 set -ag status-style "fg=blue"
3446 Will result in a red background
3451 the result would be the default background and a blue foreground.
3453 .It Xo Ic show-options
3455 .Op Fl t Ar target-pane
3458 .D1 Pq alias: Ic show
3459 Show the pane options (or a single option if
3463 the window options with
3465 the server options with
3467 otherwise the session options.
3468 If the option is not a user option,
3472 may be unnecessary -
3474 will infer the type from the option name, assuming
3477 Global session or window options are listed if
3481 shows only the option value, not the name.
3484 is set, no error will be returned if
3488 includes hooks (omitted by default).
3490 includes options inherited from a parent set of options, such options are
3491 marked with an asterisk.
3494 Available server options are:
3496 .It Ic backspace Ar key
3500 .It Ic buffer-limit Ar number
3501 Set the number of buffers; as new buffers are added to the top of the stack,
3502 old ones are removed from the bottom if necessary to maintain this maximum
3504 .It Xo Ic command-alias[]
3507 This is an array of custom aliases for commands.
3508 If an unknown command matches
3514 .Dl set -s command-alias[100] zoom='resize-pane -Z'
3522 .Dl resize-pane -Z -t:.1
3524 Note that aliases are expanded when a command is parsed rather than when it is
3525 executed, so binding an alias with
3527 will bind the expanded form.
3528 .It Ic default-terminal Ar terminal
3529 Set the default terminal for new windows created in this session - the
3530 default value of the
3532 environment variable.
3535 to work correctly, this
3540 or a derivative of them.
3541 .It Ic copy-command Ar shell-command
3542 Give the command to pipe to if the
3544 copy mode command is used without arguments.
3545 .It Ic escape-time Ar time
3546 Set the time in milliseconds for which
3548 waits after an escape is input to determine if it is part of a function or meta
3550 The default is 500 milliseconds.
3551 .It Ic editor Ar shell-command
3552 Set the command used when
3555 .It Xo Ic exit-empty
3558 If enabled (the default), the server will exit when there are no active
3560 .It Xo Ic exit-unattached
3563 If enabled, the server will exit when there are no attached clients.
3564 .It Xo Ic extended-keys
3565 .Op Ic on | off | always
3571 the escape sequence to enable extended keys is sent to the terminal, if
3573 knows that it is supported.
3575 always recognises extended keys itself.
3579 will only forward extended keys to applications when they request them; if
3582 will always forward the keys.
3583 .It Xo Ic focus-events
3586 When enabled, focus events are requested from the terminal if supported and
3587 passed through to applications running in
3589 Attached clients should be detached and attached again after changing this
3591 .It Ic history-file Ar path
3592 If not empty, a file to which
3594 will write command prompt history on exit and load it from on start.
3595 .It Ic message-limit Ar number
3596 Set the number of error or information messages to save in the message log for
3598 .It Ic prompt-history-limit Ar number
3599 Set the number of history items to save in the history file for each type of
3601 .It Xo Ic set-clipboard
3602 .Op Ic on | external | off
3604 Attempt to set the terminal clipboard content using the
3606 escape sequence, if there is an
3610 description (see the
3611 .Sx TERMINFO EXTENSIONS
3617 will both accept the escape sequence to create a buffer and attempt to set
3618 the terminal clipboard.
3622 will attempt to set the terminal clipboard but ignore attempts
3623 by applications to set
3629 will neither accept the clipboard escape sequence nor attempt to set the
3632 Note that this feature needs to be enabled in
3634 by setting the resource:
3635 .Bd -literal -offset indent
3636 disallowedWindowOps: 20,21,SetXprop
3639 Or changing this property from the
3641 interactive menu when required.
3642 .It Ic terminal-features[] Ar string
3643 Set terminal features for terminal types read from
3646 has a set of named terminal features.
3647 Each will apply appropriate changes to the
3652 can detect features for a few common terminals; this option can be used to
3653 easily tell tmux about features supported by terminals it cannot detect.
3655 .Ic terminal-overrides
3656 option allows individual
3658 capabilities to be set instead,
3659 .Ic terminal-features
3660 is intended for classes of functionality supported in a standard way but not
3663 Care must be taken to configure this only with features the terminal actually
3666 This is an array option where each entry is a colon-separated string made up
3667 of a terminal type pattern (matched using
3669 followed by a list of terminal features.
3670 The available features are:
3673 Supports 256 colours with the SGR escape sequences.
3675 Allows setting the system clipboard.
3677 Allows setting the cursor colour.
3679 Allows setting the cursor style.
3681 Supports extended keys.
3683 Supports focus reporting.
3685 Supports OSC 8 hyperlinks.
3687 Ignore function keys from
3693 Supports DECSLRM margins.
3699 Supports the OSC 7 working directory extension.
3701 Supports the overline SGR attribute.
3703 Supports the DECFRA rectangle fill escape sequence.
3705 Supports RGB colour with the SGR escape sequences.
3707 Supports SIXEL graphics.
3709 Supports the strikethrough SGR escape sequence.
3711 Supports synchronized updates.
3717 Allows underscore style and colour to be set.
3719 .It Ic terminal-overrides[] Ar string
3720 Allow terminal descriptions read using
3723 Each entry is a colon-separated string made up of a terminal type pattern
3730 For example, to set the
3735 for all terminal types matching
3738 .Dl "rxvt*:clear=\ee[H\ee[2J"
3740 The terminal entry value is passed through
3742 before interpretation.
3743 .It Ic user-keys[] Ar key
3744 Set list of user-defined key escape sequences.
3745 Each item is associated with a key named
3751 .Bd -literal -offset indent
3752 set -s user-keys[0] "\ee[5;30012~"
3753 bind User0 resize-pane -L 3
3757 Available session options are:
3759 .It Xo Ic activity-action
3760 .Op Ic any | none | current | other
3762 Set action on window activity when
3763 .Ic monitor-activity
3766 means activity in any window linked to a session causes a bell or message
3768 .Ic visual-activity )
3769 in the current window of that session,
3771 means all activity is ignored (equivalent to
3772 .Ic monitor-activity
3775 means only activity in windows other than the current window are ignored and
3777 means activity in the current window is ignored but not those in other windows.
3778 .It Ic assume-paste-time Ar milliseconds
3779 If keys are entered faster than one in
3781 they are assumed to have been pasted rather than typed and
3783 key bindings are not processed.
3784 The default is one millisecond and zero disables.
3785 .It Ic base-index Ar index
3786 Set the base index from which an unused index should be searched when a new
3788 The default is zero.
3789 .It Xo Ic bell-action
3790 .Op Ic any | none | current | other
3792 Set action on a bell in a window when
3795 The values are the same as those for
3796 .Ic activity-action .
3797 .It Ic default-command Ar shell-command
3798 Set the command used for new windows (if not specified when the window is
3804 The default is an empty string, which instructs
3806 to create a login shell using the value of the
3809 .It Ic default-shell Ar path
3810 Specify the default shell.
3811 This is used as the login shell for new windows when the
3813 option is set to empty, and must be the full path of the executable.
3816 tries to set a default value from the first suitable of the
3818 environment variable, the shell returned by
3822 This option should be configured when
3824 is used as a login shell.
3825 .It Ic default-size Ar XxY
3826 Set the default size of new windows when the
3828 option is set to manual or when a session is created with
3831 The value is the width and height separated by an
3834 The default is 80x24.
3835 .It Xo Ic destroy-unattached
3838 If enabled and the session is no longer attached to any clients, it is
3840 .It Xo Ic detach-on-destroy
3841 .Op Ic off | on | no-detached
3843 If on (the default), the client is detached when the session it is attached to
3845 If off, the client is switched to the most recently active of the remaining
3849 the client is detached only if there are no detached sessions; if detached
3850 sessions exist, the client is switched to the most recently active.
3851 .It Ic display-panes-active-colour Ar colour
3852 Set the colour used by the
3854 command to show the indicator for the active pane.
3855 .It Ic display-panes-colour Ar colour
3856 Set the colour used by the
3858 command to show the indicators for inactive panes.
3859 .It Ic display-panes-time Ar time
3860 Set the time in milliseconds for which the indicators shown by the
3863 .It Ic display-time Ar time
3864 Set the amount of time for which status line messages and other on-screen
3865 indicators are displayed.
3866 If set to 0, messages and indicators are displayed until a key is pressed.
3869 .It Ic history-limit Ar lines
3870 Set the maximum number of lines held in window history.
3871 This setting applies only to new windows - existing window histories are not
3872 resized and retain the limit at the point they were created.
3873 .It Ic key-table Ar key-table
3874 Set the default key table to
3878 .It Ic lock-after-time Ar number
3879 Lock the session (like the
3883 seconds of inactivity.
3884 The default is not to lock (set to 0).
3885 .It Ic lock-command Ar shell-command
3886 Command to run when locking each client.
3887 The default is to run
3891 .It Ic message-command-style Ar style
3892 Set status line message command style.
3893 This is used for the command prompt with
3895 keys when in command mode.
3901 .It Xo Ic message-line
3902 .Op Ic 0 | 1 | 2 | 3 | 4
3904 Set line on which status line messages and the command prompt are shown.
3905 .It Ic message-style Ar style
3906 Set status line message style.
3907 This is used for messages and for the command prompt.
3918 captures the mouse and allows mouse events to be bound as key bindings.
3921 section for details.
3922 .It Ic prefix Ar key
3923 Set the key accepted as a prefix key.
3924 In addition to the standard keys described under
3927 can be set to the special key
3930 .It Ic prefix2 Ar key
3931 Set a secondary key accepted as a prefix key.
3937 .It Xo Ic renumber-windows
3940 If on, when a window is closed in a session, automatically renumber the other
3941 windows in numerical order.
3944 option if it has been set.
3945 If off, do not renumber the windows.
3946 .It Ic repeat-time Ar time
3947 Allow multiple commands to be entered without pressing the prefix-key again
3950 milliseconds (the default is 500).
3951 Whether a key repeats may be set when it is bound using the
3955 Repeat is enabled for the default keys bound to the
3958 .It Xo Ic set-titles
3961 Attempt to set the client terminal title using the
3966 entries if they exist.
3968 automatically sets these to the \ee]0;...\e007 sequence if
3969 the terminal appears to be
3971 This option is off by default.
3972 .It Ic set-titles-string Ar string
3973 String used to set the client terminal title if
3976 Formats are expanded, see the
3979 .It Xo Ic silence-action
3980 .Op Ic any | none | current | other
3982 Set action on window silence when
3985 The values are the same as those for
3986 .Ic activity-action .
3988 .Op Ic off | on | 2 | 3 | 4 | 5
3990 Show or hide the status line or specify its size.
3993 gives a status line one row in height;
4000 .It Ic status-format[] Ar format
4001 Specify the format to be used for each line of the status line.
4002 The default builds the top status line from the various individual status
4004 .It Ic status-interval Ar interval
4005 Update the status line every
4008 By default, updates will occur every 15 seconds.
4009 A setting of zero disables redrawing at interval.
4010 .It Xo Ic status-justify
4011 .Op Ic left | centre | right | absolute-centre
4013 Set the position of the window list in the status line: left, centre or right.
4014 centre puts the window list in the relative centre of the available free space;
4015 absolute-centre uses the centre of the entire horizontal space.
4016 .It Xo Ic status-keys
4019 Use vi or emacs-style
4020 key bindings in the status line, for example at the command prompt.
4021 The default is emacs, unless the
4025 environment variables are set and contain the string
4027 .It Ic status-left Ar string
4030 (by default the session name) to the left of the status line.
4032 will be passed through
4040 For details on how the names and titles can be set see the
4041 .Sx "NAMES AND TITLES"
4045 .Bd -literal -offset indent
4046 #(sysctl vm.loadavg)
4047 #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
4052 .It Ic status-left-length Ar length
4055 of the left component of the status line.
4057 .It Ic status-left-style Ar style
4058 Set the style of the left part of the status line.
4064 .It Xo Ic status-position
4067 Set the position of the status line.
4068 .It Ic status-right Ar string
4071 to the right of the status line.
4072 By default, the current pane title in double quotes, the date and the time
4079 and character pairs are replaced.
4080 .It Ic status-right-length Ar length
4083 of the right component of the status line.
4085 .It Ic status-right-style Ar style
4086 Set the style of the right part of the status line.
4092 .It Ic status-style Ar style
4093 Set status line style.
4099 .It Ic update-environment[] Ar variable
4100 Set list of environment variables to be copied into the session environment
4101 when a new session is created or an existing session is attached.
4102 Any variables that do not exist in the source environment are set to be
4103 removed from the session environment (as if
4108 .It Xo Ic visual-activity
4109 .Op Ic on | off | both
4111 If on, display a message instead of sending a bell when activity occurs in a
4112 window for which the
4113 .Ic monitor-activity
4114 window option is enabled.
4115 If set to both, a bell and a message are produced.
4116 .It Xo Ic visual-bell
4117 .Op Ic on | off | both
4119 If on, a message is shown on a bell in a window for which the
4121 window option is enabled instead of it being passed through to the
4122 terminal (which normally makes a sound).
4123 If set to both, a bell and a message are produced.
4127 .It Xo Ic visual-silence
4128 .Op Ic on | off | both
4132 is enabled, prints a message after the interval has expired on a given window
4133 instead of sending a bell.
4134 If set to both, a bell and a message are produced.
4135 .It Ic word-separators Ar string
4136 Sets the session's conception of what characters are considered word
4137 separators, for the purposes of the next and previous word commands in
4141 Available window options are:
4143 .Bl -tag -width Ds -compact
4144 .It Xo Ic aggressive-resize
4147 Aggressively resize the chosen window.
4150 will resize the window to the size of the smallest or largest session
4153 option) for which it is the current window, rather than the session to
4154 which it is attached.
4155 The window may resize when the current window is changed on another
4156 session; this option is good for full-screen programs which support
4158 and poor for interactive programs such as shells.
4160 .It Xo Ic automatic-rename
4163 Control automatic window renaming.
4164 When this setting is enabled,
4166 will rename the window automatically using the format specified by
4167 .Ic automatic-rename-format .
4168 This flag is automatically disabled for an individual window when a name
4169 is specified at creation with
4175 or with a terminal escape sequence.
4176 It may be switched off globally with:
4177 .Bd -literal -offset indent
4178 set-option -wg automatic-rename off
4181 .It Ic automatic-rename-format Ar format
4185 .Ic automatic-rename
4188 .It Ic clock-mode-colour Ar colour
4191 .It Xo Ic clock-mode-style
4194 Set clock hour format.
4196 .It Ic fill-character Ar character
4197 Set the character used to fill areas of the terminal unused by a window.
4199 .It Ic main-pane-height Ar height
4200 .It Ic main-pane-width Ar width
4201 Set the width or height of the main (left or top) pane in the
4208 this is a percentage of the window size.
4210 .It Ic copy-mode-match-style Ar style
4211 Set the style of search matches in copy mode.
4218 .It Ic copy-mode-mark-style Ar style
4219 Set the style of the line containing the mark in copy mode.
4226 .It Ic copy-mode-current-match-style Ar style
4227 Set the style of the current search match in copy mode.
4237 Use vi or emacs-style key bindings in copy mode.
4238 The default is emacs, unless
4245 .It Ic mode-style Ar style
4246 Set window modes style.
4253 .It Xo Ic monitor-activity
4256 Monitor for activity in the window.
4257 Windows with activity are highlighted in the status line.
4259 .It Xo Ic monitor-bell
4262 Monitor for a bell in the window.
4263 Windows with a bell are highlighted in the status line.
4265 .It Xo Ic monitor-silence
4268 Monitor for silence (no activity) in the window within
4271 Windows that have been silent for the interval are highlighted in the
4273 An interval of zero disables the monitoring.
4275 .It Ic other-pane-height Ar height
4276 Set the height of the other panes (not the main pane) in the
4279 If this option is set to 0 (the default), it will have no effect.
4281 .Ic main-pane-height
4283 .Ic other-pane-height
4284 options are set, the main pane will grow taller to make the other panes the
4285 specified height, but will never shrink to do so.
4288 this is a percentage of the window size.
4290 .It Ic other-pane-width Ar width
4292 .Ic other-pane-height ,
4293 but set the width of other panes in the
4297 .It Ic pane-active-border-style Ar style
4298 Set the pane border style for the currently active pane.
4304 Attributes are ignored.
4306 .It Ic pane-base-index Ar index
4309 but set the starting index for pane numbers.
4311 .It Ic pane-border-format Ar format
4312 Set the text shown in pane border status lines.
4314 .It Xo Ic pane-border-indicators
4315 .Op Ic off | colour | arrows | both
4317 Indicate active pane by colouring only half of the border in windows with
4318 exactly two panes, by displaying arrow markers, by drawing both or neither.
4320 .It Ic pane-border-lines Ar type
4321 Set the type of characters used for drawing pane borders.
4326 single lines using ACS or UTF-8 characters
4328 double lines using UTF-8 characters
4330 heavy lines using UTF-8 characters
4332 simple ASCII characters
4340 will fall back to standard ACS line drawing when UTF-8 is not supported.
4342 .It Xo Ic pane-border-status
4343 .Op Ic off | top | bottom
4345 Turn pane border status lines off or set their position.
4347 .It Ic pane-border-style Ar style
4348 Set the pane border style for panes aside from the active pane.
4354 Attributes are ignored.
4356 .It Ic popup-style Ar style
4357 Set the popup style.
4363 Attributes are ignored.
4365 .It Ic popup-border-style Ar style
4366 Set the popup border style.
4372 Attributes are ignored.
4374 .It Ic popup-border-lines Ar type
4375 Set the type of characters used for drawing popup borders.
4380 single lines using ACS or UTF-8 characters (default)
4382 variation of single with rounded corners using UTF-8 characters
4384 double lines using UTF-8 characters
4386 heavy lines using UTF-8 characters
4388 simple ASCII characters
4390 simple ASCII space character
4398 will fall back to standard ACS line drawing when UTF-8 is not supported.
4400 .It Ic window-status-activity-style Ar style
4401 Set status line style for windows with an activity alert.
4408 .It Ic window-status-bell-style Ar style
4409 Set status line style for windows with a bell alert.
4416 .It Ic window-status-current-format Ar string
4418 .Ar window-status-format ,
4419 but is the format used when the window is the current window.
4421 .It Ic window-status-current-style Ar style
4422 Set status line style for the currently active window.
4429 .It Ic window-status-format Ar string
4430 Set the format in which the window is displayed in the status line window list.
4437 .It Ic window-status-last-style Ar style
4438 Set status line style for the last active window.
4445 .It Ic window-status-separator Ar string
4446 Sets the separator drawn between windows in the status line.
4447 The default is a single space character.
4449 .It Ic window-status-style Ar style
4450 Set status line style for a single window.
4457 .It Xo Ic window-size
4458 .Ar largest | Ar smallest | Ar manual | Ar latest
4462 determines the window size.
4465 the size of the largest attached session is used; if
4467 the size of the smallest.
4470 the size of a new window is set from the
4472 option and windows are resized automatically.
4476 uses the size of the client that had the most recent activity.
4480 .Ic aggressive-resize
4483 .It Xo Ic wrap-search
4486 If this option is set, searches will wrap around the end of the pane contents.
4490 Available pane options are:
4492 .Bl -tag -width Ds -compact
4493 .It Xo Ic allow-passthrough
4494 .Op Ic on | off | all
4496 Allow programs in the pane to bypass
4498 using a terminal escape sequence (\eePtmux;...\ee\e\e).
4501 passthrough sequences will be allowed only if the pane is visible.
4504 they will be allowed even if the pane is invisible.
4506 .It Xo Ic allow-rename
4509 Allow programs in the pane to change the window name using a terminal escape
4510 sequence (\eek...\ee\e\e).
4512 .It Xo Ic alternate-screen
4515 This option configures whether programs running inside the pane may use the
4516 terminal alternate screen feature, which allows the
4522 The alternate screen feature preserves the contents of the window when an
4523 interactive application starts and restores it on exit, so that any output
4524 visible before the application starts reappears unchanged after it exits.
4526 .It Ic cursor-colour Ar colour
4527 Set the colour of the cursor.
4529 .It Ic pane-colours[] Ar colour
4530 The default colour palette.
4531 Each entry in the array defines the colour
4533 uses when the colour with that index is requested.
4534 The index may be from zero to 255.
4536 .It Ic cursor-style Ar style
4537 Set the style of the cursor.
4538 Available styles are:
4540 .Ic blinking-block ,
4542 .Ic blinking-underline ,
4547 .It Xo Ic remain-on-exit
4548 .Op Ic on | off | failed
4550 A pane with this flag set is not destroyed when the program running in it
4554 then only when the program exit status is not zero.
4555 The pane may be reactivated with the
4559 .It Ic remain-on-exit-format Ar string
4560 Set the text shown at the bottom of exited panes when
4564 .It Xo Ic scroll-on-clear
4567 When the entire screen is cleared and this option is on, scroll the contents of
4568 the screen into history before clearing it.
4570 .It Xo Ic synchronize-panes
4573 Duplicate input to all other panes in the same window where this option is also
4574 on (only for panes that are not in any mode).
4576 .It Ic window-active-style Ar style
4577 Set the pane style when it is the active pane.
4584 .It Ic window-style Ar style
4594 allows commands to run on various triggers, called
4600 hook and there are a number of hooks not associated with commands.
4602 Hooks are stored as array options, members of the array are executed in
4603 order when the hook is triggered.
4604 Like options different hooks may be global or belong to a session, window or
4606 Hooks may be configured with the
4610 commands and displayed with
4615 The following two commands are equivalent:
4616 .Bd -literal -offset indent.
4617 set-hook -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4618 set-option -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4621 Setting a hook without specifying an array index clears the hook and sets the
4622 first member of the array.
4625 hook is run after it completes, except when the command is run as part of a hook
4627 They are named with an
4630 For example, the following command adds a hook to select the even-vertical
4633 .Bd -literal -offset indent
4634 set-hook -g after-split-window "selectl even-vertical"
4637 All the notifications listed in the
4639 section are hooks (without any arguments), except
4641 The following additional hooks are available:
4642 .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXX"
4644 Run when a window has activity.
4646 .Ic monitor-activity .
4648 Run when a window has received a bell.
4652 Run when a window has been silent.
4654 .Ic monitor-silence .
4656 Run when a client becomes the latest active client of its session.
4658 Run when a client is attached.
4660 Run when a client is detached
4662 Run when focus enters a client
4663 .It client-focus-out
4664 Run when focus exits a client
4666 Run when a client is resized.
4667 .It client-session-changed
4668 Run when a client's attached session is changed.
4670 Run when the program running in a pane exits, but
4672 is on so the pane has not closed.
4674 Run when the program running in a pane exits.
4676 Run when the focus enters a pane, if the
4680 Run when the focus exits a pane, if the
4683 .It pane-set-clipboard
4684 Run when the terminal clipboard is set using the
4688 Run when a new session created.
4690 Run when a session closed.
4692 Run when a session is renamed.
4694 Run when a window is linked into a session.
4696 Run when a window is renamed.
4698 Run when a window is resized.
4699 This may be after the
4703 Run when a window is unlinked from a session.
4706 Hooks are managed with these commands:
4710 .Op Fl t Ar target-pane
4722 The flags are the same as for
4730 .It Xo Ic show-hooks
4732 .Op Fl t Ar target-pane
4735 The flags are the same as for
4741 option is on (the default is off),
4743 allows mouse events to be bound as keys.
4744 The name of each key is made up of a mouse event (such as
4746 and a location suffix, one of the following:
4747 .Bl -column "XXXXXXXXXXXXX" -offset indent
4748 .It Li "Pane" Ta "the contents of a pane"
4749 .It Li "Border" Ta "a pane border"
4750 .It Li "Status" Ta "the status line window list"
4751 .It Li "StatusLeft" Ta "the left part of the status line"
4752 .It Li "StatusRight" Ta "the right part of the status line"
4753 .It Li "StatusDefault" Ta "any other part of the status line"
4756 The following mouse events are available:
4757 .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
4758 .It Li "WheelUp" Ta "WheelDown" Ta ""
4759 .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
4760 .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
4761 .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
4762 .It Li "SecondClick1" Ta "SecondClick2" Ta "SecondClick3"
4763 .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3"
4764 .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3"
4769 events are fired for the second click of a double click, even if there may be a
4770 third click which will fire
4775 Each should be suffixed with a location, for example
4776 .Ql MouseDown1Status .
4786 in commands bound to mouse key bindings.
4787 It resolves to the window or pane over which the mouse event took place
4788 (for example, the window in the status line over which button 1 was released
4791 binding, or the pane over which the wheel was scrolled for a
4798 flag may be used to forward a mouse event to a pane.
4800 The default key bindings allow the mouse to be used to select and resize panes,
4801 to copy text and to change window using the status line.
4802 These take effect if the
4804 option is turned on.
4806 Certain commands accept the
4811 This is a string which controls the output format of the command.
4812 Format variables are enclosed in
4817 .Ql #{session_name} .
4818 The possible variables are listed in the table below, or the name of a
4820 option may be used for an option's value.
4821 Some variables have a shorter alias such as
4824 is replaced by a single
4834 Conditionals are available by prefixing with
4836 and separating two alternatives with a comma;
4837 if the specified variable exists and is not zero, the first alternative
4838 is chosen, otherwise the second is used.
4840 .Ql #{?session_attached,attached,not attached}
4841 will include the string
4843 if the session is attached and the string
4845 if it is unattached, or
4846 .Ql #{?automatic-rename,yes,no}
4850 .Ic automatic-rename
4854 Conditionals can be nested arbitrarily.
4855 Inside a conditional,
4863 unless they are part of a
4867 .Bd -literal -offset indent
4868 #{?pane_in_mode,#[fg=white#,bg=red],#[fg=red#,bg=white]}#W .
4871 String comparisons may be expressed by prefixing two comma-separated
4882 .Ql #{==:#{host},myhost}
4892 evaluate to true if either or both of two comma-separated alternatives are
4894 .Ql #{||:#{pane_in_mode},#{alternate_on}} .
4900 or regular expression comparison.
4901 The first argument is the pattern and the second the string to compare.
4902 An optional argument specifies flags:
4904 means the pattern is a regular expression instead of the default
4908 means to ignore case.
4910 .Ql #{m:*foo*,#{host}}
4912 .Ql #{m/ri:^A,MYVAR} .
4915 performs a search for an
4917 pattern or regular expression in the pane content and evaluates to zero if not
4918 found, or a line number if found.
4923 flag means search for a regular expression and
4929 Numeric operators may be performed by prefixing two comma-separated alternatives
4935 flag may be given after the operator to use floating point numbers, otherwise
4937 This may be followed by a number giving the number of decimal places to use for
4939 The available operators are:
4956 in formats which are also expanded by
4958 and numeric comparison operators
4967 .Ql #{e|*|f|4:5.5,3}
4968 multiplies 5.5 by 3 for a result with four decimal places and
4970 returns the modulus of 7 and 3.
4972 replaces a numeric argument by its ASCII equivalent, so
4979 colour by its six-digit hexadecimal RGB value.
4981 A limit may be placed on the length of the resultant string by prefixing it
4984 a number and a colon.
4985 Positive numbers count from the start of the string and negative from the end,
4987 .Ql #{=5:pane_title}
4988 will include at most the first five characters of the pane title, or
4989 .Ql #{=-5:pane_title}
4990 the last five characters.
4991 A suffix or prefix may be given as a second argument - if provided then it is
4992 appended or prepended to the string if the length has been trimmed, for example
4993 .Ql #{=/5/...:pane_title}
4996 if the pane title is more than five characters.
4999 pads the string to a given width, for example
5000 .Ql #{p10:pane_title}
5001 will result in a width of at least 10 characters.
5002 A positive width pads on the left, a negative on the right.
5004 expands to the length of the variable and
5006 to its width when displayed, for example
5007 .Ql #{n:window_name} .
5009 Prefixing a time variable with
5011 will convert it to a string, so if
5012 .Ql #{window_activity}
5015 .Ql #{t:window_activity}
5017 .Ql Sun Oct 25 09:25:02 2015 .
5021 will use shorter but less accurate time format for times in the past.
5022 A custom format may be given using an
5028 if the format is separately being passed through
5033 .Ql #{t/f/%%H#:%%M:window_activity} ,
5045 of the variable respectively.
5049 special characters or with a
5051 suffix, escape hash characters (so
5056 will expand the format twice, for example
5057 .Ql #{E:status-left}
5058 is the result of expanding the content of the
5060 option rather than the option itself.
5072 will loop over each session, window, pane or client and insert the format once
5074 For windows and panes, two comma-separated formats may be given:
5075 the second is used for the current window or active pane.
5076 For example, to get a list of windows formatted like the status line:
5077 .Bd -literal -offset indent
5078 #{W:#{E:window-status-format} ,#{E:window-status-current-format} }
5082 checks if a window (without any suffix or with the
5084 suffix) or a session (with the
5086 suffix) name exists, for example
5088 is replaced with 1 if a window named
5092 A prefix of the form
5099 The first argument may be an extended regular expression and a final argument
5102 to ignore case, for example
5103 .Ql s/a(.)/\e1x/i:\&
5108 A different delimiter character may also be used, to avoid collisions with
5109 literal slashes in the pattern.
5118 In addition, the last line of a shell command's output may be inserted using
5122 will insert the system's uptime.
5123 When constructing formats,
5127 commands to finish; instead, the previous result from running the same command
5128 is used, or a placeholder if the command has not been run before.
5129 If the command hasn't exited, the most recent line of output will be used, but
5130 the status line will not be updated more than once a second.
5131 Commands are executed using
5135 global environment set (see the
5136 .Sx GLOBAL AND SESSION ENVIRONMENT
5141 specifies that a string should be interpreted literally and not expanded.
5143 .Ql #{l:#{?pane_in_mode,yes,no}}
5145 .Ql #{?pane_in_mode,yes,no} .
5147 The following variables are available, where appropriate:
5148 .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
5149 .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
5150 .It Li "active_window_index" Ta "" Ta "Index of active window in session"
5151 .It Li "alternate_on" Ta "" Ta "1 if pane is in alternate screen"
5152 .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
5153 .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
5154 .It Li "buffer_created" Ta "" Ta "Time buffer created"
5155 .It Li "buffer_name" Ta "" Ta "Name of buffer"
5156 .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
5157 .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
5158 .It Li "client_activity" Ta "" Ta "Time client last had activity"
5159 .It Li "client_cell_height" Ta "" Ta "Height of each client cell in pixels"
5160 .It Li "client_cell_width" Ta "" Ta "Width of each client cell in pixels"
5161 .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
5162 .It Li "client_created" Ta "" Ta "Time client created"
5163 .It Li "client_discarded" Ta "" Ta "Bytes discarded when client behind"
5164 .It Li "client_flags" Ta "" Ta "List of client flags"
5165 .It Li "client_height" Ta "" Ta "Height of client"
5166 .It Li "client_key_table" Ta "" Ta "Current key table"
5167 .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
5168 .It Li "client_name" Ta "" Ta "Name of client"
5169 .It Li "client_pid" Ta "" Ta "PID of client process"
5170 .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
5171 .It Li "client_readonly" Ta "" Ta "1 if client is read-only"
5172 .It Li "client_session" Ta "" Ta "Name of the client's session"
5173 .It Li "client_termfeatures" Ta "" Ta "Terminal features of client, if any"
5174 .It Li "client_termname" Ta "" Ta "Terminal name of client"
5175 .It Li "client_termtype" Ta "" Ta "Terminal type of client, if available"
5176 .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
5177 .It Li "client_uid" Ta "" Ta "UID of client process"
5178 .It Li "client_user" Ta "" Ta "User of client process"
5179 .It Li "client_utf8" Ta "" Ta "1 if client supports UTF-8"
5180 .It Li "client_width" Ta "" Ta "Width of client"
5181 .It Li "client_written" Ta "" Ta "Bytes written to client"
5182 .It Li "command" Ta "" Ta "Name of command in use, if any"
5183 .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
5184 .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
5185 .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
5186 .It Li "config_files" Ta "" Ta "List of configuration files loaded"
5187 .It Li "copy_cursor_line" Ta "" Ta "Line the cursor is on in copy mode"
5188 .It Li "copy_cursor_word" Ta "" Ta "Word under cursor in copy mode"
5189 .It Li "copy_cursor_x" Ta "" Ta "Cursor X position in copy mode"
5190 .It Li "copy_cursor_y" Ta "" Ta "Cursor Y position in copy mode"
5191 .It Li "current_file" Ta "" Ta "Current configuration file"
5192 .It Li "cursor_character" Ta "" Ta "Character at cursor in pane"
5193 .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
5194 .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
5195 .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
5196 .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
5197 .It Li "history_limit" Ta "" Ta "Maximum window history lines"
5198 .It Li "history_size" Ta "" Ta "Size of history in lines"
5199 .It Li "hook" Ta "" Ta "Name of running hook, if any"
5200 .It Li "hook_client" Ta "" Ta "Name of client where hook was run, if any"
5201 .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
5202 .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
5203 .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
5204 .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
5205 .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
5206 .It Li "host" Ta "#H" Ta "Hostname of local host"
5207 .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
5208 .It Li "insert_flag" Ta "" Ta "Pane insert flag"
5209 .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
5210 .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
5211 .It Li "last_window_index" Ta "" Ta "Index of last window in session"
5212 .It Li "line" Ta "" Ta "Line number in the list"
5213 .It Li "mouse_all_flag" Ta "" Ta "Pane mouse all flag"
5214 .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
5215 .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
5216 .It Li "mouse_hyperlink" Ta "" Ta "Hyperlink under mouse, if any"
5217 .It Li "mouse_line" Ta "" Ta "Line under mouse, if any"
5218 .It Li "mouse_sgr_flag" Ta "" Ta "Pane mouse SGR flag"
5219 .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
5220 .It Li "mouse_utf8_flag" Ta "" Ta "Pane mouse UTF-8 flag"
5221 .It Li "mouse_word" Ta "" Ta "Word under mouse, if any"
5222 .It Li "mouse_x" Ta "" Ta "Mouse X position, if any"
5223 .It Li "mouse_y" Ta "" Ta "Mouse Y position, if any"
5224 .It Li "next_session_id" Ta "" Ta "Unique session ID for next new session"
5225 .It Li "origin_flag" Ta "" Ta "Pane origin flag"
5226 .It Li "pane_active" Ta "" Ta "1 if active pane"
5227 .It Li "pane_at_bottom" Ta "" Ta "1 if pane is at the bottom of window"
5228 .It Li "pane_at_left" Ta "" Ta "1 if pane is at the left of window"
5229 .It Li "pane_at_right" Ta "" Ta "1 if pane is at the right of window"
5230 .It Li "pane_at_top" Ta "" Ta "1 if pane is at the top of window"
5231 .It Li "pane_bg" Ta "" Ta "Pane background colour"
5232 .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
5233 .It Li "pane_current_command" Ta "" Ta "Current command if available"
5234 .It Li "pane_current_path" Ta "" Ta "Current path if available"
5235 .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
5236 .It Li "pane_dead_signal" Ta "" Ta "Exit signal of process in dead pane"
5237 .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
5238 .It Li "pane_dead_time" Ta "" Ta "Exit time of process in dead pane"
5239 .It Li "pane_fg" Ta "" Ta "Pane foreground colour"
5240 .It Li "pane_format" Ta "" Ta "1 if format is for a pane"
5241 .It Li "pane_height" Ta "" Ta "Height of pane"
5242 .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
5243 .It Li "pane_in_mode" Ta "" Ta "1 if pane is in a mode"
5244 .It Li "pane_index" Ta "#P" Ta "Index of pane"
5245 .It Li "pane_input_off" Ta "" Ta "1 if input to pane is disabled"
5246 .It Li "pane_last" Ta "" Ta "1 if last pane"
5247 .It Li "pane_left" Ta "" Ta "Left of pane"
5248 .It Li "pane_marked" Ta "" Ta "1 if this is the marked pane"
5249 .It Li "pane_marked_set" Ta "" Ta "1 if a marked pane is set"
5250 .It Li "pane_mode" Ta "" Ta "Name of pane mode, if any"
5251 .It Li "pane_path" Ta "" Ta "Path of pane (can be set by application)"
5252 .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
5253 .It Li "pane_pipe" Ta "" Ta "1 if pane is being piped"
5254 .It Li "pane_right" Ta "" Ta "Right of pane"
5255 .It Li "pane_search_string" Ta "" Ta "Last search string in copy mode"
5256 .It Li "pane_start_command" Ta "" Ta "Command pane started with"
5257 .It Li "pane_start_path" Ta "" Ta "Path pane started with"
5258 .It Li "pane_synchronized" Ta "" Ta "1 if pane is synchronized"
5259 .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
5260 .It Li "pane_title" Ta "#T" Ta "Title of pane (can be set by application)"
5261 .It Li "pane_top" Ta "" Ta "Top of pane"
5262 .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
5263 .It Li "pane_unseen_changes" Ta "" Ta "1 if there were changes in pane while in mode"
5264 .It Li "pane_width" Ta "" Ta "Width of pane"
5265 .It Li "pid" Ta "" Ta "Server PID"
5266 .It Li "rectangle_toggle" Ta "" Ta "1 if rectangle selection is activated"
5267 .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
5268 .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
5269 .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
5270 .It Li "search_match" Ta "" Ta "Search match if any"
5271 .It Li "search_present" Ta "" Ta "1 if search started in copy mode"
5272 .It Li "selection_active" Ta "" Ta "1 if selection started and changes with the cursor in copy mode"
5273 .It Li "selection_end_x" Ta "" Ta "X position of the end of the selection"
5274 .It Li "selection_end_y" Ta "" Ta "Y position of the end of the selection"
5275 .It Li "selection_present" Ta "" Ta "1 if selection started in copy mode"
5276 .It Li "selection_start_x" Ta "" Ta "X position of the start of the selection"
5277 .It Li "selection_start_y" Ta "" Ta "Y position of the start of the selection"
5278 .It Li "server_sessions" Ta "" Ta "Number of sessions"
5279 .It Li "session_activity" Ta "" Ta "Time of session last activity"
5280 .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
5281 .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
5282 .It Li "session_attached_list" Ta "" Ta "List of clients session is attached to"
5283 .It Li "session_created" Ta "" Ta "Time session created"
5284 .It Li "session_format" Ta "" Ta "1 if format is for a session"
5285 .It Li "session_group" Ta "" Ta "Name of session group"
5286 .It Li "session_group_attached" Ta "" Ta "Number of clients sessions in group are attached to"
5287 .It Li "session_group_attached_list" Ta "" Ta "List of clients sessions in group are attached to"
5288 .It Li "session_group_list" Ta "" Ta "List of sessions in group"
5289 .It Li "session_group_many_attached" Ta "" Ta "1 if multiple clients attached to sessions in group"
5290 .It Li "session_group_size" Ta "" Ta "Size of session group"
5291 .It Li "session_grouped" Ta "" Ta "1 if session in a group"
5292 .It Li "session_id" Ta "" Ta "Unique session ID"
5293 .It Li "session_last_attached" Ta "" Ta "Time session last attached"
5294 .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
5295 .It Li "session_marked" Ta "" Ta "1 if this session contains the marked pane"
5296 .It Li "session_name" Ta "#S" Ta "Name of session"
5297 .It Li "session_path" Ta "" Ta "Working directory of session"
5298 .It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
5299 .It Li "session_windows" Ta "" Ta "Number of windows in session"
5300 .It Li "socket_path" Ta "" Ta "Server socket path"
5301 .It Li "start_time" Ta "" Ta "Server start time"
5302 .It Li "uid" Ta "" Ta "Server UID"
5303 .It Li "user" Ta "" Ta "Server user"
5304 .It Li "version" Ta "" Ta "Server version"
5305 .It Li "window_active" Ta "" Ta "1 if window active"
5306 .It Li "window_active_clients" Ta "" Ta "Number of clients viewing this window"
5307 .It Li "window_active_clients_list" Ta "" Ta "List of clients viewing this window"
5308 .It Li "window_active_sessions" Ta "" Ta "Number of sessions on which this window is active"
5309 .It Li "window_active_sessions_list" Ta "" Ta "List of sessions on which this window is active"
5310 .It Li "window_activity" Ta "" Ta "Time of window last activity"
5311 .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
5312 .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
5313 .It Li "window_bigger" Ta "" Ta "1 if window is larger than client"
5314 .It Li "window_cell_height" Ta "" Ta "Height of each cell in pixels"
5315 .It Li "window_cell_width" Ta "" Ta "Width of each cell in pixels"
5316 .It Li "window_end_flag" Ta "" Ta "1 if window has the highest index"
5317 .It Li "window_flags" Ta "#F" Ta "Window flags with # escaped as ##"
5318 .It Li "window_format" Ta "" Ta "1 if format is for a window"
5319 .It Li "window_height" Ta "" Ta "Height of window"
5320 .It Li "window_id" Ta "" Ta "Unique window ID"
5321 .It Li "window_index" Ta "#I" Ta "Index of window"
5322 .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
5323 .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
5324 .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
5325 .It Li "window_linked_sessions" Ta "" Ta "Number of sessions this window is linked to"
5326 .It Li "window_linked_sessions_list" Ta "" Ta "List of sessions this window is linked to"
5327 .It Li "window_marked_flag" Ta "" Ta "1 if window contains the marked pane"
5328 .It Li "window_name" Ta "#W" Ta "Name of window"
5329 .It Li "window_offset_x" Ta "" Ta "X offset into window if larger than client"
5330 .It Li "window_offset_y" Ta "" Ta "Y offset into window if larger than client"
5331 .It Li "window_panes" Ta "" Ta "Number of panes in window"
5332 .It Li "window_raw_flags" Ta "" Ta "Window flags with nothing escaped"
5333 .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
5334 .It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
5335 .It Li "window_start_flag" Ta "" Ta "1 if window has the lowest index"
5336 .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
5337 .It Li "window_width" Ta "" Ta "Width of window"
5338 .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
5339 .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
5343 offers various options to specify the colour and attributes of aspects of the
5344 interface, for example
5346 for the status line.
5347 In addition, embedded styles may be specified in format options, such as
5349 by enclosing them in
5354 A style may be the single term
5356 to specify the default style (which may come from an option, for example
5358 in the status line) or a space
5359 or comma separated list of the following:
5362 Set the foreground colour.
5363 The colour is one of:
5372 if supported the bright variants
5379 from the 256-colour set;
5381 for the default colour;
5383 for the terminal default colour; or a hexadecimal RGB string such as
5386 Set the background colour.
5388 Set the underscore colour.
5390 Set no attributes (turn off any active attributes).
5403 .Ic double-underscore ,
5404 .Ic curly-underscore ,
5405 .Ic dotted-underscore ,
5406 .Ic dashed-underscore
5409 Any of the attributes may be prefixed with
5413 is the terminal alternate character set.
5414 .It Xo Ic align=left
5420 Align text to the left, centre or right of the available space if appropriate.
5422 Fill the available space with a background colour if appropriate.
5425 .Ic list=left-marker ,
5426 .Ic list=right-marker ,
5429 Mark the position of the various window list components in the
5433 marks the start of the list;
5435 is the part of the list that should be kept in focus if the entire list won't
5436 fit in the available space (typically the current window);
5437 .Ic list=left-marker
5439 .Ic list=right-marker
5440 mark the text to be used to mark that text has been trimmed from the left or
5441 right of the list if there is not enough space.
5442 .It Xo Ic push-default ,
5445 Store the current colours and attributes as the default or reset to the previous
5449 affects any subsequent use of the
5453 Only one default may be pushed (each
5455 replaces the previous saved default).
5456 .It Xo Ic range=left ,
5458 .Ic range=window|X ,
5467 are the text used for the
5473 is the range for a window passed to the
5481 .Bd -literal -offset indent
5482 fg=yellow bold underscore blink
5483 bg=black,fg=default,noreverse
5485 .Sh NAMES AND TITLES
5487 distinguishes between names and titles.
5488 Windows and sessions have names, which may be used to specify them in targets
5489 and are displayed in the status line and various lists: the name is the
5491 identifier for a window or session.
5492 Only panes have titles.
5493 A pane's title is typically set by the program running inside the pane using
5494 an escape sequence (like it would set the
5498 Windows themselves do not have titles - a window's title is the title of its
5501 itself may set the title of the terminal in which the client is running, see
5506 A session's name is set with the
5511 A window's name is set with one of:
5514 A command argument (such as
5521 An escape sequence (if the
5523 option is turned on):
5524 .Bd -literal -offset indent
5525 $ printf '\e033kWINDOW_NAME\e033\e\e'
5528 Automatic renaming, which sets the name to the active command in the window's
5531 .Ic automatic-rename
5535 When a pane is first created, its title is the hostname.
5536 A pane's title can be set via the title setting escape sequence, for example:
5537 .Bd -literal -offset indent
5538 $ printf '\e033]2;My Title\e033\e\e'
5541 It can also be modified with the
5545 .Sh GLOBAL AND SESSION ENVIRONMENT
5546 When the server is started,
5548 copies the environment into the
5549 .Em global environment ;
5550 in addition, each session has a
5551 .Em session environment .
5552 When a window is created, the session and global environments are merged.
5553 If a variable exists in both, the value from the session environment is used.
5554 The result is the initial environment passed to the new process.
5557 .Ic update-environment
5558 session option may be used to update the session environment from the client
5559 when a new session is created or an old reattached.
5561 also initialises the
5563 variable with some internal information to allow commands to be executed
5564 from inside, and the
5566 variable with the correct terminal setting of
5569 Variables in both session and global environments may be marked as hidden.
5570 Hidden variables are not passed into the environment of new processes and
5571 instead can only be used by tmux itself (for example in formats, see the
5575 Commands to alter and view the environment are:
5578 .It Xo Ic set-environment
5580 .Op Fl t Ar target-session
5581 .Ar name Op Ar value
5583 .D1 Pq alias: Ic setenv
5584 Set or unset an environment variable.
5587 is used, the change is made in the global environment; otherwise, it is applied
5588 to the session environment for
5589 .Ar target-session .
5594 is expanded as a format.
5597 flag unsets a variable.
5599 indicates the variable is to be removed from the environment before starting a
5602 marks the variable as hidden.
5604 .It Xo Ic show-environment
5606 .Op Fl t Ar target-session
5609 .D1 Pq alias: Ic showenv
5610 Display the environment for
5612 or the global environment with
5616 is omitted, all variables are shown.
5617 Variables removed from the environment are prefixed with
5621 is used, the output is formatted as a set of Bourne shell commands.
5623 shows hidden variables (omitted by default).
5627 includes an optional status line which is displayed in the bottom line of each
5630 By default, the status line is enabled and one line in height (it may be
5631 disabled or made multiple lines with the
5633 session option) and contains, from left-to-right: the name of the current
5634 session in square brackets; the window list; the title of the active pane
5635 in double quotes; and the time and date.
5637 Each line of the status line is configured with the
5640 The default is made of three parts: configurable left and right sections (which
5641 may contain dynamic content such as the time or output from a shell command,
5644 .Ic status-left-length ,
5647 .Ic status-right-length
5648 options below), and a central window list.
5649 By default, the window list shows the index, name and (if any) flag of the
5650 windows present in the current session in ascending numerical order.
5651 It may be customised with the
5652 .Ar window-status-format
5654 .Ar window-status-current-format
5656 The flag is one of the following symbols appended to the window name:
5657 .Bl -column "Symbol" "Meaning" -offset indent
5658 .It Sy "Symbol" Ta Sy "Meaning"
5659 .It Li "*" Ta "Denotes the current window."
5660 .It Li "-" Ta "Marks the last window (previously selected)."
5661 .It Li "#" Ta "Window activity is monitored and activity has been detected."
5662 .It Li "\&!" Ta "Window bells are monitored and a bell has occurred in the window."
5663 .It Li "~" Ta "The window has been silent for the monitor-silence interval."
5664 .It Li "M" Ta "The window contains the marked pane."
5665 .It Li "Z" Ta "The window's active pane is zoomed."
5668 The # symbol relates to the
5669 .Ic monitor-activity
5671 The window name is printed in inverted colours if an alert (bell, activity or
5672 silence) is present.
5674 The colour and attributes of the status line may be configured, the entire
5675 status line using the
5677 session option and individual windows using the
5678 .Ic window-status-style
5681 The status line is automatically refreshed at interval if it has changed, the
5682 interval may be controlled with the
5686 Commands related to the status line are as follows:
5689 .It Xo Ic clear-prompt-history
5690 .Op Fl T Ar prompt-type
5692 .D1 Pq alias: Ic clearphist
5693 Clear status prompt history for prompt type
5697 is omitted, then clear history for all types.
5700 for possible values for
5702 .It Xo Ic command-prompt
5706 .Op Fl t Ar target-client
5707 .Op Fl T Ar prompt-type
5710 Open the command prompt in a client.
5711 This may be used from inside
5713 to execute commands interactively.
5717 is specified, it is used as the command.
5721 is expanded as a format.
5725 is a comma-separated list of the initial text for each prompt.
5730 is a comma-separated list of prompts which are displayed in order; otherwise
5731 a single prompt is displayed, constructed from
5733 if it is present, or
5737 Before the command is executed, the first occurrence of the string
5739 and all occurrences of
5741 are replaced by the response to the first prompt, all
5743 are replaced with the response to the second prompt, and so on for further
5745 Up to nine prompt responses may be replaced
5754 but any quotation marks are escaped.
5757 makes the prompt only accept one key press, in this case the resulting input
5758 is a single character.
5762 but the key press is translated to a key name.
5764 makes the prompt only accept numeric key presses.
5766 executes the command every time the prompt input changes instead of when the
5767 user exits the command prompt.
5773 This affects what completions are offered when
5776 Available types are:
5783 The following keys have a special meaning in the command prompt, depending
5787 .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
5788 .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
5789 .It Li "Cancel command prompt" Ta "q" Ta "Escape"
5790 .It Li "Delete from cursor to start of word" Ta "" Ta "C-w"
5791 .It Li "Delete entire command" Ta "d" Ta "C-u"
5792 .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
5793 .It Li "Execute command" Ta "Enter" Ta "Enter"
5794 .It Li "Get next command from history" Ta "" Ta "Down"
5795 .It Li "Get previous command from history" Ta "" Ta "Up"
5796 .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
5797 .It Li "Look for completions" Ta "Tab" Ta "Tab"
5798 .It Li "Move cursor left" Ta "h" Ta "Left"
5799 .It Li "Move cursor right" Ta "l" Ta "Right"
5800 .It Li "Move cursor to end" Ta "$" Ta "C-e"
5801 .It Li "Move cursor to next word" Ta "w" Ta "M-f"
5802 .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
5803 .It Li "Move cursor to start" Ta "0" Ta "C-a"
5804 .It Li "Transpose characters" Ta "" Ta "C-t"
5809 the prompt is shown in the background and the invoking client does not exit
5810 until it is dismissed.
5812 .It Xo Ic confirm-before
5814 .Op Fl c Ar confirm-key
5816 .Op Fl t Ar target-client
5819 .D1 Pq alias: Ic confirm
5820 Ask for confirmation before executing
5826 is the prompt to display; otherwise a prompt is constructed from
5828 It may contain the special character sequences supported by the
5833 the prompt is shown in the background and the invoking client does not exit
5834 until it is dismissed.
5836 changes the default behaviour (if Enter alone is pressed) of the prompt to
5839 changes the confirmation key to
5844 .It Xo Ic display-menu
5846 .Op Fl c Ar target-client
5847 .Op Fl t Ar target-pane
5848 .Op Fl S Ar starting-choice
5850 .Op Fl x Ar position
5851 .Op Fl y Ar position
5854 .Ar command Op Ar argument ...
5856 .D1 Pq alias: Ic menu
5860 gives the target for any commands run from the menu.
5862 A menu is passed as a series of arguments: first the menu item name,
5863 second the key shortcut (or empty for none) and third the command
5864 to run when the menu item is chosen.
5865 The name and command are formats, see the
5870 If the name begins with a hyphen (-), then the item is disabled (shown dim) and
5872 The name may be empty for a separator line, in which case both the key and
5873 command should be omitted.
5876 is a format for the menu title (see
5879 sets the menu item selected by default, if the menu is not bound to a mouse key
5885 give the position of the menu.
5886 Both may be a row or column number, or one of the following special values:
5887 .Bl -column "XXXXX" "XXXX" -offset indent
5888 .It Sy "Value" Ta Sy "Flag" Ta Sy "Meaning"
5889 .It Li "C" Ta "Both" Ta "The centre of the terminal"
5890 .It Li "R" Ta Fl x Ta "The right side of the terminal"
5891 .It Li "P" Ta "Both" Ta "The bottom left of the pane"
5892 .It Li "M" Ta "Both" Ta "The mouse position"
5893 .It Li "W" Ta "Both" Ta "The window position on the status line"
5894 .It Li "S" Ta Fl y Ta "The line above or below the status line"
5897 Or a format, which is expanded including the following additional variables:
5898 .Bl -column "XXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent
5899 .It Sy "Variable name" Ta Sy "Replaced with"
5900 .It Li "popup_centre_x" Ta "Centered in the client"
5901 .It Li "popup_centre_y" Ta "Centered in the client"
5902 .It Li "popup_height" Ta "Height of menu or popup"
5903 .It Li "popup_mouse_bottom" Ta "Bottom of at the mouse"
5904 .It Li "popup_mouse_centre_x" Ta "Horizontal centre at the mouse"
5905 .It Li "popup_mouse_centre_y" Ta "Vertical centre at the mouse"
5906 .It Li "popup_mouse_top" Ta "Top at the mouse"
5907 .It Li "popup_mouse_x" Ta "Mouse X position"
5908 .It Li "popup_mouse_y" Ta "Mouse Y position"
5909 .It Li "popup_pane_bottom" Ta "Bottom of the pane"
5910 .It Li "popup_pane_left" Ta "Left of the pane"
5911 .It Li "popup_pane_right" Ta "Right of the pane"
5912 .It Li "popup_pane_top" Ta "Top of the pane"
5913 .It Li "popup_status_line_y" Ta "Above or below the status line"
5914 .It Li "popup_width" Ta "Width of menu or popup"
5915 .It Li "popup_window_status_line_x" Ta "At the window position in status line"
5916 .It Li "popup_window_status_line_y" Ta "At the status line showing the window"
5919 Each menu consists of items followed by a key shortcut shown in brackets.
5920 If the menu is too large to fit on the terminal, it is not displayed.
5921 Pressing the key shortcut chooses the corresponding item.
5922 If the mouse is enabled and the menu is opened from a mouse key binding,
5923 releasing the mouse button with an item selected chooses that item and
5924 releasing the mouse button without an item selected closes the menu.
5926 changes this behaviour so that the menu does not close when the mouse button is
5927 released without an item selected the menu is not closed and a mouse button
5928 must be clicked to choose an item.
5930 The following keys are also available:
5931 .Bl -column "Key" "Function" -offset indent
5932 .It Sy "Key" Ta Sy "Function"
5933 .It Li "Enter" Ta "Choose selected item"
5934 .It Li "Up" Ta "Select previous item"
5935 .It Li "Down" Ta "Select next item"
5936 .It Li "q" Ta "Exit menu"
5939 .It Xo Ic display-message
5941 .Op Fl c Ar target-client
5943 .Op Fl t Ar target-pane
5946 .D1 Pq alias: Ic display
5950 is given, the output is printed to stdout, otherwise it is displayed in the
5952 status line for up to
5959 option is used; a delay of zero waits for a key press.
5961 ignores key presses and closes only after the delay expires.
5966 is printed unchanged.
5967 Otherwise, the format of
5971 section; information is taken from
5975 is given, otherwise the active pane.
5978 prints verbose logging as the format is parsed and
5980 lists the format variables and their values.
5983 forwards any input read from stdin to the empty pane given by
5986 .It Xo Ic display-popup
5988 .Op Fl b Ar border-lines
5989 .Op Fl c Ar target-client
5990 .Op Fl d Ar start-directory
5991 .Op Fl e Ar environment
5994 .Op Fl S Ar border-style
5995 .Op Fl t Ar target-pane
5998 .Op Fl x Ar position
5999 .Op Fl y Ar position
6000 .Op Ar shell-command
6002 .D1 Pq alias: Ic popup
6003 Display a popup running
6007 A popup is a rectangular box drawn over the top of any panes.
6008 Panes are not updated while a popup is present.
6011 closes the popup automatically when
6016 closes the popup only if
6018 exited with success.
6023 give the position of the popup, they have the same meaning as for the
6029 give the width and height - both may be a percentage (followed by
6031 If omitted, half of the terminal size is used.
6034 does not surround the popup by a border.
6037 sets the type of border line for the popup.
6044 .Ic popup-border-lines
6045 for possible values for
6049 sets the style for the popup and
6051 sets the style for the popup border.
6061 and sets an environment variable for the popup; it may be specified multiple
6065 is a format for the popup title (see
6070 flag closes any popup on the client.
6072 .It Xo Ic show-prompt-history
6073 .Op Fl T Ar prompt-type
6075 .D1 Pq alias: Ic showphist
6076 Display status prompt history for prompt type
6080 is omitted, then show history for all types.
6083 for possible values for
6088 maintains a set of named
6090 Each buffer may be either explicitly or automatically named.
6091 Explicitly named buffers are named when created with the
6095 commands, or by renaming an automatically named buffer with
6098 Automatically named buffers are given a name such as
6104 option is reached, the oldest automatically named buffer is deleted.
6105 Explicitly named buffers are not subject to
6107 and may be deleted with the
6111 Buffers may be added using
6117 commands, and pasted into a window using the
6120 If a buffer command is used and no buffer is specified, the most
6121 recently added automatically named buffer is assumed.
6123 A configurable history buffer is also maintained for each window.
6124 By default, up to 2000 lines are kept; this can be altered with the
6130 The buffer commands are as follows:
6137 .Op Fl K Ar key-format
6138 .Op Fl O Ar sort-order
6139 .Op Fl t Ar target-pane
6142 Put a pane into buffer mode, where a buffer may be chosen interactively from
6144 Each buffer is shown on one line.
6145 A shortcut key is shown on the left in brackets allowing for immediate choice,
6146 or the list may be navigated and an item chosen or otherwise manipulated using
6150 The following keys may be used in buffer mode:
6151 .Bl -column "Key" "Function" -offset indent
6152 .It Sy "Key" Ta Sy "Function"
6153 .It Li "Enter" Ta "Paste selected buffer"
6154 .It Li "Up" Ta "Select previous buffer"
6155 .It Li "Down" Ta "Select next buffer"
6156 .It Li "C-s" Ta "Search by name or content"
6157 .It Li "n" Ta "Repeat last search"
6158 .It Li "t" Ta "Toggle if buffer is tagged"
6159 .It Li "T" Ta "Tag no buffers"
6160 .It Li "C-t" Ta "Tag all buffers"
6161 .It Li "p" Ta "Paste selected buffer"
6162 .It Li "P" Ta "Paste tagged buffers"
6163 .It Li "d" Ta "Delete selected buffer"
6164 .It Li "D" Ta "Delete tagged buffers"
6165 .It Li "e" Ta "Open the buffer in an editor"
6166 .It Li "f" Ta "Enter a format to filter items"
6167 .It Li "O" Ta "Change sort field"
6168 .It Li "r" Ta "Reverse sort order"
6169 .It Li "v" Ta "Toggle preview"
6170 .It Li "q" Ta "Exit mode"
6173 After a buffer is chosen,
6175 is replaced by the buffer name in
6177 and the result executed as a command.
6180 is not given, "paste-buffer -b '%%'" is used.
6183 specifies the initial sort field: one of
6190 reverses the sort order.
6192 specifies an initial filter: the filter is a format - if it evaluates to zero,
6193 the item in the list is not shown, otherwise it is shown.
6194 If a filter would lead to an empty list, it is ignored.
6196 specifies the format for each item in the list and
6198 a format for each shortcut key; both are evaluated once for each line.
6200 starts without the preview.
6201 This command works only if at least one client is attached.
6203 .It Xo Ic clear-history
6205 .Op Fl t Ar target-pane
6207 .D1 Pq alias: Ic clearhist
6208 Remove and free the history for the specified pane.
6210 also removes all hyperlinks.
6212 .It Ic delete-buffer Op Fl b Ar buffer-name
6213 .D1 Pq alias: Ic deleteb
6214 Delete the buffer named
6216 or the most recently added automatically named buffer if not specified.
6218 .It Xo Ic list-buffers
6222 .D1 Pq alias: Ic lsb
6223 List the global buffers.
6225 specifies the format of each line and
6228 Only buffers for which the filter is true are shown.
6232 .It Xo Ic load-buffer
6234 .Op Fl b Ar buffer-name
6235 .Op Fl t Ar target-client
6239 .D1 Pq alias: Ic loadb
6240 Load the contents of the specified paste buffer from
6244 is given, the buffer is also sent to the clipboard for
6248 escape sequence, if possible.
6250 .It Xo Ic paste-buffer
6252 .Op Fl b Ar buffer-name
6253 .Op Fl s Ar separator
6254 .Op Fl t Ar target-pane
6256 .D1 Pq alias: Ic pasteb
6257 Insert the contents of a paste buffer into the specified pane.
6258 If not specified, paste into the current one.
6261 also delete the paste buffer.
6262 When output, any linefeed (LF) characters in the paste buffer are replaced with
6263 a separator, by default carriage return (CR).
6264 A custom separator may be specified using the
6269 flag means to do no replacement (equivalent to a separator of LF).
6272 is specified, paste bracket control codes are inserted around the
6273 buffer if the application has requested bracketed paste mode.
6275 .It Xo Ic save-buffer
6277 .Op Fl b Ar buffer-name
6280 .D1 Pq alias: Ic saveb
6281 Save the contents of the specified paste buffer to
6285 option appends to rather than overwriting the file.
6286 .It Xo Ic set-buffer
6288 .Op Fl b Ar buffer-name
6289 .Op Fl t Ar target-client
6291 .Op Fl n Ar new-buffer-name
6294 .D1 Pq alias: Ic setb
6295 Set the contents of the specified buffer to
6299 is given, the buffer is also sent to the clipboard for
6303 escape sequence, if possible.
6306 option appends to rather than overwriting the buffer.
6309 option renames the buffer to
6310 .Ar new-buffer-name .
6312 .It Xo Ic show-buffer
6313 .Op Fl b Ar buffer-name
6315 .D1 Pq alias: Ic showb
6316 Display the contents of the specified buffer.
6319 Miscellaneous commands are as follows:
6321 .It Ic clock-mode Op Fl t Ar target-pane
6322 Display a large clock.
6326 .Op Fl t Ar target-pane
6327 .Ar shell-command command
6337 returns success or the second
6340 Before being executed,
6342 is expanded using the rules specified in the
6344 section, including those relevant to
6349 is run in the background.
6355 is not executed but considered success if neither empty nor zero (after formats
6359 .D1 Pq alias: Ic lock
6360 Lock each client individually by running the command specified by the
6367 .Op Fl t Ar target-pane
6368 .Op Ar shell-command
6370 .D1 Pq alias: Ic run
6379 command in the background without creating a window.
6380 Before being executed,
6382 is expanded using the rules specified in the
6387 the command is run in the background.
6391 seconds before starting the command.
6394 is not given, any output to stdout is displayed in view mode (in the pane
6397 or the current pane if omitted) after the command finishes.
6398 If the command fails, the exit status is also displayed.
6404 .D1 Pq alias: Ic wait
6405 When used without options, prevents the client from exiting until woken using
6408 with the same channel.
6411 is used, the channel is locked and any clients that try to lock the same
6412 channel are made to wait until the channel is unlocked with
6419 client detaches, it prints a message.
6422 .It detached (from session ...)
6423 The client was detached normally.
6424 .It detached and SIGHUP
6425 The client was detached and its parent sent the
6427 signal (for example with
6435 was unexpectedly destroyed.
6437 The client was killed with
6440 The client is in control mode and became unable to keep up with the data from
6443 The server exited when it had no sessions.
6445 The server exited when it received
6447 .It server exited unexpectedly
6448 The server crashed or otherwise exited without telling the client the reason.
6450 .Sh TERMINFO EXTENSIONS
6452 understands some unofficial extensions to
6454 It is not normally necessary to set these manually, instead the
6455 .Ic terminal-features
6456 option should be used.
6459 An existing extension that tells
6461 the terminal supports default colours.
6465 that the terminal supports the VTE bidirectional text extensions.
6467 Set the cursor colour.
6468 The first takes a single string argument and is used to set the colour;
6469 the second takes no arguments and restores the default cursor colour.
6470 If set, a sequence such as this may be used
6471 to change the cursor colour from inside
6473 .Bd -literal -offset indent
6474 $ printf '\e033]12;red\e033\e\e'
6481 .It Em \&Cmg, \&Clmg, \&Dsmg , \&Enmg
6482 Set, clear, disable or enable DECSLRM margins.
6483 These are set automatically if the terminal reports it is
6486 .It Em \&Dsbp , \&Enbp
6487 Disable and enable bracketed paste.
6488 These are set automatically if the
6490 capability is present.
6491 .It Em \&Dseks , \&Eneks
6492 Disable and enable extended keys.
6493 .It Em \&Dsfcs , \&Enfcs
6494 Disable and enable focus reporting.
6495 These are set automatically if the
6497 capability is present.
6499 Set or clear a hyperlink annotation.
6503 that the terminal does not use bright colors for bold display.
6507 that the terminal supports rectangle operations.
6509 Enable the overline attribute.
6511 Set a styled underscore.
6512 The single parameter is one of: 0 for no underscore, 1 for normal
6513 underscore, 2 for double underscore, 3 for curly underscore, 4 for dotted
6514 underscore and 5 for dashed underscore.
6515 .It Em \&Setulc , \&ol
6516 Set the underscore colour or reset to the default.
6517 The argument is (red * 65536) + (green * 256) + blue where each is between 0
6520 Set or reset the cursor style.
6521 If set, a sequence such as this may be used
6522 to change the cursor to an underline:
6523 .Bd -literal -offset indent
6524 $ printf '\e033[4 q'
6529 is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
6531 Set the opening sequence for the working directory notification.
6532 The sequence is terminated using the standard
6536 Indicates that the terminal supports SIXEL.
6538 Start (parameter is 1) or end (parameter is 2) a synchronized update.
6540 Indicate that the terminal supports the
6542 RGB escape sequence (for example, \ee[38;2;255;255;255m).
6544 If supported, this is used for the initialize colour escape sequence (which
6545 may be enabled by adding the
6554 This is equivalent to the
6559 Store the current buffer in the host terminal's selection (clipboard).
6562 option above and the
6566 This is an existing extension capability that tmux uses to mean that the
6567 terminal supports the
6569 title set sequences and to automatically set some of the capabilities above.
6573 offers a textual interface called
6575 This allows applications to communicate with
6577 using a simple text-only protocol.
6579 In control mode, a client sends
6581 commands or command sequences terminated by newlines on standard input.
6582 Each command will produce one block of output on standard output.
6583 An output block consists of a
6585 line followed by the output (which may be empty).
6586 The output block ends with a
6595 have three arguments: an integer time (as seconds from epoch), command number
6596 and flags (currently not used).
6598 .Bd -literal -offset indent
6599 %begin 1363006971 2 1
6600 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
6607 command may be used to set the size of a client in control mode.
6611 outputs notifications.
6612 A notification will never occur inside an output block.
6614 The following notifications are defined:
6616 .It Ic %client-detached Ar client
6617 The client has detached.
6618 .It Ic %client-session-changed Ar client session-id name
6619 The client is now attached to the session with ID
6623 .It Ic %config-error Ar error
6624 An error has happened in a configuration file.
6625 .It Ic %continue Ar pane-id
6626 The pane has been continued after being paused (if the
6631 .It Ic %exit Op Ar reason
6634 client is exiting immediately, either because it is not attached to any session
6635 or an error occurred.
6638 describes why the client exited.
6639 .It Ic %extended-output Ar pane-id Ar age Ar ... \& : Ar value
6646 is the time in milliseconds for which tmux had buffered the output before it
6648 Any subsequent arguments up until a single
6650 are for future use and should be ignored.
6651 .It Xo Ic %layout-change
6654 .Ar window-visible-layout
6657 The layout of a window with ID
6662 The window's visible layout is
6663 .Ar window-visible-layout
6664 and the window flags are
6666 .It Ic %message Ar message
6667 A message sent with the
6670 .It Ic %output Ar pane-id Ar value
6671 A window pane produced output.
6673 escapes non-printable characters and backslash as octal \\xxx.
6674 .It Ic %pane-mode-changed Ar pane-id
6678 .It Ic %paste-buffer-changed Ar name
6682 .It Ic %paste-buffer-deleted Ar name
6686 .It Ic %pause Ar pane-id
6687 The pane has been paused (if the
6690 .It Ic %session-changed Ar session-id Ar name
6691 The client is now attached to the session with ID
6695 .It Ic %session-renamed Ar name
6696 The current session was renamed to
6698 .It Ic %session-window-changed Ar session-id Ar window-id
6701 changed its active window to the window with ID
6703 .It Ic %sessions-changed
6704 A session was created or destroyed.
6705 .It Xo Ic %subscription-changed
6710 .Ar pane-id ... \& :
6713 The value of the format associated with subscription
6724 are for future use and should be ignored.
6725 .It Ic %unlinked-window-add Ar window-id
6728 was created but is not linked to the current session.
6729 .It Ic %unlinked-window-close Ar window-id
6732 which is not linked to the current session, was closed.
6733 .It Ic %unlinked-window-renamed Ar window-id
6736 which is not linked to the current session, was renamed.
6737 .It Ic %window-add Ar window-id
6740 was linked to the current session.
6741 .It Ic %window-close Ar window-id
6745 .It Ic %window-pane-changed Ar window-id Ar pane-id
6746 The active pane in the window with ID
6748 changed to the pane with ID
6750 .It Ic %window-renamed Ar window-id Ar name
6759 is started, it inspects the following environment variables:
6760 .Bl -tag -width LC_CTYPE
6762 If the command specified in this variable contains the string
6766 is unset, use vi-style key bindings.
6773 The user's login directory.
6776 database is consulted.
6778 The character encoding
6780 It is used for two separate purposes.
6781 For output to the terminal, UTF-8 is used if the
6783 option is given or if
6789 Otherwise, only ASCII characters are written and non-ASCII characters
6790 are replaced with underscores
6794 always runs with a UTF-8 locale.
6795 If en_US.UTF-8 is provided by the operating system, it is used and
6797 is ignored for input.
6802 what the UTF-8 locale is called on the current system.
6803 If the locale specified by
6805 is not available or is not a UTF-8 locale,
6807 exits with an error message.
6809 The date and time format
6811 It is used for locale-dependent
6815 The current working directory to be set in the global environment.
6816 This may be useful if it contains symbolic links.
6817 If the value of the variable does not match the current working
6818 directory, the variable is ignored and the result of
6822 The absolute path to the default shell for new windows.
6827 The parent directory of the directory containing the server sockets.
6832 If the command specified in this variable contains the string
6834 use vi-style key bindings.
6842 .Bl -tag -width "/etc/tmux.confXXX" -compact
6847 .It Pa /etc/tmux.conf
6848 System-wide configuration file.
6856 .Dl $ tmux new-session vi
6858 Most commands have a shorter form, known as an alias.
6859 For new-session, this is
6864 Alternatively, the shortest unambiguous form of a command is accepted.
6865 If there are several options, they are listed:
6866 .Bd -literal -offset indent
6868 ambiguous command: n, could be: new-session, new-window, next-window
6871 Within an active session, a new window may be created by typing
6881 Windows may be navigated with:
6883 (to select window 0),
6885 (to select window 1), and so on;
6887 to select the next window; and
6889 to select the previous window.
6891 A session may be detached using
6893 (or by an external event such as
6895 disconnection) and reattached with:
6897 .Dl $ tmux attach-session
6901 lists the current key bindings in the current window; up and down may be used
6902 to navigate the list or
6906 Commands to be run when the
6908 server is started may be placed in the
6911 Common examples include:
6913 Changing the default prefix key:
6914 .Bd -literal -offset indent
6915 set-option -g prefix C-a
6917 bind-key C-a send-prefix
6920 Turning the status line off, or changing its colour:
6921 .Bd -literal -offset indent
6922 set-option -g status off
6923 set-option -g status-style bg=blue
6926 Setting other options, such as the default command,
6927 or locking after 30 minutes of inactivity:
6928 .Bd -literal -offset indent
6929 set-option -g default-command "exec /bin/ksh"
6930 set-option -g lock-after-time 1800
6933 Creating new key bindings:
6934 .Bd -literal -offset indent
6935 bind-key b set-option status
6936 bind-key / command-prompt "split-window 'exec man %%'"
6937 bind-key S command-prompt "new-window -n %1 'ssh %1'"
6942 .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com