[BACK]Return to tmux.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / tmux

Annotation of src/usr.bin/tmux/tmux.1, Revision 1.92

1.92    ! nicm        1: .\" $OpenBSD: tmux.1,v 1.91 2009/09/23 12:03:31 nicm Exp $
1.1       nicm        2: .\"
                      3: .\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
                      4: .\"
                      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.
                      8: .\"
                      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.
                     16: .\"
1.91      nicm       17: .Dd $Mdocdate: September 23 2009 $
1.1       nicm       18: .Dt TMUX 1
                     19: .Os
                     20: .Sh NAME
                     21: .Nm tmux
1.6       jmc        22: .Nd terminal multiplexer
1.1       nicm       23: .Sh SYNOPSIS
                     24: .Nm tmux
                     25: .Bk -words
1.90      nicm       26: .Op Fl 28dlquv
1.91      nicm       27: .Op Fl c Ar shell-command
1.1       nicm       28: .Op Fl f Ar file
                     29: .Op Fl L Ar socket-name
                     30: .Op Fl S Ar socket-path
                     31: .Op Ar command Op Ar flags
                     32: .Ek
                     33: .Sh DESCRIPTION
                     34: .Nm
1.59      jmc        35: is a terminal multiplexer:
                     36: it enables a number of terminals to be created, accessed, and
                     37: controlled from a single screen.
1.67      jmc        38: .Nm
                     39: may be detached from a screen
                     40: and continue running in the background,
                     41: then later reattached.
1.1       nicm       42: .Pp
1.60      nicm       43: When
                     44: .Nm
                     45: is started it creates a new
                     46: .Em session
                     47: with a single
                     48: .Em window
                     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.
                     53: .Pp
                     54: A session is a single collection of
                     55: .Em pseudo terminals
                     56: under the management of
                     57: .Nm .
                     58: Each session has one or more
                     59: windows linked to it.
                     60: A window occupies the entire screen
                     61: and may be split into rectangular panes,
                     62: each of which is a separate pseudo terminal
                     63: (the
                     64: .Xr pty 4
                     65: manual page documents the technical details of pseudo terminals).
                     66: Any number of
                     67: .Nm
                     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,
                     71: .Nm
                     72: exits.
                     73: .Pp
1.64      nicm       74: Each session is persistent and will survive accidental disconnection
1.66      jmc        75: (such as
1.64      nicm       76: .Xr ssh 1
1.67      jmc        77: connection timeout) or intentional detaching (with the
1.64      nicm       78: .Ql C-b d
                     79: key strokes).
                     80: .Nm
                     81: may be reattached using:
                     82: .Pp
                     83: .Dl $ tmux attach
1.60      nicm       84: .Pp
1.64      nicm       85: In
                     86: .Nm ,
                     87: a session is displayed on screen by a
                     88: .Em client
                     89: and all sessions are managed by a single
                     90: .Em server .
                     91: The server and each client are separate processes which communicate through a
                     92: socket in
                     93: .Pa /tmp .
1.65      nicm       94: .Pp
1.1       nicm       95: The options are as follows:
                     96: .Bl -tag -width "XXXXXXXXXXXX"
                     97: .It Fl 2
                     98: Force
                     99: .Nm
                    100: to assume the terminal supports 256 colours.
                    101: .It Fl 8
                    102: Like
                    103: .Fl 2 ,
1.6       jmc       104: but indicates that the terminal supports 88 colours.
1.91      nicm      105: .It Fl c Ar shell-command
                    106: Execute
                    107: .Ar shell-command
                    108: using the default shell.
                    109: If necessary, the
                    110: .Nm
                    111: server will be started to retrieve the
                    112: .Ic default-shell
                    113: option.
1.1       nicm      114: .It Fl d
                    115: Force
                    116: .Nm
                    117: to assume the terminal supports default colours.
                    118: .It Fl f Ar file
                    119: Specify an alternative configuration file.
                    120: By default,
                    121: .Nm
1.26      nicm      122: loads the system configuration file from
                    123: .Pa /etc/tmux.conf ,
                    124: if present, then looks for a user configuration file at
1.1       nicm      125: .Pa ~/.tmux.conf .
                    126: The configuration file is a set of
                    127: .Nm
                    128: commands which are executed in sequence when the server is first started.
1.61      nicm      129: .Pp
                    130: If a command in the configuration file fails,
                    131: .Nm
                    132: will report an error and exit without executing further commands.
1.82      nicm      133: .It Fl l
                    134: Behave as a login shell.
                    135: This flag currently has no effect and is for compatibility with other shells
                    136: when using tmux as a login shell.
1.1       nicm      137: .It Fl L Ar socket-name
                    138: .Nm
                    139: stores the server socket in a directory under
                    140: .Pa /tmp ;
                    141: the default socket is named
                    142: .Em default .
                    143: This option allows a different socket name to be specified, allowing several
                    144: independent
                    145: .Nm
                    146: servers to be run.
                    147: Unlike
                    148: .Fl S
                    149: a full path is not necessary: the sockets are all created in the same
                    150: directory.
1.2       nicm      151: .Pp
                    152: If the socket is accidentally removed, the
1.6       jmc       153: .Dv SIGUSR1
1.2       nicm      154: signal may be sent to the
                    155: .Nm
                    156: server process to recreate it.
1.4       sobrado   157: .It Fl q
1.6       jmc       158: Prevent the server sending various informational messages, for example when
1.4       sobrado   159: window flags are altered.
1.1       nicm      160: .It Fl S Ar socket-path
                    161: Specify a full alternative path to the server socket.
                    162: If
                    163: .Fl S
                    164: is specified, the default socket directory is not used and any
                    165: .Fl L
                    166: flag is ignored.
                    167: .It Fl u
                    168: .Nm
1.14      nicm      169: attempts to guess if the terminal is likely to support UTF-8 by checking the
                    170: first of the
                    171: .Ev LC_ALL ,
                    172: .Ev LC_CTYPE
                    173: and
1.2       nicm      174: .Ev LANG
1.14      nicm      175: environment variables to be set for the string "UTF-8".
1.5       nicm      176: This is not always correct: the
1.2       nicm      177: .Fl u
                    178: flag explicitly informs
                    179: .Nm
1.6       jmc       180: that UTF-8 is supported.
1.33      nicm      181: .Pp
                    182: If the server is started from a client passed
                    183: .Fl u
                    184: or where UTF-8 is detected, the
                    185: .Ic utf8
                    186: and
                    187: .Ic status-utf8
                    188: options are enabled in the global window and session options respectively.
1.1       nicm      189: .It Fl v
                    190: Request verbose logging.
                    191: This option may be specified multiple times for increasing verbosity.
                    192: Log messages will be saved into
                    193: .Pa tmux-client-PID.log
                    194: and
                    195: .Pa tmux-server-PID.log
                    196: files in the current directory, where
                    197: .Em PID
1.6       jmc       198: is the PID of the server or client process.
1.1       nicm      199: .It Ar command Op Ar flags
                    200: This specifies one of a set of commands used to control
                    201: .Nm ,
1.6       jmc       202: as described in the following sections.
1.59      jmc       203: If no commands are specified, the
1.1       nicm      204: .Ic new-session
                    205: command is assumed.
1.57      jmc       206: .El
1.64      nicm      207: .Sh KEY BINDINGS
                    208: .Nm
                    209: may be controlled from an attached client by using a key combination of a
                    210: prefix key,
                    211: .Ql C-b
                    212: (Ctrl-b) by default, followed by a command key.
                    213: .Pp
                    214: Some of the default key bindings are:
                    215: .Pp
1.67      jmc       216: .Bl -tag -width Ds -offset indent -compact
1.64      nicm      217: .It c
1.65      nicm      218: Create a new window.
1.64      nicm      219: .It d
1.65      nicm      220: Detach the current client.
1.64      nicm      221: .It l
1.65      nicm      222: Move to the previously selected window.
1.64      nicm      223: .It n
1.65      nicm      224: Change to the next window.
1.64      nicm      225: .It p
1.65      nicm      226: Change to the previous window.
                    227: .It &
                    228: Kill the current window.
                    229: .It ,
                    230: Rename the current window.
1.64      nicm      231: .It \&?
1.65      nicm      232: List all key bindings.
1.64      nicm      233: .El
                    234: .Pp
                    235: A complete list may be obtained with the
                    236: .Ic list-keys
                    237: command (bound to
                    238: .Ql \&?
                    239: by default).
                    240: Key bindings may be changed with the
                    241: .Ic bind-key
                    242: and
                    243: .Ic unbind-key
                    244: commands.
1.57      jmc       245: .Sh COMMANDS
                    246: This section contains a list of the commands supported by
                    247: .Nm .
                    248: Most commands accept the optional
                    249: .Fl t
                    250: argument with one of
                    251: .Ar target-client ,
                    252: .Ar target-session
                    253: .Ar target-window ,
                    254: or
                    255: .Ar target-pane .
                    256: These specify the client, session, window or pane which a command should affect.
                    257: .Ar target-client
                    258: is the name of the
                    259: .Xr pty 4
                    260: file to which the client is connected, for example either of
                    261: .Pa /dev/ttyp1
                    262: or
                    263: .Pa ttyp1
                    264: for the client attached to
                    265: .Pa /dev/ttyp1 .
                    266: If no client is specified, the current client is chosen, if possible, or an
                    267: error is reported.
                    268: Clients may be listed with the
                    269: .Ic list-clients
                    270: command.
1.1       nicm      271: .Pp
1.57      jmc       272: .Ar target-session
                    273: is either the name of a session (as listed by the
                    274: .Ic list-sessions
                    275: command) or the name of a client with the same syntax as
                    276: .Ar target-client ,
                    277: in which case the session attached to the client is used.
                    278: When looking for the session name,
                    279: .Nm
                    280: initially searches for an exact match; if none is found, the session names
                    281: are checked for any for which
                    282: .Ar target-session
                    283: is a prefix or for which it matches as an
                    284: .Xr fnmatch 3
                    285: pattern.
                    286: If a single match is found, it is used as the target session; multiple matches
                    287: produce an error.
                    288: If a session is omitted, the current session is used if available; if no
                    289: current session is available, the most recently created is chosen.
1.1       nicm      290: .Pp
1.57      jmc       291: .Ar target-window
                    292: specifies a window in the form
                    293: .Em session Ns \&: Ns Em window .
                    294: .Em session
                    295: follows the same rules as for
                    296: .Ar target-session ,
                    297: and
                    298: .Em window
                    299: is looked for in order: as a window index, for example mysession:1; as an exact
                    300: window name, such as mysession:mywindow; then as an
                    301: .Xr fnmatch 3
                    302: pattern or the start of a window name, such as mysession:mywin* or
                    303: mysession:mywin.
                    304: An empty window name specifies the next unused index if appropriate (for
                    305: example the
                    306: .Ic new-window
                    307: and
                    308: .Ic link-window
                    309: commands)
                    310: otherwise the current window in
                    311: .Em session
                    312: is chosen.
                    313: When the argument does not contain a colon,
                    314: .Nm
                    315: first attempts to parse it as window; if that fails, an attempt is made to
                    316: match a session.
1.1       nicm      317: .Pp
1.57      jmc       318: .Ar target-pane
                    319: takes a similar form to
                    320: .Ar target-window
                    321: but with the optional addition of a period followed by a pane index, for
                    322: example: mysession:mywindow.1.
                    323: If the pane index is omitted, the currently active pane in the specified
                    324: window is used.
                    325: If neither a colon nor period appears,
1.13      nicm      326: .Nm
1.57      jmc       327: first attempts to use the argument as a pane index; if that fails, it is looked
                    328: up as for
                    329: .Ar target-window .
1.15      jmc       330: .Pp
1.57      jmc       331: Multiple commands may be specified together as part of a
                    332: .Em command sequence .
                    333: Each command should be separated by spaces and a semicolon;
                    334: commands are executed sequentially from left to right.
                    335: A literal semicolon may be included by escaping it with a backslash (for
                    336: example, when specifying a command sequence to
                    337: .Ic bind-key ) .
1.13      nicm      338: .Pp
1.57      jmc       339: Examples include:
1.13      nicm      340: .Bd -literal -offset indent
1.57      jmc       341: refresh-client -t/dev/ttyp2
                    342:
                    343: rename-session -tfirst newname
                    344:
                    345: set-window-option -t:0 monitor-activity on
                    346:
                    347: new-window ; split-window -d
1.13      nicm      348: .Ed
1.57      jmc       349: .Sh CLIENTS AND SESSIONS
                    350: The following commands are available:
                    351: .Bl -tag -width Ds
                    352: .It Xo Ic attach-session
                    353: .Op Fl d
                    354: .Op Fl t Ar target-session
                    355: .Xc
                    356: .D1 (alias: Ic attach )
                    357: If run from outside
                    358: .Nm ,
                    359: create a new client in the current terminal and attach it to
                    360: .Ar target-session .
                    361: If used from inside, switch the current client.
                    362: If
                    363: .Fl d
                    364: is specified, any other clients attached to the session are detached.
1.13      nicm      365: .Pp
1.57      jmc       366: If no server is started,
                    367: .Ic attach-session
                    368: will attempt to start it; this will fail unless sessions are created in the
                    369: configuration file.
                    370: .It Ic detach-client Op Fl t Ar target-client
                    371: .D1 (alias: Ic detach )
                    372: Detach the current client if bound to a key, or the specified client with
                    373: .Fl t .
                    374: .It Ic has-session Op Fl t Ar target-session
                    375: .D1 (alias: Ic has )
                    376: Report an error and exit with 1 if the specified session does not exist.
                    377: If it does exist, exit with 0.
                    378: .It Ic kill-server
                    379: Kill the
1.1       nicm      380: .Nm
1.57      jmc       381: server and clients and destroy all sessions.
                    382: .It Ic kill-session Op Fl t Ar target-session
                    383: Destroy the given session, closing any windows linked to it and no other
                    384: sessions, and detaching all clients attached to it.
                    385: .It Ic list-clients
                    386: .D1 (alias: Ic lsc )
                    387: List all clients attached to the server.
                    388: .It Ic list-commands
                    389: .D1 (alias: Ic lscm )
                    390: List the syntax of all commands supported by
                    391: .Nm .
                    392: .It Ic list-sessions
                    393: .D1 (alias: Ic ls )
                    394: List all sessions managed by the server.
1.92    ! nicm      395: .It Xo Ic lock-client
        !           396: .Op Fl t Ar target-client
        !           397: .Xc
        !           398: Lock
        !           399: .Ar target-client ,
        !           400: see the
        !           401: .Ic lock-server
        !           402: command.
        !           403: .It Xo Ic lock-session
        !           404: .Op Fl t Ar target-session
        !           405: .Xc
        !           406: Lock all clients attached to
        !           407: .Ar target-session .
1.57      jmc       408: .It Xo Ic new-session
                    409: .Op Fl d
                    410: .Op Fl n Ar window-name
                    411: .Op Fl s Ar session-name
                    412: .Op Ar command
                    413: .Xc
                    414: .D1 (alias: Ic new )
                    415: Create a new session with name
                    416: .Ar session-name .
                    417: The new session is attached to the current terminal unless
                    418: .Fl d
                    419: is given.
                    420: .Ar window-name
1.1       nicm      421: and
1.57      jmc       422: .Ar command
                    423: are the name of and command to execute in the initial window.
1.68      nicm      424: .Pp
                    425: If run from a terminal, any
                    426: .Xr termios 4
                    427: special characters are saved and used for new windows in the new session.
1.57      jmc       428: .It Ic refresh-client Op Fl t Ar target-client
                    429: .D1 (alias: Ic refresh )
                    430: Refresh the current client if bound to a key, or a single client if one is given
                    431: with
                    432: .Fl t .
                    433: .It Xo Ic rename-session
                    434: .Op Fl t Ar target-session
                    435: .Ar new-name
                    436: .Xc
                    437: .D1 (alias: Ic rename )
                    438: Rename the session to
                    439: .Ar new-name .
                    440: .It Ic source-file Ar path
                    441: .D1 (alias: Ic source )
                    442: Execute commands from
                    443: .Ar path .
                    444: .It Ic start-server
                    445: .D1 (alias: Ic start )
                    446: Start the
1.1       nicm      447: .Nm
1.57      jmc       448: server, if not already running, without creating any sessions.
                    449: .It Xo Ic suspend-client
                    450: .Op Fl c Ar target-client
                    451: .Xc
                    452: .D1 (alias: Ic suspendc )
                    453: Suspend a client by sending
                    454: .Dv SIGTSTP
                    455: (tty stop).
                    456: .It Xo Ic switch-client
                    457: .Op Fl c Ar target-client
                    458: .Op Fl t Ar target-session
                    459: .Xc
                    460: .D1 (alias: Ic switchc )
                    461: Switch the current session for client
                    462: .Ar target-client
                    463: to
                    464: .Ar target-session .
                    465: .El
                    466: .Sh WINDOWS AND PANES
1.1       nicm      467: A
                    468: .Nm
                    469: window may be in one of several modes.
                    470: The default permits direct access to the terminal attached to the window.
                    471: The others are:
                    472: .Bl -tag -width Ds
                    473: .It Em output mode
                    474: This is entered when a command which produces output, such as
                    475: .Ic list-keys ,
                    476: is executed from a key binding.
                    477: .It Em scroll mode
                    478: This is entered with the
                    479: .Ic scroll-mode
                    480: command (bound to
                    481: .Ql =
                    482: by default) and permits the window history buffer to be inspected.
                    483: .It Em copy mode
                    484: This permits a section of a window or its history to be copied to a
                    485: .Em paste buffer
                    486: for later insertion into another window.
                    487: This mode is entered with the
                    488: .Ic copy-mode
                    489: command, bound to
                    490: .Ql [
                    491: by default.
                    492: .El
                    493: .Pp
1.6       jmc       494: The keys available depend on whether emacs or vi mode is selected
                    495: (see the
1.1       nicm      496: .Ic mode-keys
                    497: option).
                    498: The following keys are supported as appropriate for the mode:
                    499: .Bl -column "FunctionXXXXXXXXXXXX" "viXXXXXX" "emacs" -offset indent
                    500: .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
1.27      nicm      501: .It Li "Back to indentation" Ta "^" Ta "M-m"
1.1       nicm      502: .It Li "Clear selection" Ta "Escape" Ta "C-g"
                    503: .It Li "Copy selection" Ta "Enter" Ta "M-w"
                    504: .It Li "Cursor down" Ta "j" Ta "Down"
1.70      nicm      505: .It Li "Cursor left" Ta "h" Ta "Left"
                    506: .It Li "Cursor right" Ta "l" Ta "Right"
                    507: .It Li "Cursor up" Ta "k" Ta "Up"
1.71      nicm      508: .It Li "Delete entire line" Ta "d" Ta "C-u"
1.70      nicm      509: .It Li "Delete to end of line" Ta "D" Ta "C-k"
1.1       nicm      510: .It Li "End of line" Ta "$" Ta "C-e"
1.70      nicm      511: .It Li "Goto line" Ta "g" Ta "g"
1.1       nicm      512: .It Li "Next page" Ta "C-f" Ta "Page down"
                    513: .It Li "Next word" Ta "w" Ta "M-f"
1.70      nicm      514: .It Li "Paste buffer" Ta "p" Ta "C-y"
1.1       nicm      515: .It Li "Previous page" Ta "C-u" Ta "Page up"
                    516: .It Li "Previous word" Ta "b" Ta "M-b"
                    517: .It Li "Quit mode" Ta "q" Ta "Escape"
1.70      nicm      518: .It Li "Search again" Ta "n" Ta "n"
                    519: .It Li "Search backward" Ta "?" Ta "C-r"
                    520: .It Li "Search forward" Ta "/" Ta "C-s"
                    521: .It Li "Start of line" Ta "0" Ta "C-a"
1.1       nicm      522: .It Li "Start selection" Ta "Space" Ta "C-Space"
1.80      nicm      523: .It Li "Transpose chars" Ta "" Ta "C-t"
1.1       nicm      524: .El
                    525: .Pp
1.48      nicm      526: These key bindings are defined in a set of named tables:
                    527: .Em vi-edit
                    528: and
                    529: .Em emacs-edit
                    530: for keys used when line editing at the command prompt;
                    531: .Em vi-choice
                    532: and
                    533: .Em emacs-choice
                    534: for keys used when choosing from lists (such as produced by the
                    535: .Ic window-choose
                    536: command) or in output mode; and
                    537: .Em vi-copy
                    538: and
                    539: .Em emacs-copy
                    540: used in copy and scroll modes.
                    541: The tables may be viewed with the
                    542: .Ic list-keys
1.49      nicm      543: command and keys modified or removed with
                    544: .Ic bind-key
                    545: and
                    546: .Ic unbind-key .
1.48      nicm      547: .Pp
1.2       nicm      548: The paste buffer key pastes the first line from the top paste buffer on the
                    549: stack.
1.57      jmc       550: .Pp
                    551: The mode commands are as follows:
                    552: .Bl -tag -width Ds
                    553: .It Xo Ic copy-mode
                    554: .Op Fl u
1.72      nicm      555: .Op Fl t Ar target-pane
1.57      jmc       556: .Xc
                    557: Enter copy mode.
                    558: The
                    559: .Fl u
                    560: option scrolls one page up.
                    561: .It Xo Ic scroll-mode
                    562: .Op Fl u
1.72      nicm      563: .Op Fl t Ar target-pane
1.57      jmc       564: .Xc
                    565: Enter scroll mode.
                    566: The
                    567: .Fl u
                    568: has the same meaning as in the
1.1       nicm      569: .Ic copy-mode
1.18      nicm      570: command.
1.57      jmc       571: .El
1.18      nicm      572: .Pp
1.1       nicm      573: Each window displayed by
                    574: .Nm
                    575: may be split into one or more
                    576: .Em panes ;
                    577: each pane takes up a certain area of the display and is a separate terminal.
                    578: A window may be split into panes using the
                    579: .Ic split-window
                    580: command.
1.38      nicm      581: Windows may be split horizontally (with the
                    582: .Fl h
                    583: flag) or vertically.
                    584: Panes may be resized with the
                    585: .Ic resize-pane
1.1       nicm      586: command (bound to
1.38      nicm      587: .Ql C-up ,
                    588: .Ql C-down
                    589: .Ql C-left
                    590: and
                    591: .Ql C-right
1.1       nicm      592: by default), the current pane may be changed with the
                    593: .Ic up-pane
                    594: and
                    595: .Ic down-pane
                    596: commands and the
                    597: .Ic rotate-window
                    598: and
                    599: .Ic swap-pane
1.38      nicm      600: commands may be used to swap panes without changing their position.
                    601: Panes are numbered beginning from zero in the order they are created.
                    602: .Pp
                    603: A number of preset
                    604: .Em layouts
                    605: are available.
                    606: These may be selected with the
                    607: .Ic select-layout
                    608: command or cycled with
                    609: .Ic next-layout
                    610: (bound to
                    611: .Ql C-space
                    612: by default); once a layout is chosen, panes within it may be moved and resized as normal.
1.1       nicm      613: .Pp
                    614: The following layouts are supported:
                    615: .Bl -tag -width Ds
                    616: .It Ic even-horizontal
                    617: Panes are spread out evenly from left to right across the window.
                    618: .It Ic even-vertical
                    619: Panes are spread evenly from top to bottom.
1.2       nicm      620: .It Ic main-horizontal
                    621: A large (main) pane is shown at the top of the window and the remaining panes are
1.6       jmc       622: spread from left to right in the leftover space at the bottom.
1.2       nicm      623: Use the
                    624: .Em main-pane-height
                    625: window option to specify the height of the top pane.
1.1       nicm      626: .It Ic main-vertical
1.2       nicm      627: Similar to
                    628: .Ic main-horizontal
                    629: but the large pane is placed on the left and the others spread from top to
                    630: bottom along the right.
                    631: See the
                    632: .Em main-pane-width
                    633: window option.
1.1       nicm      634: .El
1.8       nicm      635: .Pp
1.57      jmc       636: Commands related to windows and panes are as follows:
                    637: .Bl -tag -width Ds
                    638: .It Xo Ic break-pane
                    639: .Op Fl d
                    640: .Op Fl t Ar target-pane
                    641: .Xc
                    642: .D1 (alias: Ic breakp )
                    643: Break
                    644: .Ar target-pane
                    645: off from its containing window to make it the only pane in a new window.
                    646: If
                    647: .Fl d
                    648: is given, the new window does not become the current window.
1.76      nicm      649: .It Xo
                    650: .Ic choose-client
                    651: .Op Fl t Ar target-window
                    652: .Op Ar template
                    653: .Xc
                    654: Put a window into client choice mode, allowing a client to be selected
                    655: interactively from a list.
                    656: After a client is chosen,
                    657: .Ql %%
                    658: is replaced by the client
                    659: .Xr pty 4
                    660: path in
                    661: .Ar template
                    662: and the result executed as a command.
                    663: If
                    664: .Ar template
                    665: is not given, "detach-client -t '%%'" is used.
1.57      jmc       666: This command works only from inside
                    667: .Nm .
1.76      nicm      668: .It Xo
                    669: .Ic choose-session
                    670: .Op Fl t Ar target-window
                    671: .Op Ar template
                    672: .Xc
                    673: Put a window into session choice mode, where a session may be selected
                    674: interactively from a list.
                    675: When one is chosen,
                    676: .Ql %%
                    677: is replaced by the session name in
                    678: .Ar template
                    679: and the result executed as a command.
                    680: If
                    681: .Ar template
                    682: is not given, "switch-client -t '%%'" is used.
                    683: This command works only from inside
                    684: .Nm .
                    685: .It Xo
                    686: .Ic choose-window
                    687: .Op Fl t Ar target-window
                    688: .Op Ar template
                    689: .Xc
                    690: Put a window into window choice mode, where a window may be chosen
                    691: interactively from a list.
                    692: After a window is selected,
                    693: .Ql %%
                    694: is replaced by the session name and window index in
                    695: .Ar template
                    696: and the result executed as a command.
                    697: If
                    698: .Ar template
                    699: is not given, "select-window -t '%%'" is used.
1.57      jmc       700: This command works only from inside
                    701: .Nm .
1.78      nicm      702: .It Ic display-panes Op Fl t Ar target-client
                    703: .D1 (alias: Ic displayp)
                    704: Display a visible indicator of each pane shown by
                    705: .Ar target-client .
                    706: See the
                    707: .Ic display-panes-time
                    708: and
                    709: .Ic display-panes-colour
                    710: session options.
1.84      nicm      711: While the indicator is on screen, a pane may be selected with the
                    712: .Ql 0
                    713: to
                    714: .Ql 9
                    715: keys.
1.57      jmc       716: .It Ic down-pane Op Fl t Ar target-pane
                    717: .D1 (alias: Ic downp )
                    718: Move down a pane.
                    719: .It Xo Ic find-window
                    720: .Op Fl t Ar target-window
                    721: .Ar match-string
                    722: .Xc
                    723: .D1 (alias: Ic findw )
                    724: Search for the
                    725: .Xr fnmatch 3
                    726: pattern
                    727: .Ar match-string
                    728: in window names, titles, and visible content (but not history).
                    729: If only one window is matched, it'll be automatically selected, otherwise a
                    730: choice list is shown.
                    731: This command only works from inside
1.1       nicm      732: .Nm .
1.57      jmc       733: .It Ic kill-pane Op Fl t Ar target-pane
                    734: .D1 (alias: Ic killp )
                    735: Destroy the given pane.
                    736: If no panes remain in the containing window, it is also destroyed.
                    737: .It Ic kill-window Op Fl t Ar target-window
                    738: .D1 (alias: Ic killw )
                    739: Kill the current window or the window at
                    740: .Ar target-window ,
1.1       nicm      741: removing it from any sessions to which it is linked.
1.56      jmc       742: .It Ic last-window Op Fl t Ar target-session
1.1       nicm      743: .D1 (alias: Ic last )
                    744: Select the last (previously selected) window.
                    745: If no
                    746: .Ar target-session
                    747: is specified, select the last window of the current session.
                    748: .It Xo Ic link-window
                    749: .Op Fl dk
                    750: .Op Fl s Ar src-window
                    751: .Op Fl t Ar dst-window
                    752: .Xc
                    753: .D1 (alias: Ic linkw )
                    754: Link the window at
                    755: .Ar src-window
                    756: to the specified
                    757: .Ar dst-window .
                    758: If
                    759: .Ar dst-window
                    760: is specified and no such window exists, the
                    761: .Ar src-window
                    762: is linked there.
                    763: If
                    764: .Fl k
                    765: is given and
                    766: .Ar dst-window
                    767: exists, it is killed, otherwise an error is generated.
                    768: If
                    769: .Fl d
                    770: is given, the newly linked window is not selected.
1.56      jmc       771: .It Ic list-windows Op Fl t Ar target-session
1.1       nicm      772: .D1 (alias: Ic lsw )
                    773: List windows in the current session or in
                    774: .Ar target-session .
                    775: .It Xo Ic move-window
                    776: .Op Fl d
                    777: .Op Fl s Ar src-window
                    778: .Op Fl t Ar dst-window
                    779: .Xc
                    780: .D1 (alias: Ic movew )
                    781: This is similar to
                    782: .Ic link-window ,
                    783: except the window at
                    784: .Ar src-window
                    785: is moved to
                    786: .Ar dst-window .
                    787: .It Xo Ic new-window
1.28      nicm      788: .Op Fl dk
1.1       nicm      789: .Op Fl n Ar window-name
                    790: .Op Fl t Ar target-window
                    791: .Op Ar command
                    792: .Xc
                    793: .D1 (alias: Ic neww )
                    794: Create a new window.
                    795: If
                    796: .Fl d
                    797: is given, the session does not make the new window the current window.
                    798: .Ar target-window
1.28      nicm      799: represents the window to be created; if the target already exists an error is
                    800: shown, unless the
                    801: .Fl k
                    802: flag is used, in which case it is destroyed.
1.1       nicm      803: .Ar command
                    804: is the command to execute.
                    805: If
                    806: .Ar command
                    807: is not specified, the default command is used.
                    808: .Pp
                    809: The
                    810: .Ev TERM
                    811: environment variable must be set to
                    812: .Dq screen
                    813: for all programs running
                    814: .Em inside
                    815: .Nm .
                    816: New windows will automatically have
                    817: .Dq TERM=screen
                    818: added to their environment, but care must be taken not to reset this in shell
                    819: start-up files.
1.56      jmc       820: .It Ic next-layout Op Fl t Ar target-window
1.1       nicm      821: .D1 (alias: Ic nextl )
                    822: Move a window to the next layout and rearrange the panes to fit.
                    823: .It Xo Ic next-window
1.9       nicm      824: .Op Fl a
1.1       nicm      825: .Op Fl t Ar target-session
                    826: .Xc
                    827: .D1 (alias: Ic next )
                    828: Move to the next window in the session.
1.9       nicm      829: If
1.12      jmc       830: .Fl a
1.9       nicm      831: is used, move to the next window with a bell, activity or content alert.
1.1       nicm      832: .It Xo Ic previous-window
1.9       nicm      833: .Op Fl a
1.1       nicm      834: .Op Fl t Ar target-session
                    835: .Xc
                    836: .D1 (alias: Ic prev )
                    837: Move to the previous window in the session.
1.9       nicm      838: With
                    839: .Fl a ,
                    840: move to the previous window with a bell, activity or content alert.
1.1       nicm      841: .It Xo Ic rename-window
                    842: .Op Fl t Ar target-window
                    843: .Ar new-name
                    844: .Xc
                    845: .D1 (alias: Ic renamew )
                    846: Rename the current window, or the window at
                    847: .Ar target-window
                    848: if specified, to
                    849: .Ar new-name .
                    850: .It Xo Ic resize-pane
1.39      jmc       851: .Op Fl DLRU
1.52      nicm      852: .Op Fl t Ar target-pane
1.1       nicm      853: .Op Ar adjustment
                    854: .Xc
                    855: .D1 (alias: Ic resizep )
1.57      jmc       856: Resize a pane, upward with
                    857: .Fl U
                    858: (the default), downward with
                    859: .Fl D ,
                    860: to the left with
                    861: .Fl L
                    862: and to the right with
                    863: .Fl R .
                    864: The
                    865: .Ar adjustment
                    866: is given in lines or cells (the default is 1).
                    867: .It Xo Ic respawn-window
                    868: .Op Fl k
                    869: .Op Fl t Ar target-window
                    870: .Op Ar command
                    871: .Xc
                    872: .D1 (alias: Ic respawnw )
                    873: Reactive a window in which the command has exited (see the
                    874: .Ic remain-on-exit
                    875: window option).
                    876: If
                    877: .Ar command
                    878: is not given, the command used when the window was created is executed.
                    879: The window must be already inactive, unless
                    880: .Fl k
                    881: is given, in which case any existing command is killed.
                    882: .It Xo Ic rotate-window
                    883: .Op Fl DU
                    884: .Op Fl t Ar target-window
                    885: .Xc
                    886: .D1 (alias: Ic rotatew )
                    887: Rotate the positions of the panes within a window, either upward (numerically
                    888: lower) with
                    889: .Fl U
                    890: or downward (numerically higher).
                    891: .It Xo Ic select-layout
                    892: .Op Fl t Ar target-window
                    893: .Op Ar layout-name
                    894: .Xc
                    895: .D1 (alias: selectl )
                    896: Choose a specific layout for a window.
                    897: If
                    898: .Ar layout-name
                    899: is not given, the last layout used (if any) is reapplied.
                    900: .It Ic select-pane Op Fl t Ar target-pane
                    901: .D1 (alias: Ic selectp )
                    902: Make pane
                    903: .Ar target-pane
                    904: the active pane in window
                    905: .Ar target-window .
                    906: .It Ic select-window Op Fl t Ar target-window
                    907: .D1 (alias: Ic selectw )
                    908: Select the window at
                    909: .Ar target-window .
                    910: .It Xo Ic split-window
                    911: .Op Fl dhv
                    912: .Oo Fl l
                    913: .Ar size |
                    914: .Fl p Ar percentage Oc
                    915: .Op Fl t Ar target-window
                    916: .Op Ar command
                    917: .Xc
                    918: .D1 (alias: splitw )
                    919: Creates a new pane by splitting the active pane:
                    920: .Fl h
                    921: does a horizontal split and
                    922: .Fl v
                    923: a vertical split; if neither is specified,
                    924: .Fl v
                    925: is assumed.
                    926: The
                    927: .Fl l
                    928: and
                    929: .Fl p
                    930: options specify the size of the new window in lines (for vertical split) or in
                    931: cells (for horizontal split), or as a percentage, respectively.
                    932: All other options have the same meaning as in the
                    933: .Ic new-window
                    934: command.
                    935: .It Xo Ic swap-pane
                    936: .Op Fl dDU
                    937: .Op Fl s Ar src-pane
                    938: .Op Fl t Ar dst-pane
                    939: .Xc
                    940: .D1 (alias: Ic swapp )
                    941: Swap two panes.
                    942: If
                    943: .Fl U
                    944: is used and no source pane is specified with
                    945: .Fl s ,
                    946: .Ar dst-pane
                    947: is swapped with the previous pane (before it numerically);
                    948: .Fl D
                    949: swaps with the next pane (after it numerically).
                    950: .It Xo Ic swap-window
                    951: .Op Fl d
                    952: .Op Fl s Ar src-window
                    953: .Op Fl t Ar dst-window
                    954: .Xc
                    955: .D1 (alias: Ic swapw )
                    956: This is similar to
                    957: .Ic link-window ,
                    958: except the source and destination windows are swapped.
                    959: It is an error if no window exists at
                    960: .Ar src-window .
                    961: .It Xo Ic unlink-window
1.1       nicm      962: .Op Fl k
                    963: .Op Fl t Ar target-window
                    964: .Xc
1.57      jmc       965: .D1 (alias: Ic unlinkw )
                    966: Unlink
                    967: .Ar target-window .
                    968: Unless
                    969: .Fl k
                    970: is given, a window may be unlinked only if it is linked to multiple sessions -
                    971: windows may not be linked to no sessions;
                    972: if
1.1       nicm      973: .Fl k
1.57      jmc       974: is specified and the window is linked to only one session, it is unlinked and
                    975: destroyed.
                    976: .It Ic up-pane Op Fl t Ar target-pane
                    977: .D1 (alias: Ic upp )
                    978: Move up a pane.
                    979: .El
                    980: .Sh KEY BINDINGS
                    981: Commands related to key bindings are as follows:
                    982: .Bl -tag -width Ds
                    983: .It Xo Ic bind-key
                    984: .Op Fl cnr
                    985: .Op Fl t Ar key-table
                    986: .Ar key Ar command Op Ar arguments
1.1       nicm      987: .Xc
1.57      jmc       988: .D1 (alias: Ic bind )
                    989: Bind key
                    990: .Ar key
                    991: to
                    992: .Ar command .
                    993: Keys may be specified prefixed with
                    994: .Ql C-
                    995: or
                    996: .Ql ^
                    997: for Ctrl keys, or
                    998: .Ql M-
                    999: for Alt (meta) keys.
                   1000: .Pp
                   1001: By default (without
                   1002: .Fl t )
                   1003: the primary key bindings are modified (those normally activated with the prefix
                   1004: key); in this case, if
                   1005: .Fl n
                   1006: is specified, it is not necessary to use the prefix key,
                   1007: .Ar command
                   1008: is bound to
                   1009: .Ar key
                   1010: alone.
1.1       nicm     1011: The
1.57      jmc      1012: .Fl r
                   1013: flag indicates this key may repeat, see the
                   1014: .Ic repeat-time
                   1015: option.
                   1016: .Pp
                   1017: If
                   1018: .Fl t
                   1019: is present,
                   1020: .Ar key
                   1021: is bound in
                   1022: .Ar key-table :
                   1023: the binding for command mode with
                   1024: .Fl c
                   1025: or for normal mode without.
                   1026: To view the default bindings and possible commands, see the
                   1027: .Ic list-keys
                   1028: command.
                   1029: .It Ic list-keys Op Fl t Ar key-table
                   1030: .D1 (alias: Ic lsk )
                   1031: List all key bindings.
                   1032: Without
                   1033: .Fl t
                   1034: the primary key bindings - those executed when preceded by the prefix key -
                   1035: are printed.
                   1036: Keys bound without the prefix key (see
                   1037: .Ic bind-key
                   1038: .Fl n )
                   1039: are enclosed in square brackets.
                   1040: .Pp
                   1041: With
                   1042: .Fl t ,
                   1043: the key bindings in
                   1044: .Ar key-table
                   1045: are listed; this may be one of:
                   1046: .Em vi-edit ,
                   1047: .Em emacs-edit ,
                   1048: .Em vi-choice ,
                   1049: .Em emacs-choice ,
                   1050: .Em vi-copy
                   1051: or
                   1052: .Em emacs-copy .
                   1053: .It Xo Ic send-keys
1.72      nicm     1054: .Op Fl t Ar target-pane
1.57      jmc      1055: .Ar key Ar ...
1.1       nicm     1056: .Xc
1.57      jmc      1057: .D1 (alias: Ic send )
                   1058: Send a key or keys to a window.
                   1059: Each argument
                   1060: .Ar key
                   1061: is the name of the key (such as
                   1062: .Ql C-a
                   1063: or
                   1064: .Ql npage
                   1065: ) to send; if the string is not recognised as a key, it is sent as a series of
                   1066: characters.
                   1067: All arguments are sent sequentially from first to last.
1.72      nicm     1068: .It Ic send-prefix Op Fl t Ar target-pane
1.57      jmc      1069: Send the prefix key to a window as if it was pressed.
1.89      nicm     1070: If multiple prefix keys are configured, only the first is sent.
1.57      jmc      1071: .It Xo Ic unbind-key
                   1072: .Op Fl cn
                   1073: .Op Fl t Ar key-table
                   1074: .Ar key
1.2       nicm     1075: .Xc
1.57      jmc      1076: .D1 (alias: Ic unbind )
                   1077: Unbind the command bound to
                   1078: .Ar key .
                   1079: Without
                   1080: .Fl t
                   1081: the primary key bindings are modified; in this case, if
                   1082: .Fl n
                   1083: is specified, the command bound to
                   1084: .Ar key
                   1085: without a prefix (if any) is removed.
                   1086: .Pp
1.47      nicm     1087: If
1.57      jmc      1088: .Fl t
                   1089: is present,
                   1090: .Ar key
                   1091: in
                   1092: .Ar key-table
                   1093: is unbound: the binding for command mode with
                   1094: .Fl c
                   1095: or for normal mode without.
                   1096: .El
                   1097: .Sh OPTIONS
                   1098: The appearance and behaviour of
                   1099: .Nm
                   1100: may be modified by changing the value of various options.
                   1101: There are two types of option:
                   1102: .Em session options
                   1103: and
                   1104: .Em window options .
                   1105: .Pp
                   1106: Each individual session may have a set of session options, and there is a
                   1107: separate set of global session options.
                   1108: Sessions which do not have a particular option configured inherit the value
                   1109: from the global session options.
                   1110: Session options are set or unset with the
                   1111: .Ic set-option
                   1112: command and may be listed with the
                   1113: .Ic show-options
                   1114: command.
                   1115: The available session options are listed under the
                   1116: .Ic set-option
                   1117: command.
                   1118: .Pp
                   1119: Similarly, a set of window options is attached to each window, and there is
                   1120: a set of global window options from which any unset options are inherited.
                   1121: Window options are altered with the
                   1122: .Ic set-window-option
                   1123: command and can be listed with the
                   1124: .Ic show-window-options
                   1125: command.
                   1126: All window options are documented with the
                   1127: .Ic set-window-option
                   1128: command.
                   1129: .Pp
                   1130: Commands which set options are as follows:
                   1131: .Bl -tag -width Ds
1.1       nicm     1132: .It Xo Ic set-option
1.58      nicm     1133: .Op Fl agu
1.1       nicm     1134: .Op Fl t Ar target-session
                   1135: .Ar option Ar value
                   1136: .Xc
                   1137: .D1 (alias: Ic set )
1.18      nicm     1138: Set a session option.
1.58      nicm     1139: With
                   1140: .Fl a ,
                   1141: and if the option expects a string,
                   1142: .Ar value
                   1143: is appended to the existing setting.
1.1       nicm     1144: If
                   1145: .Fl g
1.18      nicm     1146: is specified, the global session option is set.
1.1       nicm     1147: The
                   1148: .Fl u
                   1149: flag unsets an option, so a session inherits the option from the global
                   1150: options - it is not possible to unset a global option.
                   1151: .Pp
1.18      nicm     1152: Available session options are:
1.1       nicm     1153: .Bl -tag -width Ds
1.69      nicm     1154: .It Ic base-index Ar index
                   1155: Set the base index from which an unused index should be searched when a new
                   1156: window is created.
                   1157: The default is zero.
1.1       nicm     1158: .It Xo Ic bell-action
1.56      jmc      1159: .Op Ic any | none | current
1.1       nicm     1160: .Xc
                   1161: Set action on window bell.
                   1162: .Ic any
                   1163: means a bell in any window linked to a session causes a bell in the current
                   1164: window of that session,
                   1165: .Ic none
                   1166: means all bells are ignored and
                   1167: .Ic current
                   1168: means only bell in windows other than the current window are ignored.
                   1169: .It Ic buffer-limit Ar number
                   1170: Set the number of buffers kept for each session; as new buffers are added to
                   1171: the top of the stack, old ones are removed from the bottom if necessary to
                   1172: maintain this maximum length.
                   1173: .It Ic default-command Ar command
                   1174: Set the command used for new windows (if not specified when the window is
                   1175: created) to
1.79      nicm     1176: .Ar command ,
                   1177: which may be any
                   1178: .Xr sh 1
                   1179: command.
1.19      nicm     1180: The default is an empty string, which instructs
                   1181: .Nm
1.79      nicm     1182: to create a login shell using the value of the
                   1183: .Ic default-shell
                   1184: option.
                   1185: .It Ic default-shell Ar path
                   1186: Specify the default shell.
                   1187: This is used as the login shell for new windows when the
                   1188: .Ic default-command
                   1189: option is set to empty, and must be the full path of the executable.
                   1190: When started
                   1191: .Nm
                   1192: tries to set a default value from the first suitable of the
1.19      nicm     1193: .Ev SHELL
1.79      nicm     1194: environment variable, the shell returned by
                   1195: .Xr getpwuid 3 ,
                   1196: or
                   1197: .Pa /bin/sh .
                   1198: This option should be configured when
                   1199: .Nm
                   1200: is used as a login shell.
1.1       nicm     1201: .It Ic default-path Ar path
                   1202: Set the default working directory for processes created from keys, or
                   1203: interactively from the prompt.
                   1204: The default is the current working directory when the server is started.
1.22      nicm     1205: .It Ic default-terminal Ar terminal
                   1206: Set the default terminal for new windows created in this session - the
                   1207: default value of the
                   1208: .Ev TERM
                   1209: environment variable.
                   1210: For
                   1211: .Nm
                   1212: to work correctly, this
                   1213: .Em must
                   1214: be set to
                   1215: .Ql screen
                   1216: or a derivative of it.
1.78      nicm     1217: .It Ic display-panes-colour Ar colour
                   1218: Set the colour used for the
                   1219: .Ic display-panes
                   1220: command.
                   1221: .It Ic display-panes-time Ar time
                   1222: Set the time in milliseconds for which the indicators shown by the
                   1223: .Ic display-panes
                   1224: command appear.
1.21      nicm     1225: .It Ic display-time Ar time
1.78      nicm     1226: Set the amount of time for which status line messages and other on-screen
                   1227: indicators are displayed.
1.21      nicm     1228: .Ar time
                   1229: is in milliseconds.
1.1       nicm     1230: .It Ic history-limit Ar lines
                   1231: Set the maximum number of lines held in window history.
                   1232: This setting applies only to new windows - existing window histories are not
                   1233: resized and retain the limit at the point they were created.
                   1234: .It Ic lock-after-time Ar number
1.90      nicm     1235: Lock the server (like the
                   1236: .Ic lock-server
                   1237: command) after
1.1       nicm     1238: .Ar number
                   1239: seconds of inactivity.
                   1240: The default is off (set to 0).
                   1241: This has no effect as a session option; it must be set as a global option using
                   1242: .Fl g .
1.90      nicm     1243: .It Ic lock-command Ar command
                   1244: Command to run when locking each client.
                   1245: The default is to run
                   1246: .Xr lock 1
                   1247: with
                   1248: .Fl np .
1.1       nicm     1249: .It Ic message-attr Ar attributes
                   1250: Set status line message attributes, where
                   1251: .Ar attributes
                   1252: is either
                   1253: .Ic default
                   1254: or a comma-delimited list of one or more of:
                   1255: .Ic bright
                   1256: (or
                   1257: .Ic bold ) ,
                   1258: .Ic dim ,
                   1259: .Ic underscore ,
                   1260: .Ic blink ,
                   1261: .Ic reverse ,
                   1262: .Ic hidden ,
                   1263: or
                   1264: .Ic italics .
                   1265: .It Ic message-bg Ar colour
                   1266: Set status line message background colour, where
                   1267: .Ar colour
                   1268: is one of:
                   1269: .Ic black ,
                   1270: .Ic red ,
                   1271: .Ic green ,
                   1272: .Ic yellow ,
                   1273: .Ic blue ,
                   1274: .Ic magenta ,
                   1275: .Ic cyan ,
1.85      nicm     1276: .Ic white ,
                   1277: .Ic colour0
                   1278: to
                   1279: .Ic colour255
                   1280: from the 256-colour palette, or
1.1       nicm     1281: .Ic default .
                   1282: .It Ic message-fg Ar colour
                   1283: Set status line message foreground colour.
1.89      nicm     1284: .It Ic prefix Ar keys
                   1285: Set the keys accepted as a prefix key.
                   1286: .Ar keys
                   1287: is a comma-separated list of key names, each of which individually behave as
                   1288: the prefix key.
1.21      nicm     1289: .It Ic repeat-time Ar time
1.1       nicm     1290: Allow multiple commands to be entered without pressing the prefix-key again
                   1291: in the specified
1.21      nicm     1292: .Ar time
1.1       nicm     1293: milliseconds (the default is 500).
                   1294: Whether a key repeats may be set when it is bound using the
                   1295: .Fl r
                   1296: flag to
                   1297: .Ic bind-key .
1.52      nicm     1298: Repeat is enabled for the default keys bound to the
                   1299: .Ic resize-pane
                   1300: command.
1.1       nicm     1301: .It Xo Ic set-remain-on-exit
1.56      jmc      1302: .Op Ic on | off
1.1       nicm     1303: .Xc
                   1304: Set the
                   1305: .Ic remain-on-exit
                   1306: window option for any windows first created in this session.
                   1307: .It Xo Ic set-titles
1.56      jmc      1308: .Op Ic on | off
1.1       nicm     1309: .Xc
1.77      stsp     1310: Attempt to set the window title using the \ee]2;...\e007 xterm code if
1.1       nicm     1311: the terminal appears to be an xterm.
1.11      nicm     1312: This option is off by default.
1.6       jmc      1313: Note that elinks
1.1       nicm     1314: will only attempt to set the window title if the STY environment
                   1315: variable is set.
1.86      nicm     1316: .It Ic set-titles-string Ar string
                   1317: String used to set the window title if
                   1318: .Ic set-titles
                   1319: is on.
                   1320: Character sequences are replaced as for the
                   1321: .Ic status-left
                   1322: option.
1.1       nicm     1323: .It Xo Ic status
1.56      jmc      1324: .Op Ic on | off
1.1       nicm     1325: .Xc
                   1326: Show or hide the status line.
                   1327: .It Ic status-attr Ar attributes
                   1328: Set status line attributes.
                   1329: .It Ic status-bg Ar colour
                   1330: Set status line background colour.
                   1331: .It Ic status-fg Ar colour
                   1332: Set status line foreground colour.
                   1333: .It Ic status-interval Ar interval
                   1334: Update the status bar every
                   1335: .Ar interval
                   1336: seconds.
                   1337: By default, updates will occur every 15 seconds.
                   1338: A setting of zero disables redrawing at interval.
1.41      nicm     1339: .It Xo Ic status-justify
1.56      jmc      1340: .Op Ic left | centre | right
1.41      nicm     1341: .Xc
                   1342: Set the position of the window list component of the status line: left, centre
                   1343: or right justified.
1.1       nicm     1344: .It Xo Ic status-keys
1.56      jmc      1345: .Op Ic vi | emacs
1.1       nicm     1346: .Xc
1.6       jmc      1347: Use vi or emacs-style
1.1       nicm     1348: key bindings in the status line, for example at the command prompt.
                   1349: Defaults to emacs.
                   1350: .It Ic status-left Ar string
                   1351: Display
                   1352: .Ar string
                   1353: to the left of the status bar.
                   1354: .Ar string
                   1355: will be passed through
                   1356: .Xr strftime 3
                   1357: before being used.
                   1358: By default, the session name is shown.
                   1359: .Ar string
1.83      nicm     1360: may contain any of the following special character sequences:
1.1       nicm     1361: .Bl -column "Character pair" "Replaced with" -offset indent
                   1362: .It Sy "Character pair" Ta Sy "Replaced with"
                   1363: .It Li "#(command)" Ta "First line of command's output"
1.83      nicm     1364: .It Li "#[attributes]" Ta "Colour or attribute change"
1.1       nicm     1365: .It Li "#H" Ta "Hostname of local host"
1.35      nicm     1366: .It Li "#I" Ta "Current window index"
                   1367: .It Li "#P" Ta "Current pane index"
1.1       nicm     1368: .It Li "#S" Ta "Session name"
                   1369: .It Li "#T" Ta "Current window title"
1.35      nicm     1370: .It Li "#W" Ta "Current window name"
1.1       nicm     1371: .It Li "##" Ta "A literal" Ql #
                   1372: .El
1.83      nicm     1373: .Pp
                   1374: The #(command) form executes
                   1375: .Ql command
                   1376: as a shell command and inserts the first line of its output.
                   1377: #[attributes] allows a comma-separated list of attributes to be specified,
                   1378: these may be
                   1379: .Ql fg=colour
                   1380: to set the foreground colour,
                   1381: .Ql bg=colour
                   1382: to set the background colour, or one of the attributes described under the
                   1383: .Ic message-attr
                   1384: option.
                   1385: Examples are:
                   1386: .Bd -literal -offset indent
                   1387: #(sysctl vm.loadavg)
                   1388: #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
                   1389: .Ed
1.1       nicm     1390: .Pp
                   1391: Where appropriate, these may be prefixed with a number to specify the maximum
                   1392: length, for example
                   1393: .Ql #24T .
1.10      nicm     1394: .Pp
1.12      jmc      1395: By default, UTF-8 in
1.10      nicm     1396: .Ar string
                   1397: is not interpreted, to enable UTF-8, use the
                   1398: .Ic status-utf8
                   1399: option.
1.62      nicm     1400: .It Ic status-left-attr Ar attributes
1.66      jmc      1401: Set the attribute of the left part of the status line.
1.62      nicm     1402: .It Ic status-left-fg Ar colour
                   1403: Set the foreground colour of the left part of the status line.
                   1404: .It Ic status-left-bg Ar colour
                   1405: Set the background colour of the left part of the status line.
1.1       nicm     1406: .It Ic status-left-length Ar length
                   1407: Set the maximum
                   1408: .Ar length
                   1409: of the left component of the status bar.
                   1410: The default is 10.
                   1411: .It Ic status-right Ar string
                   1412: Display
                   1413: .Ar string
                   1414: to the right of the status bar.
                   1415: By default, the date and time will be shown.
                   1416: As with
                   1417: .Ic status-left ,
                   1418: .Ar string
                   1419: will be passed to
1.10      nicm     1420: .Xr strftime 3 ,
                   1421: character pairs are replaced, and UTF-8 is dependent on the
                   1422: .Ic status-utf8
                   1423: option.
1.62      nicm     1424: .It Ic status-right-attr Ar attributes
1.66      jmc      1425: Set the attribute of the right part of the status line.
1.62      nicm     1426: .It Ic status-right-fg Ar colour
                   1427: Set the foreground colour of the right part of the status line.
                   1428: .It Ic status-right-bg Ar colour
                   1429: Set the background colour of the right part of the status line.
1.1       nicm     1430: .It Ic status-right-length Ar length
                   1431: Set the maximum
                   1432: .Ar length
                   1433: of the right component of the status bar.
                   1434: The default is 40.
1.10      nicm     1435: .Pp
                   1436: .It Xo Ic status-utf8
1.56      jmc      1437: .Op Ic on | off
1.10      nicm     1438: .Xc
                   1439: Instruct
                   1440: .Nm
                   1441: to treat top-bit-set characters in the
                   1442: .Ic status-left
                   1443: and
                   1444: .Ic status-right
                   1445: strings as UTF-8; notably, this is important for wide characters.
                   1446: This option defaults to off.
1.55      jmc      1447: .It Ic terminal-overrides Ar string
1.54      nicm     1448: Contains a list of entries which override terminal descriptions read using
                   1449: .Xr terminfo 5 .
                   1450: .Ar string
                   1451: is a comma-separated list of items each a colon-separated string made up of a
                   1452: terminal type pattern (matched using
                   1453: .Xr fnmatch 3 )
                   1454: and a set of
                   1455: .Em name=value
                   1456: entries.
                   1457: .Pp
                   1458: For example, to set the
                   1459: .Ql clear
                   1460: .Xr terminfo 5
                   1461: entry to
                   1462: .Ql \ee[H\ee[2J
                   1463: for all terminal types and the
                   1464: .Ql dch1
                   1465: entry to
                   1466: .Ql \ee[P
1.55      jmc      1467: for the
1.54      nicm     1468: .Ql rxvt
                   1469: terminal type, the option could be set to the string:
                   1470: .Bd -literal -offset indent
                   1471: "*:clear=\ee[H\ee[2J,rxvt:dch1=\ee[P"
                   1472: .Ed
                   1473: .Pp
                   1474: The terminal entry value is passed through
                   1475: .Xr strunvis 3
                   1476: before interpretation.
                   1477: The default value forcibly corrects the
                   1478: .Ql colors
                   1479: entry for terminals which support 88 or 256 colours:
                   1480: .Bd -literal -offset indent
                   1481: "*88col*:colors=88,*256col*:colors=256"
                   1482: .Ed
1.63      nicm     1483: .It Ic update-environment Ar variables
                   1484: Set a space-separated string containing a list of environment variables to be
                   1485: copied into the session environment when a new session is created or an
                   1486: existing session is attached.
                   1487: Any variables that do not exist in the source environment are set to be
                   1488: removed from the session environment (as if
                   1489: .Fl r
                   1490: was given to the
                   1491: .Ic set-environment
                   1492: command).
                   1493: The default is
1.75      nicm     1494: "DISPLAY WINDOWID SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION".
1.37      nicm     1495: .It Xo Ic visual-activity
1.56      jmc      1496: .Op Ic on | off
1.37      nicm     1497: .Xc
                   1498: If on, display a status line message when activity occurs in a window
1.39      jmc      1499: for which the
1.37      nicm     1500: .Ic monitor-activity
                   1501: window option is enabled.
                   1502: .It Xo Ic visual-bell
1.56      jmc      1503: .Op Ic on | off
1.37      nicm     1504: .Xc
                   1505: If this option is on, a message is shown on a bell instead of it being passed
                   1506: through to the terminal (which normally makes a sound).
                   1507: Also see the
                   1508: .Ic bell-action
                   1509: option.
                   1510: .It Xo Ic visual-content
1.56      jmc      1511: .Op Ic on | off
1.37      nicm     1512: .Xc
                   1513: Like
                   1514: .Ic visual-activity ,
                   1515: display a message when content is present in a window
1.39      jmc      1516: for which the
1.37      nicm     1517: .Ic monitor-content
                   1518: window option is enabled.
1.1       nicm     1519: .El
                   1520: .It Xo Ic set-window-option
1.58      nicm     1521: .Op Fl agu
1.1       nicm     1522: .Op Fl t Ar target-window
                   1523: .Ar option Ar value
                   1524: .Xc
                   1525: .D1 (alias: Ic setw )
1.18      nicm     1526: Set a window option.
1.1       nicm     1527: The
1.58      nicm     1528: .Fl a ,
1.1       nicm     1529: .Fl g
                   1530: and
                   1531: .Fl u
                   1532: flags work similarly to the
                   1533: .Ic set-option
                   1534: command.
                   1535: .Pp
1.18      nicm     1536: Supported window options are:
1.56      jmc      1537: .Pp
                   1538: .Bl -tag -width Ds -compact
1.1       nicm     1539: .It Xo Ic aggressive-resize
1.56      jmc      1540: .Op Ic on | off
1.1       nicm     1541: .Xc
                   1542: Aggressively resize the chosen window.
                   1543: This means that
                   1544: .Nm
                   1545: will resize the window to the size of the smallest session for which it is the
                   1546: current window, rather than the smallest session to which it is attached.
                   1547: The window may resize when the current window is changed on another sessions;
1.6       jmc      1548: this option is good for full-screen programs which support
                   1549: .Dv SIGWINCH
                   1550: and poor for interactive programs such as shells.
1.56      jmc      1551: .Pp
1.1       nicm     1552: .It Xo Ic automatic-rename
1.56      jmc      1553: .Op Ic on | off
1.1       nicm     1554: .Xc
                   1555: Control automatic window renaming.
                   1556: When this setting is enabled,
                   1557: .Nm
                   1558: will attempt - on supported platforms - to rename the window to reflect the
                   1559: command currently running in it.
                   1560: This flag is automatically disabled for an individual window when a name
                   1561: is specified at creation with
                   1562: .Ic new-window or
                   1563: .Ic new-session ,
                   1564: or later with
                   1565: .Ic rename-window .
                   1566: It may be switched off globally with:
                   1567: .Bd -literal -offset indent
                   1568: set-window-option -g automatic-rename off
                   1569: .Ed
1.56      jmc      1570: .Pp
1.1       nicm     1571: .It Ic clock-mode-colour Ar colour
                   1572: Set clock colour.
1.56      jmc      1573: .Pp
1.1       nicm     1574: .It Xo Ic clock-mode-style
1.56      jmc      1575: .Op Ic 12 | 24
1.1       nicm     1576: .Xc
                   1577: Set clock hour format.
1.56      jmc      1578: .Pp
1.1       nicm     1579: .It Ic force-height Ar height
                   1580: .It Ic force-width Ar width
                   1581: Prevent
                   1582: .Nm
                   1583: from resizing a window to greater than
                   1584: .Ar width
                   1585: or
                   1586: .Ar height .
                   1587: A value of zero restores the default unlimited setting.
1.56      jmc      1588: .Pp
1.2       nicm     1589: .It Ic main-pane-width Ar width
                   1590: .It Ic main-pane-height Ar height
                   1591: Set the width or height of the main (left or top) pane in the
                   1592: .Ic main-horizontal
                   1593: or
                   1594: .Ic main-vertical
                   1595: layouts.
1.56      jmc      1596: .Pp
1.1       nicm     1597: .It Ic mode-attr Ar attributes
                   1598: Set window modes attributes.
1.56      jmc      1599: .Pp
1.1       nicm     1600: .It Ic mode-bg Ar colour
                   1601: Set window modes background colour.
1.56      jmc      1602: .Pp
1.1       nicm     1603: .It Ic mode-fg Ar colour
                   1604: Set window modes foreground colour.
1.56      jmc      1605: .Pp
1.1       nicm     1606: .It Xo Ic mode-keys
1.56      jmc      1607: .Op Ic vi | emacs
1.1       nicm     1608: .Xc
1.50      nicm     1609: Use vi or emacs-style key bindings in scroll, copy and choice modes.
1.1       nicm     1610: Key bindings default to emacs.
1.56      jmc      1611: .Pp
1.50      nicm     1612: .It Xo Ic mode-mouse
1.56      jmc      1613: .Op Ic on | off
1.50      nicm     1614: .Xc
1.51      jmc      1615: Mouse state in modes.
                   1616: If on,
1.50      nicm     1617: .Nm
                   1618: will respond to mouse clicks by moving the cursor in copy mode or selecting an
                   1619: option in choice mode.
1.56      jmc      1620: .Pp
1.1       nicm     1621: .It Xo Ic monitor-activity
1.56      jmc      1622: .Op Ic on | off
1.1       nicm     1623: .Xc
                   1624: Monitor for activity in the window.
                   1625: Windows with activity are highlighted in the status line.
1.56      jmc      1626: .Pp
                   1627: .It Ic monitor-content Ar match-string
1.6       jmc      1628: Monitor content in the window.
                   1629: When
1.16      nicm     1630: .Xr fnmatch 3
                   1631: pattern
1.1       nicm     1632: .Ar match-string
                   1633: appears in the window, it is highlighted in the status line.
1.56      jmc      1634: .Pp
1.1       nicm     1635: .It Xo Ic remain-on-exit
1.56      jmc      1636: .Op Ic on | off
1.1       nicm     1637: .Xc
                   1638: A window with this flag set is not destroyed when the program running in it
                   1639: exits.
                   1640: The window may be reactivated with the
                   1641: .Ic respawn-window
                   1642: command.
1.56      jmc      1643: .Pp
1.1       nicm     1644: .It Xo Ic utf8
1.56      jmc      1645: .Op Ic on | off
1.1       nicm     1646: .Xc
                   1647: Instructs
                   1648: .Nm
                   1649: to expect UTF-8 sequences to appear in this window.
1.56      jmc      1650: .Pp
1.1       nicm     1651: .It Ic window-status-attr Ar attributes
                   1652: Set status line attributes for a single window.
1.56      jmc      1653: .Pp
1.1       nicm     1654: .It Ic window-status-bg Ar colour
                   1655: Set status line background colour for a single window.
1.56      jmc      1656: .Pp
1.1       nicm     1657: .It Ic window-status-fg Ar colour
                   1658: Set status line foreground colour for a single window.
1.56      jmc      1659: .Pp
1.40      nicm     1660: .It Ic window-status-current-attr Ar attributes
                   1661: Set status line attributes for the currently active window.
1.56      jmc      1662: .Pp
1.40      nicm     1663: .It Ic window-status-current-bg Ar colour
                   1664: Set status line background colour for the currently active window.
1.56      jmc      1665: .Pp
1.40      nicm     1666: .It Ic window-status-current-fg Ar colour
                   1667: Set status line foreground colour for the currently active window.
1.56      jmc      1668: .Pp
1.1       nicm     1669: .It Xo Ic xterm-keys
1.56      jmc      1670: .Op Ic on | off
1.1       nicm     1671: .Xc
                   1672: If this option is set,
                   1673: .Nm
                   1674: will generate
1.57      jmc      1675: .Xr xterm 1 -style
                   1676: function key sequences; these have a number included to indicate modifiers such
                   1677: as Shift, Alt or Ctrl.
                   1678: .El
                   1679: .It Xo Ic show-options
                   1680: .Op Fl g
                   1681: .Op Fl t Ar target-session
                   1682: .Xc
                   1683: .D1 (alias: Ic show )
                   1684: Show the session options for
                   1685: .Ar target session ,
                   1686: or the global session options with
                   1687: .Fl g .
                   1688: .It Xo Ic show-window-options
                   1689: .Op Fl g
                   1690: .Op Fl t Ar target-window
                   1691: .Xc
                   1692: .D1 (alias: Ic showw )
                   1693: List the window options for
                   1694: .Ar target-window ,
                   1695: or the global window options if
                   1696: .Fl g
                   1697: is used.
1.63      nicm     1698: .El
                   1699: .Sh ENVIRONMENT
                   1700: When the server is started,
                   1701: .Nm
                   1702: copies the environment into the
                   1703: .Em global environment ;
                   1704: in addition, each session has a
                   1705: .Em session environment .
                   1706: When a window is created, the session and global environments are merged with
                   1707: the session environment overriding any variable present in both.
                   1708: This is the initial environment passed to the new process.
                   1709: .Pp
                   1710: The
                   1711: .Ic update-environment
                   1712: session option may be used to update the session environment from the client
                   1713: when a new session is created or an old reattached.
                   1714: .Nm
                   1715: also initialises the
                   1716: .Ev TMUX
                   1717: variable with some internal information to allow commands to be executed
                   1718: from inside, and the
                   1719: .Ev TERM
                   1720: variable with the correct terminal setting of
                   1721: .Ql screen .
                   1722: .Pp
                   1723: Commands to alter and view the environment are:
                   1724: .Bl -tag -width Ds
                   1725: .It Xo Ic set-environment
                   1726: .Op Fl gru
                   1727: .Op Fl t Ar target-session
                   1728: .Ar name Op Ar value
                   1729: .Xc
                   1730: Set or unset an environment variable.
                   1731: If
                   1732: .Fl g
                   1733: is used, the change is made in the global environment; otherwise, it is applied
                   1734: to the session environment for
                   1735: .Ar target-session .
                   1736: The
                   1737: .Fl u
                   1738: flag unsets a variable.
                   1739: .Fl r
                   1740: indicates the variable is to be removed from the environment before starting a
                   1741: new process.
                   1742: .It Xo Ic show-environment
                   1743: .Op Fl g
                   1744: .Op Fl t Ar target-session
                   1745: .Xc
                   1746: Display the environment for
                   1747: .Ar target-session
                   1748: or the global environment with
                   1749: .Fl g .
                   1750: Variables removed from the environment are prefixed with
                   1751: .Ql - .
1.57      jmc      1752: .El
                   1753: .Sh STATUS LINE
                   1754: .Nm
                   1755: includes an optional status line which is displayed in the bottom line of each
                   1756: terminal.
                   1757: By default, the status line is enabled (it may be disabled with the
                   1758: .Ic status
                   1759: session option) and contains, from left-to-right: the name of the current
                   1760: session in square brackets; the window list; the current window title in double
                   1761: quotes; and the time and date.
                   1762: .Pp
                   1763: The status line is made of three parts: configurable left and right sections
                   1764: (which may contain dynamic content such as the time or output from a shell
                   1765: command, see the
                   1766: .Ic status-left ,
                   1767: .Ic status-left-length ,
                   1768: .Ic status-right ,
                   1769: and
                   1770: .Ic status-right-length
                   1771: options below), and a central window list.
                   1772: The window list shows the index, name and (if any) flag of the windows
                   1773: present in the current session in ascending numerical order.
                   1774: The flag is one of the following symbols appended to the window name:
                   1775: .Bl -column "Symbol" "Meaning" -offset indent
                   1776: .It Sy "Symbol" Ta Sy "Meaning"
                   1777: .It Li "*" Ta "Denotes the current window."
                   1778: .It Li "-" Ta "Marks the last window (previously selected)."
                   1779: .It Li "#" Ta "Window is monitored and activity has been detected."
                   1780: .It Li "!" Ta "A bell has occurred in the window."
                   1781: .It Li "+" Ta "Window is monitored for content and it has appeared."
                   1782: .El
                   1783: .Pp
                   1784: The # symbol relates to the
                   1785: .Ic monitor-activity
                   1786: and + to the
                   1787: .Ic monitor-content
                   1788: window options.
                   1789: The window name is printed in inverted colours if an alert (bell, activity or
                   1790: content) is present.
                   1791: .Pp
                   1792: The colour and attributes of the status line may be configured, the entire status line using
                   1793: the
                   1794: .Ic status-attr ,
                   1795: .Ic status-fg
                   1796: and
                   1797: .Ic status-bg
                   1798: session options and individual windows using the
                   1799: .Ic window-status-attr ,
                   1800: .Ic window-status-fg
                   1801: and
                   1802: .Ic window-status-bg
                   1803: window options.
                   1804: .Pp
                   1805: The status line is automatically refreshed at interval if it has changed, the interval may be
                   1806: controlled with the
                   1807: .Ic status-interval
                   1808: session option.
                   1809: .Pp
                   1810: Commands related to the status line are as follows:
                   1811: .Bl -tag -width Ds
                   1812: .It Xo Ic command-prompt
1.73      nicm     1813: .Op Fl p Ar prompts
1.57      jmc      1814: .Op Fl t Ar target-client
                   1815: .Op Ar template
                   1816: .Xc
                   1817: Open the command prompt in a client.
                   1818: This may be used from inside
                   1819: .Nm
                   1820: to execute commands interactively.
                   1821: If
                   1822: .Ar template
1.73      nicm     1823: is specified, it is used as the command.
                   1824: If
                   1825: .Fl p
                   1826: is given,
                   1827: .Ar prompts
                   1828: is a comma-separated list of prompts which are displayed in order; otherwise
                   1829: a single prompt is displayed, constructed from
                   1830: .Ar template
                   1831: if it is present, or
                   1832: .Ql \&:
                   1833: if not.
                   1834: Before the command is executed, the first occurrence of the string
                   1835: .Ql %%
1.74      jmc      1836: and all occurrences of
1.73      nicm     1837: .Ql %1
                   1838: are replaced by the response to the first prompt, the second
                   1839: .Ql %%
                   1840: and all
                   1841: .Ql %2
                   1842: are replaced with the response to the second prompt, and so on for further
1.74      jmc      1843: prompts.
                   1844: Up to nine prompt responses may be replaced
                   1845: .Po
                   1846: .Ql %1
1.73      nicm     1847: to
1.74      jmc      1848: .Ql %9
                   1849: .Pc .
1.57      jmc      1850: .It Xo Ic confirm-before
                   1851: .Op Fl t Ar target-client
                   1852: .Ar command
                   1853: .Xc
                   1854: .D1 (alias: Ic confirm )
                   1855: Ask for confirmation before executing
                   1856: .Ar command .
                   1857: This command works only from inside
                   1858: .Nm .
                   1859: .It Xo Ic display-message
                   1860: .Op Fl t Ar target-client
                   1861: .Op Ar message
                   1862: .Xc
                   1863: .D1 (alias: Ic display )
                   1864: Display a message (see the
                   1865: .Ic status-left
                   1866: option below)
                   1867: in the status line.
                   1868: .It Ic select-prompt Op Fl t Ar target-client
                   1869: Open a prompt inside
                   1870: .Ar target-client
                   1871: allowing a window index to be entered interactively.
                   1872: .El
                   1873: .Sh BUFFERS
                   1874: .Nm
                   1875: maintains a stack of
                   1876: .Em paste buffers
                   1877: for each session.
                   1878: Up to the value of the
                   1879: .Ic buffer-limit
                   1880: option are kept; when a new buffer is added, the buffer at the bottom of the
                   1881: stack is removed.
                   1882: Buffers may be added using
                   1883: .Ic copy-mode
                   1884: or the
                   1885: .Ic set-buffer
                   1886: command, and pasted into a window using the
                   1887: .Ic paste-buffer
                   1888: command.
                   1889: .Pp
                   1890: A configurable history buffer is also maintained for each window.
                   1891: By default, up to 2000 lines are kept; this can be altered with the
                   1892: .Ic history-limit
                   1893: option (see the
                   1894: .Ic set-option
                   1895: command above).
                   1896: .Pp
                   1897: The buffer commands are as follows:
                   1898: .Bl -tag -width Ds
                   1899: .It Ic clear-history Op Fl t Ar target-pane
                   1900: .D1 (alias: Ic clearhist )
                   1901: Remove and free the history for the specified pane.
                   1902: .It Xo Ic copy-buffer
                   1903: .Op Fl a Ar src-index
                   1904: .Op Fl b Ar dst-index
                   1905: .Op Fl s Ar src-session
                   1906: .Op Fl t Ar dst-session
                   1907: .Xc
                   1908: .D1 (alias: Ic copyb )
                   1909: Copy a session paste buffer to another session.
                   1910: If no sessions are specified, the current one is used instead.
                   1911: .It Xo Ic delete-buffer
                   1912: .Op Fl b Ar buffer-index
                   1913: .Op Fl t Ar target-session
                   1914: .Xc
                   1915: .D1 (alias: Ic deleteb )
                   1916: Delete the buffer at
                   1917: .Ar buffer-index ,
                   1918: or the top buffer if not specified.
                   1919: .It Ic list-buffers Op Fl t Ar target-session
                   1920: .D1 (alias: Ic lsb )
                   1921: List the buffers in the given session.
                   1922: .It Xo Ic load-buffer
                   1923: .Op Fl b Ar buffer-index
                   1924: .Op Fl t Ar target-session
                   1925: .Ar path
                   1926: .Xc
                   1927: .D1 (alias: Ic loadb )
                   1928: Load the contents of the specified paste buffer from
                   1929: .Ar path .
                   1930: .It Xo Ic paste-buffer
                   1931: .Op Fl dr
                   1932: .Op Fl b Ar buffer-index
                   1933: .Op Fl t Ar target-window
                   1934: .Xc
                   1935: .D1 (alias: Ic pasteb )
                   1936: Insert the contents of a paste buffer into the current window.
                   1937: With
                   1938: .Fl d ,
                   1939: also delete the paste buffer from the stack.
                   1940: When output, any linefeed (LF) characters in the paste buffer are replaced with
                   1941: carriage returns (CR).
                   1942: This translation may be disabled with the
                   1943: .Fl r
                   1944: flag.
                   1945: .It Xo Ic save-buffer
                   1946: .Op Fl a
                   1947: .Op Fl b Ar buffer-index
                   1948: .Op Fl t Ar target-session
                   1949: .Ar path
                   1950: .Xc
                   1951: .D1 (alias: Ic saveb )
                   1952: Save the contents of the specified paste buffer to
                   1953: .Ar path .
                   1954: The
                   1955: .Fl a
                   1956: option appends to rather than overwriting the file.
                   1957: .It Xo Ic set-buffer
                   1958: .Op Fl b Ar buffer-index
                   1959: .Op Fl t Ar target-session
                   1960: .Ar data
                   1961: .Xc
                   1962: .D1 (alias: Ic setb )
                   1963: Set the contents of the specified buffer to
                   1964: .Ar data .
1.1       nicm     1965: .It Xo Ic show-buffer
                   1966: .Op Fl b Ar buffer-index
                   1967: .Op Fl t Ar target-session
                   1968: .Xc
                   1969: .D1 (alias: Ic showb )
                   1970: Display the contents of the specified buffer.
1.57      jmc      1971: .El
                   1972: .Sh MISCELLANEOUS
                   1973: .Pp
                   1974: Miscellaneous commands are as follows:
                   1975: .Bl -tag -width Ds
1.72      nicm     1976: .It Ic clock-mode Op Fl t Ar target-pane
1.57      jmc      1977: Display a large clock.
                   1978: .It Ic if-shell Ar shell-command command
                   1979: .D1 (alias: Ic if )
                   1980: Execute
                   1981: .Ar command
                   1982: if
                   1983: .Ar shell-command
                   1984: returns success.
                   1985: .It Ic lock-server
                   1986: .D1 (alias: Ic lock )
1.90      nicm     1987: Lock each client individually by running the command specified by the
                   1988: .Ic lock-command
                   1989: option.
1.87      nicm     1990: .It Ic run-shell Ar command
                   1991: .D1 (alias: Ic run )
                   1992: Execute
                   1993: .Ar command
                   1994: without creating a window.
                   1995: Any output to stdout is displayed in output mode.
                   1996: If
1.88      jmc      1997: .Ar command
1.87      nicm     1998: doesn't return success, the exit status is also displayed.
1.57      jmc      1999: .It Ic server-info
                   2000: .D1 (alias: Ic info )
                   2001: Show server information and terminal details.
1.1       nicm     2002: .El
                   2003: .Sh FILES
1.26      nicm     2004: .Bl -tag -width "/etc/tmux.confXXX" -compact
1.1       nicm     2005: .It Pa ~/.tmux.conf
1.6       jmc      2006: Default
1.1       nicm     2007: .Nm
1.6       jmc      2008: configuration file.
1.26      nicm     2009: .It Pa /etc/tmux.conf
                   2010: System-wide configuration file.
1.1       nicm     2011: .El
1.57      jmc      2012: .Sh EXAMPLES
                   2013: To create a new
                   2014: .Nm
                   2015: session running
                   2016: .Xr vi 1 :
                   2017: .Pp
                   2018: .Dl $ tmux new-session vi
                   2019: .Pp
                   2020: Most commands have a shorter form, known as an alias.
                   2021: For new-session, this is
                   2022: .Ic new :
                   2023: .Pp
                   2024: .Dl $ tmux new vi
                   2025: .Pp
                   2026: Alternatively, the shortest unambiguous form of a command is accepted.
                   2027: If there are several options, they are listed:
                   2028: .Bd -literal -offset indent
                   2029: $ tmux n
                   2030: ambiguous command: n, could be: new-session, new-window, next-window
                   2031: .Ed
                   2032: .Pp
                   2033: Within an active session, a new window may be created by typing
                   2034: .Ql C-b c
                   2035: (Ctrl
                   2036: followed by the
                   2037: .Ql b
                   2038: key
                   2039: followed by the
                   2040: .Ql c
                   2041: key).
                   2042: .Pp
                   2043: Windows may be navigated with:
                   2044: .Ql C-b 0
                   2045: (to select window 0),
                   2046: .Ql C-b 1
                   2047: (to select window 1), and so on;
                   2048: .Ql C-b n
                   2049: to select the next window; and
                   2050: .Ql C-b p
                   2051: to select the previous window.
                   2052: .Pp
                   2053: A session may be detached using
                   2054: .Ql C-b d
1.64      nicm     2055: (or by an external event such as
                   2056: .Xr ssh 1
                   2057: disconnection) and reattached with:
1.57      jmc      2058: .Pp
                   2059: .Dl $ tmux attach-session
                   2060: .Pp
                   2061: Typing
                   2062: .Ql C-b \&?
                   2063: lists the current key bindings in the current window; up and down may be used
                   2064: to navigate the list or
                   2065: .Ql q
                   2066: to exit from it.
                   2067: .Pp
                   2068: Commands to be run when the
                   2069: .Nm
                   2070: server is started may be placed in the
                   2071: .Pa ~/.tmux.conf
                   2072: configuration file.
                   2073: Common examples include:
                   2074: .Pp
                   2075: Changing the default prefix key:
                   2076: .Bd -literal -offset indent
                   2077: set-option -g prefix C-a
                   2078: unbind-key C-b
                   2079: bind-key C-a send-prefix
                   2080: .Ed
                   2081: .Pp
                   2082: Turning the status line off, or changing its colour:
                   2083: .Bd -literal -offset indent
                   2084: set-option -g status off
                   2085: set-option -g status-bg blue
                   2086: .Ed
                   2087: .Pp
                   2088: Setting other options, such as the default command,
                   2089: or locking after 30 minutes of inactivity:
                   2090: .Bd -literal -offset indent
                   2091: set-option -g default-command "exec /bin/ksh"
                   2092: set-option -g lock-after-time 1800
                   2093: .Ed
                   2094: .Pp
                   2095: Creating new key bindings:
                   2096: .Bd -literal -offset indent
                   2097: bind-key b set-option status
                   2098: bind-key / command-prompt "split-window 'exec man %%'"
1.73      nicm     2099: bind-key S command-prompt "new-window -n %1 'ssh %1'"
1.57      jmc      2100: .Ed
1.1       nicm     2101: .Sh SEE ALSO
                   2102: .Xr pty 4
                   2103: .Sh AUTHORS
                   2104: .An Nicholas Marriott Aq nicm@users.sourceforge.net