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
138 the default socket is named
140 This option allows a different socket name to be specified, allowing several
146 a full path is not necessary: the sockets are all created in the same
149 If the socket is accidentally removed, the
151 signal may be sent to the
153 server process to recreate it.
155 Behave as a login shell.
156 This flag currently has no effect and is for compatibility with other shells
157 when using tmux as a login shell.
161 server option to prevent the server sending various informational messages.
162 .It Fl S Ar socket-path
163 Specify a full alternative path to the server socket.
166 is specified, the default socket directory is not used and any
171 attempts to guess if the terminal is likely to support UTF-8 by checking the
177 environment variables to be set for the string "UTF-8".
178 This is not always correct: the
180 flag explicitly informs
182 that UTF-8 is supported.
184 If the server is started from a client passed
186 or where UTF-8 is detected, the
190 options are enabled in the global window and session options respectively.
192 Request verbose logging.
193 This option may be specified multiple times for increasing verbosity.
194 Log messages will be saved into
195 .Pa tmux-client-PID.log
197 .Pa tmux-server-PID.log
198 files in the current directory, where
200 is the PID of the server or client process.
201 .It Ar command Op Ar flags
202 This specifies one of a set of commands used to control
204 as described in the following sections.
205 If no commands are specified, the
211 may be controlled from an attached client by using a key combination of a
214 (Ctrl-b) by default, followed by a command key.
216 The default command key bindings are:
218 .Bl -tag -width "XXXXXXXXXX" -offset indent -compact
220 Send the prefix key (C-b) through to the application.
222 Rotate the panes in the current window forwards.
228 Break the current pane out of the window.
230 Split the current pane into two, top and bottom.
232 List all paste buffers.
234 Split the current pane into two, left and right.
236 Kill the current window.
238 Prompt for a window index to select.
240 Rename the current window.
242 Delete the most recently copied buffer of text.
244 Prompt for an index to move the current window.
246 Select windows 0 to 9.
252 Move to the previously active pane.
254 Choose which buffer to paste interactively from a list.
256 List all key bindings.
258 Choose a client to detach.
260 Enter copy mode to copy text or view the history.
262 Paste the most recently copied buffer of text.
266 Detach the current client.
268 Prompt to search for text in open windows.
270 Display some information about the current window.
272 Move to the previously selected window.
274 Change to the next window.
276 Select the next pane in the current window.
278 Change to the previous window.
280 Briefly display pane indexes.
282 Force redraw of the attached client.
284 Select a new session for the attached client interactively.
288 Choose the current window interactively.
290 Kill the current pane.
292 Swap the current pane with the previous pane.
294 Swap the current pane with the next pane.
296 Show previous messages from
300 Enter copy mode and scroll one page up.
303 Change to the pane above, below, to the left, or to the right of the current
306 Arrange panes in one of the five preset layouts: even-horizontal,
307 even-vertical, main-horizontal, main-vertical, or tiled.
309 Move to the next window with a bell or activity marker.
311 Rotate the panes in the current window backwards.
313 Move to the previous window with a bell or activity marker.
316 Resize the current pane in steps of one cell.
319 Resize the current pane in steps of five cells.
322 Key bindings may be changed with the
328 This section contains a list of the commands supported by
330 Most commands accept the optional
338 These specify the client, session, window or pane which a command should affect.
342 file to which the client is connected, for example either of
346 for the client attached to
348 If no client is specified, the current client is chosen, if possible, or an
350 Clients may be listed with the
355 is either the name of a session (as listed by the
357 command) or the name of a client with the same syntax as
359 in which case the session attached to the client is used.
360 When looking for the session name,
362 initially searches for an exact match; if none is found, the session names
363 are checked for any for which
365 is a prefix or for which it matches as an
368 If a single match is found, it is used as the target session; multiple matches
370 If a session is omitted, the current session is used if available; if no
371 current session is available, the most recently used is chosen.
374 specifies a window in the form
375 .Em session Ns \&: Ns Em window .
377 follows the same rules as for
381 is looked for in order: as a window index, for example mysession:1; as an exact
382 window name, such as mysession:mywindow; then as an
384 pattern or the start of a window name, such as mysession:mywin* or
386 An empty window name specifies the next unused index if appropriate (for
392 otherwise the current window in
395 The special character
397 uses the last (previously current) window, or
401 are the next window or the previous window by number.
402 When the argument does not contain a colon,
404 first attempts to parse it as window; if that fails, an attempt is made to
408 takes a similar form to
410 but with the optional addition of a period followed by a pane index, for
411 example: mysession:mywindow.1.
412 If the pane index is omitted, the currently active pane in the specified
414 If neither a colon nor period appears,
416 first attempts to use the argument as a pane index; if that fails, it is looked
423 indicate the next or previous pane index, respectively.
433 may be used instead of a pane index.
435 The special characters
439 may be followed by an offset, for example:
440 .Bd -literal -offset indent
444 When dealing with a session that doesn't contain sequential window indexes,
445 they will be correctly skipped.
451 These must be passed as a single item, which typically means quoting them, for
453 .Bd -literal -offset indent
454 new-window 'vi /etc/passwd'
461 command, passed with the command and arguments separately, for example:
462 .Bd -literal -offset indent
463 bind-key F1 set-window-option force-width 81
468 .Bd -literal -offset indent
469 $ tmux bind-key F1 set-window-option force-width 81
472 Multiple commands may be specified together as part of a
473 .Em command sequence .
474 Each command should be separated by spaces and a semicolon;
475 commands are executed sequentially from left to right.
476 A literal semicolon may be included by escaping it with a backslash (for
477 example, when specifying a command sequence to
483 .Bd -literal -offset indent
484 refresh-client -t/dev/ttyp2
486 rename-session -tfirst newname
488 set-window-option -t:0 monitor-activity on
490 new-window ; split-window -d
495 .Bd -literal -offset indent
496 $ tmux kill-window -t :1
498 $ tmux new-window \e; split-window -d
500 $ tmux new-session -d 'vi /etc/passwd' \e; split-window -d \e; attach
502 .Sh CLIENTS AND SESSIONS
505 server manages clients, sessions, windows and panes.
506 Clients are attached to sessions to interact with them, either
507 when they are created with the
509 command, or later with the
512 Each session has one or more windows
515 Windows may be linked to multiple sessions and are made up of one or
517 each of which contains a pseudo terminal.
518 Commands for creating, linking and otherwise manipulating windows
521 .Sx WINDOWS AND PANES
524 The following commands are available to manage clients and sessions:
526 .It Xo Ic attach-session
528 .Op Fl t Ar target-session
530 .D1 (alias: Ic attach )
533 create a new client in the current terminal and attach it to
535 If used from inside, switch the current client.
538 is specified, any other clients attached to the session are detached.
540 signifies the client is read-only (only keys bound to the
542 command have any effect)
544 If no server is started,
546 will attempt to start it; this will fail unless sessions are created in the
548 .It Ic detach-client Op Fl t Ar target-client
549 .D1 (alias: Ic detach )
550 Detach the current client if bound to a key, or the specified client with
552 .It Ic has-session Op Fl t Ar target-session
554 Report an error and exit with 1 if the specified session does not exist.
555 If it does exist, exit with 0.
559 server and clients and destroy all sessions.
560 .It Ic kill-session Op Fl t Ar target-session
561 Destroy the given session, closing any windows linked to it and no other
562 sessions, and detaching all clients attached to it.
565 List all clients attached to the server.
567 .D1 (alias: Ic lscm )
568 List the syntax of all commands supported by
572 List all sessions managed by the server.
573 .It Ic lock-client Op Fl t Ar target-client
574 .D1 (alias: Ic lockc )
580 .It Ic lock-session Op Fl t Ar target-session
581 .D1 (alias: Ic locks )
582 Lock all clients attached to
584 .It Xo Ic new-session
586 .Op Fl n Ar window-name
587 .Op Fl s Ar session-name
588 .Op Fl t Ar target-session
592 Create a new session with name
595 The new session is attached to the current terminal unless
601 are the name of and shell command to execute in the initial window.
603 If run from a terminal, any
605 special characters are saved and used for new windows in the new session.
609 is given, the new session is
613 This means they share the same set of windows - all windows from
615 are linked to the new session and any subsequent new windows or windows being
616 closed are applied to both sessions.
617 The current and previous window and any session options remain independent and
618 either session may be killed without affecting the other.
626 .It Ic refresh-client Op Fl t Ar target-client
627 .D1 (alias: Ic refresh )
628 Refresh the current client if bound to a key, or a single client if one is given
631 .It Xo Ic rename-session
632 .Op Fl t Ar target-session
635 .D1 (alias: Ic rename )
636 Rename the session to
638 .It Xo Ic show-messages
639 .Op Fl t Ar target-client
641 .D1 (alias: Ic showmsgs )
642 Any messages displayed on the status line are saved in a per-client message
643 log, up to a maximum of the limit set by the
645 session option for the session attached to that client.
646 This command displays the log for
648 .It Ic source-file Ar path
649 .D1 (alias: Ic source )
650 Execute commands from
653 .D1 (alias: Ic start )
656 server, if not already running, without creating any sessions.
657 .It Xo Ic suspend-client
658 .Op Fl c Ar target-client
660 .D1 (alias: Ic suspendc )
661 Suspend a client by sending
664 .It Xo Ic switch-client
666 .Op Fl c Ar target-client
667 .Op Fl t Ar target-session
669 .D1 (alias: Ic switchc )
670 Switch the current session for client
678 is used, the client is moved to the next or previous session respectively.
680 .Sh WINDOWS AND PANES
683 window may be in one of several modes.
684 The default permits direct access to the terminal attached to the window.
685 The other is copy mode, which permits a section of a window or its
686 history to be copied to a
688 for later insertion into another window.
689 This mode is entered with the
694 It is also entered when a command that produces output, such as
696 is executed from a key binding.
698 The keys available depend on whether emacs or vi mode is selected
702 The following keys are supported as appropriate for the mode:
703 .Bl -column "FunctionXXXXXXXXXXXXXXXXX" "viXXXXXXXXXX" "emacs" -offset indent
704 .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
705 .It Li "Back to indentation" Ta "^" Ta "M-m"
706 .It Li "Bottom of history" Ta "G" Ta "M-<"
707 .It Li "Clear selection" Ta "Escape" Ta "C-g"
708 .It Li "Copy selection" Ta "Enter" Ta "M-w"
709 .It Li "Cursor down" Ta "j" Ta "Down"
710 .It Li "Cursor left" Ta "h" Ta "Left"
711 .It Li "Cursor right" Ta "l" Ta "Right"
712 .It Li "Cursor to bottom line" Ta "L" Ta ""
713 .It Li "Cursor to middle line" Ta "M" Ta "M-r"
714 .It Li "Cursor to top line" Ta "H" Ta "M-R"
715 .It Li "Cursor up" Ta "k" Ta "Up"
716 .It Li "Delete entire line" Ta "d" Ta "C-u"
717 .It Li "Delete to end of line" Ta "D" Ta "C-k"
718 .It Li "End of line" Ta "$" Ta "C-e"
719 .It Li "Go to line" Ta ":" Ta "g"
720 .It Li "Half page down" Ta "C-d" Ta "M-Down"
721 .It Li "Half page up" Ta "C-u" Ta "M-Up"
722 .It Li "Jump forward" Ta "f" Ta "f"
723 .It Li "Jump backward" Ta "F" Ta "F"
724 .It Li "Jump again" Ta ";" Ta ";"
725 .It Li "Jump again in reverse" Ta "," Ta ","
726 .It Li "Next page" Ta "C-f" Ta "Page down"
727 .It Li "Next space" Ta "W" Ta ""
728 .It Li "Next space, end of word" Ta "E" Ta ""
729 .It Li "Next word" Ta "w" Ta ""
730 .It Li "Next word end" Ta "e" Ta "M-f"
731 .It Li "Paste buffer" Ta "p" Ta "C-y"
732 .It Li "Previous page" Ta "C-b" Ta "Page up"
733 .It Li "Previous word" Ta "b" Ta "M-b"
734 .It Li "Previous space" Ta "B" Ta ""
735 .It Li "Quit mode" Ta "q" Ta "Escape"
736 .It Li "Rectangle toggle" Ta "v" Ta "R"
737 .It Li "Scroll down" Ta "C-Down or C-e" Ta "C-Down"
738 .It Li "Scroll up" Ta "C-Up or C-y" Ta "C-Up"
739 .It Li "Search again" Ta "n" Ta "n"
740 .It Li "Search again in reverse" Ta "N" Ta "N"
741 .It Li "Search backward" Ta "?" Ta "C-r"
742 .It Li "Search forward" Ta "/" Ta "C-s"
743 .It Li "Start of line" Ta "0" Ta "C-a"
744 .It Li "Start selection" Ta "Space" Ta "C-Space"
745 .It Li "Top of history" Ta "g" Ta "M->"
746 .It Li "Transpose chars" Ta "" Ta "C-t"
749 The next and previous word keys use space and the
754 characters as word delimiters by default, but this can be adjusted by
758 Next word moves to the start of the next word, next word end to the end of the
759 next word and previous word to the start of the previous word.
760 The three next and previous space keys work similarly but use a space alone as
763 The jump commands enable quick movement within a line.
768 will move the cursor to the next
770 character on the current line.
773 will then jump to the next occurrence.
775 Commands in copy mode may be prefaced by an optional repeat count.
776 With vi key bindings, a prefix is entered using the number keys; with
777 emacs, the Alt (meta) key and a number begins prefix entry.
778 For example, to move the cursor forward by ten words, use
784 Mode key bindings are defined in a set of named tables:
788 for keys used when line editing at the command prompt;
792 for keys used when choosing from lists (such as produced by the
799 The tables may be viewed with the
801 command and keys modified or removed with
806 The paste buffer key pastes the first line from the top paste buffer on the
815 .Op Fl t Ar target-pane
820 option scrolls one page up.
823 Each window displayed by
825 may be split into one or more
827 each pane takes up a certain area of the display and is a separate terminal.
828 A window may be split into panes using the
831 Windows may be split horizontally (with the
834 Panes may be resized with the
842 by default), the current pane may be changed with the
848 commands may be used to swap panes without changing their position.
849 Panes are numbered beginning from zero in the order they are created.
854 These may be selected with the
856 command or cycled with
860 by default); once a layout is chosen, panes within it may be moved and resized
863 The following layouts are supported:
865 .It Ic even-horizontal
866 Panes are spread out evenly from left to right across the window.
868 Panes are spread evenly from top to bottom.
869 .It Ic main-horizontal
870 A large (main) pane is shown at the top of the window and the remaining panes
871 are spread from left to right in the leftover space at the bottom.
874 window option to specify the height of the top pane.
878 but the large pane is placed on the left and the others spread from top to
879 bottom along the right.
884 Panes are spread out as evenly as possible over the window in both rows and
890 may be used to apply a previously used layout - the
892 command displays the layout of each window in a form suitable for use with
895 .Bd -literal -offset indent
898 layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
899 $ tmux select-layout bb62,159x48,0,0{79x48,0,0,79x48,80,0}
902 automatically adjusts the size of the layout for the current window size.
903 Note that a layout cannot be applied to a window with more panes than that
904 from which the layout was originally defined.
906 Commands related to windows and panes are as follows:
910 .Op Fl t Ar target-pane
912 .D1 (alias: Ic breakp )
915 off from its containing window to make it the only pane in a new window.
918 is given, the new window does not become the current window.
919 .It Xo Ic capture-pane
920 .Op Fl b Ar buffer-index
921 .Op Fl t Ar target-pane
923 .D1 (alias: Ic capturep )
924 Capture the contents of a pane to the specified buffer, or a new buffer if none
928 .Op Fl t Ar target-window
931 Put a window into client choice mode, allowing a client to be selected
932 interactively from a list.
933 After a client is chosen,
935 is replaced by the client
939 and the result executed as a command.
942 is not given, "detach-client -t '%%'" is used.
943 This command works only from inside
947 .Op Fl t Ar target-window
950 Put a window into session choice mode, where a session may be selected
951 interactively from a list.
954 is replaced by the session name in
956 and the result executed as a command.
959 is not given, "switch-client -t '%%'" is used.
960 This command works only from inside
964 .Op Fl t Ar target-window
967 Put a window into window choice mode, where a window may be chosen
968 interactively from a list.
969 After a window is selected,
971 is replaced by the session name and window index in
973 and the result executed as a command.
976 is not given, "select-window -t '%%'" is used.
977 This command works only from inside
979 .It Ic display-panes Op Fl t Ar target-client
980 .D1 (alias: Ic displayp)
981 Display a visible indicator of each pane shown by
984 .Ic display-panes-time ,
985 .Ic display-panes-colour ,
987 .Ic display-panes-active-colour
989 While the indicator is on screen, a pane may be selected with the
994 .It Xo Ic find-window
995 .Op Fl t Ar target-window
998 .D1 (alias: Ic findw )
1003 in window names, titles, and visible content (but not history).
1004 If only one window is matched, it'll be automatically selected, otherwise a
1005 choice list is shown.
1006 This command only works from inside
1012 .Fl p Ar percentage Oc
1013 .Op Fl s Ar src-pane
1014 .Op Fl t Ar dst-pane
1016 .D1 (alias: Ic joinp )
1019 but instead of splitting
1021 and creating a new pane, split it and move
1024 This can be used to reverse
1028 .Op Fl t Ar target-pane
1030 .D1 (alias: Ic killp )
1031 Destroy the given pane.
1032 If no panes remain in the containing window, it is also destroyed.
1035 option kills all but the pane given with
1037 .It Ic kill-window Op Fl t Ar target-window
1038 .D1 (alias: Ic killw )
1039 Kill the current window or the window at
1041 removing it from any sessions to which it is linked.
1042 .It Ic last-pane Op Fl t Ar target-window
1043 .D1 (alias: Ic lastp )
1044 Select the last (previously selected) pane.
1045 .It Ic last-window Op Fl t Ar target-session
1046 .D1 (alias: Ic last )
1047 Select the last (previously selected) window.
1050 is specified, select the last window of the current session.
1051 .It Xo Ic link-window
1053 .Op Fl s Ar src-window
1054 .Op Fl t Ar dst-window
1056 .D1 (alias: Ic linkw )
1063 is specified and no such window exists, the
1070 exists, it is killed, otherwise an error is generated.
1073 is given, the newly linked window is not selected.
1074 .It Ic list-panes Op Fl t Ar target-window
1075 .D1 (alias: Ic lsp )
1076 List the panes in the current window or in
1078 .It Ic list-windows Op Fl t Ar target-session
1079 .D1 (alias: Ic lsw )
1080 List windows in the current session or in
1081 .Ar target-session .
1082 .It Xo Ic move-window
1084 .Op Fl s Ar src-window
1085 .Op Fl t Ar dst-window
1087 .D1 (alias: Ic movew )
1090 except the window at
1094 .It Xo Ic new-window
1096 .Op Fl n Ar window-name
1097 .Op Fl t Ar target-window
1098 .Op Ar shell-command
1100 .D1 (alias: Ic neww )
1101 Create a new window.
1104 the new window is inserted at the next index up from the specified
1106 moving windows up if necessary,
1109 is the new window location.
1113 is given, the session does not make the new window the current window.
1115 represents the window to be created; if the target already exists an error is
1118 flag is used, in which case it is destroyed.
1120 is the command to execute.
1123 is not specified, the value of the
1127 When the shell command completes, the window closes.
1130 option to change this behaviour.
1134 environment variable must be set to
1136 for all programs running
1139 New windows will automatically have
1141 added to their environment, but care must be taken not to reset this in shell
1143 .It Ic next-layout Op Fl t Ar target-window
1144 .D1 (alias: Ic nextl )
1145 Move a window to the next layout and rearrange the panes to fit.
1146 .It Xo Ic next-window
1148 .Op Fl t Ar target-session
1150 .D1 (alias: Ic next )
1151 Move to the next window in the session.
1154 is used, move to the next window with a bell, activity or content alert.
1157 .Op Fl t Ar target-pane
1158 .Op Ar shell-command
1160 .D1 (alias: Ic pipep )
1161 Pipe any output sent by the program in
1164 A pane may only be piped to one command at a time, any existing pipe is
1170 string may contain the special character sequences supported by the
1175 is given, the current pipe (if any) is closed.
1179 option only opens a new pipe if no previous pipe exists, allowing a pipe to
1180 be toggled with a single key, for example:
1181 .Bd -literal -offset indent
1182 bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
1184 .It Xo Ic previous-layout
1185 .Op Fl t Ar target-window
1187 .D1 (alias: Ic prevl )
1188 Move to the previous layout in the session.
1189 .It Xo Ic previous-window
1191 .Op Fl t Ar target-session
1193 .D1 (alias: Ic prev )
1194 Move to the previous window in the session.
1197 move to the previous window with a bell, activity or content alert.
1198 .It Xo Ic rename-window
1199 .Op Fl t Ar target-window
1202 .D1 (alias: Ic renamew )
1203 Rename the current window, or the window at
1207 .It Xo Ic resize-pane
1209 .Op Fl t Ar target-pane
1212 .D1 (alias: Ic resizep )
1213 Resize a pane, upward with
1215 (the default), downward with
1219 and to the right with
1223 is given in lines or cells (the default is 1).
1224 .It Xo Ic respawn-window
1226 .Op Fl t Ar target-window
1227 .Op Ar shell-command
1229 .D1 (alias: Ic respawnw )
1230 Reactivate a window in which the command has exited (see the
1235 is not given, the command used when the window was created is executed.
1236 The window must be already inactive, unless
1238 is given, in which case any existing command is killed.
1239 .It Xo Ic rotate-window
1241 .Op Fl t Ar target-window
1243 .D1 (alias: Ic rotatew )
1244 Rotate the positions of the panes within a window, either upward (numerically
1247 or downward (numerically higher).
1248 .It Xo Ic select-layout
1249 .Op Fl t Ar target-window
1252 .D1 (alias: Ic selectl )
1253 Choose a specific layout for a window.
1256 is not given, the last preset layout used (if any) is reapplied.
1257 .It Xo Ic select-pane
1259 .Op Fl t Ar target-pane
1261 .D1 (alias: Ic selectp )
1264 the active pane in window
1272 is used, respectively the pane below, to the left, to the right, or above the
1273 target pane is used.
1274 .It Ic select-window Op Fl t Ar target-window
1275 .D1 (alias: Ic selectw )
1276 Select the window at
1278 .It Xo Ic split-window
1282 .Fl p Ar percentage Oc
1283 .Op Fl t Ar target-pane
1284 .Op Ar shell-command
1286 .D1 (alias: Ic splitw )
1287 Create a new pane by splitting
1290 does a horizontal split and
1292 a vertical split; if neither is specified,
1299 options specify the size of the new pane in lines (for vertical split) or in
1300 cells (for horizontal split), or as a percentage, respectively.
1301 All other options have the same meaning as for the
1306 .Op Fl s Ar src-pane
1307 .Op Fl t Ar dst-pane
1309 .D1 (alias: Ic swapp )
1313 is used and no source pane is specified with
1316 is swapped with the previous pane (before it numerically);
1318 swaps with the next pane (after it numerically).
1322 not to change the active pane.
1323 .It Xo Ic swap-window
1325 .Op Fl s Ar src-window
1326 .Op Fl t Ar dst-window
1328 .D1 (alias: Ic swapw )
1331 except the source and destination windows are swapped.
1332 It is an error if no window exists at
1334 .It Xo Ic unlink-window
1336 .Op Fl t Ar target-window
1338 .D1 (alias: Ic unlinkw )
1343 is given, a window may be unlinked only if it is linked to multiple sessions -
1344 windows may not be linked to no sessions;
1347 is specified and the window is linked to only one session, it is unlinked and
1352 allows a command to be bound to most keys, with or without a prefix key.
1353 When specifying keys, most represent themselves (for example
1357 Ctrl keys may be prefixed with
1363 In addition, the following special key names are accepted:
1388 Note that to bind the
1392 keys, quotation marks are necessary, for example:
1393 .Bd -literal -offset indent
1394 bind-key '"' split-window
1395 bind-key "'" new-window
1398 Commands related to key bindings are as follows:
1402 .Op Fl t Ar key-table
1403 .Ar key Ar command Op Ar arguments
1405 .D1 (alias: Ic bind )
1412 the primary key bindings are modified (those normally activated with the prefix
1413 key); in this case, if
1415 is specified, it is not necessary to use the prefix key,
1422 flag indicates this key may repeat, see the
1432 the binding for command mode with
1434 or for normal mode without.
1435 To view the default bindings and possible commands, see the
1438 .It Ic list-keys Op Fl t Ar key-table
1439 .D1 (alias: Ic lsk )
1440 List all key bindings.
1443 the primary key bindings - those executed when preceded by the prefix key -
1445 Keys bound without the prefix key (see
1455 are listed; this may be one of:
1464 .Op Fl t Ar target-pane
1467 .D1 (alias: Ic send )
1468 Send a key or keys to a window.
1471 is the name of the key (such as
1475 ) to send; if the string is not recognised as a key, it is sent as a series of
1477 All arguments are sent sequentially from first to last.
1478 .It Ic send-prefix Op Fl t Ar target-pane
1479 Send the prefix key to a window as if it was pressed.
1480 If multiple prefix keys are configured, only the first is sent.
1481 .It Xo Ic unbind-key
1483 .Op Fl t Ar key-table
1486 .D1 (alias: Ic unbind )
1487 Unbind the command bound to
1491 the primary key bindings are modified; in this case, if
1493 is specified, the command bound to
1495 without a prefix (if any) is removed.
1498 is present, all key bindings are removed.
1506 is unbound: the binding for command mode with
1508 or for normal mode without.
1511 The appearance and behaviour of
1513 may be modified by changing the value of various options.
1514 There are three types of option:
1515 .Em server options ,
1518 .Em window options .
1522 server has a set of global options which do not apply to any particular
1524 These are altered with the
1527 command, or displayed with the
1532 In addition, each individual session may have a set of session options, and
1533 there is a separate set of global session options.
1534 Sessions which do not have a particular option configured inherit the value
1535 from the global session options.
1536 Session options are set or unset with the
1538 command and may be listed with the
1541 The available server and session options are listed under the
1545 Similarly, a set of window options is attached to each window, and there is
1546 a set of global window options from which any unset options are inherited.
1547 Window options are altered with the
1548 .Ic set-window-option
1549 command and can be listed with the
1550 .Ic show-window-options
1552 All window options are documented with the
1553 .Ic set-window-option
1556 Commands which set options are as follows:
1558 .It Xo Ic set-option
1560 .Op Fl t Ar target-session | Ar target-window
1563 .D1 (alias: Ic set )
1564 Set a window option with
1567 .Ic set-window-option
1569 a server option with
1571 otherwise a session option.
1575 is specified, the global session or window option is set.
1578 and if the option expects a string,
1580 is appended to the existing setting.
1583 flag unsets an option, so a session inherits the option from the global
1585 It is not possible to unset a global option.
1587 Available window options are listed under
1588 .Ic set-window-option .
1590 Available server options are:
1593 Set the time in milliseconds for which
1595 waits after an escape is input to determine if it is part of a function or meta
1597 The default is 500 milliseconds.
1598 .It Ic exit-unattached
1599 If enabled, the server will exit when there are no attached clients, rather
1600 than when there are no attached sessions.
1602 Enable or disable the display of various informational messages (see also the
1607 Available session options are:
1609 .It Ic base-index Ar index
1610 Set the base index from which an unused index should be searched when a new
1612 The default is zero.
1613 .It Xo Ic bell-action
1614 .Op Ic any | none | current
1616 Set action on window bell.
1618 means a bell in any window linked to a session causes a bell in the current
1619 window of that session,
1621 means all bells are ignored and
1623 means only bell in windows other than the current window are ignored.
1624 .It Ic buffer-limit Ar number
1625 Set the number of buffers kept for each session; as new buffers are added to
1626 the top of the stack, old ones are removed from the bottom if necessary to
1627 maintain this maximum length.
1628 .It Ic default-command Ar shell-command
1629 Set the command used for new windows (if not specified when the window is
1635 The default is an empty string, which instructs
1637 to create a login shell using the value of the
1640 .It Ic default-shell Ar path
1641 Specify the default shell.
1642 This is used as the login shell for new windows when the
1644 option is set to empty, and must be the full path of the executable.
1647 tries to set a default value from the first suitable of the
1649 environment variable, the shell returned by
1653 This option should be configured when
1655 is used as a login shell.
1656 .It Ic default-path Ar path
1657 Set the default working directory for processes created from keys, or
1658 interactively from the prompt.
1659 The default is empty, which means to use the working directory of the shell
1660 from which the server was started if it is available or the user's home if not.
1661 .It Ic default-terminal Ar terminal
1662 Set the default terminal for new windows created in this session - the
1663 default value of the
1665 environment variable.
1668 to work correctly, this
1672 or a derivative of it.
1673 .It Ic destroy-unattached
1674 If enabled and the session is no longer attached to any clients, it is
1676 .It Ic detach-on-destroy
1677 If on (the default), the client is detached when the session it is attached to
1679 If off, the client is switched to the most recently active of the remaining
1681 .It Ic display-panes-active-colour Ar colour
1682 Set the colour used by the
1684 command to show the indicator for the active pane.
1685 .It Ic display-panes-colour Ar colour
1686 Set the colour used by the
1688 command to show the indicators for inactive panes.
1689 .It Ic display-panes-time Ar time
1690 Set the time in milliseconds for which the indicators shown by the
1693 .It Ic display-time Ar time
1694 Set the amount of time for which status line messages and other on-screen
1695 indicators are displayed.
1698 .It Ic history-limit Ar lines
1699 Set the maximum number of lines held in window history.
1700 This setting applies only to new windows - existing window histories are not
1701 resized and retain the limit at the point they were created.
1702 .It Ic lock-after-time Ar number
1703 Lock the session (like the
1707 seconds of inactivity, or the entire server (all sessions) if the
1710 The default is not to lock (set to 0).
1711 .It Ic lock-command Ar shell-command
1712 Command to run when locking each client.
1713 The default is to run
1717 .It Xo Ic lock-server
1723 instead of each session locking individually as each has been
1725 .Ic lock-after-time ,
1726 the entire server will lock after
1728 sessions would have locked.
1729 This has no effect as a session option; it must be set as a global option.
1730 .It Ic message-attr Ar attributes
1731 Set status line message attributes, where
1735 or a comma-delimited list of one or more of:
1746 .It Ic message-bg Ar colour
1747 Set status line message background colour, where
1761 from the 256-colour palette, or
1763 .It Ic message-fg Ar colour
1764 Set status line message foreground colour.
1765 .It Ic message-limit Ar number
1766 Set the number of error or information messages to save in the message log for
1769 .It Xo Ic mouse-select-pane
1774 captures the mouse and when a window is split into multiple panes the mouse may
1775 be used to select the current pane.
1776 The mouse click is also passed through to the application as normal.
1777 .It Ic pane-border-fg Ar colour
1778 .It Ic pane-border-bg Ar colour
1779 Set the pane border colour for panes aside from the active pane.
1780 .It Ic pane-active-border-fg Ar colour
1781 .It Ic pane-active-border-bg Ar colour
1782 Set the pane border colour for the currently active pane.
1783 .It Ic prefix Ar keys
1784 Set the keys accepted as a prefix key.
1786 is a comma-separated list of key names, each of which individually behave as
1788 .It Ic repeat-time Ar time
1789 Allow multiple commands to be entered without pressing the prefix-key again
1792 milliseconds (the default is 500).
1793 Whether a key repeats may be set when it is bound using the
1797 Repeat is enabled for the default keys bound to the
1800 .It Xo Ic set-remain-on-exit
1805 window option for any windows first created in this session.
1806 When this option is true, windows in which the running program has
1807 exited do not close, instead remaining open but inactivate.
1810 command to reactivate such a window, or the
1812 command to destroy it.
1813 .It Xo Ic set-titles
1816 Attempt to set the window title using the \ee]2;...\e007 xterm code if
1817 the terminal appears to be an xterm.
1818 This option is off by default.
1820 will only attempt to set the window title if the STY environment
1822 .It Ic set-titles-string Ar string
1823 String used to set the window title if
1826 Character sequences are replaced as for the
1832 Show or hide the status line.
1833 .It Ic status-attr Ar attributes
1834 Set status line attributes.
1835 .It Ic status-bg Ar colour
1836 Set status line background colour.
1837 .It Ic status-fg Ar colour
1838 Set status line foreground colour.
1839 .It Ic status-interval Ar interval
1840 Update the status bar every
1843 By default, updates will occur every 15 seconds.
1844 A setting of zero disables redrawing at interval.
1845 .It Xo Ic status-justify
1846 .Op Ic left | centre | right
1848 Set the position of the window list component of the status line: left, centre
1850 .It Xo Ic status-keys
1853 Use vi or emacs-style
1854 key bindings in the status line, for example at the command prompt.
1855 The default is emacs, unless the
1859 environment variables are set and contain the string
1861 .It Ic status-left Ar string
1864 to the left of the status bar.
1866 will be passed through
1869 By default, the session name is shown.
1871 may contain any of the following special character sequences:
1872 .Bl -column "Character pair" "Replaced with" -offset indent
1873 .It Sy "Character pair" Ta Sy "Replaced with"
1874 .It Li "#(shell-command)" Ta "First line of the command's output"
1875 .It Li "#[attributes]" Ta "Colour or attribute change"
1876 .It Li "#H" Ta "Hostname of local host"
1877 .It Li "#F" Ta "Current window flag"
1878 .It Li "#I" Ta "Current window index"
1879 .It Li "#P" Ta "Current pane index"
1880 .It Li "#S" Ta "Session name"
1881 .It Li "#T" Ta "Current window title"
1882 .It Li "#W" Ta "Current window name"
1883 .It Li "##" Ta "A literal" Ql #
1886 The #(shell-command) form executes
1888 and inserts the first line of its output.
1889 Note that shell commands are only executed once at the interval specified by
1892 option: if the status line is redrawn in the meantime, the previous result is
1894 Shell commands are executed with the
1896 global environment set (see the
1900 The window title (#T) is the title set by the program running within the window
1901 using the OSC title setting sequence, for example:
1902 .Bd -literal -offset indent
1903 $ printf '\e033]2;My Title\e033\e\e'
1906 When a window is first created, its title is the hostname.
1908 #[attributes] allows a comma-separated list of attributes to be specified,
1911 to set the foreground colour,
1913 to set the background colour, the name of one of the attributes (listed under
1916 option) to turn an attribute on, or an attribute prefixed with
1918 to turn one off, for example
1921 .Bd -literal -offset indent
1922 #(sysctl vm.loadavg)
1923 #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
1926 Where appropriate, special character sequences may be prefixed with a number to
1927 specify the maximum length, for example
1930 By default, UTF-8 in
1932 is not interpreted, to enable UTF-8, use the
1935 .It Ic status-left-attr Ar attributes
1936 Set the attribute of the left part of the status line.
1937 .It Ic status-left-fg Ar colour
1938 Set the foreground colour of the left part of the status line.
1939 .It Ic status-left-bg Ar colour
1940 Set the background colour of the left part of the status line.
1941 .It Ic status-left-length Ar length
1944 of the left component of the status bar.
1946 .It Ic status-right Ar string
1949 to the right of the status bar.
1950 By default, the current window title in double quotes, the date and the time
1957 character pairs are replaced, and UTF-8 is dependent on the
1960 .It Ic status-right-attr Ar attributes
1961 Set the attribute of the right part of the status line.
1962 .It Ic status-right-fg Ar colour
1963 Set the foreground colour of the right part of the status line.
1964 .It Ic status-right-bg Ar colour
1965 Set the background colour of the right part of the status line.
1966 .It Ic status-right-length Ar length
1969 of the right component of the status bar.
1972 .It Xo Ic status-utf8
1977 to treat top-bit-set characters in the
1981 strings as UTF-8; notably, this is important for wide characters.
1982 This option defaults to off.
1983 .It Ic terminal-overrides Ar string
1984 Contains a list of entries which override terminal descriptions read using
1987 is a comma-separated list of items each a colon-separated string made up of a
1988 terminal type pattern (matched using
1994 For example, to set the
1999 for all terminal types and the
2005 terminal type, the option could be set to the string:
2006 .Bd -literal -offset indent
2007 "*:clear=\ee[H\ee[2J,rxvt:dch1=\ee[P"
2010 The terminal entry value is passed through
2012 before interpretation.
2013 The default value forcibly corrects the
2015 entry for terminals which support 88 or 256 colours:
2016 .Bd -literal -offset indent
2017 "*88col*:colors=88,*256col*:colors=256"
2019 .It Ic update-environment Ar variables
2020 Set a space-separated string containing a list of environment variables to be
2021 copied into the session environment when a new session is created or an
2022 existing session is attached.
2023 Any variables that do not exist in the source environment are set to be
2024 removed from the session environment (as if
2030 "DISPLAY SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION WINDOWID
2032 .It Xo Ic visual-activity
2035 If on, display a status line message when activity occurs in a window
2037 .Ic monitor-activity
2038 window option is enabled.
2039 .It Xo Ic visual-bell
2042 If this option is on, a message is shown on a bell instead of it being passed
2043 through to the terminal (which normally makes a sound).
2047 .It Xo Ic visual-content
2051 .Ic visual-activity ,
2052 display a message when content is present in a window
2055 window option is enabled.
2056 .It Xo Ic visual-silence
2061 is enabled, prints a message after the interval has expired on a given window.
2063 .It Xo Ic set-window-option
2065 .Op Fl t Ar target-window
2068 .D1 (alias: Ic setw )
2069 Set a window option.
2075 flags work similarly to the
2079 Supported window options are:
2081 .Bl -tag -width Ds -compact
2082 .It Xo Ic aggressive-resize
2085 Aggressively resize the chosen window.
2088 will resize the window to the size of the smallest session for which it is the
2089 current window, rather than the smallest session to which it is attached.
2090 The window may resize when the current window is changed on another sessions;
2091 this option is good for full-screen programs which support
2093 and poor for interactive programs such as shells.
2095 .It Xo Ic automatic-rename
2098 Control automatic window renaming.
2099 When this setting is enabled,
2101 will attempt - on supported platforms - to rename the window to reflect the
2102 command currently running in it.
2103 This flag is automatically disabled for an individual window when a name
2104 is specified at creation with
2110 It may be switched off globally with:
2111 .Bd -literal -offset indent
2112 set-window-option -g automatic-rename off
2115 .It Ic clock-mode-colour Ar colour
2118 .It Xo Ic clock-mode-style
2121 Set clock hour format.
2123 .It Ic force-height Ar height
2124 .It Ic force-width Ar width
2127 from resizing a window to greater than
2131 A value of zero restores the default unlimited setting.
2133 .It Ic main-pane-width Ar width
2134 .It Ic main-pane-height Ar height
2135 Set the width or height of the main (left or top) pane in the
2141 .It Ic mode-attr Ar attributes
2142 Set window modes attributes.
2144 .It Ic mode-bg Ar colour
2145 Set window modes background colour.
2147 .It Ic mode-fg Ar colour
2148 Set window modes foreground colour.
2153 Use vi or emacs-style key bindings in copy and choice modes.
2156 option, the default is emacs, unless
2163 .It Xo Ic mode-mouse
2166 Mouse state in modes.
2167 If on, the mouse may be used to copy a selection by dragging in copy mode, or
2168 to select an option in choice mode.
2170 .It Xo Ic monitor-activity
2173 Monitor for activity in the window.
2174 Windows with activity are highlighted in the status line.
2176 .It Ic monitor-content Ar match-string
2177 Monitor content in the window.
2182 appears in the window, it is highlighted in the status line.
2184 .It Xo Ic monitor-silence
2187 Monitor for silence (no activity) in the window within
2190 Windows that have been silent for the interval are highlighted in the
2192 An interval of zero disables the monitoring.
2194 .It Xo Ic remain-on-exit
2197 A window with this flag set is not destroyed when the program running in it
2199 The window may be reactivated with the
2203 .It Xo Ic synchronize-panes
2206 Duplicate input to any pane to all other panes in the same window (only
2207 for panes that are not in any special mode).
2209 .It Xo Ic alternate-screen
2212 This option configures whether programs running inside
2214 may use the terminal alternate screen feature, which allows the
2219 capabilities to be issued to preserve the existing window content on start and
2227 to expect UTF-8 sequences to appear in this window.
2229 .It Ic window-status-attr Ar attributes
2230 Set status line attributes for a single window.
2232 .It Ic window-status-bg Ar colour
2233 Set status line background colour for a single window.
2235 .It Ic window-status-fg Ar colour
2236 Set status line foreground colour for a single window.
2238 .It Ic window-status-format Ar string
2239 Set the format in which the window is displayed in the status line window list.
2242 option for details of special character sequences available.
2246 .It Ic window-status-alert-attr Ar attributes
2247 Set status line attributes for windows which have an alert (bell, activity
2250 .It Ic window-status-alert-bg Ar colour
2251 Set status line background colour for windows with an alert.
2253 .It Ic window-status-alert-fg Ar colour
2254 Set status line foreground colour for windows with an alert.
2256 .It Ic window-status-current-attr Ar attributes
2257 Set status line attributes for the currently active window.
2259 .It Ic window-status-current-bg Ar colour
2260 Set status line background colour for the currently active window.
2262 .It Ic window-status-current-fg Ar colour
2263 Set status line foreground colour for the currently active window.
2265 .It Ic window-status-current-format Ar string
2267 .Ar window-status-format ,
2268 but is the format used when the window is the current window.
2270 .It Ic word-separators Ar string
2271 Sets the window's conception of what characters are considered word
2272 separators, for the purposes of the next and previous word commands in
2277 .It Xo Ic xterm-keys
2280 If this option is set,
2284 function key sequences; these have a number included to indicate modifiers such
2285 as Shift, Alt or Ctrl.
2288 .It Xo Ic show-options
2290 .Op Fl t Ar target-session | Ar target-window
2292 .D1 (alias: Ic show )
2293 Show the window options with
2296 .Ic show-window-options ) ,
2297 the server options with
2299 otherwise the session options for
2300 .Ar target session .
2301 Global session or window options are listed if
2304 .It Xo Ic show-window-options
2306 .Op Fl t Ar target-window
2308 .D1 (alias: Ic showw )
2309 List the window options for
2311 or the global window options if
2316 When the server is started,
2318 copies the environment into the
2319 .Em global environment ;
2320 in addition, each session has a
2321 .Em session environment .
2322 When a window is created, the session and global environments are merged.
2323 If a variable exists in both, the value from the session environment is used.
2324 The result is the initial environment passed to the new process.
2327 .Ic update-environment
2328 session option may be used to update the session environment from the client
2329 when a new session is created or an old reattached.
2331 also initialises the
2333 variable with some internal information to allow commands to be executed
2334 from inside, and the
2336 variable with the correct terminal setting of
2339 Commands to alter and view the environment are:
2341 .It Xo Ic set-environment
2343 .Op Fl t Ar target-session
2344 .Ar name Op Ar value
2346 .D1 (alias: Ic setenv )
2347 Set or unset an environment variable.
2350 is used, the change is made in the global environment; otherwise, it is applied
2351 to the session environment for
2352 .Ar target-session .
2355 flag unsets a variable.
2357 indicates the variable is to be removed from the environment before starting a
2359 .It Xo Ic show-environment
2361 .Op Fl t Ar target-session
2363 .D1 (alias: Ic showenv )
2364 Display the environment for
2366 or the global environment with
2368 Variables removed from the environment are prefixed with
2373 includes an optional status line which is displayed in the bottom line of each
2375 By default, the status line is enabled (it may be disabled with the
2377 session option) and contains, from left-to-right: the name of the current
2378 session in square brackets; the window list; the current window title in double
2379 quotes; and the time and date.
2381 The status line is made of three parts: configurable left and right sections
2382 (which may contain dynamic content such as the time or output from a shell
2385 .Ic status-left-length ,
2388 .Ic status-right-length
2389 options below), and a central window list.
2390 By default, the window list shows the index, name and (if any) flag of the
2391 windows present in the current session in ascending numerical order.
2392 It may be customised with the
2393 .Ar window-status-format
2395 .Ar window-status-current-format
2397 The flag is one of the following symbols appended to the window name:
2398 .Bl -column "Symbol" "Meaning" -offset indent
2399 .It Sy "Symbol" Ta Sy "Meaning"
2400 .It Li "*" Ta "Denotes the current window."
2401 .It Li "-" Ta "Marks the last window (previously selected)."
2402 .It Li "#" Ta "Window is monitored and activity has been detected."
2403 .It Li "!" Ta "A bell has occurred in the window."
2404 .It Li "+" Ta "Window is monitored for content and it has appeared."
2405 .It Li "~" Ta "The window has been silent for the monitor-silence interval."
2408 The # symbol relates to the
2409 .Ic monitor-activity
2413 The window name is printed in inverted colours if an alert (bell, activity or
2414 content) is present.
2416 The colour and attributes of the status line may be configured, the entire
2417 status line using the
2422 session options and individual windows using the
2423 .Ic window-status-attr ,
2424 .Ic window-status-fg
2426 .Ic window-status-bg
2429 The status line is automatically refreshed at interval if it has changed, the
2430 interval may be controlled with the
2434 Commands related to the status line are as follows:
2436 .It Xo Ic command-prompt
2438 .Op Fl t Ar target-client
2441 Open the command prompt in a client.
2442 This may be used from inside
2444 to execute commands interactively.
2447 is specified, it is used as the command.
2452 is a comma-separated list of prompts which are displayed in order; otherwise
2453 a single prompt is displayed, constructed from
2455 if it is present, or
2458 Before the command is executed, the first occurrence of the string
2460 and all occurrences of
2462 are replaced by the response to the first prompt, the second
2466 are replaced with the response to the second prompt, and so on for further
2468 Up to nine prompt responses may be replaced
2474 .It Xo Ic confirm-before
2475 .Op Fl t Ar target-client
2478 .D1 (alias: Ic confirm )
2479 Ask for confirmation before executing
2481 This command works only from inside
2483 .It Xo Ic display-message
2485 .Op Fl t Ar target-client
2488 .D1 (alias: Ic display )
2492 is given, the output is printed to stdout, otherwise it is displayed in the
2499 with the exception that #() are not handled.
2503 maintains a stack of
2506 Up to the value of the
2508 option are kept; when a new buffer is added, the buffer at the bottom of the
2510 Buffers may be added using
2514 command, and pasted into a window using the
2518 A configurable history buffer is also maintained for each window.
2519 By default, up to 2000 lines are kept; this can be altered with the
2525 The buffer commands are as follows:
2529 .Op Fl t Ar target-window
2532 Put a window into buffer choice mode, where a buffer may be chosen
2533 interactively from a list.
2534 After a buffer is selected,
2536 is replaced by the buffer index in
2538 and the result executed as a command.
2541 is not given, "paste-buffer -b '%%'" is used.
2542 This command works only from inside
2544 .It Ic clear-history Op Fl t Ar target-pane
2545 .D1 (alias: Ic clearhist )
2546 Remove and free the history for the specified pane.
2547 .It Xo Ic copy-buffer
2548 .Op Fl a Ar src-index
2549 .Op Fl b Ar dst-index
2550 .Op Fl s Ar src-session
2551 .Op Fl t Ar dst-session
2553 .D1 (alias: Ic copyb )
2554 Copy a session paste buffer to another session.
2555 If no sessions are specified, the current one is used instead.
2556 .It Xo Ic delete-buffer
2557 .Op Fl b Ar buffer-index
2558 .Op Fl t Ar target-session
2560 .D1 (alias: Ic deleteb )
2561 Delete the buffer at
2563 or the top buffer if not specified.
2564 .It Ic list-buffers Op Fl t Ar target-session
2565 .D1 (alias: Ic lsb )
2566 List the buffers in the given session.
2567 .It Xo Ic load-buffer
2568 .Op Fl b Ar buffer-index
2569 .Op Fl t Ar target-session
2572 .D1 (alias: Ic loadb )
2573 Load the contents of the specified paste buffer from
2575 .It Xo Ic paste-buffer
2577 .Op Fl b Ar buffer-index
2578 .Op Fl s Ar separator
2579 .Op Fl t Ar target-pane
2581 .D1 (alias: Ic pasteb )
2582 Insert the contents of a paste buffer into the specified pane.
2583 If not specified, paste into the current one.
2586 also delete the paste buffer from the stack.
2587 When output, any linefeed (LF) characters in the paste buffer are replaced with
2588 a separator, by default carriage return (CR).
2589 A custom separator may be specified using the
2594 flag means to do no replacement (equivalent to a separator of LF).
2595 .It Xo Ic save-buffer
2597 .Op Fl b Ar buffer-index
2598 .Op Fl t Ar target-session
2601 .D1 (alias: Ic saveb )
2602 Save the contents of the specified paste buffer to
2606 option appends to rather than overwriting the file.
2607 .It Xo Ic set-buffer
2608 .Op Fl b Ar buffer-index
2609 .Op Fl t Ar target-session
2612 .D1 (alias: Ic setb )
2613 Set the contents of the specified buffer to
2615 .It Xo Ic show-buffer
2616 .Op Fl b Ar buffer-index
2617 .Op Fl t Ar target-session
2619 .D1 (alias: Ic showb )
2620 Display the contents of the specified buffer.
2624 Miscellaneous commands are as follows:
2626 .It Ic clock-mode Op Fl t Ar target-pane
2627 Display a large clock.
2628 .It Ic if-shell Ar shell-command command
2636 .D1 (alias: Ic lock )
2637 Lock each client individually by running the command specified by the
2640 .It Ic run-shell Ar shell-command
2641 .D1 (alias: Ic run )
2644 in the background without creating a window.
2645 After it finishes, any output to stdout is displayed in copy mode.
2646 If the command doesn't return success, the exit status is also displayed.
2648 .D1 (alias: Ic info )
2649 Show server information and terminal details.
2652 .Bl -tag -width "/etc/tmux.confXXX" -compact
2657 .It Pa /etc/tmux.conf
2658 System-wide configuration file.
2666 .Dl $ tmux new-session vi
2668 Most commands have a shorter form, known as an alias.
2669 For new-session, this is
2674 Alternatively, the shortest unambiguous form of a command is accepted.
2675 If there are several options, they are listed:
2676 .Bd -literal -offset indent
2678 ambiguous command: n, could be: new-session, new-window, next-window
2681 Within an active session, a new window may be created by typing
2691 Windows may be navigated with:
2693 (to select window 0),
2695 (to select window 1), and so on;
2697 to select the next window; and
2699 to select the previous window.
2701 A session may be detached using
2703 (or by an external event such as
2705 disconnection) and reattached with:
2707 .Dl $ tmux attach-session
2711 lists the current key bindings in the current window; up and down may be used
2712 to navigate the list or
2716 Commands to be run when the
2718 server is started may be placed in the
2721 Common examples include:
2723 Changing the default prefix key:
2724 .Bd -literal -offset indent
2725 set-option -g prefix C-a
2727 bind-key C-a send-prefix
2730 Turning the status line off, or changing its colour:
2731 .Bd -literal -offset indent
2732 set-option -g status off
2733 set-option -g status-bg blue
2736 Setting other options, such as the default command,
2737 or locking after 30 minutes of inactivity:
2738 .Bd -literal -offset indent
2739 set-option -g default-command "exec /bin/ksh"
2740 set-option -g lock-after-time 1800
2743 Creating new key bindings:
2744 .Bd -literal -offset indent
2745 bind-key b set-option status
2746 bind-key / command-prompt "split-window 'exec man %%'"
2747 bind-key S command-prompt "new-window -n %1 'ssh %1'"
2752 .An Nicholas Marriott Aq nicm@users.sourceforge.net