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-prompt" Ta "" Ta ""
1791 .It Li "next-space" Ta "W" Ta ""
1792 .It Li "next-space-end" Ta "E" Ta ""
1793 .It Li "next-word" Ta "w" Ta ""
1794 .It Li "next-word-end" Ta "e" Ta "M-f"
1795 .It Li "other-end" Ta "o" Ta ""
1796 .It Li "page-down" Ta "C-f" Ta "PageDown"
1797 .It Li "page-down-and-cancel" Ta "" Ta ""
1798 .It Li "page-up" Ta "C-b" Ta "PageUp"
1799 .It Li "pipe [<command>] [<prefix>]" Ta "" Ta ""
1800 .It Li "pipe-no-clear [<command>] [<prefix>]" Ta "" Ta ""
1801 .It Li "pipe-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1802 .It Li "previous-matching-bracket" Ta "" Ta "M-C-b"
1803 .It Li "previous-paragraph" Ta "{" Ta "M-{"
1804 .It Li "previous-prompt" Ta "" Ta ""
1805 .It Li "previous-space" Ta "B" Ta ""
1806 .It Li "previous-word" Ta "b" Ta "M-b"
1807 .It Li "rectangle-on" Ta "" Ta ""
1808 .It Li "rectangle-off" Ta "" Ta ""
1809 .It Li "rectangle-toggle" Ta "v" Ta "R"
1810 .It Li "refresh-from-pane" Ta "r" Ta "r"
1811 .It Li "scroll-down" Ta "C-e" Ta "C-Down"
1812 .It Li "scroll-down-and-cancel" Ta "" Ta ""
1813 .It Li "scroll-up" Ta "C-y" Ta "C-Up"
1814 .It Li "search-again" Ta "n" Ta "n"
1815 .It Li "search-backward <for>" Ta "?" Ta ""
1816 .It Li "search-backward-incremental <for>" Ta "" Ta "C-r"
1817 .It Li "search-backward-text <for>" Ta "" Ta ""
1818 .It Li "search-forward <for>" Ta "/" Ta ""
1819 .It Li "search-forward-incremental <for>" Ta "" Ta "C-s"
1820 .It Li "search-forward-text <for>" Ta "" Ta ""
1821 .It Li "scroll-bottom" Ta "" Ta ""
1822 .It Li "scroll-middle" Ta "z" Ta ""
1823 .It Li "scroll-top" Ta "" Ta ""
1824 .It Li "search-reverse" Ta "N" Ta "N"
1825 .It Li "select-line" Ta "V" Ta ""
1826 .It Li "select-word" Ta "" Ta ""
1827 .It Li "set-mark" Ta "X" Ta "X"
1828 .It Li "start-of-line" Ta "0" Ta "C-a"
1829 .It Li "stop-selection" Ta "" Ta ""
1830 .It Li "toggle-position" Ta "P" Ta "P"
1831 .It Li "top-line" Ta "H" Ta "M-R"
1834 The search commands come in several varieties:
1838 search for a regular expression;
1841 variants search for a plain text string rather than a regular expression;
1843 perform an incremental search and expect to be used with the
1849 repeats the last search and
1851 does the same but reverses the direction (forward becomes backward and backward
1858 move between shell prompts, but require the shell to emit an escape sequence
1859 (\e033]133;A\e033\e\e) to tell
1861 where the prompts are located; if the shell does not do this, these commands
1864 Copy commands may take an optional buffer prefix argument which is used
1865 to generate the buffer name (the default is
1867 so buffers are named
1871 Pipe commands take a command argument which is the command to which the
1872 selected text is piped.
1874 variants also copy the selection.
1877 variants of some commands exit copy mode after they have completed (for copy
1878 commands) or when the cursor reaches the bottom (for scrolling commands).
1880 variants do not clear the selection.
1882 The next and previous word keys skip over whitespace and treat consecutive
1883 runs of either word separators or other letters as words.
1884 Word separators can be customized with the
1887 Next word moves to the start of the next word, next word end to the end of the
1888 next word and previous word to the start of the previous word.
1889 The three next and previous space keys work similarly but use a space alone as
1893 to the empty string makes next/previous word equivalent to next/previous space.
1895 The jump commands enable quick movement within a line.
1896 For instance, typing
1900 will move the cursor to the next
1902 character on the current line.
1905 will then jump to the next occurrence.
1907 Commands in copy mode may be prefaced by an optional repeat count.
1908 With vi key bindings, a prefix is entered using the number keys; with
1909 emacs, the Alt (meta) key and a number begins prefix entry.
1911 The synopsis for the
1917 .Op Fl s Ar src-pane
1918 .Op Fl t Ar target-pane
1923 option scrolls one page up.
1925 begins a mouse drag (only valid if bound to a mouse key binding, see
1926 .Sx MOUSE SUPPORT ) .
1928 hides the position indicator in the top right.
1930 cancels copy mode and any other modes.
1938 specifies that scrolling to the bottom of the history (to the visible screen)
1939 should exit copy mode.
1940 While in copy mode, pressing a key other than those used for scrolling will
1941 disable this behaviour.
1942 This is intended to allow fast scrolling through a pane's history, for
1944 .Bd -literal -offset indent
1945 bind PageUp copy-mode -eu
1949 A number of preset arrangements of panes are available, these are called
1951 These may be selected with the
1953 command or cycled with
1957 by default); once a layout is chosen, panes within it may be moved and resized
1960 The following layouts are supported:
1962 .It Ic even-horizontal
1963 Panes are spread out evenly from left to right across the window.
1964 .It Ic even-vertical
1965 Panes are spread evenly from top to bottom.
1966 .It Ic main-horizontal
1967 A large (main) pane is shown at the top of the window and the remaining panes
1968 are spread from left to right in the leftover space at the bottom.
1970 .Em main-pane-height
1971 window option to specify the height of the top pane.
1972 .It Ic main-vertical
1975 but the large pane is placed on the left and the others spread from top to
1976 bottom along the right.
1981 Panes are spread out as evenly as possible over the window in both rows and
1987 may be used to apply a previously used layout - the
1989 command displays the layout of each window in a form suitable for use with
1992 .Bd -literal -offset indent
1995 layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1996 $ tmux select-layout 'bb62,159x48,0,0{79x48,0,0,79x48,80,0}'
2000 automatically adjusts the size of the layout for the current window size.
2001 Note that a layout cannot be applied to a window with more panes than that
2002 from which the layout was originally defined.
2004 Commands related to windows and panes are as follows:
2007 .It Xo Ic break-pane
2010 .Op Fl n Ar window-name
2011 .Op Fl s Ar src-pane
2012 .Op Fl t Ar dst-window
2014 .D1 Pq alias: Ic breakp
2017 off from its containing window to make it the only pane in
2023 the window is moved to the next index after or before (existing windows are
2024 moved if necessary).
2027 is given, the new window does not become the current window.
2030 option prints information about the new window after it has been created.
2031 By default, it uses the format
2032 .Ql #{session_name}:#{window_index}.#{pane_index}
2033 but a different format may be specified with
2036 .It Xo Ic capture-pane
2038 .Op Fl b Ar buffer-name
2039 .Op Fl E Ar end-line
2040 .Op Fl S Ar start-line
2041 .Op Fl t Ar target-pane
2043 .D1 Pq alias: Ic capturep
2044 Capture the contents of a pane.
2047 is given, the output goes to stdout, otherwise to the buffer specified with
2049 or a new buffer if omitted.
2052 is given, the alternate screen is used, and the history is not accessible.
2053 If no alternate screen exists, an error will be returned unless
2058 is given, the output includes escape sequences for text and background
2061 also escapes non-printable characters as octal \exxx.
2063 ignores trailing positions that do not contain a character.
2065 preserves trailing spaces at each line's end and
2067 preserves trailing spaces and joins any wrapped lines;
2072 captures only any output that the pane has received that is the beginning of an
2073 as-yet incomplete escape sequence.
2078 specify the starting and ending line numbers, zero is the first line of the
2079 visible pane and negative numbers are lines in the history.
2083 is the start of the history and to
2085 the end of the visible pane.
2086 The default is to capture only the visible contents of the pane.
2092 .Op Fl K Ar key-format
2093 .Op Fl O Ar sort-order
2094 .Op Fl t Ar target-pane
2097 Put a pane into client mode, allowing a client to be selected interactively from
2099 Each client is shown on one line.
2100 A shortcut key is shown on the left in brackets allowing for immediate choice,
2101 or the list may be navigated and an item chosen or otherwise manipulated using
2105 The following keys may be used in client mode:
2106 .Bl -column "Key" "Function" -offset indent
2107 .It Sy "Key" Ta Sy "Function"
2108 .It Li "Enter" Ta "Choose selected client"
2109 .It Li "Up" Ta "Select previous client"
2110 .It Li "Down" Ta "Select next client"
2111 .It Li "C-s" Ta "Search by name"
2112 .It Li "n" Ta "Repeat last search"
2113 .It Li "t" Ta "Toggle if client is tagged"
2114 .It Li "T" Ta "Tag no clients"
2115 .It Li "C-t" Ta "Tag all clients"
2116 .It Li "d" Ta "Detach selected client"
2117 .It Li "D" Ta "Detach tagged clients"
2118 .It Li "x" Ta "Detach and HUP selected client"
2119 .It Li "X" Ta "Detach and HUP tagged clients"
2120 .It Li "z" Ta "Suspend selected client"
2121 .It Li "Z" Ta "Suspend tagged clients"
2122 .It Li "f" Ta "Enter a format to filter items"
2123 .It Li "O" Ta "Change sort field"
2124 .It Li "r" Ta "Reverse sort order"
2125 .It Li "v" Ta "Toggle preview"
2126 .It Li "q" Ta "Exit mode"
2129 After a client is chosen,
2131 is replaced by the client name in
2133 and the result executed as a command.
2136 is not given, "detach-client -t '%%'" is used.
2139 specifies the initial sort field: one of
2148 reverses the sort order.
2150 specifies an initial filter: the filter is a format - if it evaluates to zero,
2151 the item in the list is not shown, otherwise it is shown.
2152 If a filter would lead to an empty list, it is ignored.
2154 specifies the format for each item in the list and
2156 a format for each shortcut key; both are evaluated once for each line.
2158 starts without the preview.
2159 This command works only if at least one client is attached.
2165 .Op Fl K Ar key-format
2166 .Op Fl O Ar sort-order
2167 .Op Fl t Ar target-pane
2170 Put a pane into tree mode, where a session, window or pane may be chosen
2171 interactively from a tree.
2172 Each session, window or pane is shown on one line.
2173 A shortcut key is shown on the left in brackets allowing for immediate choice,
2174 or the tree may be navigated and an item chosen or otherwise manipulated using
2177 starts with sessions collapsed and
2179 with windows collapsed.
2182 The following keys may be used in tree mode:
2183 .Bl -column "Key" "Function" -offset indent
2184 .It Sy "Key" Ta Sy "Function"
2185 .It Li "Enter" Ta "Choose selected item"
2186 .It Li "Up" Ta "Select previous item"
2187 .It Li "Down" Ta "Select next item"
2188 .It Li "+" Ta "Expand selected item"
2189 .It Li "-" Ta "Collapse selected item"
2190 .It Li "M-+" Ta "Expand all items"
2191 .It Li "M--" Ta "Collapse all items"
2192 .It Li "x" Ta "Kill selected item"
2193 .It Li "X" Ta "Kill tagged items"
2194 .It Li "<" Ta "Scroll list of previews left"
2195 .It Li ">" Ta "Scroll list of previews right"
2196 .It Li "C-s" Ta "Search by name"
2197 .It Li "m" Ta "Set the marked pane"
2198 .It Li "M" Ta "Clear the marked pane"
2199 .It Li "n" Ta "Repeat last search"
2200 .It Li "t" Ta "Toggle if item is tagged"
2201 .It Li "T" Ta "Tag no items"
2202 .It Li "C-t" Ta "Tag all items"
2203 .It Li "\&:" Ta "Run a command for each tagged item"
2204 .It Li "f" Ta "Enter a format to filter items"
2205 .It Li "H" Ta "Jump to the starting pane"
2206 .It Li "O" Ta "Change sort field"
2207 .It Li "r" Ta "Reverse sort order"
2208 .It Li "v" Ta "Toggle preview"
2209 .It Li "q" Ta "Exit mode"
2212 After a session, window or pane is chosen, the first instance of
2214 and all instances of
2216 are replaced by the target in
2218 and the result executed as a command.
2221 is not given, "switch-client -t '%%'" is used.
2224 specifies the initial sort field: one of
2231 reverses the sort order.
2233 specifies an initial filter: the filter is a format - if it evaluates to zero,
2234 the item in the list is not shown, otherwise it is shown.
2235 If a filter would lead to an empty list, it is ignored.
2237 specifies the format for each item in the tree and
2239 a format for each shortcut key; both are evaluated once for each line.
2241 starts without the preview.
2243 includes all sessions in any session groups in the tree rather than only the
2245 This command works only if at least one client is attached.
2251 .Op Fl t Ar target-pane
2254 Put a pane into customize mode, where options and key bindings may be browsed
2255 and modified from a list.
2256 Option values in the list are shown for the active pane in the current window.
2259 The following keys may be used in customize mode:
2260 .Bl -column "Key" "Function" -offset indent
2261 .It Sy "Key" Ta Sy "Function"
2262 .It Li "Enter" Ta "Set pane, window, session or global option value"
2263 .It Li "Up" Ta "Select previous item"
2264 .It Li "Down" Ta "Select next item"
2265 .It Li "+" Ta "Expand selected item"
2266 .It Li "-" Ta "Collapse selected item"
2267 .It Li "M-+" Ta "Expand all items"
2268 .It Li "M--" Ta "Collapse all items"
2269 .It Li "s" Ta "Set option value or key attribute"
2270 .It Li "S" Ta "Set global option value"
2271 .It Li "w" Ta "Set window option value, if option is for pane and window"
2272 .It Li "d" Ta "Set an option or key to the default"
2273 .It Li "D" Ta "Set tagged options and tagged keys to the default"
2274 .It Li "u" Ta "Unset an option (set to default value if global) or unbind a key"
2275 .It Li "U" Ta "Unset tagged options and unbind tagged keys"
2276 .It Li "C-s" Ta "Search by name"
2277 .It Li "n" Ta "Repeat last search"
2278 .It Li "t" Ta "Toggle if item is tagged"
2279 .It Li "T" Ta "Tag no items"
2280 .It Li "C-t" Ta "Tag all items"
2281 .It Li "f" Ta "Enter a format to filter items"
2282 .It Li "v" Ta "Toggle option information"
2283 .It Li "q" Ta "Exit mode"
2287 specifies an initial filter: the filter is a format - if it evaluates to zero,
2288 the item in the list is not shown, otherwise it is shown.
2289 If a filter would lead to an empty list, it is ignored.
2291 specifies the format for each item in the tree.
2293 starts without the option information.
2294 This command works only if at least one client is attached.
2299 .Op Fl d Ar duration
2300 .Op Fl t Ar target-client
2303 .D1 Pq alias: Ic displayp
2304 Display a visible indicator of each pane shown by
2307 .Ic display-panes-colour
2309 .Ic display-panes-active-colour
2311 The indicator is closed when a key is pressed (unless
2315 milliseconds have passed.
2319 .Ic display-panes-time
2321 A duration of zero means the indicator stays until a key is pressed.
2322 While the indicator is on screen, a pane may be chosen with the
2326 keys, which will cause
2328 to be executed as a command with
2330 substituted by the pane ID.
2333 is "select-pane -t '%%'".
2336 other commands are not blocked from running until the indicator is closed.
2338 .It Xo Ic find-window
2340 .Op Fl t Ar target-pane
2343 .D1 Pq alias: Ic findw
2350 in window names, titles, and visible content (but not history).
2351 The flags control matching behavior:
2353 matches only visible window contents,
2355 matches only the window name and
2357 matches only the window title.
2359 makes the search ignore case.
2365 This command works only if at least one client is attached.
2370 .Op Fl s Ar src-pane
2371 .Op Fl t Ar dst-pane
2373 .D1 Pq alias: Ic joinp
2376 but instead of splitting
2378 and creating a new pane, split it and move
2381 This can be used to reverse
2387 to be joined to left of or above
2392 is omitted and a marked pane is present (see
2395 the marked pane is used rather than the current pane.
2399 .Op Fl t Ar target-pane
2401 .D1 Pq alias: Ic killp
2402 Destroy the given pane.
2403 If no panes remain in the containing window, it is also destroyed.
2406 option kills all but the pane given with
2409 .It Xo Ic kill-window
2411 .Op Fl t Ar target-window
2413 .D1 Pq alias: Ic killw
2414 Kill the current window or the window at
2416 removing it from any sessions to which it is linked.
2419 option kills all but the window given with
2424 .Op Fl t Ar target-window
2426 .D1 Pq alias: Ic lastp
2427 Select the last (previously selected) pane.
2429 keeps the window zoomed if it was zoomed.
2433 disables input to the pane.
2435 .It Ic last-window Op Fl t Ar target-session
2436 .D1 Pq alias: Ic last
2437 Select the last (previously selected) window.
2440 is specified, select the last window of the current session.
2442 .It Xo Ic link-window
2444 .Op Fl s Ar src-window
2445 .Op Fl t Ar dst-window
2447 .D1 Pq alias: Ic linkw
2454 is specified and no such window exists, the
2461 the window is moved to the next index after or before
2463 (existing windows are moved if necessary).
2468 exists, it is killed, otherwise an error is generated.
2471 is given, the newly linked window is not selected.
2473 .It Xo Ic list-panes
2479 .D1 Pq alias: Ic lsp
2484 is ignored and all panes on the server are listed.
2489 is a session (or the current session).
2490 If neither is given,
2492 is a window (or the current window).
2494 specifies the format of each line and
2497 Only panes for which the filter is true are shown.
2502 .It Xo Ic list-windows
2506 .Op Fl t Ar target-session
2508 .D1 Pq alias: Ic lsw
2511 is given, list all windows on the server.
2512 Otherwise, list windows in the current session or in
2513 .Ar target-session .
2515 specifies the format of each line and
2518 Only windows for which the filter is true are shown.
2526 .Op Fl s Ar src-pane
2527 .Op Fl t Ar dst-pane
2529 .D1 Pq alias: Ic movep
2533 .It Xo Ic move-window
2535 .Op Fl s Ar src-window
2536 .Op Fl t Ar dst-window
2538 .D1 Pq alias: Ic movew
2541 except the window at
2547 all windows in the session are renumbered in sequential order, respecting
2552 .It Xo Ic new-window
2554 .Op Fl c Ar start-directory
2555 .Op Fl e Ar environment
2557 .Op Fl n Ar window-name
2558 .Op Fl t Ar target-window
2559 .Op Ar shell-command
2561 .D1 Pq alias: Ic neww
2562 Create a new window.
2567 the new window is inserted at the next index after or before the specified
2569 moving windows up if necessary;
2572 is the new window location.
2576 is given, the session does not make the new window the current window.
2578 represents the window to be created; if the target already exists an error is
2581 flag is used, in which case it is destroyed.
2584 is given and a window named
2586 already exists, it is selected (unless
2588 is also given in which case the command does nothing).
2591 is the command to execute.
2594 is not specified, the value of the
2598 specifies the working directory in which the new window is created.
2600 When the shell command completes, the window closes.
2603 option to change this behaviour.
2608 and sets an environment variable for the newly created window; it may be
2609 specified multiple times.
2613 environment variable must be set to
2617 for all programs running
2620 New windows will automatically have
2622 added to their environment, but care must be taken not to reset this in shell
2623 start-up files or by the
2629 option prints information about the new window after it has been created.
2630 By default, it uses the format
2631 .Ql #{session_name}:#{window_index}
2632 but a different format may be specified with
2635 .It Ic next-layout Op Fl t Ar target-window
2636 .D1 Pq alias: Ic nextl
2637 Move a window to the next layout and rearrange the panes to fit.
2639 .It Xo Ic next-window
2641 .Op Fl t Ar target-session
2643 .D1 Pq alias: Ic next
2644 Move to the next window in the session.
2647 is used, move to the next window with an alert.
2651 .Op Fl t Ar target-pane
2652 .Op Ar shell-command
2654 .D1 Pq alias: Ic pipep
2655 Pipe output sent by the program in
2657 to a shell command or vice versa.
2658 A pane may only be connected to one command at a time, any existing pipe is
2664 string may contain the special character sequences supported by the
2669 is given, the current pipe (if any) is closed.
2674 specify which of the
2676 output streams are connected to the pane:
2679 stdout is connected (so anything
2681 prints is written to the pane as if it were typed);
2684 stdin is connected (so any output in the pane is piped to
2685 .Ar shell-command ) .
2686 Both may be used together and if neither are specified,
2692 option only opens a new pipe if no previous pipe exists, allowing a pipe to
2693 be toggled with a single key, for example:
2694 .Bd -literal -offset indent
2695 bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
2698 .It Xo Ic previous-layout
2699 .Op Fl t Ar target-window
2701 .D1 Pq alias: Ic prevl
2702 Move to the previous layout in the session.
2704 .It Xo Ic previous-window
2706 .Op Fl t Ar target-session
2708 .D1 Pq alias: Ic prev
2709 Move to the previous window in the session.
2712 move to the previous window with an alert.
2714 .It Xo Ic rename-window
2715 .Op Fl t Ar target-window
2718 .D1 Pq alias: Ic renamew
2719 Rename the current window, or the window at
2724 .It Xo Ic resize-pane
2726 .Op Fl t Ar target-pane
2731 .D1 Pq alias: Ic resizep
2732 Resize a pane, up, down, left or right by
2748 is given in lines or columns (the default is 1);
2752 may be a given as a number of lines or columns or followed by
2754 for a percentage of the window size (for example
2758 the active pane is toggled between zoomed (occupying the whole of the window)
2759 and unzoomed (its normal position in the layout).
2762 begins mouse resizing (only valid if bound to a mouse key binding, see
2763 .Sx MOUSE SUPPORT ) .
2766 trims all lines below the current cursor position and moves lines out of the
2767 history to replace them.
2769 .It Xo Ic resize-window
2771 .Op Fl t Ar target-window
2776 .D1 Pq alias: Ic resizew
2777 Resize a window, up, down, left or right by
2793 is given in lines or cells (the default is 1).
2795 sets the size of the largest session containing the window;
2797 the size of the smallest.
2798 This command will automatically set
2800 to manual in the window options.
2802 .It Xo Ic respawn-pane
2804 .Op Fl c Ar start-directory
2805 .Op Fl e Ar environment
2806 .Op Fl t Ar target-pane
2807 .Op Ar shell-command
2809 .D1 Pq alias: Ic respawnp
2810 Reactivate a pane in which the command has exited (see the
2815 is not given, the command used when the pane was created or last respawned is
2817 The pane must be already inactive, unless
2819 is given, in which case any existing command is killed.
2821 specifies a new working directory for the pane.
2824 option has the same meaning as for the
2828 .It Xo Ic respawn-window
2830 .Op Fl c Ar start-directory
2831 .Op Fl e Ar environment
2832 .Op Fl t Ar target-window
2833 .Op Ar shell-command
2835 .D1 Pq alias: Ic respawnw
2836 Reactivate a window in which the command has exited (see the
2841 is not given, the command used when the window was created or last respawned is
2843 The window must be already inactive, unless
2845 is given, in which case any existing command is killed.
2847 specifies a new working directory for the window.
2850 option has the same meaning as for the
2854 .It Xo Ic rotate-window
2856 .Op Fl t Ar target-window
2858 .D1 Pq alias: Ic rotatew
2859 Rotate the positions of the panes within a window, either upward (numerically
2862 or downward (numerically higher).
2864 keeps the window zoomed if it was zoomed.
2866 .It Xo Ic select-layout
2868 .Op Fl t Ar target-pane
2871 .D1 Pq alias: Ic selectl
2872 Choose a specific layout for a window.
2875 is not given, the last preset layout used (if any) is reapplied.
2879 are equivalent to the
2885 applies the last set layout if possible (undoes the most recent layout change).
2887 spreads the current pane and any panes next to it out evenly.
2889 .It Xo Ic select-pane
2892 .Op Fl t Ar target-pane
2894 .D1 Pq alias: Ic selectp
2897 the active pane in its window.
2904 is used, respectively the pane below, to the left, to the right, or above the
2905 target pane is used.
2907 keeps the window zoomed if it was zoomed.
2909 is the same as using the
2915 disables input to the pane.
2917 sets the pane title.
2922 are used to set and clear the
2924 There is one marked pane at a time, setting a new marked pane clears the last.
2925 The marked pane is the default target for
2934 .It Xo Ic select-window
2936 .Op Fl t Ar target-window
2938 .D1 Pq alias: Ic selectw
2939 Select the window at
2945 are equivalent to the
2953 is given and the selected window is already the current window,
2954 the command behaves like
2957 .It Xo Ic split-window
2959 .Op Fl c Ar start-directory
2960 .Op Fl e Ar environment
2962 .Op Fl t Ar target-pane
2963 .Op Ar shell-command
2966 .D1 Pq alias: Ic splitw
2967 Create a new pane by splitting
2970 does a horizontal split and
2972 a vertical split; if neither is specified,
2977 option specifies the size of the new pane in lines (for vertical split) or in
2978 columns (for horizontal split);
2982 to specify a percentage of the available space.
2985 option causes the new pane to be created to the left of or above
2989 option creates a new pane spanning the full window height (with
2991 or full window width (with
2993 instead of splitting the active pane.
2995 zooms if the window is not zoomed, or keeps it zoomed if already zoomed.
2999 ('') will create a pane with no command running in it.
3000 Output can be sent to such a pane with the
3007 is not specified or empty)
3008 will create an empty pane and forward any output from stdin to it.
3010 .Bd -literal -offset indent
3011 $ make 2>&1|tmux splitw -dI &
3014 All other options have the same meaning as for the
3020 .Op Fl s Ar src-pane
3021 .Op Fl t Ar dst-pane
3023 .D1 Pq alias: Ic swapp
3027 is used and no source pane is specified with
3030 is swapped with the previous pane (before it numerically);
3032 swaps with the next pane (after it numerically).
3036 not to change the active pane and
3038 keeps the window zoomed if it was zoomed.
3042 is omitted and a marked pane is present (see
3045 the marked pane is used rather than the current pane.
3047 .It Xo Ic swap-window
3049 .Op Fl s Ar src-window
3050 .Op Fl t Ar dst-window
3052 .D1 Pq alias: Ic swapw
3055 except the source and destination windows are swapped.
3056 It is an error if no window exists at
3060 is given, the new window does not become the current window.
3064 is omitted and a marked pane is present (see
3067 the window containing the marked pane is used rather than the current window.
3069 .It Xo Ic unlink-window
3071 .Op Fl t Ar target-window
3073 .D1 Pq alias: Ic unlinkw
3078 is given, a window may be unlinked only if it is linked to multiple sessions -
3079 windows may not be linked to no sessions;
3082 is specified and the window is linked to only one session, it is unlinked and
3087 allows a command to be bound to most keys, with or without a prefix key.
3088 When specifying keys, most represent themselves (for example
3092 Ctrl keys may be prefixed with
3100 In addition, the following special key names are accepted:
3118 .Em NPage/PageDown/PgDn ,
3119 .Em PPage/PageUp/PgUp ,
3123 Note that to bind the
3127 keys, quotation marks are necessary, for example:
3128 .Bd -literal -offset indent
3129 bind-key '"' split-window
3130 bind-key "'" new-window
3133 A command bound to the
3135 key will execute for all keys which do not have a more specific binding.
3137 Commands related to key bindings are as follows:
3143 .Op Fl T Ar key-table
3144 .Ar key command Op Ar argument ...
3146 .D1 Pq alias: Ic bind
3151 Keys are bound in a key table.
3152 By default (without -T), the key is bound in
3156 This table is used for keys pressed after the prefix key (for example,
3165 creates a new window).
3168 table is used for keys pressed without the prefix key: binding
3174 table (not recommended) means a plain
3176 will create a new window.
3181 Keys may also be bound in custom key tables and the
3184 command used to switch to them from a key binding.
3187 flag indicates this key may repeat, see the
3191 attaches a note to the key (shown with
3195 To view the default bindings and possible commands, see the
3201 .Op Fl P Ar prefix-string Fl T Ar key-table
3204 .D1 Pq alias: Ic lsk
3206 There are two forms: the default lists keys as
3210 lists only keys with attached notes and shows only the key and note for each
3213 With the default form, all key tables are listed by default.
3220 form, only keys in the
3224 key tables are listed by default;
3226 also lists only keys in
3229 specifies a prefix to print before each key and
3231 lists only the first matching key.
3233 lists the command for keys that do not have a note rather than skipping them.
3237 .Op Fl c Ar target-client
3238 .Op Fl N Ar repeat-count
3239 .Op Fl t Ar target-pane
3242 .D1 Pq alias: Ic send
3243 Send a key or keys to a window or client.
3246 is the name of the key (such as
3250 to send; if the string is not recognised as a key, it is sent as a series of
3254 is given, keys are sent to
3256 so they are looked up in the client's key table, rather than to
3258 All arguments are sent sequentially from first to last.
3259 If no keys are given and the command is bound to a key, then that key is used.
3263 flag disables key name lookup and processes the keys as literal UTF-8
3267 flag expects each key to be a hexadecimal number for an ASCII character.
3271 flag causes the terminal state to be reset.
3274 passes through a mouse event (only valid if bound to a mouse key binding, see
3275 .Sx MOUSE SUPPORT ) .
3278 is used to send a command into copy mode - see
3280 .Sx WINDOWS AND PANES
3283 specifies a repeat count and
3285 expands formats in arguments where appropriate.
3286 .It Xo Ic send-prefix
3288 .Op Fl t Ar target-pane
3290 Send the prefix key, or with
3292 the secondary prefix key, to a window as if it was pressed.
3294 .It Xo Ic unbind-key
3296 .Op Fl T Ar key-table
3299 .D1 Pq alias: Ic unbind
3300 Unbind the command bound to
3309 is present, all key bindings are removed.
3312 option prevents errors being returned.
3315 The appearance and behaviour of
3317 may be modified by changing the value of various options.
3318 There are four types of option:
3319 .Em server options ,
3320 .Em session options ,
3321 .Em window options ,
3327 server has a set of global server options which do not apply to any particular
3328 window or session or pane.
3329 These are altered with the
3332 command, or displayed with the
3337 In addition, each individual session may have a set of session options, and
3338 there is a separate set of global session options.
3339 Sessions which do not have a particular option configured inherit the value
3340 from the global session options.
3341 Session options are set or unset with the
3343 command and may be listed with the
3346 The available server and session options are listed under the
3350 Similarly, a set of window options is attached to each window and a set of pane
3351 options to each pane.
3352 Pane options inherit from window options.
3353 This means any pane option may be set as a window option to apply the option to
3354 all panes in the window without the option set, for example these commands will
3355 set the background colour to red for all panes except pane 0:
3356 .Bd -literal -offset indent
3357 set -w window-style bg=red
3358 set -pt:.0 window-style bg=blue
3361 There is also a set of global window options from which any unset window or
3362 pane options are inherited.
3363 Window and pane options are altered with
3368 commands and displayed with
3375 also supports user options which are prefixed with a
3377 User options may have any name, so long as they are prefixed with
3379 and be set to any string.
3381 .Bd -literal -offset indent
3382 $ tmux set -wq @foo "abc123"
3383 $ tmux show -wv @foo
3387 Commands which set options are as follows:
3390 .It Xo Ic set-option
3392 .Op Fl t Ar target-pane
3395 .D1 Pq alias: Ic set
3396 Set a pane option with
3398 a window option with
3400 a server option with
3402 otherwise a session option.
3403 If the option is not a user option,
3407 may be unnecessary -
3409 will infer the type from the option name, assuming
3414 is given, the global session or window option is set.
3417 expands formats in the option value.
3420 flag unsets an option, so a session inherits the option from the global
3423 restores a global option to the default).
3425 unsets an option (like
3427 but if the option is a pane option also unsets the option on any panes in the
3430 depends on the option and may be a number, a string, or a flag (on, off, or
3435 flag prevents setting an option that is already set and the
3437 flag suppresses errors about unknown or ambiguous options.
3441 and if the option expects a string or a style,
3443 is appended to the existing setting.
3445 .Bd -literal -offset indent
3446 set -g status-left "foo"
3447 set -ag status-left "bar"
3453 .Bd -literal -offset indent
3454 set -g status-style "bg=red"
3455 set -ag status-style "fg=blue"
3458 Will result in a red background
3463 the result would be the default background and a blue foreground.
3465 .It Xo Ic show-options
3467 .Op Fl t Ar target-pane
3470 .D1 Pq alias: Ic show
3471 Show the pane options (or a single option if
3475 the window options with
3477 the server options with
3479 otherwise the session options.
3480 If the option is not a user option,
3484 may be unnecessary -
3486 will infer the type from the option name, assuming
3489 Global session or window options are listed if
3493 shows only the option value, not the name.
3496 is set, no error will be returned if
3500 includes hooks (omitted by default).
3502 includes options inherited from a parent set of options, such options are
3503 marked with an asterisk.
3506 Available server options are:
3508 .It Ic backspace Ar key
3512 .It Ic buffer-limit Ar number
3513 Set the number of buffers; as new buffers are added to the top of the stack,
3514 old ones are removed from the bottom if necessary to maintain this maximum
3516 .It Xo Ic command-alias[]
3519 This is an array of custom aliases for commands.
3520 If an unknown command matches
3526 .Dl set -s command-alias[100] zoom='resize-pane -Z'
3534 .Dl resize-pane -Z -t:.1
3536 Note that aliases are expanded when a command is parsed rather than when it is
3537 executed, so binding an alias with
3539 will bind the expanded form.
3540 .It Ic default-terminal Ar terminal
3541 Set the default terminal for new windows created in this session - the
3542 default value of the
3544 environment variable.
3547 to work correctly, this
3552 or a derivative of them.
3553 .It Ic copy-command Ar shell-command
3554 Give the command to pipe to if the
3556 copy mode command is used without arguments.
3557 .It Ic escape-time Ar time
3558 Set the time in milliseconds for which
3560 waits after an escape is input to determine if it is part of a function or meta
3562 The default is 500 milliseconds.
3563 .It Ic editor Ar shell-command
3564 Set the command used when
3567 .It Xo Ic exit-empty
3570 If enabled (the default), the server will exit when there are no active
3572 .It Xo Ic exit-unattached
3575 If enabled, the server will exit when there are no attached clients.
3576 .It Xo Ic extended-keys
3577 .Op Ic on | off | always
3583 the escape sequence to enable extended keys is sent to the terminal, if
3585 knows that it is supported.
3587 always recognises extended keys itself.
3591 will only forward extended keys to applications when they request them; if
3594 will always forward the keys.
3595 .It Xo Ic focus-events
3598 When enabled, focus events are requested from the terminal if supported and
3599 passed through to applications running in
3601 Attached clients should be detached and attached again after changing this
3603 .It Ic history-file Ar path
3604 If not empty, a file to which
3606 will write command prompt history on exit and load it from on start.
3607 .It Ic message-limit Ar number
3608 Set the number of error or information messages to save in the message log for
3610 .It Ic prompt-history-limit Ar number
3611 Set the number of history items to save in the history file for each type of
3613 .It Xo Ic set-clipboard
3614 .Op Ic on | external | off
3616 Attempt to set the terminal clipboard content using the
3618 escape sequence, if there is an
3622 description (see the
3623 .Sx TERMINFO EXTENSIONS
3629 will both accept the escape sequence to create a buffer and attempt to set
3630 the terminal clipboard.
3634 will attempt to set the terminal clipboard but ignore attempts
3635 by applications to set
3641 will neither accept the clipboard escape sequence nor attempt to set the
3644 Note that this feature needs to be enabled in
3646 by setting the resource:
3647 .Bd -literal -offset indent
3648 disallowedWindowOps: 20,21,SetXprop
3651 Or changing this property from the
3653 interactive menu when required.
3654 .It Ic terminal-features[] Ar string
3655 Set terminal features for terminal types read from
3658 has a set of named terminal features.
3659 Each will apply appropriate changes to the
3664 can detect features for a few common terminals; this option can be used to
3665 easily tell tmux about features supported by terminals it cannot detect.
3667 .Ic terminal-overrides
3668 option allows individual
3670 capabilities to be set instead,
3671 .Ic terminal-features
3672 is intended for classes of functionality supported in a standard way but not
3675 Care must be taken to configure this only with features the terminal actually
3678 This is an array option where each entry is a colon-separated string made up
3679 of a terminal type pattern (matched using
3681 followed by a list of terminal features.
3682 The available features are:
3685 Supports 256 colours with the SGR escape sequences.
3687 Allows setting the system clipboard.
3689 Allows setting the cursor colour.
3691 Allows setting the cursor style.
3693 Supports extended keys.
3695 Supports focus reporting.
3697 Supports OSC 8 hyperlinks.
3699 Ignore function keys from
3705 Supports DECSLRM margins.
3711 Supports the OSC 7 working directory extension.
3713 Supports the overline SGR attribute.
3715 Supports the DECFRA rectangle fill escape sequence.
3717 Supports RGB colour with the SGR escape sequences.
3719 Supports SIXEL graphics.
3721 Supports the strikethrough SGR escape sequence.
3723 Supports synchronized updates.
3729 Allows underscore style and colour to be set.
3731 .It Ic terminal-overrides[] Ar string
3732 Allow terminal descriptions read using
3735 Each entry is a colon-separated string made up of a terminal type pattern
3742 For example, to set the
3747 for all terminal types matching
3750 .Dl "rxvt*:clear=\ee[H\ee[2J"
3752 The terminal entry value is passed through
3754 before interpretation.
3755 .It Ic user-keys[] Ar key
3756 Set list of user-defined key escape sequences.
3757 Each item is associated with a key named
3763 .Bd -literal -offset indent
3764 set -s user-keys[0] "\ee[5;30012~"
3765 bind User0 resize-pane -L 3
3769 Available session options are:
3771 .It Xo Ic activity-action
3772 .Op Ic any | none | current | other
3774 Set action on window activity when
3775 .Ic monitor-activity
3778 means activity in any window linked to a session causes a bell or message
3780 .Ic visual-activity )
3781 in the current window of that session,
3783 means all activity is ignored (equivalent to
3784 .Ic monitor-activity
3787 means only activity in windows other than the current window are ignored and
3789 means activity in the current window is ignored but not those in other windows.
3790 .It Ic assume-paste-time Ar milliseconds
3791 If keys are entered faster than one in
3793 they are assumed to have been pasted rather than typed and
3795 key bindings are not processed.
3796 The default is one millisecond and zero disables.
3797 .It Ic base-index Ar index
3798 Set the base index from which an unused index should be searched when a new
3800 The default is zero.
3801 .It Xo Ic bell-action
3802 .Op Ic any | none | current | other
3804 Set action on a bell in a window when
3807 The values are the same as those for
3808 .Ic activity-action .
3809 .It Ic default-command Ar shell-command
3810 Set the command used for new windows (if not specified when the window is
3816 The default is an empty string, which instructs
3818 to create a login shell using the value of the
3821 .It Ic default-shell Ar path
3822 Specify the default shell.
3823 This is used as the login shell for new windows when the
3825 option is set to empty, and must be the full path of the executable.
3828 tries to set a default value from the first suitable of the
3830 environment variable, the shell returned by
3834 This option should be configured when
3836 is used as a login shell.
3837 .It Ic default-size Ar XxY
3838 Set the default size of new windows when the
3840 option is set to manual or when a session is created with
3843 The value is the width and height separated by an
3846 The default is 80x24.
3847 .It Xo Ic destroy-unattached
3850 If enabled and the session is no longer attached to any clients, it is
3852 .It Xo Ic detach-on-destroy
3853 .Op Ic off | on | no-detached
3855 If on (the default), the client is detached when the session it is attached to
3857 If off, the client is switched to the most recently active of the remaining
3861 the client is detached only if there are no detached sessions; if detached
3862 sessions exist, the client is switched to the most recently active.
3863 .It Ic display-panes-active-colour Ar colour
3864 Set the colour used by the
3866 command to show the indicator for the active pane.
3867 .It Ic display-panes-colour Ar colour
3868 Set the colour used by the
3870 command to show the indicators for inactive panes.
3871 .It Ic display-panes-time Ar time
3872 Set the time in milliseconds for which the indicators shown by the
3875 .It Ic display-time Ar time
3876 Set the amount of time for which status line messages and other on-screen
3877 indicators are displayed.
3878 If set to 0, messages and indicators are displayed until a key is pressed.
3881 .It Ic history-limit Ar lines
3882 Set the maximum number of lines held in window history.
3883 This setting applies only to new windows - existing window histories are not
3884 resized and retain the limit at the point they were created.
3885 .It Ic key-table Ar key-table
3886 Set the default key table to
3890 .It Ic lock-after-time Ar number
3891 Lock the session (like the
3895 seconds of inactivity.
3896 The default is not to lock (set to 0).
3897 .It Ic lock-command Ar shell-command
3898 Command to run when locking each client.
3899 The default is to run
3903 .It Ic message-command-style Ar style
3904 Set status line message command style.
3905 This is used for the command prompt with
3907 keys when in command mode.
3913 .It Xo Ic message-line
3914 .Op Ic 0 | 1 | 2 | 3 | 4
3916 Set line on which status line messages and the command prompt are shown.
3917 .It Ic message-style Ar style
3918 Set status line message style.
3919 This is used for messages and for the command prompt.
3930 captures the mouse and allows mouse events to be bound as key bindings.
3933 section for details.
3934 .It Ic prefix Ar key
3935 Set the key accepted as a prefix key.
3936 In addition to the standard keys described under
3939 can be set to the special key
3942 .It Ic prefix2 Ar key
3943 Set a secondary key accepted as a prefix key.
3949 .It Xo Ic renumber-windows
3952 If on, when a window is closed in a session, automatically renumber the other
3953 windows in numerical order.
3956 option if it has been set.
3957 If off, do not renumber the windows.
3958 .It Ic repeat-time Ar time
3959 Allow multiple commands to be entered without pressing the prefix-key again
3962 milliseconds (the default is 500).
3963 Whether a key repeats may be set when it is bound using the
3967 Repeat is enabled for the default keys bound to the
3970 .It Xo Ic set-titles
3973 Attempt to set the client terminal title using the
3978 entries if they exist.
3980 automatically sets these to the \ee]0;...\e007 sequence if
3981 the terminal appears to be
3983 This option is off by default.
3984 .It Ic set-titles-string Ar string
3985 String used to set the client terminal title if
3988 Formats are expanded, see the
3991 .It Xo Ic silence-action
3992 .Op Ic any | none | current | other
3994 Set action on window silence when
3997 The values are the same as those for
3998 .Ic activity-action .
4000 .Op Ic off | on | 2 | 3 | 4 | 5
4002 Show or hide the status line or specify its size.
4005 gives a status line one row in height;
4012 .It Ic status-format[] Ar format
4013 Specify the format to be used for each line of the status line.
4014 The default builds the top status line from the various individual status
4016 .It Ic status-interval Ar interval
4017 Update the status line every
4020 By default, updates will occur every 15 seconds.
4021 A setting of zero disables redrawing at interval.
4022 .It Xo Ic status-justify
4023 .Op Ic left | centre | right | absolute-centre
4025 Set the position of the window list in the status line: left, centre or right.
4026 centre puts the window list in the relative centre of the available free space;
4027 absolute-centre uses the centre of the entire horizontal space.
4028 .It Xo Ic status-keys
4031 Use vi or emacs-style
4032 key bindings in the status line, for example at the command prompt.
4033 The default is emacs, unless the
4037 environment variables are set and contain the string
4039 .It Ic status-left Ar string
4042 (by default the session name) to the left of the status line.
4044 will be passed through
4052 For details on how the names and titles can be set see the
4053 .Sx "NAMES AND TITLES"
4057 .Bd -literal -offset indent
4058 #(sysctl vm.loadavg)
4059 #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
4064 .It Ic status-left-length Ar length
4067 of the left component of the status line.
4069 .It Ic status-left-style Ar style
4070 Set the style of the left part of the status line.
4076 .It Xo Ic status-position
4079 Set the position of the status line.
4080 .It Ic status-right Ar string
4083 to the right of the status line.
4084 By default, the current pane title in double quotes, the date and the time
4091 and character pairs are replaced.
4092 .It Ic status-right-length Ar length
4095 of the right component of the status line.
4097 .It Ic status-right-style Ar style
4098 Set the style of the right part of the status line.
4104 .It Ic status-style Ar style
4105 Set status line style.
4111 .It Ic update-environment[] Ar variable
4112 Set list of environment variables to be copied into the session environment
4113 when a new session is created or an existing session is attached.
4114 Any variables that do not exist in the source environment are set to be
4115 removed from the session environment (as if
4120 .It Xo Ic visual-activity
4121 .Op Ic on | off | both
4123 If on, display a message instead of sending a bell when activity occurs in a
4124 window for which the
4125 .Ic monitor-activity
4126 window option is enabled.
4127 If set to both, a bell and a message are produced.
4128 .It Xo Ic visual-bell
4129 .Op Ic on | off | both
4131 If on, a message is shown on a bell in a window for which the
4133 window option is enabled instead of it being passed through to the
4134 terminal (which normally makes a sound).
4135 If set to both, a bell and a message are produced.
4139 .It Xo Ic visual-silence
4140 .Op Ic on | off | both
4144 is enabled, prints a message after the interval has expired on a given window
4145 instead of sending a bell.
4146 If set to both, a bell and a message are produced.
4147 .It Ic word-separators Ar string
4148 Sets the session's conception of what characters are considered word
4149 separators, for the purposes of the next and previous word commands in
4153 Available window options are:
4155 .Bl -tag -width Ds -compact
4156 .It Xo Ic aggressive-resize
4159 Aggressively resize the chosen window.
4162 will resize the window to the size of the smallest or largest session
4165 option) for which it is the current window, rather than the session to
4166 which it is attached.
4167 The window may resize when the current window is changed on another
4168 session; this option is good for full-screen programs which support
4170 and poor for interactive programs such as shells.
4172 .It Xo Ic automatic-rename
4175 Control automatic window renaming.
4176 When this setting is enabled,
4178 will rename the window automatically using the format specified by
4179 .Ic automatic-rename-format .
4180 This flag is automatically disabled for an individual window when a name
4181 is specified at creation with
4187 or with a terminal escape sequence.
4188 It may be switched off globally with:
4189 .Bd -literal -offset indent
4190 set-option -wg automatic-rename off
4193 .It Ic automatic-rename-format Ar format
4197 .Ic automatic-rename
4200 .It Ic clock-mode-colour Ar colour
4203 .It Xo Ic clock-mode-style
4206 Set clock hour format.
4208 .It Ic fill-character Ar character
4209 Set the character used to fill areas of the terminal unused by a window.
4211 .It Ic main-pane-height Ar height
4212 .It Ic main-pane-width Ar width
4213 Set the width or height of the main (left or top) pane in the
4220 this is a percentage of the window size.
4222 .It Ic copy-mode-match-style Ar style
4223 Set the style of search matches in copy mode.
4230 .It Ic copy-mode-mark-style Ar style
4231 Set the style of the line containing the mark in copy mode.
4238 .It Ic copy-mode-current-match-style Ar style
4239 Set the style of the current search match in copy mode.
4249 Use vi or emacs-style key bindings in copy mode.
4250 The default is emacs, unless
4257 .It Ic mode-style Ar style
4258 Set window modes style.
4265 .It Xo Ic monitor-activity
4268 Monitor for activity in the window.
4269 Windows with activity are highlighted in the status line.
4271 .It Xo Ic monitor-bell
4274 Monitor for a bell in the window.
4275 Windows with a bell are highlighted in the status line.
4277 .It Xo Ic monitor-silence
4280 Monitor for silence (no activity) in the window within
4283 Windows that have been silent for the interval are highlighted in the
4285 An interval of zero disables the monitoring.
4287 .It Ic other-pane-height Ar height
4288 Set the height of the other panes (not the main pane) in the
4291 If this option is set to 0 (the default), it will have no effect.
4293 .Ic main-pane-height
4295 .Ic other-pane-height
4296 options are set, the main pane will grow taller to make the other panes the
4297 specified height, but will never shrink to do so.
4300 this is a percentage of the window size.
4302 .It Ic other-pane-width Ar width
4304 .Ic other-pane-height ,
4305 but set the width of other panes in the
4309 .It Ic pane-active-border-style Ar style
4310 Set the pane border style for the currently active pane.
4316 Attributes are ignored.
4318 .It Ic pane-base-index Ar index
4321 but set the starting index for pane numbers.
4323 .It Ic pane-border-format Ar format
4324 Set the text shown in pane border status lines.
4326 .It Xo Ic pane-border-indicators
4327 .Op Ic off | colour | arrows | both
4329 Indicate active pane by colouring only half of the border in windows with
4330 exactly two panes, by displaying arrow markers, by drawing both or neither.
4332 .It Ic pane-border-lines Ar type
4333 Set the type of characters used for drawing pane borders.
4338 single lines using ACS or UTF-8 characters
4340 double lines using UTF-8 characters
4342 heavy lines using UTF-8 characters
4344 simple ASCII characters
4352 will fall back to standard ACS line drawing when UTF-8 is not supported.
4354 .It Xo Ic pane-border-status
4355 .Op Ic off | top | bottom
4357 Turn pane border status lines off or set their position.
4359 .It Ic pane-border-style Ar style
4360 Set the pane border style for panes aside from the active pane.
4366 Attributes are ignored.
4368 .It Ic popup-style Ar style
4369 Set the popup style.
4375 Attributes are ignored.
4377 .It Ic popup-border-style Ar style
4378 Set the popup border style.
4384 Attributes are ignored.
4386 .It Ic popup-border-lines Ar type
4387 Set the type of characters used for drawing popup borders.
4392 single lines using ACS or UTF-8 characters (default)
4394 variation of single with rounded corners using UTF-8 characters
4396 double lines using UTF-8 characters
4398 heavy lines using UTF-8 characters
4400 simple ASCII characters
4402 simple ASCII space character
4410 will fall back to standard ACS line drawing when UTF-8 is not supported.
4412 .It Ic window-status-activity-style Ar style
4413 Set status line style for windows with an activity alert.
4420 .It Ic window-status-bell-style Ar style
4421 Set status line style for windows with a bell alert.
4428 .It Ic window-status-current-format Ar string
4430 .Ar window-status-format ,
4431 but is the format used when the window is the current window.
4433 .It Ic window-status-current-style Ar style
4434 Set status line style for the currently active window.
4441 .It Ic window-status-format Ar string
4442 Set the format in which the window is displayed in the status line window list.
4449 .It Ic window-status-last-style Ar style
4450 Set status line style for the last active window.
4457 .It Ic window-status-separator Ar string
4458 Sets the separator drawn between windows in the status line.
4459 The default is a single space character.
4461 .It Ic window-status-style Ar style
4462 Set status line style for a single window.
4469 .It Xo Ic window-size
4470 .Ar largest | Ar smallest | Ar manual | Ar latest
4474 determines the window size.
4477 the size of the largest attached session is used; if
4479 the size of the smallest.
4482 the size of a new window is set from the
4484 option and windows are resized automatically.
4488 uses the size of the client that had the most recent activity.
4492 .Ic aggressive-resize
4495 .It Xo Ic wrap-search
4498 If this option is set, searches will wrap around the end of the pane contents.
4502 Available pane options are:
4504 .Bl -tag -width Ds -compact
4505 .It Xo Ic allow-passthrough
4506 .Op Ic on | off | all
4508 Allow programs in the pane to bypass
4510 using a terminal escape sequence (\eePtmux;...\ee\e\e).
4513 passthrough sequences will be allowed only if the pane is visible.
4516 they will be allowed even if the pane is invisible.
4518 .It Xo Ic allow-rename
4521 Allow programs in the pane to change the window name using a terminal escape
4522 sequence (\eek...\ee\e\e).
4524 .It Xo Ic alternate-screen
4527 This option configures whether programs running inside the pane may use the
4528 terminal alternate screen feature, which allows the
4534 The alternate screen feature preserves the contents of the window when an
4535 interactive application starts and restores it on exit, so that any output
4536 visible before the application starts reappears unchanged after it exits.
4538 .It Ic cursor-colour Ar colour
4539 Set the colour of the cursor.
4541 .It Ic pane-colours[] Ar colour
4542 The default colour palette.
4543 Each entry in the array defines the colour
4545 uses when the colour with that index is requested.
4546 The index may be from zero to 255.
4548 .It Ic cursor-style Ar style
4549 Set the style of the cursor.
4550 Available styles are:
4552 .Ic blinking-block ,
4554 .Ic blinking-underline ,
4559 .It Xo Ic remain-on-exit
4560 .Op Ic on | off | failed
4562 A pane with this flag set is not destroyed when the program running in it
4566 then only when the program exit status is not zero.
4567 The pane may be reactivated with the
4571 .It Ic remain-on-exit-format Ar string
4572 Set the text shown at the bottom of exited panes when
4576 .It Xo Ic scroll-on-clear
4579 When the entire screen is cleared and this option is on, scroll the contents of
4580 the screen into history before clearing it.
4582 .It Xo Ic synchronize-panes
4585 Duplicate input to all other panes in the same window where this option is also
4586 on (only for panes that are not in any mode).
4588 .It Ic window-active-style Ar style
4589 Set the pane style when it is the active pane.
4596 .It Ic window-style Ar style
4606 allows commands to run on various triggers, called
4612 hook and there are a number of hooks not associated with commands.
4614 Hooks are stored as array options, members of the array are executed in
4615 order when the hook is triggered.
4616 Like options different hooks may be global or belong to a session, window or
4618 Hooks may be configured with the
4622 commands and displayed with
4627 The following two commands are equivalent:
4628 .Bd -literal -offset indent.
4629 set-hook -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4630 set-option -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4633 Setting a hook without specifying an array index clears the hook and sets the
4634 first member of the array.
4637 hook is run after it completes, except when the command is run as part of a hook
4639 They are named with an
4642 For example, the following command adds a hook to select the even-vertical
4645 .Bd -literal -offset indent
4646 set-hook -g after-split-window "selectl even-vertical"
4649 All the notifications listed in the
4651 section are hooks (without any arguments), except
4653 The following additional hooks are available:
4654 .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXX"
4656 Run when a window has activity.
4658 .Ic monitor-activity .
4660 Run when a window has received a bell.
4664 Run when a window has been silent.
4666 .Ic monitor-silence .
4668 Run when a client becomes the latest active client of its session.
4670 Run when a client is attached.
4672 Run when a client is detached
4674 Run when focus enters a client
4675 .It client-focus-out
4676 Run when focus exits a client
4678 Run when a client is resized.
4679 .It client-session-changed
4680 Run when a client's attached session is changed.
4682 Run when the program running in a pane exits, but
4684 is on so the pane has not closed.
4686 Run when the program running in a pane exits.
4688 Run when the focus enters a pane, if the
4692 Run when the focus exits a pane, if the
4695 .It pane-set-clipboard
4696 Run when the terminal clipboard is set using the
4700 Run when a new session created.
4702 Run when a session closed.
4704 Run when a session is renamed.
4706 Run when a window is linked into a session.
4708 Run when a window is renamed.
4710 Run when a window is resized.
4711 This may be after the
4715 Run when a window is unlinked from a session.
4718 Hooks are managed with these commands:
4722 .Op Fl t Ar target-pane
4734 The flags are the same as for
4742 .It Xo Ic show-hooks
4744 .Op Fl t Ar target-pane
4747 The flags are the same as for
4753 option is on (the default is off),
4755 allows mouse events to be bound as keys.
4756 The name of each key is made up of a mouse event (such as
4758 and a location suffix, one of the following:
4759 .Bl -column "XXXXXXXXXXXXX" -offset indent
4760 .It Li "Pane" Ta "the contents of a pane"
4761 .It Li "Border" Ta "a pane border"
4762 .It Li "Status" Ta "the status line window list"
4763 .It Li "StatusLeft" Ta "the left part of the status line"
4764 .It Li "StatusRight" Ta "the right part of the status line"
4765 .It Li "StatusDefault" Ta "any other part of the status line"
4768 The following mouse events are available:
4769 .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
4770 .It Li "WheelUp" Ta "WheelDown" Ta ""
4771 .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
4772 .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
4773 .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
4774 .It Li "SecondClick1" Ta "SecondClick2" Ta "SecondClick3"
4775 .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3"
4776 .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3"
4781 events are fired for the second click of a double click, even if there may be a
4782 third click which will fire
4787 Each should be suffixed with a location, for example
4788 .Ql MouseDown1Status .
4798 in commands bound to mouse key bindings.
4799 It resolves to the window or pane over which the mouse event took place
4800 (for example, the window in the status line over which button 1 was released
4803 binding, or the pane over which the wheel was scrolled for a
4810 flag may be used to forward a mouse event to a pane.
4812 The default key bindings allow the mouse to be used to select and resize panes,
4813 to copy text and to change window using the status line.
4814 These take effect if the
4816 option is turned on.
4818 Certain commands accept the
4823 This is a string which controls the output format of the command.
4824 Format variables are enclosed in
4829 .Ql #{session_name} .
4830 The possible variables are listed in the table below, or the name of a
4832 option may be used for an option's value.
4833 Some variables have a shorter alias such as
4836 is replaced by a single
4846 Conditionals are available by prefixing with
4848 and separating two alternatives with a comma;
4849 if the specified variable exists and is not zero, the first alternative
4850 is chosen, otherwise the second is used.
4852 .Ql #{?session_attached,attached,not attached}
4853 will include the string
4855 if the session is attached and the string
4857 if it is unattached, or
4858 .Ql #{?automatic-rename,yes,no}
4862 .Ic automatic-rename
4866 Conditionals can be nested arbitrarily.
4867 Inside a conditional,
4875 unless they are part of a
4879 .Bd -literal -offset indent
4880 #{?pane_in_mode,#[fg=white#,bg=red],#[fg=red#,bg=white]}#W .
4883 String comparisons may be expressed by prefixing two comma-separated
4894 .Ql #{==:#{host},myhost}
4904 evaluate to true if either or both of two comma-separated alternatives are
4906 .Ql #{||:#{pane_in_mode},#{alternate_on}} .
4912 or regular expression comparison.
4913 The first argument is the pattern and the second the string to compare.
4914 An optional argument specifies flags:
4916 means the pattern is a regular expression instead of the default
4920 means to ignore case.
4922 .Ql #{m:*foo*,#{host}}
4924 .Ql #{m/ri:^A,MYVAR} .
4927 performs a search for an
4929 pattern or regular expression in the pane content and evaluates to zero if not
4930 found, or a line number if found.
4935 flag means search for a regular expression and
4941 Numeric operators may be performed by prefixing two comma-separated alternatives
4947 flag may be given after the operator to use floating point numbers, otherwise
4949 This may be followed by a number giving the number of decimal places to use for
4951 The available operators are:
4968 in formats which are also expanded by
4970 and numeric comparison operators
4979 .Ql #{e|*|f|4:5.5,3}
4980 multiplies 5.5 by 3 for a result with four decimal places and
4982 returns the modulus of 7 and 3.
4984 replaces a numeric argument by its ASCII equivalent, so
4991 colour by its six-digit hexadecimal RGB value.
4993 A limit may be placed on the length of the resultant string by prefixing it
4996 a number and a colon.
4997 Positive numbers count from the start of the string and negative from the end,
4999 .Ql #{=5:pane_title}
5000 will include at most the first five characters of the pane title, or
5001 .Ql #{=-5:pane_title}
5002 the last five characters.
5003 A suffix or prefix may be given as a second argument - if provided then it is
5004 appended or prepended to the string if the length has been trimmed, for example
5005 .Ql #{=/5/...:pane_title}
5008 if the pane title is more than five characters.
5011 pads the string to a given width, for example
5012 .Ql #{p10:pane_title}
5013 will result in a width of at least 10 characters.
5014 A positive width pads on the left, a negative on the right.
5016 expands to the length of the variable and
5018 to its width when displayed, for example
5019 .Ql #{n:window_name} .
5021 Prefixing a time variable with
5023 will convert it to a string, so if
5024 .Ql #{window_activity}
5027 .Ql #{t:window_activity}
5029 .Ql Sun Oct 25 09:25:02 2015 .
5033 will use shorter but less accurate time format for times in the past.
5034 A custom format may be given using an
5040 if the format is separately being passed through
5045 .Ql #{t/f/%%H#:%%M:window_activity} ,
5057 of the variable respectively.
5061 special characters or with a
5063 suffix, escape hash characters (so
5068 will expand the format twice, for example
5069 .Ql #{E:status-left}
5070 is the result of expanding the content of the
5072 option rather than the option itself.
5084 will loop over each session, window, pane or client and insert the format once
5086 For windows and panes, two comma-separated formats may be given:
5087 the second is used for the current window or active pane.
5088 For example, to get a list of windows formatted like the status line:
5089 .Bd -literal -offset indent
5090 #{W:#{E:window-status-format} ,#{E:window-status-current-format} }
5094 checks if a window (without any suffix or with the
5096 suffix) or a session (with the
5098 suffix) name exists, for example
5100 is replaced with 1 if a window named
5104 A prefix of the form
5111 The first argument may be an extended regular expression and a final argument
5114 to ignore case, for example
5115 .Ql s/a(.)/\e1x/i:\&
5120 A different delimiter character may also be used, to avoid collisions with
5121 literal slashes in the pattern.
5130 In addition, the last line of a shell command's output may be inserted using
5134 will insert the system's uptime.
5135 When constructing formats,
5139 commands to finish; instead, the previous result from running the same command
5140 is used, or a placeholder if the command has not been run before.
5141 If the command hasn't exited, the most recent line of output will be used, but
5142 the status line will not be updated more than once a second.
5143 Commands are executed using
5147 global environment set (see the
5148 .Sx GLOBAL AND SESSION ENVIRONMENT
5153 specifies that a string should be interpreted literally and not expanded.
5155 .Ql #{l:#{?pane_in_mode,yes,no}}
5157 .Ql #{?pane_in_mode,yes,no} .
5159 The following variables are available, where appropriate:
5160 .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
5161 .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
5162 .It Li "active_window_index" Ta "" Ta "Index of active window in session"
5163 .It Li "alternate_on" Ta "" Ta "1 if pane is in alternate screen"
5164 .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
5165 .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
5166 .It Li "buffer_created" Ta "" Ta "Time buffer created"
5167 .It Li "buffer_name" Ta "" Ta "Name of buffer"
5168 .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
5169 .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
5170 .It Li "client_activity" Ta "" Ta "Time client last had activity"
5171 .It Li "client_cell_height" Ta "" Ta "Height of each client cell in pixels"
5172 .It Li "client_cell_width" Ta "" Ta "Width of each client cell in pixels"
5173 .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
5174 .It Li "client_created" Ta "" Ta "Time client created"
5175 .It Li "client_discarded" Ta "" Ta "Bytes discarded when client behind"
5176 .It Li "client_flags" Ta "" Ta "List of client flags"
5177 .It Li "client_height" Ta "" Ta "Height of client"
5178 .It Li "client_key_table" Ta "" Ta "Current key table"
5179 .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
5180 .It Li "client_name" Ta "" Ta "Name of client"
5181 .It Li "client_pid" Ta "" Ta "PID of client process"
5182 .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
5183 .It Li "client_readonly" Ta "" Ta "1 if client is read-only"
5184 .It Li "client_session" Ta "" Ta "Name of the client's session"
5185 .It Li "client_termfeatures" Ta "" Ta "Terminal features of client, if any"
5186 .It Li "client_termname" Ta "" Ta "Terminal name of client"
5187 .It Li "client_termtype" Ta "" Ta "Terminal type of client, if available"
5188 .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
5189 .It Li "client_uid" Ta "" Ta "UID of client process"
5190 .It Li "client_user" Ta "" Ta "User of client process"
5191 .It Li "client_utf8" Ta "" Ta "1 if client supports UTF-8"
5192 .It Li "client_width" Ta "" Ta "Width of client"
5193 .It Li "client_written" Ta "" Ta "Bytes written to client"
5194 .It Li "command" Ta "" Ta "Name of command in use, if any"
5195 .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
5196 .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
5197 .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
5198 .It Li "config_files" Ta "" Ta "List of configuration files loaded"
5199 .It Li "copy_cursor_line" Ta "" Ta "Line the cursor is on in copy mode"
5200 .It Li "copy_cursor_word" Ta "" Ta "Word under cursor in copy mode"
5201 .It Li "copy_cursor_x" Ta "" Ta "Cursor X position in copy mode"
5202 .It Li "copy_cursor_y" Ta "" Ta "Cursor Y position in copy mode"
5203 .It Li "current_file" Ta "" Ta "Current configuration file"
5204 .It Li "cursor_character" Ta "" Ta "Character at cursor in pane"
5205 .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
5206 .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
5207 .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
5208 .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
5209 .It Li "history_limit" Ta "" Ta "Maximum window history lines"
5210 .It Li "history_size" Ta "" Ta "Size of history in lines"
5211 .It Li "hook" Ta "" Ta "Name of running hook, if any"
5212 .It Li "hook_client" Ta "" Ta "Name of client where hook was run, if any"
5213 .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
5214 .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
5215 .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
5216 .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
5217 .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
5218 .It Li "host" Ta "#H" Ta "Hostname of local host"
5219 .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
5220 .It Li "insert_flag" Ta "" Ta "Pane insert flag"
5221 .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
5222 .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
5223 .It Li "last_window_index" Ta "" Ta "Index of last window in session"
5224 .It Li "line" Ta "" Ta "Line number in the list"
5225 .It Li "mouse_all_flag" Ta "" Ta "Pane mouse all flag"
5226 .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
5227 .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
5228 .It Li "mouse_hyperlink" Ta "" Ta "Hyperlink under mouse, if any"
5229 .It Li "mouse_line" Ta "" Ta "Line under mouse, if any"
5230 .It Li "mouse_sgr_flag" Ta "" Ta "Pane mouse SGR flag"
5231 .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
5232 .It Li "mouse_utf8_flag" Ta "" Ta "Pane mouse UTF-8 flag"
5233 .It Li "mouse_word" Ta "" Ta "Word under mouse, if any"
5234 .It Li "mouse_x" Ta "" Ta "Mouse X position, if any"
5235 .It Li "mouse_y" Ta "" Ta "Mouse Y position, if any"
5236 .It Li "next_session_id" Ta "" Ta "Unique session ID for next new session"
5237 .It Li "origin_flag" Ta "" Ta "Pane origin flag"
5238 .It Li "pane_active" Ta "" Ta "1 if active pane"
5239 .It Li "pane_at_bottom" Ta "" Ta "1 if pane is at the bottom of window"
5240 .It Li "pane_at_left" Ta "" Ta "1 if pane is at the left of window"
5241 .It Li "pane_at_right" Ta "" Ta "1 if pane is at the right of window"
5242 .It Li "pane_at_top" Ta "" Ta "1 if pane is at the top of window"
5243 .It Li "pane_bg" Ta "" Ta "Pane background colour"
5244 .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
5245 .It Li "pane_current_command" Ta "" Ta "Current command if available"
5246 .It Li "pane_current_path" Ta "" Ta "Current path if available"
5247 .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
5248 .It Li "pane_dead_signal" Ta "" Ta "Exit signal of process in dead pane"
5249 .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
5250 .It Li "pane_dead_time" Ta "" Ta "Exit time of process in dead pane"
5251 .It Li "pane_fg" Ta "" Ta "Pane foreground colour"
5252 .It Li "pane_format" Ta "" Ta "1 if format is for a pane"
5253 .It Li "pane_height" Ta "" Ta "Height of pane"
5254 .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
5255 .It Li "pane_in_mode" Ta "" Ta "1 if pane is in a mode"
5256 .It Li "pane_index" Ta "#P" Ta "Index of pane"
5257 .It Li "pane_input_off" Ta "" Ta "1 if input to pane is disabled"
5258 .It Li "pane_last" Ta "" Ta "1 if last pane"
5259 .It Li "pane_left" Ta "" Ta "Left of pane"
5260 .It Li "pane_marked" Ta "" Ta "1 if this is the marked pane"
5261 .It Li "pane_marked_set" Ta "" Ta "1 if a marked pane is set"
5262 .It Li "pane_mode" Ta "" Ta "Name of pane mode, if any"
5263 .It Li "pane_path" Ta "" Ta "Path of pane (can be set by application)"
5264 .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
5265 .It Li "pane_pipe" Ta "" Ta "1 if pane is being piped"
5266 .It Li "pane_right" Ta "" Ta "Right of pane"
5267 .It Li "pane_search_string" Ta "" Ta "Last search string in copy mode"
5268 .It Li "pane_start_command" Ta "" Ta "Command pane started with"
5269 .It Li "pane_start_path" Ta "" Ta "Path pane started with"
5270 .It Li "pane_synchronized" Ta "" Ta "1 if pane is synchronized"
5271 .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
5272 .It Li "pane_title" Ta "#T" Ta "Title of pane (can be set by application)"
5273 .It Li "pane_top" Ta "" Ta "Top of pane"
5274 .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
5275 .It Li "pane_unseen_changes" Ta "" Ta "1 if there were changes in pane while in mode"
5276 .It Li "pane_width" Ta "" Ta "Width of pane"
5277 .It Li "pid" Ta "" Ta "Server PID"
5278 .It Li "rectangle_toggle" Ta "" Ta "1 if rectangle selection is activated"
5279 .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
5280 .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
5281 .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
5282 .It Li "search_match" Ta "" Ta "Search match if any"
5283 .It Li "search_present" Ta "" Ta "1 if search started in copy mode"
5284 .It Li "selection_active" Ta "" Ta "1 if selection started and changes with the cursor in copy mode"
5285 .It Li "selection_end_x" Ta "" Ta "X position of the end of the selection"
5286 .It Li "selection_end_y" Ta "" Ta "Y position of the end of the selection"
5287 .It Li "selection_present" Ta "" Ta "1 if selection started in copy mode"
5288 .It Li "selection_start_x" Ta "" Ta "X position of the start of the selection"
5289 .It Li "selection_start_y" Ta "" Ta "Y position of the start of the selection"
5290 .It Li "server_sessions" Ta "" Ta "Number of sessions"
5291 .It Li "session_activity" Ta "" Ta "Time of session last activity"
5292 .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
5293 .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
5294 .It Li "session_attached_list" Ta "" Ta "List of clients session is attached to"
5295 .It Li "session_created" Ta "" Ta "Time session created"
5296 .It Li "session_format" Ta "" Ta "1 if format is for a session"
5297 .It Li "session_group" Ta "" Ta "Name of session group"
5298 .It Li "session_group_attached" Ta "" Ta "Number of clients sessions in group are attached to"
5299 .It Li "session_group_attached_list" Ta "" Ta "List of clients sessions in group are attached to"
5300 .It Li "session_group_list" Ta "" Ta "List of sessions in group"
5301 .It Li "session_group_many_attached" Ta "" Ta "1 if multiple clients attached to sessions in group"
5302 .It Li "session_group_size" Ta "" Ta "Size of session group"
5303 .It Li "session_grouped" Ta "" Ta "1 if session in a group"
5304 .It Li "session_id" Ta "" Ta "Unique session ID"
5305 .It Li "session_last_attached" Ta "" Ta "Time session last attached"
5306 .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
5307 .It Li "session_marked" Ta "" Ta "1 if this session contains the marked pane"
5308 .It Li "session_name" Ta "#S" Ta "Name of session"
5309 .It Li "session_path" Ta "" Ta "Working directory of session"
5310 .It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
5311 .It Li "session_windows" Ta "" Ta "Number of windows in session"
5312 .It Li "socket_path" Ta "" Ta "Server socket path"
5313 .It Li "start_time" Ta "" Ta "Server start time"
5314 .It Li "uid" Ta "" Ta "Server UID"
5315 .It Li "user" Ta "" Ta "Server user"
5316 .It Li "version" Ta "" Ta "Server version"
5317 .It Li "window_active" Ta "" Ta "1 if window active"
5318 .It Li "window_active_clients" Ta "" Ta "Number of clients viewing this window"
5319 .It Li "window_active_clients_list" Ta "" Ta "List of clients viewing this window"
5320 .It Li "window_active_sessions" Ta "" Ta "Number of sessions on which this window is active"
5321 .It Li "window_active_sessions_list" Ta "" Ta "List of sessions on which this window is active"
5322 .It Li "window_activity" Ta "" Ta "Time of window last activity"
5323 .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
5324 .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
5325 .It Li "window_bigger" Ta "" Ta "1 if window is larger than client"
5326 .It Li "window_cell_height" Ta "" Ta "Height of each cell in pixels"
5327 .It Li "window_cell_width" Ta "" Ta "Width of each cell in pixels"
5328 .It Li "window_end_flag" Ta "" Ta "1 if window has the highest index"
5329 .It Li "window_flags" Ta "#F" Ta "Window flags with # escaped as ##"
5330 .It Li "window_format" Ta "" Ta "1 if format is for a window"
5331 .It Li "window_height" Ta "" Ta "Height of window"
5332 .It Li "window_id" Ta "" Ta "Unique window ID"
5333 .It Li "window_index" Ta "#I" Ta "Index of window"
5334 .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
5335 .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
5336 .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
5337 .It Li "window_linked_sessions" Ta "" Ta "Number of sessions this window is linked to"
5338 .It Li "window_linked_sessions_list" Ta "" Ta "List of sessions this window is linked to"
5339 .It Li "window_marked_flag" Ta "" Ta "1 if window contains the marked pane"
5340 .It Li "window_name" Ta "#W" Ta "Name of window"
5341 .It Li "window_offset_x" Ta "" Ta "X offset into window if larger than client"
5342 .It Li "window_offset_y" Ta "" Ta "Y offset into window if larger than client"
5343 .It Li "window_panes" Ta "" Ta "Number of panes in window"
5344 .It Li "window_raw_flags" Ta "" Ta "Window flags with nothing escaped"
5345 .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
5346 .It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
5347 .It Li "window_start_flag" Ta "" Ta "1 if window has the lowest index"
5348 .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
5349 .It Li "window_width" Ta "" Ta "Width of window"
5350 .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
5351 .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
5355 offers various options to specify the colour and attributes of aspects of the
5356 interface, for example
5358 for the status line.
5359 In addition, embedded styles may be specified in format options, such as
5361 by enclosing them in
5366 A style may be the single term
5368 to specify the default style (which may come from an option, for example
5370 in the status line) or a space
5371 or comma separated list of the following:
5374 Set the foreground colour.
5375 The colour is one of:
5384 if supported the bright variants
5391 from the 256-colour set;
5393 for the default colour;
5395 for the terminal default colour; or a hexadecimal RGB string such as
5398 Set the background colour.
5400 Set the underscore colour.
5402 Set no attributes (turn off any active attributes).
5415 .Ic double-underscore ,
5416 .Ic curly-underscore ,
5417 .Ic dotted-underscore ,
5418 .Ic dashed-underscore
5421 Any of the attributes may be prefixed with
5425 is the terminal alternate character set.
5426 .It Xo Ic align=left
5432 Align text to the left, centre or right of the available space if appropriate.
5434 Fill the available space with a background colour if appropriate.
5437 .Ic list=left-marker ,
5438 .Ic list=right-marker ,
5441 Mark the position of the various window list components in the
5445 marks the start of the list;
5447 is the part of the list that should be kept in focus if the entire list won't
5448 fit in the available space (typically the current window);
5449 .Ic list=left-marker
5451 .Ic list=right-marker
5452 mark the text to be used to mark that text has been trimmed from the left or
5453 right of the list if there is not enough space.
5454 .It Xo Ic push-default ,
5457 Store the current colours and attributes as the default or reset to the previous
5461 affects any subsequent use of the
5465 Only one default may be pushed (each
5467 replaces the previous saved default).
5468 .It Xo Ic range=left ,
5470 .Ic range=window|X ,
5479 are the text used for the
5485 is the range for a window passed to the
5493 .Bd -literal -offset indent
5494 fg=yellow bold underscore blink
5495 bg=black,fg=default,noreverse
5497 .Sh NAMES AND TITLES
5499 distinguishes between names and titles.
5500 Windows and sessions have names, which may be used to specify them in targets
5501 and are displayed in the status line and various lists: the name is the
5503 identifier for a window or session.
5504 Only panes have titles.
5505 A pane's title is typically set by the program running inside the pane using
5506 an escape sequence (like it would set the
5510 Windows themselves do not have titles - a window's title is the title of its
5513 itself may set the title of the terminal in which the client is running, see
5518 A session's name is set with the
5523 A window's name is set with one of:
5526 A command argument (such as
5533 An escape sequence (if the
5535 option is turned on):
5536 .Bd -literal -offset indent
5537 $ printf '\e033kWINDOW_NAME\e033\e\e'
5540 Automatic renaming, which sets the name to the active command in the window's
5543 .Ic automatic-rename
5547 When a pane is first created, its title is the hostname.
5548 A pane's title can be set via the title setting escape sequence, for example:
5549 .Bd -literal -offset indent
5550 $ printf '\e033]2;My Title\e033\e\e'
5553 It can also be modified with the
5557 .Sh GLOBAL AND SESSION ENVIRONMENT
5558 When the server is started,
5560 copies the environment into the
5561 .Em global environment ;
5562 in addition, each session has a
5563 .Em session environment .
5564 When a window is created, the session and global environments are merged.
5565 If a variable exists in both, the value from the session environment is used.
5566 The result is the initial environment passed to the new process.
5569 .Ic update-environment
5570 session option may be used to update the session environment from the client
5571 when a new session is created or an old reattached.
5573 also initialises the
5575 variable with some internal information to allow commands to be executed
5576 from inside, and the
5578 variable with the correct terminal setting of
5581 Variables in both session and global environments may be marked as hidden.
5582 Hidden variables are not passed into the environment of new processes and
5583 instead can only be used by tmux itself (for example in formats, see the
5587 Commands to alter and view the environment are:
5590 .It Xo Ic set-environment
5592 .Op Fl t Ar target-session
5593 .Ar name Op Ar value
5595 .D1 Pq alias: Ic setenv
5596 Set or unset an environment variable.
5599 is used, the change is made in the global environment; otherwise, it is applied
5600 to the session environment for
5601 .Ar target-session .
5606 is expanded as a format.
5609 flag unsets a variable.
5611 indicates the variable is to be removed from the environment before starting a
5614 marks the variable as hidden.
5616 .It Xo Ic show-environment
5618 .Op Fl t Ar target-session
5621 .D1 Pq alias: Ic showenv
5622 Display the environment for
5624 or the global environment with
5628 is omitted, all variables are shown.
5629 Variables removed from the environment are prefixed with
5633 is used, the output is formatted as a set of Bourne shell commands.
5635 shows hidden variables (omitted by default).
5639 includes an optional status line which is displayed in the bottom line of each
5642 By default, the status line is enabled and one line in height (it may be
5643 disabled or made multiple lines with the
5645 session option) and contains, from left-to-right: the name of the current
5646 session in square brackets; the window list; the title of the active pane
5647 in double quotes; and the time and date.
5649 Each line of the status line is configured with the
5652 The default is made of three parts: configurable left and right sections (which
5653 may contain dynamic content such as the time or output from a shell command,
5656 .Ic status-left-length ,
5659 .Ic status-right-length
5660 options below), and a central window list.
5661 By default, the window list shows the index, name and (if any) flag of the
5662 windows present in the current session in ascending numerical order.
5663 It may be customised with the
5664 .Ar window-status-format
5666 .Ar window-status-current-format
5668 The flag is one of the following symbols appended to the window name:
5669 .Bl -column "Symbol" "Meaning" -offset indent
5670 .It Sy "Symbol" Ta Sy "Meaning"
5671 .It Li "*" Ta "Denotes the current window."
5672 .It Li "-" Ta "Marks the last window (previously selected)."
5673 .It Li "#" Ta "Window activity is monitored and activity has been detected."
5674 .It Li "\&!" Ta "Window bells are monitored and a bell has occurred in the window."
5675 .It Li "~" Ta "The window has been silent for the monitor-silence interval."
5676 .It Li "M" Ta "The window contains the marked pane."
5677 .It Li "Z" Ta "The window's active pane is zoomed."
5680 The # symbol relates to the
5681 .Ic monitor-activity
5683 The window name is printed in inverted colours if an alert (bell, activity or
5684 silence) is present.
5686 The colour and attributes of the status line may be configured, the entire
5687 status line using the
5689 session option and individual windows using the
5690 .Ic window-status-style
5693 The status line is automatically refreshed at interval if it has changed, the
5694 interval may be controlled with the
5698 Commands related to the status line are as follows:
5701 .It Xo Ic clear-prompt-history
5702 .Op Fl T Ar prompt-type
5704 .D1 Pq alias: Ic clearphist
5705 Clear status prompt history for prompt type
5709 is omitted, then clear history for all types.
5712 for possible values for
5714 .It Xo Ic command-prompt
5718 .Op Fl t Ar target-client
5719 .Op Fl T Ar prompt-type
5722 Open the command prompt in a client.
5723 This may be used from inside
5725 to execute commands interactively.
5729 is specified, it is used as the command.
5733 is expanded as a format.
5737 is a comma-separated list of the initial text for each prompt.
5742 is a comma-separated list of prompts which are displayed in order; otherwise
5743 a single prompt is displayed, constructed from
5745 if it is present, or
5749 Before the command is executed, the first occurrence of the string
5751 and all occurrences of
5753 are replaced by the response to the first prompt, all
5755 are replaced with the response to the second prompt, and so on for further
5757 Up to nine prompt responses may be replaced
5766 but any quotation marks are escaped.
5769 makes the prompt only accept one key press, in this case the resulting input
5770 is a single character.
5774 but the key press is translated to a key name.
5776 makes the prompt only accept numeric key presses.
5778 executes the command every time the prompt input changes instead of when the
5779 user exits the command prompt.
5785 This affects what completions are offered when
5788 Available types are:
5795 The following keys have a special meaning in the command prompt, depending
5799 .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
5800 .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
5801 .It Li "Cancel command prompt" Ta "q" Ta "Escape"
5802 .It Li "Delete from cursor to start of word" Ta "" Ta "C-w"
5803 .It Li "Delete entire command" Ta "d" Ta "C-u"
5804 .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
5805 .It Li "Execute command" Ta "Enter" Ta "Enter"
5806 .It Li "Get next command from history" Ta "" Ta "Down"
5807 .It Li "Get previous command from history" Ta "" Ta "Up"
5808 .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
5809 .It Li "Look for completions" Ta "Tab" Ta "Tab"
5810 .It Li "Move cursor left" Ta "h" Ta "Left"
5811 .It Li "Move cursor right" Ta "l" Ta "Right"
5812 .It Li "Move cursor to end" Ta "$" Ta "C-e"
5813 .It Li "Move cursor to next word" Ta "w" Ta "M-f"
5814 .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
5815 .It Li "Move cursor to start" Ta "0" Ta "C-a"
5816 .It Li "Transpose characters" Ta "" Ta "C-t"
5821 the prompt is shown in the background and the invoking client does not exit
5822 until it is dismissed.
5824 .It Xo Ic confirm-before
5826 .Op Fl c Ar confirm-key
5828 .Op Fl t Ar target-client
5831 .D1 Pq alias: Ic confirm
5832 Ask for confirmation before executing
5838 is the prompt to display; otherwise a prompt is constructed from
5840 It may contain the special character sequences supported by the
5845 the prompt is shown in the background and the invoking client does not exit
5846 until it is dismissed.
5848 changes the default behaviour (if Enter alone is pressed) of the prompt to
5851 changes the confirmation key to
5856 .It Xo Ic display-menu
5858 .Op Fl c Ar target-client
5859 .Op Fl t Ar target-pane
5860 .Op Fl S Ar starting-choice
5862 .Op Fl x Ar position
5863 .Op Fl y Ar position
5866 .Ar command Op Ar argument ...
5868 .D1 Pq alias: Ic menu
5872 gives the target for any commands run from the menu.
5874 A menu is passed as a series of arguments: first the menu item name,
5875 second the key shortcut (or empty for none) and third the command
5876 to run when the menu item is chosen.
5877 The name and command are formats, see the
5882 If the name begins with a hyphen (-), then the item is disabled (shown dim) and
5884 The name may be empty for a separator line, in which case both the key and
5885 command should be omitted.
5888 is a format for the menu title (see
5891 sets the menu item selected by default, if the menu is not bound to a mouse key
5897 give the position of the menu.
5898 Both may be a row or column number, or one of the following special values:
5899 .Bl -column "XXXXX" "XXXX" -offset indent
5900 .It Sy "Value" Ta Sy "Flag" Ta Sy "Meaning"
5901 .It Li "C" Ta "Both" Ta "The centre of the terminal"
5902 .It Li "R" Ta Fl x Ta "The right side of the terminal"
5903 .It Li "P" Ta "Both" Ta "The bottom left of the pane"
5904 .It Li "M" Ta "Both" Ta "The mouse position"
5905 .It Li "W" Ta "Both" Ta "The window position on the status line"
5906 .It Li "S" Ta Fl y Ta "The line above or below the status line"
5909 Or a format, which is expanded including the following additional variables:
5910 .Bl -column "XXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent
5911 .It Sy "Variable name" Ta Sy "Replaced with"
5912 .It Li "popup_centre_x" Ta "Centered in the client"
5913 .It Li "popup_centre_y" Ta "Centered in the client"
5914 .It Li "popup_height" Ta "Height of menu or popup"
5915 .It Li "popup_mouse_bottom" Ta "Bottom of at the mouse"
5916 .It Li "popup_mouse_centre_x" Ta "Horizontal centre at the mouse"
5917 .It Li "popup_mouse_centre_y" Ta "Vertical centre at the mouse"
5918 .It Li "popup_mouse_top" Ta "Top at the mouse"
5919 .It Li "popup_mouse_x" Ta "Mouse X position"
5920 .It Li "popup_mouse_y" Ta "Mouse Y position"
5921 .It Li "popup_pane_bottom" Ta "Bottom of the pane"
5922 .It Li "popup_pane_left" Ta "Left of the pane"
5923 .It Li "popup_pane_right" Ta "Right of the pane"
5924 .It Li "popup_pane_top" Ta "Top of the pane"
5925 .It Li "popup_status_line_y" Ta "Above or below the status line"
5926 .It Li "popup_width" Ta "Width of menu or popup"
5927 .It Li "popup_window_status_line_x" Ta "At the window position in status line"
5928 .It Li "popup_window_status_line_y" Ta "At the status line showing the window"
5931 Each menu consists of items followed by a key shortcut shown in brackets.
5932 If the menu is too large to fit on the terminal, it is not displayed.
5933 Pressing the key shortcut chooses the corresponding item.
5934 If the mouse is enabled and the menu is opened from a mouse key binding,
5935 releasing the mouse button with an item selected chooses that item and
5936 releasing the mouse button without an item selected closes the menu.
5938 changes this behaviour so that the menu does not close when the mouse button is
5939 released without an item selected the menu is not closed and a mouse button
5940 must be clicked to choose an item.
5942 The following keys are also available:
5943 .Bl -column "Key" "Function" -offset indent
5944 .It Sy "Key" Ta Sy "Function"
5945 .It Li "Enter" Ta "Choose selected item"
5946 .It Li "Up" Ta "Select previous item"
5947 .It Li "Down" Ta "Select next item"
5948 .It Li "q" Ta "Exit menu"
5951 .It Xo Ic display-message
5953 .Op Fl c Ar target-client
5955 .Op Fl t Ar target-pane
5958 .D1 Pq alias: Ic display
5962 is given, the output is printed to stdout, otherwise it is displayed in the
5964 status line for up to
5971 option is used; a delay of zero waits for a key press.
5973 ignores key presses and closes only after the delay expires.
5978 is printed unchanged.
5979 Otherwise, the format of
5983 section; information is taken from
5987 is given, otherwise the active pane.
5990 prints verbose logging as the format is parsed and
5992 lists the format variables and their values.
5995 forwards any input read from stdin to the empty pane given by
5998 .It Xo Ic display-popup
6000 .Op Fl b Ar border-lines
6001 .Op Fl c Ar target-client
6002 .Op Fl d Ar start-directory
6003 .Op Fl e Ar environment
6006 .Op Fl S Ar border-style
6007 .Op Fl t Ar target-pane
6010 .Op Fl x Ar position
6011 .Op Fl y Ar position
6012 .Op Ar shell-command
6014 .D1 Pq alias: Ic popup
6015 Display a popup running
6019 A popup is a rectangular box drawn over the top of any panes.
6020 Panes are not updated while a popup is present.
6023 closes the popup automatically when
6028 closes the popup only if
6030 exited with success.
6035 give the position of the popup, they have the same meaning as for the
6041 give the width and height - both may be a percentage (followed by
6043 If omitted, half of the terminal size is used.
6046 does not surround the popup by a border.
6049 sets the type of border line for the popup.
6056 .Ic popup-border-lines
6057 for possible values for
6061 sets the style for the popup and
6063 sets the style for the popup border.
6073 and sets an environment variable for the popup; it may be specified multiple
6077 is a format for the popup title (see
6082 flag closes any popup on the client.
6084 .It Xo Ic show-prompt-history
6085 .Op Fl T Ar prompt-type
6087 .D1 Pq alias: Ic showphist
6088 Display status prompt history for prompt type
6092 is omitted, then show history for all types.
6095 for possible values for
6100 maintains a set of named
6102 Each buffer may be either explicitly or automatically named.
6103 Explicitly named buffers are named when created with the
6107 commands, or by renaming an automatically named buffer with
6110 Automatically named buffers are given a name such as
6116 option is reached, the oldest automatically named buffer is deleted.
6117 Explicitly named buffers are not subject to
6119 and may be deleted with the
6123 Buffers may be added using
6129 commands, and pasted into a window using the
6132 If a buffer command is used and no buffer is specified, the most
6133 recently added automatically named buffer is assumed.
6135 A configurable history buffer is also maintained for each window.
6136 By default, up to 2000 lines are kept; this can be altered with the
6142 The buffer commands are as follows:
6149 .Op Fl K Ar key-format
6150 .Op Fl O Ar sort-order
6151 .Op Fl t Ar target-pane
6154 Put a pane into buffer mode, where a buffer may be chosen interactively from
6156 Each buffer is shown on one line.
6157 A shortcut key is shown on the left in brackets allowing for immediate choice,
6158 or the list may be navigated and an item chosen or otherwise manipulated using
6162 The following keys may be used in buffer mode:
6163 .Bl -column "Key" "Function" -offset indent
6164 .It Sy "Key" Ta Sy "Function"
6165 .It Li "Enter" Ta "Paste selected buffer"
6166 .It Li "Up" Ta "Select previous buffer"
6167 .It Li "Down" Ta "Select next buffer"
6168 .It Li "C-s" Ta "Search by name or content"
6169 .It Li "n" Ta "Repeat last search"
6170 .It Li "t" Ta "Toggle if buffer is tagged"
6171 .It Li "T" Ta "Tag no buffers"
6172 .It Li "C-t" Ta "Tag all buffers"
6173 .It Li "p" Ta "Paste selected buffer"
6174 .It Li "P" Ta "Paste tagged buffers"
6175 .It Li "d" Ta "Delete selected buffer"
6176 .It Li "D" Ta "Delete tagged buffers"
6177 .It Li "e" Ta "Open the buffer in an editor"
6178 .It Li "f" Ta "Enter a format to filter items"
6179 .It Li "O" Ta "Change sort field"
6180 .It Li "r" Ta "Reverse sort order"
6181 .It Li "v" Ta "Toggle preview"
6182 .It Li "q" Ta "Exit mode"
6185 After a buffer is chosen,
6187 is replaced by the buffer name in
6189 and the result executed as a command.
6192 is not given, "paste-buffer -b '%%'" is used.
6195 specifies the initial sort field: one of
6202 reverses the sort order.
6204 specifies an initial filter: the filter is a format - if it evaluates to zero,
6205 the item in the list is not shown, otherwise it is shown.
6206 If a filter would lead to an empty list, it is ignored.
6208 specifies the format for each item in the list and
6210 a format for each shortcut key; both are evaluated once for each line.
6212 starts without the preview.
6213 This command works only if at least one client is attached.
6215 .It Xo Ic clear-history
6217 .Op Fl t Ar target-pane
6219 .D1 Pq alias: Ic clearhist
6220 Remove and free the history for the specified pane.
6222 also removes all hyperlinks.
6224 .It Ic delete-buffer Op Fl b Ar buffer-name
6225 .D1 Pq alias: Ic deleteb
6226 Delete the buffer named
6228 or the most recently added automatically named buffer if not specified.
6230 .It Xo Ic list-buffers
6234 .D1 Pq alias: Ic lsb
6235 List the global buffers.
6237 specifies the format of each line and
6240 Only buffers for which the filter is true are shown.
6244 .It Xo Ic load-buffer
6246 .Op Fl b Ar buffer-name
6247 .Op Fl t Ar target-client
6251 .D1 Pq alias: Ic loadb
6252 Load the contents of the specified paste buffer from
6256 is given, the buffer is also sent to the clipboard for
6260 escape sequence, if possible.
6262 .It Xo Ic paste-buffer
6264 .Op Fl b Ar buffer-name
6265 .Op Fl s Ar separator
6266 .Op Fl t Ar target-pane
6268 .D1 Pq alias: Ic pasteb
6269 Insert the contents of a paste buffer into the specified pane.
6270 If not specified, paste into the current one.
6273 also delete the paste buffer.
6274 When output, any linefeed (LF) characters in the paste buffer are replaced with
6275 a separator, by default carriage return (CR).
6276 A custom separator may be specified using the
6281 flag means to do no replacement (equivalent to a separator of LF).
6284 is specified, paste bracket control codes are inserted around the
6285 buffer if the application has requested bracketed paste mode.
6287 .It Xo Ic save-buffer
6289 .Op Fl b Ar buffer-name
6292 .D1 Pq alias: Ic saveb
6293 Save the contents of the specified paste buffer to
6297 option appends to rather than overwriting the file.
6298 .It Xo Ic set-buffer
6300 .Op Fl b Ar buffer-name
6301 .Op Fl t Ar target-client
6303 .Op Fl n Ar new-buffer-name
6306 .D1 Pq alias: Ic setb
6307 Set the contents of the specified buffer to
6311 is given, the buffer is also sent to the clipboard for
6315 escape sequence, if possible.
6318 option appends to rather than overwriting the buffer.
6321 option renames the buffer to
6322 .Ar new-buffer-name .
6324 .It Xo Ic show-buffer
6325 .Op Fl b Ar buffer-name
6327 .D1 Pq alias: Ic showb
6328 Display the contents of the specified buffer.
6331 Miscellaneous commands are as follows:
6333 .It Ic clock-mode Op Fl t Ar target-pane
6334 Display a large clock.
6338 .Op Fl t Ar target-pane
6339 .Ar shell-command command
6349 returns success or the second
6352 Before being executed,
6354 is expanded using the rules specified in the
6356 section, including those relevant to
6361 is run in the background.
6367 is not executed but considered success if neither empty nor zero (after formats
6371 .D1 Pq alias: Ic lock
6372 Lock each client individually by running the command specified by the
6379 .Op Fl t Ar target-pane
6380 .Op Ar shell-command
6382 .D1 Pq alias: Ic run
6391 command in the background without creating a window.
6392 Before being executed,
6394 is expanded using the rules specified in the
6399 the command is run in the background.
6403 seconds before starting the command.
6406 is not given, any output to stdout is displayed in view mode (in the pane
6409 or the current pane if omitted) after the command finishes.
6410 If the command fails, the exit status is also displayed.
6416 .D1 Pq alias: Ic wait
6417 When used without options, prevents the client from exiting until woken using
6420 with the same channel.
6423 is used, the channel is locked and any clients that try to lock the same
6424 channel are made to wait until the channel is unlocked with
6431 client detaches, it prints a message.
6434 .It detached (from session ...)
6435 The client was detached normally.
6436 .It detached and SIGHUP
6437 The client was detached and its parent sent the
6439 signal (for example with
6447 was unexpectedly destroyed.
6449 The client was killed with
6452 The client is in control mode and became unable to keep up with the data from
6455 The server exited when it had no sessions.
6457 The server exited when it received
6459 .It server exited unexpectedly
6460 The server crashed or otherwise exited without telling the client the reason.
6462 .Sh TERMINFO EXTENSIONS
6464 understands some unofficial extensions to
6466 It is not normally necessary to set these manually, instead the
6467 .Ic terminal-features
6468 option should be used.
6471 An existing extension that tells
6473 the terminal supports default colours.
6477 that the terminal supports the VTE bidirectional text extensions.
6479 Set the cursor colour.
6480 The first takes a single string argument and is used to set the colour;
6481 the second takes no arguments and restores the default cursor colour.
6482 If set, a sequence such as this may be used
6483 to change the cursor colour from inside
6485 .Bd -literal -offset indent
6486 $ printf '\e033]12;red\e033\e\e'
6493 .It Em \&Cmg, \&Clmg, \&Dsmg , \&Enmg
6494 Set, clear, disable or enable DECSLRM margins.
6495 These are set automatically if the terminal reports it is
6498 .It Em \&Dsbp , \&Enbp
6499 Disable and enable bracketed paste.
6500 These are set automatically if the
6502 capability is present.
6503 .It Em \&Dseks , \&Eneks
6504 Disable and enable extended keys.
6505 .It Em \&Dsfcs , \&Enfcs
6506 Disable and enable focus reporting.
6507 These are set automatically if the
6509 capability is present.
6511 Set or clear a hyperlink annotation.
6515 that the terminal does not use bright colors for bold display.
6519 that the terminal supports rectangle operations.
6521 Enable the overline attribute.
6523 Set a styled underscore.
6524 The single parameter is one of: 0 for no underscore, 1 for normal
6525 underscore, 2 for double underscore, 3 for curly underscore, 4 for dotted
6526 underscore and 5 for dashed underscore.
6527 .It Em \&Setulc , \&ol
6528 Set the underscore colour or reset to the default.
6529 The argument is (red * 65536) + (green * 256) + blue where each is between 0
6532 Set or reset the cursor style.
6533 If set, a sequence such as this may be used
6534 to change the cursor to an underline:
6535 .Bd -literal -offset indent
6536 $ printf '\e033[4 q'
6541 is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
6543 Set the opening sequence for the working directory notification.
6544 The sequence is terminated using the standard
6548 Indicates that the terminal supports SIXEL.
6550 Start (parameter is 1) or end (parameter is 2) a synchronized update.
6552 Indicate that the terminal supports the
6554 RGB escape sequence (for example, \ee[38;2;255;255;255m).
6556 If supported, this is used for the initialize colour escape sequence (which
6557 may be enabled by adding the
6566 This is equivalent to the
6571 Store the current buffer in the host terminal's selection (clipboard).
6574 option above and the
6578 This is an existing extension capability that tmux uses to mean that the
6579 terminal supports the
6581 title set sequences and to automatically set some of the capabilities above.
6585 offers a textual interface called
6587 This allows applications to communicate with
6589 using a simple text-only protocol.
6591 In control mode, a client sends
6593 commands or command sequences terminated by newlines on standard input.
6594 Each command will produce one block of output on standard output.
6595 An output block consists of a
6597 line followed by the output (which may be empty).
6598 The output block ends with a
6607 have three arguments: an integer time (as seconds from epoch), command number
6608 and flags (currently not used).
6610 .Bd -literal -offset indent
6611 %begin 1363006971 2 1
6612 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
6619 command may be used to set the size of a client in control mode.
6623 outputs notifications.
6624 A notification will never occur inside an output block.
6626 The following notifications are defined:
6628 .It Ic %client-detached Ar client
6629 The client has detached.
6630 .It Ic %client-session-changed Ar client session-id name
6631 The client is now attached to the session with ID
6635 .It Ic %config-error Ar error
6636 An error has happened in a configuration file.
6637 .It Ic %continue Ar pane-id
6638 The pane has been continued after being paused (if the
6643 .It Ic %exit Op Ar reason
6646 client is exiting immediately, either because it is not attached to any session
6647 or an error occurred.
6650 describes why the client exited.
6651 .It Ic %extended-output Ar pane-id Ar age Ar ... \& : Ar value
6658 is the time in milliseconds for which tmux had buffered the output before it
6660 Any subsequent arguments up until a single
6662 are for future use and should be ignored.
6663 .It Xo Ic %layout-change
6666 .Ar window-visible-layout
6669 The layout of a window with ID
6674 The window's visible layout is
6675 .Ar window-visible-layout
6676 and the window flags are
6678 .It Ic %message Ar message
6679 A message sent with the
6682 .It Ic %output Ar pane-id Ar value
6683 A window pane produced output.
6685 escapes non-printable characters and backslash as octal \\xxx.
6686 .It Ic %pane-mode-changed Ar pane-id
6690 .It Ic %paste-buffer-changed Ar name
6694 .It Ic %paste-buffer-deleted Ar name
6698 .It Ic %pause Ar pane-id
6699 The pane has been paused (if the
6702 .It Ic %session-changed Ar session-id Ar name
6703 The client is now attached to the session with ID
6707 .It Ic %session-renamed Ar name
6708 The current session was renamed to
6710 .It Ic %session-window-changed Ar session-id Ar window-id
6713 changed its active window to the window with ID
6715 .It Ic %sessions-changed
6716 A session was created or destroyed.
6717 .It Xo Ic %subscription-changed
6722 .Ar pane-id ... \& :
6725 The value of the format associated with subscription
6736 are for future use and should be ignored.
6737 .It Ic %unlinked-window-add Ar window-id
6740 was created but is not linked to the current session.
6741 .It Ic %unlinked-window-close Ar window-id
6744 which is not linked to the current session, was closed.
6745 .It Ic %unlinked-window-renamed Ar window-id
6748 which is not linked to the current session, was renamed.
6749 .It Ic %window-add Ar window-id
6752 was linked to the current session.
6753 .It Ic %window-close Ar window-id
6757 .It Ic %window-pane-changed Ar window-id Ar pane-id
6758 The active pane in the window with ID
6760 changed to the pane with ID
6762 .It Ic %window-renamed Ar window-id Ar name
6771 is started, it inspects the following environment variables:
6772 .Bl -tag -width LC_CTYPE
6774 If the command specified in this variable contains the string
6778 is unset, use vi-style key bindings.
6785 The user's login directory.
6788 database is consulted.
6790 The character encoding
6792 It is used for two separate purposes.
6793 For output to the terminal, UTF-8 is used if the
6795 option is given or if
6801 Otherwise, only ASCII characters are written and non-ASCII characters
6802 are replaced with underscores
6806 always runs with a UTF-8 locale.
6807 If en_US.UTF-8 is provided by the operating system, it is used and
6809 is ignored for input.
6814 what the UTF-8 locale is called on the current system.
6815 If the locale specified by
6817 is not available or is not a UTF-8 locale,
6819 exits with an error message.
6821 The date and time format
6823 It is used for locale-dependent
6827 The current working directory to be set in the global environment.
6828 This may be useful if it contains symbolic links.
6829 If the value of the variable does not match the current working
6830 directory, the variable is ignored and the result of
6834 The absolute path to the default shell for new windows.
6839 The parent directory of the directory containing the server sockets.
6844 If the command specified in this variable contains the string
6846 use vi-style key bindings.
6854 .Bl -tag -width "/etc/tmux.confXXX" -compact
6859 .It Pa /etc/tmux.conf
6860 System-wide configuration file.
6868 .Dl $ tmux new-session vi
6870 Most commands have a shorter form, known as an alias.
6871 For new-session, this is
6876 Alternatively, the shortest unambiguous form of a command is accepted.
6877 If there are several options, they are listed:
6878 .Bd -literal -offset indent
6880 ambiguous command: n, could be: new-session, new-window, next-window
6883 Within an active session, a new window may be created by typing
6893 Windows may be navigated with:
6895 (to select window 0),
6897 (to select window 1), and so on;
6899 to select the next window; and
6901 to select the previous window.
6903 A session may be detached using
6905 (or by an external event such as
6907 disconnection) and reattached with:
6909 .Dl $ tmux attach-session
6913 lists the current key bindings in the current window; up and down may be used
6914 to navigate the list or
6918 Commands to be run when the
6920 server is started may be placed in the
6923 Common examples include:
6925 Changing the default prefix key:
6926 .Bd -literal -offset indent
6927 set-option -g prefix C-a
6929 bind-key C-a send-prefix
6932 Turning the status line off, or changing its colour:
6933 .Bd -literal -offset indent
6934 set-option -g status off
6935 set-option -g status-style bg=blue
6938 Setting other options, such as the default command,
6939 or locking after 30 minutes of inactivity:
6940 .Bd -literal -offset indent
6941 set-option -g default-command "exec /bin/ksh"
6942 set-option -g lock-after-time 1800
6945 Creating new key bindings:
6946 .Bd -literal -offset indent
6947 bind-key b set-option status
6948 bind-key / command-prompt "split-window 'exec man %%'"
6949 bind-key S command-prompt "new-window -n %1 'ssh %1'"
6954 .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com