3 .\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
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
31 .Op Ar command Op Ar flags
35 is a terminal multiplexer:
36 it enables a number of terminals to be created, accessed, and
37 controlled from a single screen.
39 may be detached from a screen
40 and continue running in the background,
41 then later reattached.
45 is started it creates a new
49 and displays it on screen.
50 A status line at the bottom of the screen
51 shows information on the current session
52 and is used to enter interactive commands.
54 A session is a single collection of
56 under the management of
58 Each session has one or more
60 A window occupies the entire screen
61 and may be split into rectangular panes,
62 each of which is a separate pseudo terminal
65 manual page documents the technical details of pseudo terminals).
68 instances may connect to the same session,
69 and any number of windows may be present in the same session.
70 Once all sessions are killed,
74 Each session is persistent and will survive accidental disconnection
77 connection timeout) or intentional detaching (with the
81 may be reattached using:
87 a session is displayed on screen by a
89 and all sessions are managed by a single
91 The server and each client are separate processes which communicate through a
95 The options are as follows:
96 .Bl -tag -width "XXXXXXXXXXXX"
100 to assume the terminal supports 256 colours.
104 but indicates that the terminal supports 88 colours.
105 .It Fl c Ar shell-command
108 using the default shell.
111 server will be started to retrieve the
114 This option is for compatibility with
118 is used as a login shell.
120 Specify an alternative configuration file.
123 loads the system configuration file from
125 if present, then looks for a user configuration file at
127 The configuration file is a set of
129 commands which are executed in sequence when the server is first started.
131 If a command in the configuration file fails,
133 will report an error and exit without executing further commands.
134 .It Fl L Ar socket-name
136 stores the server socket in a directory under
141 the default socket is named
143 This option allows a different socket name to be specified, allowing several
149 a full path is not necessary: the sockets are all created in the same
152 If the socket is accidentally removed, the
154 signal may be sent to the
156 server process to recreate it.
158 Behave as a login shell.
159 This flag currently has no effect and is for compatibility with other shells
160 when using tmux as a login shell.
164 server option to prevent the server sending various informational messages.
165 .It Fl S Ar socket-path
166 Specify a full alternative path to the server socket.
169 is specified, the default socket directory is not used and any
174 attempts to guess if the terminal is likely to support UTF-8 by checking the
180 environment variables to be set for the string "UTF-8".
181 This is not always correct: the
183 flag explicitly informs
185 that UTF-8 is supported.
187 If the server is started from a client passed
189 or where UTF-8 is detected, the
193 options are enabled in the global window and session options respectively.
195 Request verbose logging.
196 This option may be specified multiple times for increasing verbosity.
197 Log messages will be saved into
198 .Pa tmux-client-PID.log
200 .Pa tmux-server-PID.log
201 files in the current directory, where
203 is the PID of the server or client process.
204 .It Ar command Op Ar flags
205 This specifies one of a set of commands used to control
207 as described in the following sections.
208 If no commands are specified, the
214 may be controlled from an attached client by using a key combination of a
217 (Ctrl-b) by default, followed by a command key.
219 The default command key bindings are:
221 .Bl -tag -width "XXXXXXXXXX" -offset indent -compact
223 Send the prefix key (C-b) through to the application.
225 Rotate the panes in the current window forwards.
231 Break the current pane out of the window.
233 Split the current pane into two, top and bottom.
235 List all paste buffers.
237 Rename the current session.
239 Split the current pane into two, left and right.
241 Kill the current window.
243 Prompt for a window index to select.
245 Rename the current window.
247 Delete the most recently copied buffer of text.
249 Prompt for an index to move the current window.
251 Select windows 0 to 9.
257 Move to the previously active pane.
259 Choose which buffer to paste interactively from a list.
261 List all key bindings.
263 Choose a client to detach.
265 Enter copy mode to copy text or view the history.
267 Paste the most recently copied buffer of text.
271 Detach the current client.
273 Prompt to search for text in open windows.
275 Display some information about the current window.
277 Move to the previously selected window.
279 Change to the next window.
281 Select the next pane in the current window.
283 Change to the previous window.
285 Briefly display pane indexes.
287 Force redraw of the attached client.
289 Select a new session for the attached client interactively.
291 Switch the attached client back to the last session.
295 Choose the current window interactively.
297 Kill the current pane.
299 Swap the current pane with the previous pane.
301 Swap the current pane with the next pane.
303 Show previous messages from
307 Enter copy mode and scroll one page up.
310 Change to the pane above, below, to the left, or to the right of the current
313 Arrange panes in one of the five preset layouts: even-horizontal,
314 even-vertical, main-horizontal, main-vertical, or tiled.
316 Move to the next window with a bell or activity marker.
318 Rotate the panes in the current window backwards.
320 Move to the previous window with a bell or activity marker.
323 Resize the current pane in steps of one cell.
326 Resize the current pane in steps of five cells.
329 Key bindings may be changed with the
335 This section contains a list of the commands supported by
337 Most commands accept the optional
345 These specify the client, session, window or pane which a command should affect.
349 file to which the client is connected, for example either of
353 for the client attached to
355 If no client is specified, the current client is chosen, if possible, or an
357 Clients may be listed with the
362 is either the name of a session (as listed by the
364 command) or the name of a client with the same syntax as
366 in which case the session attached to the client is used.
367 When looking for the session name,
369 initially searches for an exact match; if none is found, the session names
370 are checked for any for which
372 is a prefix or for which it matches as an
375 If a single match is found, it is used as the target session; multiple matches
377 If a session is omitted, the current session is used if available; if no
378 current session is available, the most recently used is chosen.
381 specifies a window in the form
382 .Em session Ns \&: Ns Em window .
384 follows the same rules as for
388 is looked for in order: as a window index, for example mysession:1; as an exact
389 window name, such as mysession:mywindow; then as an
391 pattern or the start of a window name, such as mysession:mywin* or
393 An empty window name specifies the next unused index if appropriate (for
399 otherwise the current window in
402 The special character
404 uses the last (previously current) window, or
408 are the next window or the previous window by number.
409 When the argument does not contain a colon,
411 first attempts to parse it as window; if that fails, an attempt is made to
415 takes a similar form to
417 but with the optional addition of a period followed by a pane index, for
418 example: mysession:mywindow.1.
419 If the pane index is omitted, the currently active pane in the specified
421 If neither a colon nor period appears,
423 first attempts to use the argument as a pane index; if that fails, it is looked
430 indicate the next or previous pane index, respectively.
441 may be used instead of a pane index.
443 The special characters
447 may be followed by an offset, for example:
448 .Bd -literal -offset indent
452 When dealing with a session that doesn't contain sequential window indexes,
453 they will be correctly skipped.
456 also gives each pane created in a server an identifier consisting of a
458 and a number, starting from zero.
459 A pane's identifier is unique for the life of the
461 server and is passed to the child process of the pane in the
463 environment variable.
464 It may be used alone to target a pane or the window containing it.
470 These must be passed as a single item, which typically means quoting them, for
472 .Bd -literal -offset indent
473 new-window 'vi /etc/passwd'
480 command, passed with the command and arguments separately, for example:
481 .Bd -literal -offset indent
482 bind-key F1 set-window-option force-width 81
487 .Bd -literal -offset indent
488 $ tmux bind-key F1 set-window-option force-width 81
491 Multiple commands may be specified together as part of a
492 .Em command sequence .
493 Each command should be separated by spaces and a semicolon;
494 commands are executed sequentially from left to right and
495 lines ending with a backslash continue on to the next line.
496 A literal semicolon may be included by escaping it with a backslash (for
497 example, when specifying a command sequence to
503 .Bd -literal -offset indent
504 refresh-client -t/dev/ttyp2
506 rename-session -tfirst newname
508 set-window-option -t:0 monitor-activity on
510 new-window ; split-window -d
512 bind-key R source-file ~/.tmux.conf \e; \e
513 display-message "source-file done"
518 .Bd -literal -offset indent
519 $ tmux kill-window -t :1
521 $ tmux new-window \e; split-window -d
523 $ tmux new-session -d 'vi /etc/passwd' \e; split-window -d \e; attach
525 .Sh CLIENTS AND SESSIONS
528 server manages clients, sessions, windows and panes.
529 Clients are attached to sessions to interact with them, either
530 when they are created with the
532 command, or later with the
535 Each session has one or more windows
538 Windows may be linked to multiple sessions and are made up of one or
540 each of which contains a pseudo terminal.
541 Commands for creating, linking and otherwise manipulating windows
544 .Sx WINDOWS AND PANES
547 The following commands are available to manage clients and sessions:
549 .It Xo Ic attach-session
551 .Op Fl t Ar target-session
553 .D1 (alias: Ic attach )
556 create a new client in the current terminal and attach it to
558 If used from inside, switch the current client.
561 is specified, any other clients attached to the session are detached.
563 signifies the client is read-only (only keys bound to the
567 commands have any effect)
569 If no server is started,
571 will attempt to start it; this will fail unless sessions are created in the
578 are slightly adjusted: if
580 needs to select the most recently used session, it will prefer the most
584 .It Xo Ic detach-client
586 .Op Fl s Ar target-session
587 .Op Fl t Ar target-client
589 .D1 (alias: Ic detach )
590 Detach the current client if bound to a key, the client specified with
592 or all clients currently attached to to the session specified by
596 is given, send SIGHUP to the parent process of the client, typically causing it
598 .It Ic has-session Op Fl t Ar target-session
600 Report an error and exit with 1 if the specified session does not exist.
601 If it does exist, exit with 0.
605 server and clients and destroy all sessions.
606 .It Ic kill-session Op Fl t Ar target-session
607 Destroy the given session, closing any windows linked to it and no other
608 sessions, and detaching all clients attached to it.
609 .It Xo Ic list-clients
611 .Op Fl t Ar target-session
614 List all clients attached to the server.
615 For the meaning of the
621 is specified, list only clients connected to that session.
623 .D1 (alias: Ic lscm )
624 List the syntax of all commands supported by
626 .It Ic list-sessions Op Fl F Ar format
628 List all sessions managed by the server.
629 For the meaning of the
634 .It Ic lock-client Op Fl t Ar target-client
635 .D1 (alias: Ic lockc )
641 .It Ic lock-session Op Fl t Ar target-session
642 .D1 (alias: Ic locks )
643 Lock all clients attached to
645 .It Xo Ic new-session
647 .Op Fl n Ar window-name
648 .Op Fl s Ar session-name
649 .Op Fl t Ar target-session
655 Create a new session with name
658 The new session is attached to the current terminal unless
664 are the name of and shell command to execute in the initial window.
671 specify the size of the initial window (80 by 24 if not given).
673 If run from a terminal, any
675 special characters are saved and used for new windows in the new session.
679 is given, the new session is
683 This means they share the same set of windows - all windows from
685 are linked to the new session and any subsequent new windows or windows being
686 closed are applied to both sessions.
687 The current and previous window and any session options remain independent and
688 either session may be killed without affecting the other.
696 .It Xo Ic refresh-client
698 .Op Fl t Ar target-client
700 .D1 (alias: Ic refresh )
701 Refresh the current client if bound to a key, or a single client if one is given
706 is specified, only update the client's status bar.
707 .It Xo Ic rename-session
708 .Op Fl t Ar target-session
711 .D1 (alias: Ic rename )
712 Rename the session to
714 .It Xo Ic show-messages
715 .Op Fl t Ar target-client
717 .D1 (alias: Ic showmsgs )
718 Any messages displayed on the status line are saved in a per-client message
719 log, up to a maximum of the limit set by the
721 session option for the session attached to that client.
722 This command displays the log for
724 .It Ic source-file Ar path
725 .D1 (alias: Ic source )
726 Execute commands from
729 .D1 (alias: Ic start )
732 server, if not already running, without creating any sessions.
733 .It Xo Ic suspend-client
734 .Op Fl t Ar target-client
736 .D1 (alias: Ic suspendc )
737 Suspend a client by sending
740 .It Xo Ic switch-client
742 .Op Fl c Ar target-client
743 .Op Fl t Ar target-session
745 .D1 (alias: Ic switchc )
746 Switch the current session for client
755 is used, the client is moved to the last, next or previous session
758 toggles whether a client is read-only (see the
762 .Sh WINDOWS AND PANES
765 window may be in one of several modes.
766 The default permits direct access to the terminal attached to the window.
767 The other is copy mode, which permits a section of a window or its
768 history to be copied to a
770 for later insertion into another window.
771 This mode is entered with the
776 It is also entered when a command that produces output, such as
778 is executed from a key binding.
780 The keys available depend on whether emacs or vi mode is selected
784 The following keys are supported as appropriate for the mode:
785 .Bl -column "FunctionXXXXXXXXXXXXXXXXX" "viXXXXXXXXXX" "emacs" -offset indent
786 .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
787 .It Li "Back to indentation" Ta "^" Ta "M-m"
788 .It Li "Bottom of history" Ta "G" Ta "M-<"
789 .It Li "Clear selection" Ta "Escape" Ta "C-g"
790 .It Li "Copy selection" Ta "Enter" Ta "M-w"
791 .It Li "Cursor down" Ta "j" Ta "Down"
792 .It Li "Cursor left" Ta "h" Ta "Left"
793 .It Li "Cursor right" Ta "l" Ta "Right"
794 .It Li "Cursor to bottom line" Ta "L" Ta ""
795 .It Li "Cursor to middle line" Ta "M" Ta "M-r"
796 .It Li "Cursor to top line" Ta "H" Ta "M-R"
797 .It Li "Cursor up" Ta "k" Ta "Up"
798 .It Li "Delete entire line" Ta "d" Ta "C-u"
799 .It Li "Delete/Copy to end of line" Ta "D" Ta "C-k"
800 .It Li "End of line" Ta "$" Ta "C-e"
801 .It Li "Go to line" Ta ":" Ta "g"
802 .It Li "Half page down" Ta "C-d" Ta "M-Down"
803 .It Li "Half page up" Ta "C-u" Ta "M-Up"
804 .It Li "Jump forward" Ta "f" Ta "f"
805 .It Li "Jump backward" Ta "F" Ta "F"
806 .It Li "Jump again" Ta ";" Ta ";"
807 .It Li "Jump again in reverse" Ta "," Ta ","
808 .It Li "Next page" Ta "C-f" Ta "Page down"
809 .It Li "Next space" Ta "W" Ta ""
810 .It Li "Next space, end of word" Ta "E" Ta ""
811 .It Li "Next word" Ta "w" Ta ""
812 .It Li "Next word end" Ta "e" Ta "M-f"
813 .It Li "Paste buffer" Ta "p" Ta "C-y"
814 .It Li "Previous page" Ta "C-b" Ta "Page up"
815 .It Li "Previous word" Ta "b" Ta "M-b"
816 .It Li "Previous space" Ta "B" Ta ""
817 .It Li "Quit mode" Ta "q" Ta "Escape"
818 .It Li "Rectangle toggle" Ta "v" Ta "R"
819 .It Li "Scroll down" Ta "C-Down or C-e" Ta "C-Down"
820 .It Li "Scroll up" Ta "C-Up or C-y" Ta "C-Up"
821 .It Li "Search again" Ta "n" Ta "n"
822 .It Li "Search again in reverse" Ta "N" Ta "N"
823 .It Li "Search backward" Ta "?" Ta "C-r"
824 .It Li "Search forward" Ta "/" Ta "C-s"
825 .It Li "Start of line" Ta "0" Ta "C-a"
826 .It Li "Start selection" Ta "Space" Ta "C-Space"
827 .It Li "Top of history" Ta "g" Ta "M->"
828 .It Li "Transpose chars" Ta "" Ta "C-t"
831 The next and previous word keys use space and the
836 characters as word delimiters by default, but this can be adjusted by
840 Next word moves to the start of the next word, next word end to the end of the
841 next word and previous word to the start of the previous word.
842 The three next and previous space keys work similarly but use a space alone as
845 The jump commands enable quick movement within a line.
850 will move the cursor to the next
852 character on the current line.
855 will then jump to the next occurrence.
857 Commands in copy mode may be prefaced by an optional repeat count.
858 With vi key bindings, a prefix is entered using the number keys; with
859 emacs, the Alt (meta) key and a number begins prefix entry.
860 For example, to move the cursor forward by ten words, use
866 Mode key bindings are defined in a set of named tables:
870 for keys used when line editing at the command prompt;
874 for keys used when choosing from lists (such as produced by the
881 The tables may be viewed with the
883 command and keys modified or removed with
888 The paste buffer key pastes the first line from the top paste buffer on the
897 .Op Fl t Ar target-pane
902 option scrolls one page up.
905 Each window displayed by
907 may be split into one or more
909 each pane takes up a certain area of the display and is a separate terminal.
910 A window may be split into panes using the
913 Windows may be split horizontally (with the
916 Panes may be resized with the
924 by default), the current pane may be changed with the
930 commands may be used to swap panes without changing their position.
931 Panes are numbered beginning from zero in the order they are created.
936 These may be selected with the
938 command or cycled with
942 by default); once a layout is chosen, panes within it may be moved and resized
945 The following layouts are supported:
947 .It Ic even-horizontal
948 Panes are spread out evenly from left to right across the window.
950 Panes are spread evenly from top to bottom.
951 .It Ic main-horizontal
952 A large (main) pane is shown at the top of the window and the remaining panes
953 are spread from left to right in the leftover space at the bottom.
956 window option to specify the height of the top pane.
960 but the large pane is placed on the left and the others spread from top to
961 bottom along the right.
966 Panes are spread out as evenly as possible over the window in both rows and
972 may be used to apply a previously used layout - the
974 command displays the layout of each window in a form suitable for use with
977 .Bd -literal -offset indent
980 layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
981 $ tmux select-layout bb62,159x48,0,0{79x48,0,0,79x48,80,0}
985 automatically adjusts the size of the layout for the current window size.
986 Note that a layout cannot be applied to a window with more panes than that
987 from which the layout was originally defined.
989 Commands related to windows and panes are as follows:
993 .Op Fl t Ar target-pane
995 .D1 (alias: Ic breakp )
998 off from its containing window to make it the only pane in a new window.
1001 is given, the new window does not become the current window.
1002 .It Xo Ic capture-pane
1003 .Op Fl b Ar buffer-index
1004 .Op Fl E Ar end-line
1005 .Op Fl S Ar start-line
1006 .Op Fl t Ar target-pane
1008 .D1 (alias: Ic capturep )
1009 Capture the contents of a pane to the specified buffer, or a new buffer if none
1015 specify the starting and ending line numbers, zero is the first line of the
1016 visible pane and negative numbers are lines in the history.
1017 The default is to capture only the visible contents of the pane.
1020 .Op Fl t Ar target-window
1023 Put a window into client choice mode, allowing a client to be selected
1024 interactively from a list.
1025 After a client is chosen,
1027 is replaced by the client
1031 and the result executed as a command.
1034 is not given, "detach-client -t '%%'" is used.
1035 This command works only from inside
1039 .Op Fl t Ar target-window
1042 Put a window into session choice mode, where a session may be selected
1043 interactively from a list.
1046 is replaced by the session name in
1048 and the result executed as a command.
1051 is not given, "switch-client -t '%%'" is used.
1052 This command works only from inside
1056 .Op Fl t Ar target-window
1059 Put a window into window choice mode, where a window may be chosen
1060 interactively from a list.
1061 After a window is selected,
1063 is replaced by the session name and window index in
1065 and the result executed as a command.
1068 is not given, "select-window -t '%%'" is used.
1069 This command works only from inside
1071 .It Ic display-panes Op Fl t Ar target-client
1072 .D1 (alias: Ic displayp)
1073 Display a visible indicator of each pane shown by
1076 .Ic display-panes-time ,
1077 .Ic display-panes-colour ,
1079 .Ic display-panes-active-colour
1081 While the indicator is on screen, a pane may be selected with the
1086 .It Xo Ic find-window
1087 .Op Fl t Ar target-window
1090 .D1 (alias: Ic findw )
1095 in window names, titles, and visible content (but not history).
1096 If only one window is matched, it'll be automatically selected, otherwise a
1097 choice list is shown.
1098 This command only works from inside
1104 .Fl p Ar percentage Oc
1105 .Op Fl s Ar src-pane
1106 .Op Fl t Ar dst-pane
1108 .D1 (alias: Ic joinp )
1111 but instead of splitting
1113 and creating a new pane, split it and move
1116 This can be used to reverse
1120 .Op Fl t Ar target-pane
1122 .D1 (alias: Ic killp )
1123 Destroy the given pane.
1124 If no panes remain in the containing window, it is also destroyed.
1127 option kills all but the pane given with
1129 .It Ic kill-window Op Fl t Ar target-window
1130 .D1 (alias: Ic killw )
1131 Kill the current window or the window at
1133 removing it from any sessions to which it is linked.
1134 .It Ic last-pane Op Fl t Ar target-window
1135 .D1 (alias: Ic lastp )
1136 Select the last (previously selected) pane.
1137 .It Ic last-window Op Fl t Ar target-session
1138 .D1 (alias: Ic last )
1139 Select the last (previously selected) window.
1142 is specified, select the last window of the current session.
1143 .It Xo Ic link-window
1145 .Op Fl s Ar src-window
1146 .Op Fl t Ar dst-window
1148 .D1 (alias: Ic linkw )
1155 is specified and no such window exists, the
1162 exists, it is killed, otherwise an error is generated.
1165 is given, the newly linked window is not selected.
1166 .It Xo Ic list-panes
1171 .D1 (alias: Ic lsp )
1176 is ignored and all panes on the server are listed.
1181 is a session (or the current session).
1182 If neither is given,
1184 is a window (or the current window).
1185 For the meaning of the
1190 .It Xo Ic list-windows
1193 .Op Fl t Ar target-session
1195 .D1 (alias: Ic lsw )
1198 is given, list all windows on the server.
1199 Otherwise, list windows in the current session or in
1200 .Ar target-session .
1201 For the meaning of the
1206 .It Xo Ic move-window
1208 .Op Fl s Ar src-window
1209 .Op Fl t Ar dst-window
1211 .D1 (alias: Ic movew )
1214 except the window at
1218 .It Xo Ic new-window
1220 .Op Fl n Ar window-name
1221 .Op Fl t Ar target-window
1222 .Op Ar shell-command
1224 .D1 (alias: Ic neww )
1225 Create a new window.
1228 the new window is inserted at the next index up from the specified
1230 moving windows up if necessary,
1233 is the new window location.
1237 is given, the session does not make the new window the current window.
1239 represents the window to be created; if the target already exists an error is
1242 flag is used, in which case it is destroyed.
1244 is the command to execute.
1247 is not specified, the value of the
1251 When the shell command completes, the window closes.
1254 option to change this behaviour.
1258 environment variable must be set to
1260 for all programs running
1263 New windows will automatically have
1265 added to their environment, but care must be taken not to reset this in shell
1270 option prints the location of the new window after it has been created.
1271 .It Ic next-layout Op Fl t Ar target-window
1272 .D1 (alias: Ic nextl )
1273 Move a window to the next layout and rearrange the panes to fit.
1274 .It Xo Ic next-window
1276 .Op Fl t Ar target-session
1278 .D1 (alias: Ic next )
1279 Move to the next window in the session.
1282 is used, move to the next window with a bell, activity or content alert.
1285 .Op Fl t Ar target-pane
1286 .Op Ar shell-command
1288 .D1 (alias: Ic pipep )
1289 Pipe any output sent by the program in
1292 A pane may only be piped to one command at a time, any existing pipe is
1298 string may contain the special character sequences supported by the
1303 is given, the current pipe (if any) is closed.
1307 option only opens a new pipe if no previous pipe exists, allowing a pipe to
1308 be toggled with a single key, for example:
1309 .Bd -literal -offset indent
1310 bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
1312 .It Xo Ic previous-layout
1313 .Op Fl t Ar target-window
1315 .D1 (alias: Ic prevl )
1316 Move to the previous layout in the session.
1317 .It Xo Ic previous-window
1319 .Op Fl t Ar target-session
1321 .D1 (alias: Ic prev )
1322 Move to the previous window in the session.
1325 move to the previous window with a bell, activity or content alert.
1326 .It Xo Ic rename-window
1327 .Op Fl t Ar target-window
1330 .D1 (alias: Ic renamew )
1331 Rename the current window, or the window at
1335 .It Xo Ic resize-pane
1337 .Op Fl t Ar target-pane
1340 .D1 (alias: Ic resizep )
1341 Resize a pane, upward with
1343 (the default), downward with
1347 and to the right with
1351 is given in lines or cells (the default is 1).
1352 .It Xo Ic respawn-pane
1354 .Op Fl t Ar target-pane
1355 .Op Ar shell-command
1357 .D1 (alias: Ic respawnp )
1358 Reactivate a pane in which the command has exited (see the
1363 is not given, the command used when the pane was created is executed.
1364 The pane must be already inactive, unless
1366 is given, in which case any existing command is killed.
1367 .It Xo Ic respawn-window
1369 .Op Fl t Ar target-window
1370 .Op Ar shell-command
1372 .D1 (alias: Ic respawnw )
1373 Reactivate a window in which the command has exited (see the
1378 is not given, the command used when the window was created is executed.
1379 The window must be already inactive, unless
1381 is given, in which case any existing command is killed.
1382 .It Xo Ic rotate-window
1384 .Op Fl t Ar target-window
1386 .D1 (alias: Ic rotatew )
1387 Rotate the positions of the panes within a window, either upward (numerically
1390 or downward (numerically higher).
1391 .It Xo Ic select-layout
1393 .Op Fl t Ar target-window
1396 .D1 (alias: Ic selectl )
1397 Choose a specific layout for a window.
1400 is not given, the last preset layout used (if any) is reapplied.
1404 are equivalent to the
1409 .It Xo Ic select-pane
1411 .Op Fl t Ar target-pane
1413 .D1 (alias: Ic selectp )
1416 the active pane in window
1424 is used, respectively the pane below, to the left, to the right, or above the
1425 target pane is used.
1427 is the same as using the
1430 .It Xo Ic select-window
1432 .Op Fl t Ar target-window
1434 .D1 (alias: Ic selectw )
1435 Select the window at
1441 are equivalent to the
1447 .It Xo Ic split-window
1451 .Fl p Ar percentage Oc
1452 .Op Fl t Ar target-pane
1453 .Op Ar shell-command
1455 .D1 (alias: Ic splitw )
1456 Create a new pane by splitting
1459 does a horizontal split and
1461 a vertical split; if neither is specified,
1468 options specify the size of the new pane in lines (for vertical split) or in
1469 cells (for horizontal split), or as a percentage, respectively.
1470 All other options have the same meaning as for the
1475 .Op Fl s Ar src-pane
1476 .Op Fl t Ar dst-pane
1478 .D1 (alias: Ic swapp )
1482 is used and no source pane is specified with
1485 is swapped with the previous pane (before it numerically);
1487 swaps with the next pane (after it numerically).
1491 not to change the active pane.
1492 .It Xo Ic swap-window
1494 .Op Fl s Ar src-window
1495 .Op Fl t Ar dst-window
1497 .D1 (alias: Ic swapw )
1500 except the source and destination windows are swapped.
1501 It is an error if no window exists at
1503 .It Xo Ic unlink-window
1505 .Op Fl t Ar target-window
1507 .D1 (alias: Ic unlinkw )
1512 is given, a window may be unlinked only if it is linked to multiple sessions -
1513 windows may not be linked to no sessions;
1516 is specified and the window is linked to only one session, it is unlinked and
1521 allows a command to be bound to most keys, with or without a prefix key.
1522 When specifying keys, most represent themselves (for example
1526 Ctrl keys may be prefixed with
1532 In addition, the following special key names are accepted:
1557 Note that to bind the
1561 keys, quotation marks are necessary, for example:
1562 .Bd -literal -offset indent
1563 bind-key '"' split-window
1564 bind-key "'" new-window
1567 Commands related to key bindings are as follows:
1571 .Op Fl t Ar key-table
1572 .Ar key Ar command Op Ar arguments
1574 .D1 (alias: Ic bind )
1581 the primary key bindings are modified (those normally activated with the prefix
1582 key); in this case, if
1584 is specified, it is not necessary to use the prefix key,
1591 flag indicates this key may repeat, see the
1601 the binding for command mode with
1603 or for normal mode without.
1604 To view the default bindings and possible commands, see the
1607 .It Ic list-keys Op Fl t Ar key-table
1608 .D1 (alias: Ic lsk )
1609 List all key bindings.
1612 the primary key bindings - those executed when preceded by the prefix key -
1614 Keys bound without the prefix key (see
1624 are listed; this may be one of:
1633 .Op Fl t Ar target-pane
1636 .D1 (alias: Ic send )
1637 Send a key or keys to a window.
1640 is the name of the key (such as
1644 ) to send; if the string is not recognised as a key, it is sent as a series of
1646 All arguments are sent sequentially from first to last.
1647 .It Ic send-prefix Op Fl t Ar target-pane
1648 Send the prefix key to a window as if it was pressed.
1649 If multiple prefix keys are configured, only the first is sent.
1650 .It Xo Ic unbind-key
1652 .Op Fl t Ar key-table
1655 .D1 (alias: Ic unbind )
1656 Unbind the command bound to
1660 the primary key bindings are modified; in this case, if
1662 is specified, the command bound to
1664 without a prefix (if any) is removed.
1667 is present, all key bindings are removed.
1675 is unbound: the binding for command mode with
1677 or for normal mode without.
1680 The appearance and behaviour of
1682 may be modified by changing the value of various options.
1683 There are three types of option:
1684 .Em server options ,
1687 .Em window options .
1691 server has a set of global options which do not apply to any particular
1693 These are altered with the
1696 command, or displayed with the
1701 In addition, each individual session may have a set of session options, and
1702 there is a separate set of global session options.
1703 Sessions which do not have a particular option configured inherit the value
1704 from the global session options.
1705 Session options are set or unset with the
1707 command and may be listed with the
1710 The available server and session options are listed under the
1714 Similarly, a set of window options is attached to each window, and there is
1715 a set of global window options from which any unset options are inherited.
1716 Window options are altered with the
1717 .Ic set-window-option
1718 command and can be listed with the
1719 .Ic show-window-options
1721 All window options are documented with the
1722 .Ic set-window-option
1725 Commands which set options are as follows:
1727 .It Xo Ic set-option
1729 .Op Fl t Ar target-session | Ar target-window
1732 .D1 (alias: Ic set )
1733 Set a window option with
1736 .Ic set-window-option
1738 a server option with
1740 otherwise a session option.
1744 is specified, the global session or window option is set.
1747 and if the option expects a string,
1749 is appended to the existing setting.
1752 flag unsets an option, so a session inherits the option from the global
1754 It is not possible to unset a global option.
1756 Available window options are listed under
1757 .Ic set-window-option .
1759 Available server options are:
1761 .It Ic buffer-limit Ar number
1762 Set the number of buffers; as new buffers are added to the top of the stack,
1763 old ones are removed from the bottom if necessary to maintain this maximum
1765 .It Ic escape-time Ar time
1766 Set the time in milliseconds for which
1768 waits after an escape is input to determine if it is part of a function or meta
1770 The default is 500 milliseconds.
1771 .It Xo Ic exit-unattached
1774 If enabled, the server will exit when there are no attached clients.
1778 Enable or disable the display of various informational messages (see also the
1781 .It Xo Ic set-clipboard
1784 Attempt to set the terminal clipboard content using the
1788 This option is on by default if there is an
1792 description for the client terminal.
1793 Note that this feature needs to be enabled in
1795 by setting the resource:
1796 .Bd -literal -offset indent
1797 disallowedWindowOps: 20,21,SetXprop
1800 Or changing this property from the
1802 interactive menu when required.
1805 Available session options are:
1807 .It Ic base-index Ar index
1808 Set the base index from which an unused index should be searched when a new
1810 The default is zero.
1811 .It Xo Ic bell-action
1812 .Op Ic any | none | current
1814 Set action on window bell.
1816 means a bell in any window linked to a session causes a bell in the current
1817 window of that session,
1819 means all bells are ignored and
1821 means only bell in windows other than the current window are ignored.
1822 .It Xo Ic bell-on-alert
1825 If on, ring the terminal bell when an activity, content or silence alert
1827 .It Ic default-command Ar shell-command
1828 Set the command used for new windows (if not specified when the window is
1834 The default is an empty string, which instructs
1836 to create a login shell using the value of the
1839 .It Ic default-path Ar path
1840 Set the default working directory for processes created from keys, or
1841 interactively from the prompt.
1842 The default is empty, which means to use the working directory of the shell
1843 from which the server was started if it is available or the user's home if not.
1844 .It Ic default-shell Ar path
1845 Specify the default shell.
1846 This is used as the login shell for new windows when the
1848 option is set to empty, and must be the full path of the executable.
1851 tries to set a default value from the first suitable of the
1853 environment variable, the shell returned by
1857 This option should be configured when
1859 is used as a login shell.
1860 .It Ic default-terminal Ar terminal
1861 Set the default terminal for new windows created in this session - the
1862 default value of the
1864 environment variable.
1867 to work correctly, this
1871 or a derivative of it.
1872 .It Xo Ic destroy-unattached
1875 If enabled and the session is no longer attached to any clients, it is
1877 .It Xo Ic detach-on-destroy
1880 If on (the default), the client is detached when the session it is attached to
1882 If off, the client is switched to the most recently active of the remaining
1884 .It Ic display-panes-active-colour Ar colour
1885 Set the colour used by the
1887 command to show the indicator for the active pane.
1888 .It Ic display-panes-colour Ar colour
1889 Set the colour used by the
1891 command to show the indicators for inactive panes.
1892 .It Ic display-panes-time Ar time
1893 Set the time in milliseconds for which the indicators shown by the
1896 .It Ic display-time Ar time
1897 Set the amount of time for which status line messages and other on-screen
1898 indicators are displayed.
1901 .It Ic history-limit Ar lines
1902 Set the maximum number of lines held in window history.
1903 This setting applies only to new windows - existing window histories are not
1904 resized and retain the limit at the point they were created.
1905 .It Ic lock-after-time Ar number
1906 Lock the session (like the
1910 seconds of inactivity, or the entire server (all sessions) if the
1913 The default is not to lock (set to 0).
1914 .It Ic lock-command Ar shell-command
1915 Command to run when locking each client.
1916 The default is to run
1920 .It Xo Ic lock-server
1926 instead of each session locking individually as each has been
1928 .Ic lock-after-time ,
1929 the entire server will lock after
1931 sessions would have locked.
1932 This has no effect as a session option; it must be set as a global option.
1933 .It Ic message-attr Ar attributes
1934 Set status line message attributes, where
1938 or a comma-delimited list of one or more of:
1949 .It Ic message-bg Ar colour
1950 Set status line message background colour, where
1964 from the 256-colour set,
1966 or a hexadecimal RGB string such as
1968 which chooses the closest match from the default 256-colour set.
1969 .It Ic message-fg Ar colour
1970 Set status line message foreground colour.
1971 .It Ic message-limit Ar number
1972 Set the number of error or information messages to save in the message log for
1975 .It Xo Ic mouse-resize-pane
1980 captures the mouse and allows panes to be resized by dragging on their borders.
1981 .It Xo Ic mouse-select-pane
1986 captures the mouse and when a window is split into multiple panes the mouse may
1987 be used to select the current pane.
1988 The mouse click is also passed through to the application as normal.
1989 .It Xo Ic mouse-select-window
1992 If on, clicking the mouse on a window name in the status line will select that
1994 .It Xo Ic mouse-utf8
1997 If enabled, request mouse input as UTF-8 on UTF-8 terminals.
1998 .It Ic pane-active-border-bg Ar colour
1999 .It Ic pane-active-border-fg Ar colour
2000 Set the pane border colour for the currently active pane.
2001 .It Ic pane-border-bg Ar colour
2002 .It Ic pane-border-fg Ar colour
2003 Set the pane border colour for panes aside from the active pane.
2004 .It Ic prefix Ar keys
2005 Set the keys accepted as a prefix key.
2007 is a comma-separated list of key names, each of which individually behave as
2009 .It Ic repeat-time Ar time
2010 Allow multiple commands to be entered without pressing the prefix-key again
2013 milliseconds (the default is 500).
2014 Whether a key repeats may be set when it is bound using the
2018 Repeat is enabled for the default keys bound to the
2021 .It Xo Ic set-remain-on-exit
2026 window option for any windows first created in this session.
2027 When this option is true, windows in which the running program has
2028 exited do not close, instead remaining open but inactivate.
2031 command to reactivate such a window, or the
2033 command to destroy it.
2034 .It Xo Ic set-titles
2037 Attempt to set the window title using the \ee]2;...\e007 xterm code if
2038 the terminal appears to be an xterm.
2039 This option is off by default.
2041 will only attempt to set the window title if the STY environment
2043 .It Ic set-titles-string Ar string
2044 String used to set the window title if
2047 Character sequences are replaced as for the
2053 Show or hide the status line.
2054 .It Ic status-attr Ar attributes
2055 Set status line attributes.
2056 .It Ic status-bg Ar colour
2057 Set status line background colour.
2058 .It Ic status-fg Ar colour
2059 Set status line foreground colour.
2060 .It Ic status-interval Ar interval
2061 Update the status bar every
2064 By default, updates will occur every 15 seconds.
2065 A setting of zero disables redrawing at interval.
2066 .It Xo Ic status-justify
2067 .Op Ic left | centre | right
2069 Set the position of the window list component of the status line: left, centre
2071 .It Xo Ic status-keys
2074 Use vi or emacs-style
2075 key bindings in the status line, for example at the command prompt.
2076 The default is emacs, unless the
2080 environment variables are set and contain the string
2082 .It Ic status-left Ar string
2085 to the left of the status bar.
2087 will be passed through
2090 By default, the session name is shown.
2092 may contain any of the following special character sequences:
2093 .Bl -column "Character pair" "Replaced with" -offset indent
2094 .It Sy "Character pair" Ta Sy "Replaced with"
2095 .It Li "#(shell-command)" Ta "First line of the command's output"
2096 .It Li "#[attributes]" Ta "Colour or attribute change"
2097 .It Li "#H" Ta "Hostname of local host"
2098 .It Li "#h" Ta "Hostname of local host without the domain name"
2099 .It Li "#F" Ta "Current window flag"
2100 .It Li "#I" Ta "Current window index"
2101 .It Li "#P" Ta "Current pane index"
2102 .It Li "#S" Ta "Session name"
2103 .It Li "#T" Ta "Current window title"
2104 .It Li "#W" Ta "Current window name"
2105 .It Li "##" Ta "A literal" Ql #
2108 The #(shell-command) form executes
2110 and inserts the first line of its output.
2111 Note that shell commands are only executed once at the interval specified by
2114 option: if the status line is redrawn in the meantime, the previous result is
2116 Shell commands are executed with the
2118 global environment set (see the
2122 The window title (#T) is the title set by the program running within the window
2123 using the OSC title setting sequence, for example:
2124 .Bd -literal -offset indent
2125 $ printf '\e033]2;My Title\e033\e\e'
2128 When a window is first created, its title is the hostname.
2130 #[attributes] allows a comma-separated list of attributes to be specified,
2133 to set the foreground colour,
2135 to set the background colour, the name of one of the attributes (listed under
2138 option) to turn an attribute on, or an attribute prefixed with
2140 to turn one off, for example
2143 .Bd -literal -offset indent
2144 #(sysctl vm.loadavg)
2145 #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
2148 Where appropriate, special character sequences may be prefixed with a number to
2149 specify the maximum length, for example
2152 By default, UTF-8 in
2154 is not interpreted, to enable UTF-8, use the
2157 .It Ic status-left-attr Ar attributes
2158 Set the attribute of the left part of the status line.
2159 .It Ic status-left-bg Ar colour
2160 Set the background colour of the left part of the status line.
2161 .It Ic status-left-fg Ar colour
2162 Set the foreground colour of the left part of the status line.
2163 .It Ic status-left-length Ar length
2166 of the left component of the status bar.
2168 .It Ic status-right Ar string
2171 to the right of the status bar.
2172 By default, the current window title in double quotes, the date and the time
2179 character pairs are replaced, and UTF-8 is dependent on the
2182 .It Ic status-right-attr Ar attributes
2183 Set the attribute of the right part of the status line.
2184 .It Ic status-right-bg Ar colour
2185 Set the background colour of the right part of the status line.
2186 .It Ic status-right-fg Ar colour
2187 Set the foreground colour of the right part of the status line.
2188 .It Ic status-right-length Ar length
2191 of the right component of the status bar.
2193 .It Xo Ic status-utf8
2198 to treat top-bit-set characters in the
2202 strings as UTF-8; notably, this is important for wide characters.
2203 This option defaults to off.
2204 .It Ic terminal-overrides Ar string
2205 Contains a list of entries which override terminal descriptions read using
2208 is a comma-separated list of items each a colon-separated string made up of a
2209 terminal type pattern (matched using
2215 For example, to set the
2220 for all terminal types and the
2226 terminal type, the option could be set to the string:
2227 .Bd -literal -offset indent
2228 "*:clear=\ee[H\ee[2J,rxvt:dch1=\ee[P"
2231 The terminal entry value is passed through
2233 before interpretation.
2234 The default value forcibly corrects the
2236 entry for terminals which support 88 or 256 colours:
2237 .Bd -literal -offset indent
2238 "*88col*:colors=88,*256col*:colors=256,xterm*:XT"
2240 .It Ic update-environment Ar variables
2241 Set a space-separated string containing a list of environment variables to be
2242 copied into the session environment when a new session is created or an
2243 existing session is attached.
2244 Any variables that do not exist in the source environment are set to be
2245 removed from the session environment (as if
2251 "DISPLAY SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION WINDOWID
2253 .It Xo Ic visual-activity
2256 If on, display a status line message when activity occurs in a window
2258 .Ic monitor-activity
2259 window option is enabled.
2260 .It Xo Ic visual-bell
2263 If this option is on, a message is shown on a bell instead of it being passed
2264 through to the terminal (which normally makes a sound).
2268 .It Xo Ic visual-content
2272 .Ic visual-activity ,
2273 display a message when content is present in a window
2276 window option is enabled.
2277 .It Xo Ic visual-silence
2282 is enabled, prints a message after the interval has expired on a given window.
2284 .It Xo Ic set-window-option
2286 .Op Fl t Ar target-window
2289 .D1 (alias: Ic setw )
2290 Set a window option.
2296 flags work similarly to the
2300 Supported window options are:
2302 .Bl -tag -width Ds -compact
2303 .It Xo Ic aggressive-resize
2306 Aggressively resize the chosen window.
2309 will resize the window to the size of the smallest session for which it is the
2310 current window, rather than the smallest session to which it is attached.
2311 The window may resize when the current window is changed on another sessions;
2312 this option is good for full-screen programs which support
2314 and poor for interactive programs such as shells.
2316 .It Xo Ic alternate-screen
2319 This option configures whether programs running inside
2321 may use the terminal alternate screen feature, which allows the
2327 The alternate screen feature preserves the contents of the window when an
2328 interactive application starts and restores it on exit, so that any output
2329 visible before the application starts reappears unchanged after it exits.
2332 .It Xo Ic automatic-rename
2335 Control automatic window renaming.
2336 When this setting is enabled,
2338 will attempt - on supported platforms - to rename the window to reflect the
2339 command currently running in it.
2340 This flag is automatically disabled for an individual window when a name
2341 is specified at creation with
2347 It may be switched off globally with:
2348 .Bd -literal -offset indent
2349 set-window-option -g automatic-rename off
2352 .It Ic clock-mode-colour Ar colour
2355 .It Xo Ic clock-mode-style
2358 Set clock hour format.
2360 .It Ic force-height Ar height
2361 .It Ic force-width Ar width
2364 from resizing a window to greater than
2368 A value of zero restores the default unlimited setting.
2370 .It Ic main-pane-height Ar height
2371 .It Ic main-pane-width Ar width
2372 Set the width or height of the main (left or top) pane in the
2378 .It Ic mode-attr Ar attributes
2379 Set window modes attributes.
2381 .It Ic mode-bg Ar colour
2382 Set window modes background colour.
2384 .It Ic mode-fg Ar colour
2385 Set window modes foreground colour.
2390 Use vi or emacs-style key bindings in copy and choice modes.
2393 option, the default is emacs, unless
2400 .It Xo Ic mode-mouse
2401 .Op Ic on | off | copy-mode
2403 Mouse state in modes.
2404 If on, the mouse may be used to enter copy mode and copy a selection by
2405 dragging, to enter copy mode and scroll with the mouse wheel, or to select an
2406 option in choice mode.
2409 the mouse behaves as set to on, but cannot be used to enter copy
2412 .It Xo Ic monitor-activity
2415 Monitor for activity in the window.
2416 Windows with activity are highlighted in the status line.
2418 .It Ic monitor-content Ar match-string
2419 Monitor content in the window.
2424 appears in the window, it is highlighted in the status line.
2426 .It Xo Ic monitor-silence
2429 Monitor for silence (no activity) in the window within
2432 Windows that have been silent for the interval are highlighted in the
2434 An interval of zero disables the monitoring.
2436 .It Ic other-pane-height Ar height
2437 Set the height of the other panes (not the main pane) in the
2440 If this option is set to 0 (the default), it will have no effect.
2442 .Ic main-pane-height
2444 .Ic other-pane-height
2445 options are set, the main pane will grow taller to make the other panes the
2446 specified height, but will never shrink to do so.
2448 .It Ic other-pane-width Ar width
2450 .Ic other-pane-height ,
2451 but set the width of other panes in the
2455 .It Ic pane-base-index Ar index
2458 but set the starting index for pane numbers.
2460 .It Xo Ic remain-on-exit
2463 A window with this flag set is not destroyed when the program running in it
2465 The window may be reactivated with the
2469 .It Xo Ic synchronize-panes
2472 Duplicate input to any pane to all other panes in the same window (only
2473 for panes that are not in any special mode).
2480 to expect UTF-8 sequences to appear in this window.
2482 .It Ic window-status-alert-attr Ar attributes
2483 Set status line attributes for windows which have an alert (bell, activity
2486 .It Ic window-status-alert-bg Ar colour
2487 Set status line background colour for windows with an alert.
2489 .It Ic window-status-alert-fg Ar colour
2490 Set status line foreground colour for windows with an alert.
2492 .It Ic window-status-attr Ar attributes
2493 Set status line attributes for a single window.
2495 .It Ic window-status-bg Ar colour
2496 Set status line background colour for a single window.
2498 .It Ic window-status-current-attr Ar attributes
2499 Set status line attributes for the currently active window.
2501 .It Ic window-status-current-bg Ar colour
2502 Set status line background colour for the currently active window.
2504 .It Ic window-status-current-fg Ar colour
2505 Set status line foreground colour for the currently active window.
2507 .It Ic window-status-current-format Ar string
2509 .Ar window-status-format ,
2510 but is the format used when the window is the current window.
2512 .It Ic window-status-fg Ar colour
2513 Set status line foreground colour for a single window.
2515 .It Ic window-status-format Ar string
2516 Set the format in which the window is displayed in the status line window list.
2519 option for details of special character sequences available.
2523 .It Ic word-separators Ar string
2524 Sets the window's conception of what characters are considered word
2525 separators, for the purposes of the next and previous word commands in
2530 .It Xo Ic xterm-keys
2533 If this option is set,
2537 function key sequences; these have a number included to indicate modifiers such
2538 as Shift, Alt or Ctrl.
2541 .It Xo Ic show-options
2543 .Op Fl t Ar target-session | Ar target-window
2545 .D1 (alias: Ic show )
2546 Show the window options with
2549 .Ic show-window-options ) ,
2550 the server options with
2552 otherwise the session options for
2553 .Ar target session .
2554 Global session or window options are listed if
2557 .It Xo Ic show-window-options
2559 .Op Fl t Ar target-window
2561 .D1 (alias: Ic showw )
2562 List the window options for
2564 or the global window options if
2580 This is a string which controls the output format of the command.
2581 Special character sequences are replaced as documented under the
2583 option and an additional long form is accepted.
2584 Replacement variables are enclosed in
2592 Conditionals are also accepted by prefixing with
2594 and separating two alternatives with a comma;
2595 if the specified variable exists and is not zero, the first alternative
2596 is chosen, otherwise the second is used.
2598 .Ql #{?session_attached,attached,not attached}
2599 will include the string
2601 if the session is attached and the string
2603 if it is unattached.
2605 The following variables are available, where appropriate:
2606 .Bl -column "session_created_string" "Replaced with" -offset indent
2607 .It Sy "Variable name" Ta Sy "Replaced with"
2608 .It Li "client_activity" Ta "Integer time client last had activity"
2609 .It Li "client_activity_string" Ta "String time client last had activity"
2610 .It Li "client_created" Ta "Integer time client created"
2611 .It Li "client_created_string" Ta "String time client created"
2612 .It Li "client_cwd" Ta "Working directory of client"
2613 .It Li "client_height" Ta "Height of client"
2614 .It Li "client_readonly" Ta "1 if client is readonly"
2615 .It Li "client_termname" Ta "Terminal name of client"
2616 .It Li "client_tty" Ta "Pseudo terminal of client"
2617 .It Li "client_utf8" Ta "1 if client supports utf8"
2618 .It Li "client_width" Ta "Width of client"
2619 .It Li "host" Ta "Hostname of local host"
2620 .It Li "line" Ta "Line number in the list"
2621 .It Li "pane_active" Ta "1 if active pane"
2622 .It Li "pane_dead" Ta "1 if pane is dead"
2623 .It Li "pane_height" Ta "Height of pane"
2624 .It Li "pane_id" Ta "Unique pane id"
2625 .It Li "pane_pid" Ta "PID of first process in pane"
2626 .It Li "pane_start_command" Ta "Command pane started with"
2627 .It Li "pane_start_path" Ta "Path pane started with"
2628 .It Li "pane_title" Ta "Title of pane"
2629 .It Li "pane_tty" Ta "Pseudo terminal of pane"
2630 .It Li "pane_width" Ta "Width of pane"
2631 .It Li "session_attached" Ta "1 if session attached"
2632 .It Li "session_created" Ta "Integer time session created"
2633 .It Li "session_created_string" Ta "String time session created"
2634 .It Li "session_group" Ta "Number of session group"
2635 .It Li "session_grouped" Ta "1 if session in a group"
2636 .It Li "session_height" Ta "Height of session"
2637 .It Li "session_name" Ta "Name of session"
2638 .It Li "session_width" Ta "Width of session"
2639 .It Li "session_windows" Ta "Number of windows in session"
2640 .It Li "window_active" Ta "1 if window active"
2641 .It Li "window_flags" Ta "Window flags"
2642 .It Li "window_height" Ta "Height of window"
2643 .It Li "window_index" Ta "Index of window"
2644 .It Li "window_layout" Ta "Window layout description"
2645 .It Li "window_name" Ta "Name of window"
2646 .It Li "window_width" Ta "Width of window"
2649 When the server is started,
2651 copies the environment into the
2652 .Em global environment ;
2653 in addition, each session has a
2654 .Em session environment .
2655 When a window is created, the session and global environments are merged.
2656 If a variable exists in both, the value from the session environment is used.
2657 The result is the initial environment passed to the new process.
2660 .Ic update-environment
2661 session option may be used to update the session environment from the client
2662 when a new session is created or an old reattached.
2664 also initialises the
2666 variable with some internal information to allow commands to be executed
2667 from inside, and the
2669 variable with the correct terminal setting of
2672 Commands to alter and view the environment are:
2674 .It Xo Ic set-environment
2676 .Op Fl t Ar target-session
2677 .Ar name Op Ar value
2679 .D1 (alias: Ic setenv )
2680 Set or unset an environment variable.
2683 is used, the change is made in the global environment; otherwise, it is applied
2684 to the session environment for
2685 .Ar target-session .
2688 flag unsets a variable.
2690 indicates the variable is to be removed from the environment before starting a
2692 .It Xo Ic show-environment
2694 .Op Fl t Ar target-session
2696 .D1 (alias: Ic showenv )
2697 Display the environment for
2699 or the global environment with
2701 Variables removed from the environment are prefixed with
2706 includes an optional status line which is displayed in the bottom line of each
2708 By default, the status line is enabled (it may be disabled with the
2710 session option) and contains, from left-to-right: the name of the current
2711 session in square brackets; the window list; the current window title in double
2712 quotes; and the time and date.
2714 The status line is made of three parts: configurable left and right sections
2715 (which may contain dynamic content such as the time or output from a shell
2718 .Ic status-left-length ,
2721 .Ic status-right-length
2722 options below), and a central window list.
2723 By default, the window list shows the index, name and (if any) flag of the
2724 windows present in the current session in ascending numerical order.
2725 It may be customised with the
2726 .Ar window-status-format
2728 .Ar window-status-current-format
2730 The flag is one of the following symbols appended to the window name:
2731 .Bl -column "Symbol" "Meaning" -offset indent
2732 .It Sy "Symbol" Ta Sy "Meaning"
2733 .It Li "*" Ta "Denotes the current window."
2734 .It Li "-" Ta "Marks the last window (previously selected)."
2735 .It Li "#" Ta "Window is monitored and activity has been detected."
2736 .It Li "!" Ta "A bell has occurred in the window."
2737 .It Li "+" Ta "Window is monitored for content and it has appeared."
2738 .It Li "~" Ta "The window has been silent for the monitor-silence interval."
2741 The # symbol relates to the
2742 .Ic monitor-activity
2746 The window name is printed in inverted colours if an alert (bell, activity or
2747 content) is present.
2749 The colour and attributes of the status line may be configured, the entire
2750 status line using the
2755 session options and individual windows using the
2756 .Ic window-status-attr ,
2757 .Ic window-status-fg
2759 .Ic window-status-bg
2762 The status line is automatically refreshed at interval if it has changed, the
2763 interval may be controlled with the
2767 Commands related to the status line are as follows:
2769 .It Xo Ic command-prompt
2772 .Op Fl t Ar target-client
2775 Open the command prompt in a client.
2776 This may be used from inside
2778 to execute commands interactively.
2782 is specified, it is used as the command.
2785 is a comma-separated list of the initial text for each prompt.
2790 is a comma-separated list of prompts which are displayed in order; otherwise
2791 a single prompt is displayed, constructed from
2793 if it is present, or
2801 may contain the special character sequences supported by the
2805 Before the command is executed, the first occurrence of the string
2807 and all occurrences of
2809 are replaced by the response to the first prompt, the second
2813 are replaced with the response to the second prompt, and so on for further
2815 Up to nine prompt responses may be replaced
2821 .It Xo Ic confirm-before
2823 .Op Fl t Ar target-client
2826 .D1 (alias: Ic confirm )
2827 Ask for confirmation before executing
2833 is the prompt to display; otherwise a prompt is constructed from
2835 It may contain the special character sequences supported by the
2839 This command works only from inside
2841 .It Xo Ic display-message
2843 .Op Fl c Ar target-client
2844 .Op Fl t Ar target-pane
2847 .D1 (alias: Ic display )
2851 is given, the output is printed to stdout, otherwise it is displayed in the
2858 with the exception that #() are not handled; information is taken from
2862 is given, otherwise the active pane for the session attached to
2867 maintains a stack of
2869 Up to the value of the
2871 option are kept; when a new buffer is added, the buffer at the bottom of the
2873 Buffers may be added using
2877 command, and pasted into a window using the
2881 A configurable history buffer is also maintained for each window.
2882 By default, up to 2000 lines are kept; this can be altered with the
2888 The buffer commands are as follows:
2892 .Op Fl t Ar target-window
2895 Put a window into buffer choice mode, where a buffer may be chosen
2896 interactively from a list.
2897 After a buffer is selected,
2899 is replaced by the buffer index in
2901 and the result executed as a command.
2904 is not given, "paste-buffer -b '%%'" is used.
2905 This command works only from inside
2907 .It Ic clear-history Op Fl t Ar target-pane
2908 .D1 (alias: Ic clearhist )
2909 Remove and free the history for the specified pane.
2910 .It Ic delete-buffer Op Fl b Ar buffer-index
2911 .D1 (alias: Ic deleteb )
2912 Delete the buffer at
2914 or the top buffer if not specified.
2916 .D1 (alias: Ic lsb )
2917 List the global buffers.
2918 .It Xo Ic load-buffer
2919 .Op Fl b Ar buffer-index
2922 .D1 (alias: Ic loadb )
2923 Load the contents of the specified paste buffer from
2925 .It Xo Ic paste-buffer
2927 .Op Fl b Ar buffer-index
2928 .Op Fl s Ar separator
2929 .Op Fl t Ar target-pane
2931 .D1 (alias: Ic pasteb )
2932 Insert the contents of a paste buffer into the specified pane.
2933 If not specified, paste into the current one.
2936 also delete the paste buffer from the stack.
2937 When output, any linefeed (LF) characters in the paste buffer are replaced with
2938 a separator, by default carriage return (CR).
2939 A custom separator may be specified using the
2944 flag means to do no replacement (equivalent to a separator of LF).
2945 .It Xo Ic save-buffer
2947 .Op Fl b Ar buffer-index
2950 .D1 (alias: Ic saveb )
2951 Save the contents of the specified paste buffer to
2955 option appends to rather than overwriting the file.
2956 .It Xo Ic set-buffer
2957 .Op Fl b Ar buffer-index
2960 .D1 (alias: Ic setb )
2961 Set the contents of the specified buffer to
2963 .It Xo Ic show-buffer
2964 .Op Fl b Ar buffer-index
2966 .D1 (alias: Ic showb )
2967 Display the contents of the specified buffer.
2970 Miscellaneous commands are as follows:
2972 .It Ic clock-mode Op Fl t Ar target-pane
2973 Display a large clock.
2974 .It Ic if-shell Ar shell-command command
2982 .D1 (alias: Ic lock )
2983 Lock each client individually by running the command specified by the
2986 .It Ic run-shell Ar shell-command
2987 .D1 (alias: Ic run )
2990 in the background without creating a window.
2991 After it finishes, any output to stdout is displayed in copy mode.
2992 If the command doesn't return success, the exit status is also displayed.
2994 .D1 (alias: Ic info )
2995 Show server information and terminal details.
2997 .Sh TERMINFO EXTENSIONS
2999 understands some extensions to
3003 Set the cursor colour.
3004 The first takes a single string argument and is used to set the colour;
3005 the second takes no arguments and restores the default cursor colour.
3006 If set, a sequence such as this may be used
3007 to change the cursor colour from inside
3009 .Bd -literal -offset indent
3010 $ printf '\e033]12;red\e033\e\e'
3013 Change the cursor style.
3014 If set, a sequence such as this may be used
3015 to change the cursor to an underline:
3016 .Bd -literal -offset indent
3017 $ printf '\e033[4 q'
3022 is set, it will be used to reset the cursor style instead
3026 This sequence can be used by
3028 to store the current buffer in the host terminal's selection (clipboard).
3031 option above and the
3036 .Bl -tag -width "/etc/tmux.confXXX" -compact
3041 .It Pa /etc/tmux.conf
3042 System-wide configuration file.
3050 .Dl $ tmux new-session vi
3052 Most commands have a shorter form, known as an alias.
3053 For new-session, this is
3058 Alternatively, the shortest unambiguous form of a command is accepted.
3059 If there are several options, they are listed:
3060 .Bd -literal -offset indent
3062 ambiguous command: n, could be: new-session, new-window, next-window
3065 Within an active session, a new window may be created by typing
3075 Windows may be navigated with:
3077 (to select window 0),
3079 (to select window 1), and so on;
3081 to select the next window; and
3083 to select the previous window.
3085 A session may be detached using
3087 (or by an external event such as
3089 disconnection) and reattached with:
3091 .Dl $ tmux attach-session
3095 lists the current key bindings in the current window; up and down may be used
3096 to navigate the list or
3100 Commands to be run when the
3102 server is started may be placed in the
3105 Common examples include:
3107 Changing the default prefix key:
3108 .Bd -literal -offset indent
3109 set-option -g prefix C-a
3111 bind-key C-a send-prefix
3114 Turning the status line off, or changing its colour:
3115 .Bd -literal -offset indent
3116 set-option -g status off
3117 set-option -g status-bg blue
3120 Setting other options, such as the default command,
3121 or locking after 30 minutes of inactivity:
3122 .Bd -literal -offset indent
3123 set-option -g default-command "exec /bin/ksh"
3124 set-option -g lock-after-time 1800
3127 Creating new key bindings:
3128 .Bd -literal -offset indent
3129 bind-key b set-option status
3130 bind-key / command-prompt "split-window 'exec man %%'"
3131 bind-key S command-prompt "new-window -n %1 'ssh %1'"
3136 .An Nicholas Marriott Aq nicm@users.sourceforge.net