[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.14

1.14    ! nicm        1: .\" $OpenBSD: tmux.1,v 1.13 2009/06/23 22:13:11 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.14    ! nicm       17: .Dd $Mdocdate: June 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
                     26: .Op Fl 28dqUuv
                     27: .Op Fl f Ar file
                     28: .Op Fl L Ar socket-name
                     29: .Op Fl S Ar socket-path
                     30: .Op Ar command Op Ar flags
                     31: .Ek
                     32: .Sh DESCRIPTION
                     33: .Nm
1.6       jmc        34: is a terminal multiplexer: it enables a number of terminals to be accessed and
1.1       nicm       35: controlled from a single terminal.
                     36: .Pp
                     37: .Nm
                     38: runs as a server-client system.
                     39: A server is created automatically when necessary and holds a number of
                     40: .Em sessions ,
                     41: each of which may have a number of
                     42: .Em windows
                     43: linked to it.
                     44: A window may be split on screen into one or more
                     45: .Em panes ,
                     46: each of which is a separate terminal.
                     47: Any number of
                     48: .Em clients
                     49: may connect to a session, or the server
                     50: may be controlled by issuing commands with
                     51: .Nm .
                     52: Communication takes place through a socket, by default placed in
                     53: .Pa /tmp .
                     54: .Pp
                     55: The options are as follows:
                     56: .Bl -tag -width "XXXXXXXXXXXX"
                     57: .It Fl 2
                     58: Force
                     59: .Nm
                     60: to assume the terminal supports 256 colours.
                     61: .It Fl 8
                     62: Like
                     63: .Fl 2 ,
1.6       jmc        64: but indicates that the terminal supports 88 colours.
1.1       nicm       65: .It Fl d
                     66: Force
                     67: .Nm
                     68: to assume the terminal supports default colours.
                     69: .It Fl f Ar file
                     70: Specify an alternative configuration file.
                     71: By default,
                     72: .Nm
                     73: will look for a config file at
                     74: .Pa ~/.tmux.conf .
                     75: The configuration file is a set of
                     76: .Nm
                     77: commands which are executed in sequence when the server is first started.
                     78: .It Fl L Ar socket-name
                     79: .Nm
                     80: stores the server socket in a directory under
                     81: .Pa /tmp ;
                     82: the default socket is named
                     83: .Em default .
                     84: This option allows a different socket name to be specified, allowing several
                     85: independent
                     86: .Nm
                     87: servers to be run.
                     88: Unlike
                     89: .Fl S
                     90: a full path is not necessary: the sockets are all created in the same
                     91: directory.
1.2       nicm       92: .Pp
                     93: If the socket is accidentally removed, the
1.6       jmc        94: .Dv SIGUSR1
1.2       nicm       95: signal may be sent to the
                     96: .Nm
                     97: server process to recreate it.
1.4       sobrado    98: .It Fl q
1.6       jmc        99: Prevent the server sending various informational messages, for example when
1.4       sobrado   100: window flags are altered.
1.1       nicm      101: .It Fl S Ar socket-path
                    102: Specify a full alternative path to the server socket.
                    103: If
                    104: .Fl S
                    105: is specified, the default socket directory is not used and any
                    106: .Fl L
                    107: flag is ignored.
                    108: .It Fl U
                    109: Unlock the server.
                    110: .It Fl u
                    111: .Nm
1.14    ! nicm      112: attempts to guess if the terminal is likely to support UTF-8 by checking the
        !           113: first of the
        !           114: .Ev LC_ALL ,
        !           115: .Ev LC_CTYPE
        !           116: and
1.2       nicm      117: .Ev LANG
1.14    ! nicm      118: environment variables to be set for the string "UTF-8".
1.5       nicm      119: This is not always correct: the
1.2       nicm      120: .Fl u
                    121: flag explicitly informs
                    122: .Nm
1.6       jmc       123: that UTF-8 is supported.
1.1       nicm      124: .It Fl v
                    125: Request verbose logging.
                    126: This option may be specified multiple times for increasing verbosity.
                    127: Log messages will be saved into
                    128: .Pa tmux-client-PID.log
                    129: and
                    130: .Pa tmux-server-PID.log
                    131: files in the current directory, where
                    132: .Em PID
1.6       jmc       133: is the PID of the server or client process.
1.1       nicm      134: .It Ar command Op Ar flags
                    135: This specifies one of a set of commands used to control
                    136: .Nm ,
1.6       jmc       137: as described in the following sections.
                    138: If no command and flags are specified, the
1.1       nicm      139: .Ic new-session
                    140: command is assumed.
                    141: .El
                    142: .Sh QUICK START
1.6       jmc       143: To create a new
                    144: .Nm
                    145: session running
1.1       nicm      146: .Xr vi 1 :
                    147: .Pp
                    148: .Dl $ tmux new-session vi
                    149: .Pp
                    150: Most commands have a shorter form, known as an alias.
                    151: For new-session, this is
                    152: .Ic new :
                    153: .Pp
                    154: .Dl $ tmux new vi
                    155: .Pp
                    156: Alternatively, the shortest unambiguous form of a command is accepted.
                    157: If there are several options, they are listed:
                    158: .Bd -literal -offset indent
                    159: $ tmux n
                    160: ambiguous command: n, could be: new-session, new-window, next-window
                    161: .Ed
                    162: .Pp
                    163: Within an active session, a new window may be created by typing
1.7       jmc       164: .Ql C-b c
                    165: (Ctrl
1.1       nicm      166: followed by the
1.6       jmc       167: .Ql b
1.7       jmc       168: key
                    169: followed by the
                    170: .Ql c
1.6       jmc       171: key).
1.1       nicm      172: .Pp
                    173: Windows may be navigated with:
                    174: .Ql C-b 0
                    175: (to select window 0),
                    176: .Ql C-b 1
                    177: (to select window 1), and so on;
                    178: .Ql C-b n
                    179: to select the next window; and
                    180: .Ql C-b p
                    181: to select the previous window.
                    182: .Pp
                    183: A session may be detached using
                    184: .Ql C-b d
                    185: and reattached with:
                    186: .Pp
                    187: .Dl $ tmux attach-session
                    188: .Pp
                    189: Typing
                    190: .Ql C-b \&?
                    191: lists the current key bindings in the current window; up and down may be used
                    192: to navigate the list or
1.6       jmc       193: .Ql q
1.1       nicm      194: to exit from it.
1.13      nicm      195: .Pp
                    196: Commands to be run when the
                    197: .Nm
                    198: server is started may be placed in the
                    199: .Pa ~/.tmux.conf
                    200: configuration file.
                    201: Common examples include:
                    202: .Bl -ohang -width Ds
                    203: .It Changing the default prefix key:
                    204: .Bd -literal -offset indent
                    205: set-option -g prefix C-a
                    206: unbind-key C-b
                    207: bind-key C-a send-prefix
                    208: .Ed
                    209: .Pp
                    210: .It Xo
                    211: Turning the status line off, or changing its colour:
                    212: .Xc
                    213: .Bd -literal -offset indent
                    214: set-option -g status off
                    215: set-option -g status-bg blue
                    216: .Ed
                    217: .Pp
                    218: .It Xo
                    219: Setting other options, such as the default command, or locking after 30 minutes
                    220: of inactivity:
                    221: .Xc
                    222: .Bd -literal -offset indent
                    223: set-option -g default-command "exec /bin/ksh"
                    224: set-option -g lock-after-time 1800
                    225: .Ed
                    226: .It Creating new key bindings:
                    227: .Bd -literal -offset indent
                    228: bind-key b set-option status
                    229: bind-key / command-prompt "split-window 'exec man %%'"
                    230: .Ed
                    231: .El
1.1       nicm      232: .Sh KEY BINDINGS
                    233: .Nm
                    234: may be controlled from an attached client by using a key combination of a
                    235: prefix key,
                    236: .Ql C-b
1.6       jmc       237: (Ctrl-b) by default, followed by a command key.
1.1       nicm      238: .Pp
                    239: Some of the default key bindings include:
                    240: .Pp
1.6       jmc       241: .Bl -tag -width Ds -offset 3n -compact
                    242: .It c
                    243: Create new window.
                    244: .It d
1.1       nicm      245: Detach current client.
1.6       jmc       246: .It l
                    247: Move to last (previously selected) window in the current session.
                    248: .It n
1.1       nicm      249: Change to next window in the current session.
1.6       jmc       250: .It p
1.1       nicm      251: Change to previous window in the current session.
1.6       jmc       252: .It t
1.1       nicm      253: Display a large clock.
1.6       jmc       254: .It \&?
1.1       nicm      255: List current key bindings.
                    256: .El
                    257: .Pp
                    258: A complete list may be obtained with the
                    259: .Ic list-keys
                    260: command (bound to
                    261: .Ql \&?
                    262: by default).
                    263: Key bindings may be changed with the
                    264: .Ic bind-key
                    265: and
                    266: .Ic unbind-key
                    267: commands.
                    268: .Sh HISTORY
                    269: .Nm
                    270: maintains a configurable history buffer for each window.
1.6       jmc       271: By default, up to 2000 lines are kept; this can be altered with the
1.1       nicm      272: .Ic history-limit
                    273: option (see the
                    274: .Ic set-option
                    275: command below).
                    276: .Sh MODES
                    277: A
                    278: .Nm
                    279: window may be in one of several modes.
                    280: The default permits direct access to the terminal attached to the window.
                    281: The others are:
                    282: .Bl -tag -width Ds
                    283: .It Em output mode
                    284: This is entered when a command which produces output, such as
                    285: .Ic list-keys ,
                    286: is executed from a key binding.
                    287: .It Em scroll mode
                    288: This is entered with the
                    289: .Ic scroll-mode
                    290: command (bound to
                    291: .Ql =
                    292: by default) and permits the window history buffer to be inspected.
                    293: .It Em copy mode
                    294: This permits a section of a window or its history to be copied to a
                    295: .Em paste buffer
                    296: for later insertion into another window.
                    297: This mode is entered with the
                    298: .Ic copy-mode
                    299: command, bound to
                    300: .Ql [
                    301: by default.
                    302: .El
                    303: .Pp
1.6       jmc       304: The keys available depend on whether emacs or vi mode is selected
                    305: (see the
1.1       nicm      306: .Ic mode-keys
                    307: option).
                    308: The following keys are supported as appropriate for the mode:
                    309: .Bl -column "FunctionXXXXXXXXXXXX" "viXXXXXX" "emacs" -offset indent
                    310: .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
                    311: .It Li "Start of line" Ta "0 or ^" Ta "C-a"
                    312: .It Li "Clear selection" Ta "Escape" Ta "C-g"
                    313: .It Li "Copy selection" Ta "Enter" Ta "M-w"
                    314: .It Li "Cursor down" Ta "j" Ta "Down"
                    315: .It Li "End of line" Ta "$" Ta "C-e"
                    316: .It Li "Cursor left" Ta "h" Ta "Left"
                    317: .It Li "Next page" Ta "C-f" Ta "Page down"
                    318: .It Li "Next word" Ta "w" Ta "M-f"
                    319: .It Li "Previous page" Ta "C-u" Ta "Page up"
                    320: .It Li "Previous word" Ta "b" Ta "M-b"
                    321: .It Li "Quit mode" Ta "q" Ta "Escape"
                    322: .It Li "Cursor right" Ta "l" Ta "Right"
                    323: .It Li "Start selection" Ta "Space" Ta "C-Space"
                    324: .It Li "Cursor up" Ta "k" Ta "Up"
1.2       nicm      325: .It Li "Paste buffer" Ta "p" Ta "C-y"
1.1       nicm      326: .El
                    327: .Pp
1.2       nicm      328: The paste buffer key pastes the first line from the top paste buffer on the
                    329: stack.
1.1       nicm      330: .Sh BUFFERS
                    331: .Nm
                    332: maintains a stack of
                    333: .Em paste buffers
                    334: for each session.
                    335: Up to the value of the
                    336: .Ic buffer-limit
                    337: option are kept; when a new buffer is added, the buffer at the bottom of the
                    338: stack is removed.
                    339: Buffers may be added using
                    340: .Ic copy-mode
                    341: or the
                    342: .Ic set-buffer
                    343: command, and pasted into a window using the
                    344: .Ic paste-buffer
                    345: command.
                    346: .Sh PANES AND LAYOUTS
                    347: Each window displayed by
                    348: .Nm
                    349: may be split into one or more
                    350: .Em panes ;
                    351: each pane takes up a certain area of the display and is a separate terminal.
                    352: A window may be split into panes using the
                    353: .Ic split-window
                    354: command.
                    355: .Pp
                    356: Panes are numbered beginning from zero; in horizontal layouts zero is the
                    357: leftmost pane and in vertical the topmost.
                    358: .Pp
                    359: Panes may be arranged using several layouts.
                    360: The layout may be cycled with the
                    361: .Ic next-layout
                    362: command (bound to
                    363: .Ql C-space
                    364: by default), the current pane may be changed with the
                    365: .Ic up-pane
                    366: and
                    367: .Ic down-pane
                    368: commands and the
                    369: .Ic rotate-window
                    370: and
                    371: .Ic swap-pane
                    372: commands may be used to swap panes without changing the window layout.
                    373: .Pp
                    374: The following layouts are supported:
                    375: .Bl -tag -width Ds
                    376: .It Ic active-only
1.6       jmc       377: Only the active pane is shown \(en all other panes are hidden.
1.1       nicm      378: .It Ic even-horizontal
                    379: Panes are spread out evenly from left to right across the window.
                    380: .It Ic even-vertical
                    381: Panes are spread evenly from top to bottom.
1.2       nicm      382: .It Ic main-horizontal
                    383: A large (main) pane is shown at the top of the window and the remaining panes are
1.6       jmc       384: spread from left to right in the leftover space at the bottom.
1.2       nicm      385: Use the
                    386: .Em main-pane-height
                    387: window option to specify the height of the top pane.
1.1       nicm      388: .It Ic main-vertical
1.2       nicm      389: Similar to
                    390: .Ic main-horizontal
                    391: but the large pane is placed on the left and the others spread from top to
                    392: bottom along the right.
                    393: See the
                    394: .Em main-pane-width
                    395: window option.
1.6       jmc       396: .It Ic manual
                    397: Manual layout splits windows vertically (running across); only with this layout
                    398: may panes be resized using the
                    399: .Ic resize-pane
                    400: command.
1.1       nicm      401: .El
1.8       nicm      402: .Sh STATUS LINE
                    403: .Nm
                    404: includes an optional status line which is displayed in the bottom line of each
                    405: terminal.
                    406: By default, the status line is enabled (it may be disabled with the
                    407: .Ic status
                    408: session option) and contains, from left-to-right: the name of the current
                    409: session in square brackets; the window list; the current window title in double
                    410: quotes; and the time and date.
                    411: .Pp
                    412: The status line is made of three parts: configurable left and right sections
                    413: (which may contain dynamic content such as the time or output from a shell
                    414: command, see the
                    415: .Ic status-left ,
                    416: .Ic status-left-length ,
                    417: .Ic status-right ,
                    418: and
                    419: .Ic status-right-length
                    420: options below), and a central window list.
                    421: The window list shows the index, name and (if any) flag of the windows
                    422: present in the current session in ascending numerical order.
                    423: The flag is one of the following symbols appended to the window name:
                    424: .Bl -column "Symbol" "Meaning" -offset indent
                    425: .It Sy "Symbol" Ta Sy "Meaning"
                    426: .It Li "*" Ta "Denotes the current window."
                    427: .It Li "-" Ta "Marks the last window (previously selected)."
                    428: .It Li "#" Ta "Window is monitored and activity has been detected."
                    429: .It Li "!" Ta "A bell has occurred in the window."
                    430: .It Li "+" Ta "Window is monitored for content and it has appeared."
                    431: .El
                    432: .Pp
                    433: The # symbol relates to the
                    434: .Ic monitor-activity
                    435: and + to the
                    436: .Ic monitor-content
                    437: window options.
                    438: The window name is printed in inverted colours if an alert (bell, activity or
                    439: content) is present.
                    440: .Pp
                    441: The colour and attributes of the status line may be configured, the entire status line using
                    442: the
                    443: .Ic status-attr ,
                    444: .Ic status-fg
                    445: and
                    446: .Ic status-bg
                    447: session options and individual windows using the
                    448: .Ic window-status-attr ,
                    449: .Ic window-status-fg
                    450: and
                    451: .Ic window-status-bg
                    452: window options.
                    453: .Pp
                    454: The status line is automatically refreshed at interval if it has changed, the interval may be
                    455: controlled with the
                    456: .Ic status-interval
                    457: session option.
1.1       nicm      458: .Sh COMMANDS
                    459: This section contains a list of the commands supported by
                    460: .Nm .
                    461: Most commands accept the optional
                    462: .Fl t
                    463: argument with one of
                    464: .Ar target-client ,
                    465: .Ar target-session
                    466: or
                    467: .Ar target-window .
                    468: These specify the client, session or window which a command should affect.
                    469: .Ar target-client
                    470: is the name of the
                    471: .Xr pty 4
                    472: file to which the client is connected, for example
                    473: .Pa /dev/ttyp1 .
                    474: Clients may be listed with the
                    475: .Ic list-clients
                    476: command.
                    477: .Pp
                    478: .Ar target-session
                    479: is either the name of a session (as listed by the
                    480: .Ic list-sessions
1.6       jmc       481: command) or the name of a client,
1.1       nicm      482: .Ar target-client ,
1.6       jmc       483: in which case the session attached to the client is used.
1.1       nicm      484: An
                    485: .Xr fnmatch 3
                    486: pattern may be used to match the session name.
                    487: If a session is omitted when required,
                    488: .Nm tmux
                    489: attempts to use the current session; if no current session is available, the
                    490: most recently created is chosen.
                    491: If no client is specified, the current client is chosen, if possible, or an
                    492: error is reported.
                    493: .Pp
                    494: .Ar target-window
                    495: specifies a window in the form
                    496: .Em session Ns \&: Ns Em index ,
                    497: for example mysession:1.
                    498: The session is in the same form as for
                    499: .Ar target-session .
                    500: .Em session ,
                    501: .Em index
                    502: or both may be omitted.
                    503: If
                    504: .Em session
                    505: is omitted, the same rules as for
                    506: .Ar target-session
                    507: are followed; if
                    508: .Em index
                    509: is not present, the current window for the given session is used.
1.6       jmc       510: When the argument does not contain a colon,
1.1       nicm      511: .Nm
                    512: first attempts to parse it as window index; if that fails, an attempt is made
                    513: to match a session or client name.
                    514: .Pp
                    515: Multiple commands may be specified together as part of a
                    516: .Em command sequence .
1.6       jmc       517: Each command should be separated by spaces and a semicolon;
1.1       nicm      518: commands are executed sequentially from left to right.
                    519: A literal semicolon may be included by escaping it with a backslash (for
                    520: example, when specifying a command sequence to
                    521: .Ic bind-key ) .
                    522: .Pp
                    523: Examples include:
                    524: .Bd -literal -offset indent
                    525: refresh-client -t/dev/ttyp2
                    526:
                    527: rename-session -tfirst newname
                    528:
                    529: set-window-option -t:0 monitor-activity on
                    530:
                    531: new-window ; split-window -d
                    532:
                    533: bind-key D detach-client \e\; lock-server
                    534: .Ed
                    535: .Pp
                    536: The following commands are available:
                    537: .Bl -tag -width Ds
                    538: .It Xo Ic attach-session
                    539: .Op Fl d
                    540: .Op Fl t Ar target-session
                    541: .Xc
                    542: .D1 (alias: Ic attach )
                    543: Create a new client in the current terminal and attach it to a session.
                    544: If
                    545: .Fl d
                    546: is specified, any other clients attached to the session are detached.
                    547: .Pp
                    548: If no server is started,
                    549: .Ic attach-session
                    550: will attempt to start it; this will fail unless sessions are created in the
                    551: configuration file.
                    552: .It Xo Ic bind-key
                    553: .Op Fl r
                    554: .Ar key Ar command Op Ar arguments
                    555: .Xc
                    556: .D1 (alias: Ic bind )
                    557: Bind key
                    558: .Ar key
                    559: to
                    560: .Ar command .
                    561: Keys may be specified prefixed with
                    562: .Ql C-
                    563: or
                    564: .Ql ^
1.6       jmc       565: for Ctrl keys, or
1.1       nicm      566: .Ql M-
1.6       jmc       567: for Alt (meta) keys.
1.1       nicm      568: The
                    569: .Fl r
                    570: flag indicates this key may repeat, see the
                    571: .Ic repeat-time
                    572: option.
                    573: .It Xo Ic break-pane
                    574: .Op Fl d
                    575: .Op Fl p Ar pane-index
                    576: .Op Fl t Ar target-window
                    577: .Xc
                    578: .D1 (alias: Ic breakp)
                    579: Break the current pane off from its containing window to make it the only pane
                    580: in a new window.
                    581: If
                    582: .Fl d
                    583: is given, the new window does not become the current window.
                    584: .It Xo Ic choose-session
                    585: .Op Fl t Ar target-window
                    586: .Xc
                    587: Put a window into session choice mode, where the session for the current
                    588: client may be selected interactively from a list.
                    589: This command works only from inside
                    590: .Nm .
                    591: .It Xo Ic choose-window
                    592: .Op Fl t Ar target-window
                    593: .Xc
                    594: Put a window into window choice mode, where the window for the session
                    595: attached to the current client may be selected interactively from a list.
                    596: This command works only from inside
                    597: .Nm .
1.2       nicm      598: .It Xo Ic clear-history
                    599: .Op Fl p Ar pane-index
                    600: .Op Fl t Ar target-window
                    601: .Xc
                    602: .D1 (alias: Ic clearhist)
                    603: Remove and free the history for the specified pane.
1.1       nicm      604: .It Xo Ic clock-mode
                    605: .Op Fl t Ar target-window
                    606: .Xc
                    607: Display a large clock.
                    608: .It Xo Ic command-prompt
                    609: .Op Fl t Ar target-client
                    610: .Op Ar template
                    611: .Xc
                    612: Open the command prompt in a client.
                    613: This may be used from inside
                    614: .Nm
                    615: to execute commands interactively.
                    616: If
                    617: .Ar template
                    618: is specified, it is used as the command; any %% in the template will be
                    619: replaced by what is entered at the prompt.
                    620: .It Xo Ic confirm-before
                    621: .Op Fl t Ar target-client
                    622: .Ar command
                    623: .Xc
                    624: .D1 (alias: Ic confirm)
                    625: Ask for confirmation before executing
                    626: .Ar command .
                    627: This command works only from inside
                    628: .Nm .
                    629: .It Xo Ic copy-buffer
                    630: .Op Fl a Ar src-index
                    631: .Op Fl b Ar dst-index
                    632: .Op Fl s Ar src-session
                    633: .Op Fl t Ar dst-session
                    634: .Xc
                    635: .D1 (alias: Ic copyb)
                    636: Copy a session paste buffer to another session.
                    637: If no sessions are specified, the current one is used instead.
                    638: .It Xo Ic copy-mode
                    639: .Op Fl u
                    640: .Op Fl t Ar target-window
                    641: .Xc
                    642: Enter copy mode.
                    643: The
                    644: .Fl u
                    645: option scrolls one page up.
                    646: .It Xo Ic delete-buffer
                    647: .Op Fl b Ar buffer-index
                    648: .Op Fl t Ar target-session
                    649: .Xc
                    650: .D1 (alias: Ic deleteb )
                    651: Delete the buffer at
                    652: .Ar buffer-index ,
                    653: or the top buffer if not specified.
                    654: .It Xo Ic detach-client
                    655: .Op Fl t Ar target-client
                    656: .Xc
                    657: .D1 (alias: Ic detach )
                    658: Detach the current client if bound to a key, or the specified client with
                    659: .Fl t .
                    660: .It Xo Ic down-pane
                    661: .Op Fl p Ar pane-index
                    662: .Op Fl t Ar target-window
                    663: .Xc
                    664: .D1 (alias: Ic downp )
                    665: Move down a pane.
                    666: .It Xo Ic find-window
                    667: .Op Fl t Ar target-window
                    668: .Ar match-string
                    669: .Xc
                    670: .D1 (alias: Ic findw )
                    671: Search for
                    672: .Ar match-string
                    673: in window names, titles, and visible content (but not history).
                    674: If only one window is matched, it'll be automatically selected, otherwise a
                    675: choice list is shown.
                    676: This command only works from inside
                    677: .Nm .
                    678: .It Xo Ic has-session
                    679: .Op Fl t Ar target-session
                    680: .Xc
                    681: .D1 (alias: Ic has )
                    682: Report an error and exit with 1 if the specified session does not exist.
                    683: If it does exist, exit with 0.
                    684: .It Xo Ic kill-pane
                    685: .Op Fl p Ar pane-index
                    686: .Op Fl t Ar target-window
                    687: .Xc
                    688: .D1 (alias: Ic killp )
                    689: Destroy the given pane.
                    690: .It Xo Ic kill-server
                    691: .Xc
                    692: Kill the
                    693: .Nm
                    694: server and clients and destroy all sessions.
                    695: .It Xo Ic kill-session
                    696: .Op Fl t Ar target-session
                    697: .Xc
                    698: Destroy the given session, closing any windows linked to it and no other
                    699: sessions, and detaching all clients attached to it.
                    700: .It Xo Ic kill-window
                    701: .Op Fl t Ar target-window
                    702: .Xc
                    703: .D1 (alias: Ic killw )
                    704: Kill the current window or the window at
                    705: .Ar target-window ,
                    706: removing it from any sessions to which it is linked.
                    707: .It Xo Ic last-window
                    708: .Op Fl t Ar target-session
                    709: .Xc
                    710: .D1 (alias: Ic last )
                    711: Select the last (previously selected) window.
                    712: If no
                    713: .Ar target-session
                    714: is specified, select the last window of the current session.
                    715: .It Xo Ic link-window
                    716: .Op Fl dk
                    717: .Op Fl s Ar src-window
                    718: .Op Fl t Ar dst-window
                    719: .Xc
                    720: .D1 (alias: Ic linkw )
                    721: Link the window at
                    722: .Ar src-window
                    723: to the specified
                    724: .Ar dst-window .
                    725: If
                    726: .Ar dst-window
                    727: is specified and no such window exists, the
                    728: .Ar src-window
                    729: is linked there.
                    730: If
                    731: .Fl k
                    732: is given and
                    733: .Ar dst-window
                    734: exists, it is killed, otherwise an error is generated.
                    735: If
                    736: .Fl d
                    737: is given, the newly linked window is not selected.
                    738: .It Xo Ic list-buffers
                    739: .Op Fl t Ar target-session
                    740: .Xc
                    741: .D1 (alias: Ic lsb )
                    742: List the buffers in the given session.
                    743: .It Xo Ic list-clients
                    744: .Xc
                    745: .D1 (alias: Ic lsc )
                    746: List all clients attached to the server.
                    747: .It Xo Ic list-commands
                    748: .Xc
                    749: .D1 (alias: Ic lscm )
                    750: List the syntax of all commands supported by
                    751: .Nm .
                    752: .It Xo Ic list-keys
                    753: .Xc
                    754: .D1 (alias: Ic lsk )
                    755: List all key bindings.
                    756: .It Xo Ic list-sessions
                    757: .Xc
                    758: .D1 (alias: Ic ls )
                    759: List all sessions managed by the server.
                    760: .It Xo Ic list-windows
                    761: .Op Fl t Ar target-session
                    762: .Xc
                    763: .D1 (alias: Ic lsw )
                    764: List windows in the current session or in
                    765: .Ar target-session .
                    766: .It Xo Ic load-buffer
                    767: .Op Fl b Ar buffer-index
                    768: .Op Fl t Ar target-session
                    769: .Ar path
                    770: .Xc
                    771: .D1 (alias: Ic loadb )
                    772: Load the contents of the specified paste buffer from
                    773: .Ar path .
                    774: .It Xo Ic lock-server
                    775: .Xc
                    776: .D1 (alias: Ic lock )
                    777: Lock the server until a password is entered.
                    778: .It Xo Ic move-window
                    779: .Op Fl d
                    780: .Op Fl s Ar src-window
                    781: .Op Fl t Ar dst-window
                    782: .Xc
                    783: .D1 (alias: Ic movew )
                    784: This is similar to
                    785: .Ic link-window ,
                    786: except the window at
                    787: .Ar src-window
                    788: is moved to
                    789: .Ar dst-window .
                    790: .It Xo Ic new-session
                    791: .Op Fl d
                    792: .Op Fl n Ar window-name
                    793: .Op Fl s Ar session-name
                    794: .Op Ar command
                    795: .Xc
                    796: .D1 (alias: Ic new )
                    797: Create a new session with name
                    798: .Ar session-name .
                    799: The new session is attached to the current terminal unless
                    800: .Fl d
                    801: is given.
                    802: .Ar window-name
                    803: and
                    804: .Ar command
                    805: are the name of and command to execute in the initial window.
                    806: .It Xo Ic new-window
                    807: .Op Fl d
                    808: .Op Fl n Ar window-name
                    809: .Op Fl t Ar target-window
                    810: .Op Ar command
                    811: .Xc
                    812: .D1 (alias: Ic neww )
                    813: Create a new window.
                    814: If
                    815: .Fl d
                    816: is given, the session does not make the new window the current window.
                    817: .Ar target-window
                    818: represents the window to be created.
                    819: .Ar command
                    820: is the command to execute.
                    821: If
                    822: .Ar command
                    823: is not specified, the default command is used.
                    824: .Pp
                    825: The
                    826: .Ev TERM
                    827: environment variable must be set to
                    828: .Dq screen
                    829: for all programs running
                    830: .Em inside
                    831: .Nm .
                    832: New windows will automatically have
                    833: .Dq TERM=screen
                    834: added to their environment, but care must be taken not to reset this in shell
                    835: start-up files.
                    836: .It Xo Ic next-layout
                    837: .Op Fl t Ar target-window
                    838: .Xc
                    839: .D1 (alias: Ic nextl )
                    840: Move a window to the next layout and rearrange the panes to fit.
                    841: .It Xo Ic next-window
1.9       nicm      842: .Op Fl a
1.1       nicm      843: .Op Fl t Ar target-session
                    844: .Xc
                    845: .D1 (alias: Ic next )
                    846: Move to the next window in the session.
1.9       nicm      847: If
1.12      jmc       848: .Fl a
1.9       nicm      849: is used, move to the next window with a bell, activity or content alert.
1.1       nicm      850: .It Xo Ic paste-buffer
                    851: .Op Fl d
                    852: .Op Fl b Ar buffer-index
                    853: .Op Fl t Ar target-window
                    854: .Xc
                    855: .D1 (alias: Ic pasteb )
                    856: Insert the contents of a paste buffer into the current window.
                    857: .It Xo Ic previous-window
1.9       nicm      858: .Op Fl a
1.1       nicm      859: .Op Fl t Ar target-session
                    860: .Xc
                    861: .D1 (alias: Ic prev )
                    862: Move to the previous window in the session.
1.9       nicm      863: With
                    864: .Fl a ,
                    865: move to the previous window with a bell, activity or content alert.
1.1       nicm      866: .It Xo Ic refresh-client
                    867: .Op Fl t Ar target-client
                    868: .Xc
                    869: .D1 (alias: Ic refresh )
                    870: Refresh the current client if bound to a key, or a single client if one is given
                    871: with
                    872: .Fl t .
                    873: .It Xo Ic rename-session
                    874: .Op Fl t Ar target-session
                    875: .Ar new-name
                    876: .Xc
                    877: .D1 (alias: Ic rename )
                    878: Rename the session to
                    879: .Ar new-name .
                    880: .It Xo Ic rename-window
                    881: .Op Fl t Ar target-window
                    882: .Ar new-name
                    883: .Xc
                    884: .D1 (alias: Ic renamew )
                    885: Rename the current window, or the window at
                    886: .Ar target-window
                    887: if specified, to
                    888: .Ar new-name .
                    889: .It Xo Ic resize-pane
                    890: .Op Fl DU
                    891: .Op Fl p Ar pane-index
                    892: .Op Fl t Ar target-window
                    893: .Op Ar adjustment
                    894: .Xc
                    895: .D1 (alias: Ic resizep )
                    896: Resize a pane, upward with
                    897: .Fl U
                    898: (the default) or downward with
                    899: .Fl D .
                    900: The
                    901: .Ar adjustment
                    902: is given in lines (the default is 1).
                    903: .It Xo Ic respawn-window
                    904: .Op Fl k
                    905: .Op Fl t Ar target-window
                    906: .Op Ar command
                    907: .Xc
                    908: .D1 (alias: Ic respawnw )
                    909: Reactive a window in which the command has exited (see the
                    910: .Ic remain-on-exit
                    911: window option).
                    912: If
                    913: .Ar command
                    914: is not given, the command used when the window was created is executed.
                    915: The window must be already inactive, unless
                    916: .Fl k
                    917: is given, in which case any existing command is killed.
                    918: .It Xo Ic rotate-window
                    919: .Op Fl DU
                    920: .Op Fl t Ar target-window
                    921: .Xc
                    922: .D1 (alias: Ic rotatew )
                    923: Rotate the positions of the panes within a window, either upward (numerically
                    924: lower) with
                    925: .Fl U
                    926: or downward (numerically higher).
                    927: .It Xo Ic save-buffer
                    928: .Op Fl a
                    929: .Op Fl b Ar buffer-index
                    930: .Op Fl t Ar target-session
                    931: .Ar path
                    932: .Xc
                    933: .D1 (alias: Ic saveb )
                    934: Save the contents of the specified paste buffer to
                    935: .Ar path .
                    936: The
                    937: .Fl a
                    938: option appends to rather than overwriting the file.
                    939: .It Xo Ic scroll-mode
                    940: .Op Fl u
                    941: .Op Fl t Ar target-window
                    942: .Xc
                    943: Enter scroll mode.
                    944: The
                    945: .Fl u
                    946: has the same meaning as in the
                    947: .Ic copy-mode
                    948: command.
1.2       nicm      949: .It Xo Ic select-layout
                    950: .Op Fl t Ar target-window
                    951: .Ar layout-name
                    952: .Xc
                    953: .D1 (alias: selectl)
                    954: Choose a specific layout for a window.
1.1       nicm      955: .It Xo Ic select-pane
                    956: .Op Fl p Ar pane-index
                    957: .Op Fl t Ar target-window
                    958: .Xc
                    959: .D1 (alias: Ic selectp )
                    960: Make pane
                    961: .Ar pane-index
                    962: the active pane in window
                    963: .Ar target-window .
                    964: .It Xo Ic select-prompt
                    965: .Op Fl t Ar target-client
                    966: .Xc
                    967: Open a prompt inside
                    968: .Ar target-client
                    969: allowing a window index to be entered interactively.
                    970: .It Xo Ic select-window
                    971: .Op Fl t Ar target-window
                    972: .Xc
                    973: .D1 (alias: Ic selectw )
                    974: Select the window at
                    975: .Ar target-window .
                    976: .It Xo Ic send-keys
                    977: .Op Fl t Ar target-window
                    978: .Ar key Ar ...
                    979: .Xc
                    980: .D1 (alias: Ic send )
                    981: Send a key or keys to a window.
                    982: Each argument
                    983: .Ar key
                    984: is the name of the key (such as
                    985: .Ql C-a
                    986: or
                    987: .Ql npage
                    988: ) to send; if the string is not recognised as a key, it is sent as a series of
                    989: characters.
                    990: All arguments are sent sequentially from first to last.
                    991: .It Xo Ic send-prefix
                    992: .Op Fl t Ar target-window
                    993: .Xc
                    994: Send the prefix key to a window as if it was pressed.
                    995: .It Xo Ic server-info
                    996: .Xc
                    997: .D1 (alias: Ic info )
                    998: Show server information and terminal details.
                    999: .It Xo Ic set-buffer
                   1000: .Op Fl b Ar buffer-index
                   1001: .Op Fl t Ar target-session
                   1002: .Ar data
                   1003: .Xc
                   1004: .D1 (alias: Ic setb )
                   1005: Set the contents of the specified buffer to
                   1006: .Ar data .
                   1007: .It Xo Ic set-option
                   1008: .Op Fl gu
                   1009: .Op Fl t Ar target-session
                   1010: .Ar option Ar value
                   1011: .Xc
                   1012: .D1 (alias: Ic set )
                   1013: Set an option.
                   1014: If
                   1015: .Fl g
                   1016: is specified, the option is set as a global option.
                   1017: Global options apply to all sessions which don't have the option explicitly
                   1018: set.
                   1019: If
                   1020: .Fl g
                   1021: is not used, the option applies only to
                   1022: .Ar target-session .
                   1023: The
                   1024: .Fl u
                   1025: flag unsets an option, so a session inherits the option from the global
                   1026: options - it is not possible to unset a global option.
                   1027: .Pp
                   1028: Possible options are:
                   1029: .Bl -tag -width Ds
                   1030: .It Xo Ic bell-action
                   1031: .Op Ic any | Ic none | Ic current
                   1032: .Xc
                   1033: Set action on window bell.
                   1034: .Ic any
                   1035: means a bell in any window linked to a session causes a bell in the current
                   1036: window of that session,
                   1037: .Ic none
                   1038: means all bells are ignored and
                   1039: .Ic current
                   1040: means only bell in windows other than the current window are ignored.
                   1041: .It Ic buffer-limit Ar number
                   1042: Set the number of buffers kept for each session; as new buffers are added to
                   1043: the top of the stack, old ones are removed from the bottom if necessary to
                   1044: maintain this maximum length.
                   1045: .It Ic default-command Ar command
                   1046: Set the command used for new windows (if not specified when the window is
                   1047: created) to
                   1048: .Ar command .
                   1049: The default is
1.3       pyr      1050: .Dq exec $SHELL -l .
1.1       nicm     1051: .It Ic default-path Ar path
                   1052: Set the default working directory for processes created from keys, or
                   1053: interactively from the prompt.
                   1054: The default is the current working directory when the server is started.
                   1055: .It Ic history-limit Ar lines
                   1056: Set the maximum number of lines held in window history.
                   1057: This setting applies only to new windows - existing window histories are not
                   1058: resized and retain the limit at the point they were created.
                   1059: .It Ic lock-after-time Ar number
                   1060: Lock the server after
                   1061: .Ar number
                   1062: seconds of inactivity.
                   1063: The default is off (set to 0).
                   1064: This has no effect as a session option; it must be set as a global option using
                   1065: .Fl g .
                   1066: .It Ic message-attr Ar attributes
                   1067: Set status line message attributes, where
                   1068: .Ar attributes
                   1069: is either
                   1070: .Ic default
                   1071: or a comma-delimited list of one or more of:
                   1072: .Ic bright
                   1073: (or
                   1074: .Ic bold ) ,
                   1075: .Ic dim ,
                   1076: .Ic underscore ,
                   1077: .Ic blink ,
                   1078: .Ic reverse ,
                   1079: .Ic hidden ,
                   1080: or
                   1081: .Ic italics .
                   1082: .It Ic message-bg Ar colour
                   1083: Set status line message background colour, where
                   1084: .Ar colour
                   1085: is one of:
                   1086: .Ic black ,
                   1087: .Ic red ,
                   1088: .Ic green ,
                   1089: .Ic yellow ,
                   1090: .Ic blue ,
                   1091: .Ic magenta ,
                   1092: .Ic cyan ,
                   1093: .Ic white
                   1094: or
                   1095: .Ic default .
                   1096: .It Ic message-fg Ar colour
                   1097: Set status line message foreground colour.
                   1098: .It Ic prefix Ar key
                   1099: Set the current prefix key.
                   1100: .It Ic repeat-time Ar number
                   1101: Allow multiple commands to be entered without pressing the prefix-key again
                   1102: in the specified
                   1103: .Ar number
                   1104: milliseconds (the default is 500).
                   1105: Whether a key repeats may be set when it is bound using the
                   1106: .Fl r
                   1107: flag to
                   1108: .Ic bind-key .
                   1109: Repeat is enabled for the default keys of the
                   1110: .Ic up-pane ,
                   1111: .Ic down-pane ,
                   1112: .Ic resize-pane-up ,
                   1113: and
                   1114: .Ic resize-pane-down
                   1115: commands.
                   1116: .It Xo Ic set-remain-on-exit
                   1117: .Op Ic on | Ic off
                   1118: .Xc
                   1119: Set the
                   1120: .Ic remain-on-exit
                   1121: window option for any windows first created in this session.
                   1122: .It Xo Ic set-titles
                   1123: .Op Ic on | Ic off
                   1124: .Xc
                   1125: Attempt to set the window title using the \ee]2;...\e007 xterm code and
                   1126: the terminal appears to be an xterm.
1.11      nicm     1127: This option is off by default.
1.6       jmc      1128: Note that elinks
1.1       nicm     1129: will only attempt to set the window title if the STY environment
                   1130: variable is set.
                   1131: .It Xo Ic status
                   1132: .Op Ic on | Ic off
                   1133: .Xc
                   1134: Show or hide the status line.
                   1135: .It Ic status-attr Ar attributes
                   1136: Set status line attributes.
                   1137: .It Ic status-bg Ar colour
                   1138: Set status line background colour.
                   1139: .It Ic status-fg Ar colour
                   1140: Set status line foreground colour.
                   1141: .It Ic status-interval Ar interval
                   1142: Update the status bar every
                   1143: .Ar interval
                   1144: seconds.
                   1145: By default, updates will occur every 15 seconds.
                   1146: A setting of zero disables redrawing at interval.
                   1147: .It Xo Ic status-keys
                   1148: .Op Ic vi | Ic emacs
                   1149: .Xc
1.6       jmc      1150: Use vi or emacs-style
1.1       nicm     1151: key bindings in the status line, for example at the command prompt.
                   1152: Defaults to emacs.
                   1153: .It Ic status-left Ar string
                   1154: Display
                   1155: .Ar string
                   1156: to the left of the status bar.
                   1157: .Ar string
                   1158: will be passed through
                   1159: .Xr strftime 3
                   1160: before being used.
                   1161: By default, the session name is shown.
                   1162: .Ar string
                   1163: may contain any of the following special character pairs:
                   1164: .Bl -column "Character pair" "Replaced with" -offset indent
                   1165: .It Sy "Character pair" Ta Sy "Replaced with"
                   1166: .It Li "#(command)" Ta "First line of command's output"
                   1167: .It Li "#H" Ta "Hostname of local host"
                   1168: .It Li "#S" Ta "Session name"
                   1169: .It Li "#T" Ta "Current window title"
                   1170: .It Li "##" Ta "A literal" Ql #
                   1171: .El
                   1172: .Pp
                   1173: Where appropriate, these may be prefixed with a number to specify the maximum
                   1174: length, for example
                   1175: .Ql #24T .
1.10      nicm     1176: .Pp
1.12      jmc      1177: By default, UTF-8 in
1.10      nicm     1178: .Ar string
                   1179: is not interpreted, to enable UTF-8, use the
                   1180: .Ic status-utf8
                   1181: option.
1.1       nicm     1182: .It Ic status-left-length Ar length
                   1183: Set the maximum
                   1184: .Ar length
                   1185: of the left component of the status bar.
                   1186: The default is 10.
                   1187: .It Ic status-right Ar string
                   1188: Display
                   1189: .Ar string
                   1190: to the right of the status bar.
                   1191: By default, the date and time will be shown.
                   1192: As with
                   1193: .Ic status-left ,
                   1194: .Ar string
                   1195: will be passed to
1.10      nicm     1196: .Xr strftime 3 ,
                   1197: character pairs are replaced, and UTF-8 is dependent on the
                   1198: .Ic status-utf8
                   1199: option.
1.1       nicm     1200: .It Ic status-right-length Ar length
                   1201: Set the maximum
                   1202: .Ar length
                   1203: of the right component of the status bar.
                   1204: The default is 40.
1.10      nicm     1205: .Pp
                   1206: .It Xo Ic status-utf8
                   1207: .Op Ic on | Ic off
                   1208: .Xc
                   1209: Instruct
                   1210: .Nm
                   1211: to treat top-bit-set characters in the
                   1212: .Ic status-left
                   1213: and
                   1214: .Ic status-right
                   1215: strings as UTF-8; notably, this is important for wide characters.
                   1216: This option defaults to off.
1.1       nicm     1217: .El
                   1218: .It Xo Ic set-password
                   1219: .Op Fl c
                   1220: .Ar password
                   1221: .Xc
                   1222: .D1 (alias: Ic pass )
                   1223: Set the server password.
                   1224: If the
                   1225: .Fl c
                   1226: option is given, a pre-encrypted password may be specified.
                   1227: By default, the password is blank, thus any entered password will be accepted
                   1228: when unlocking the server (see the
                   1229: .Ic lock-server
                   1230: command).
                   1231: To prevent variable expansion when an encrypted password is read from a
                   1232: configuration file, enclose it in single quotes (').
                   1233: .It Xo Ic set-window-option
                   1234: .Op Fl gu
                   1235: .Op Fl t Ar target-window
                   1236: .Ar option Ar value
                   1237: .Xc
                   1238: .D1 (alias: Ic setw )
                   1239: Set a window-specific option.
                   1240: The
                   1241: .Fl g
                   1242: and
                   1243: .Fl u
                   1244: flags work similarly to the
                   1245: .Ic set-option
                   1246: command.
                   1247: .Pp
                   1248: Supported options are:
                   1249: .Bl -tag -width Ds
                   1250: .It Xo Ic aggressive-resize
                   1251: .Op Ic on | Ic off
                   1252: .Xc
                   1253: Aggressively resize the chosen window.
                   1254: This means that
                   1255: .Nm
                   1256: will resize the window to the size of the smallest session for which it is the
                   1257: current window, rather than the smallest session to which it is attached.
                   1258: The window may resize when the current window is changed on another sessions;
1.6       jmc      1259: this option is good for full-screen programs which support
                   1260: .Dv SIGWINCH
                   1261: and poor for interactive programs such as shells.
1.1       nicm     1262: .It Xo Ic automatic-rename
                   1263: .Op Ic on | Ic off
                   1264: .Xc
                   1265: Control automatic window renaming.
                   1266: When this setting is enabled,
                   1267: .Nm
                   1268: will attempt - on supported platforms - to rename the window to reflect the
                   1269: command currently running in it.
                   1270: This flag is automatically disabled for an individual window when a name
                   1271: is specified at creation with
                   1272: .Ic new-window or
                   1273: .Ic new-session ,
                   1274: or later with
                   1275: .Ic rename-window .
                   1276: It may be switched off globally with:
                   1277: .Bd -literal -offset indent
                   1278: set-window-option -g automatic-rename off
                   1279: .Ed
                   1280: .It Ic clock-mode-colour Ar colour
                   1281: Set clock colour.
                   1282: .It Xo Ic clock-mode-style
                   1283: .Op Ic 12 | Ic 24
                   1284: .Xc
                   1285: Set clock hour format.
                   1286: .It Ic force-height Ar height
                   1287: .It Ic force-width Ar width
                   1288: Prevent
                   1289: .Nm
                   1290: from resizing a window to greater than
                   1291: .Ar width
                   1292: or
                   1293: .Ar height .
                   1294: A value of zero restores the default unlimited setting.
1.2       nicm     1295: .It Ic main-pane-width Ar width
                   1296: .It Ic main-pane-height Ar height
                   1297: Set the width or height of the main (left or top) pane in the
                   1298: .Ic main-horizontal
                   1299: or
                   1300: .Ic main-vertical
                   1301: layouts.
1.1       nicm     1302: .It Ic mode-attr Ar attributes
                   1303: Set window modes attributes.
                   1304: .It Ic mode-bg Ar colour
                   1305: Set window modes background colour.
                   1306: .It Ic mode-fg Ar colour
                   1307: Set window modes foreground colour.
                   1308: .It Xo Ic mode-keys
                   1309: .Op Ic vi | Ic emacs
                   1310: .Xc
1.6       jmc      1311: Use vi or emacs-style
1.1       nicm     1312: key bindings in scroll and copy modes.
                   1313: Key bindings default to emacs.
                   1314: .It Xo Ic monitor-activity
                   1315: .Op Ic on | Ic off
                   1316: .Xc
                   1317: Monitor for activity in the window.
                   1318: Windows with activity are highlighted in the status line.
                   1319: .It Xo Ic monitor-content Ar match-string
                   1320: .Xc
1.6       jmc      1321: Monitor content in the window.
                   1322: When
1.1       nicm     1323: .Ar match-string
                   1324: appears in the window, it is highlighted in the status line.
                   1325: .It Xo Ic remain-on-exit
                   1326: .Op Ic on | Ic off
                   1327: .Xc
                   1328: A window with this flag set is not destroyed when the program running in it
                   1329: exits.
                   1330: The window may be reactivated with the
                   1331: .Ic respawn-window
                   1332: command.
                   1333: .It Xo Ic utf8
                   1334: .Op Ic on | Ic off
                   1335: .Xc
                   1336: Instructs
                   1337: .Nm
                   1338: to expect UTF-8 sequences to appear in this window.
                   1339: .It Ic window-status-attr Ar attributes
                   1340: Set status line attributes for a single window.
                   1341: .It Ic window-status-bg Ar colour
                   1342: Set status line background colour for a single window.
                   1343: .It Ic window-status-fg Ar colour
                   1344: Set status line foreground colour for a single window.
                   1345: .It Xo Ic xterm-keys
                   1346: .Op Ic on | Ic off
                   1347: .Xc
                   1348: If this option is set,
                   1349: .Nm
                   1350: will generate
                   1351: .Xr xterm 1 -style
                   1352: function key sequences; these have a number included to indicate modifiers such
1.6       jmc      1353: as Shift, Alt or Ctrl.
1.1       nicm     1354: .El
                   1355: .It Xo Ic show-buffer
                   1356: .Op Fl b Ar buffer-index
                   1357: .Op Fl t Ar target-session
                   1358: .Xc
                   1359: .D1 (alias: Ic showb )
                   1360: Display the contents of the specified buffer.
                   1361: .It Xo Ic show-options
                   1362: .Op Fl t Ar target-session
                   1363: .Ar option Ar value
                   1364: .Xc
                   1365: .D1 (alias: Ic show )
                   1366: Show the currently set options.
                   1367: If a
                   1368: .Ar target-session
                   1369: is specified, the options for that session are shown; otherwise, the global
                   1370: options are listed.
                   1371: .It Xo Ic show-window-options
                   1372: .Op Fl t Ar target-window
                   1373: .Ar option Ar value
                   1374: .Xc
                   1375: .D1 (alias: Ic showw )
                   1376: List the current options for the given window.
                   1377: .It Xo Ic source-file
                   1378: .Ar path
                   1379: .Xc
                   1380: .D1 (alias: Ic source )
                   1381: Execute commands from
                   1382: .Ar path .
                   1383: .It Xo Ic split-window
                   1384: .Op Fl d
                   1385: .Oo Fl l
                   1386: .Ar lines |
                   1387: .Fl p Ar percentage Oc
                   1388: .Op Fl t Ar target-window
                   1389: .Op Ar command
                   1390: .Xc
                   1391: .D1 (alias: splitw )
                   1392: Creates a new window by splitting it vertically.
                   1393: The
                   1394: .Fl l
                   1395: and
                   1396: .Fl p
                   1397: options specify the size of the new window in lines, or as a percentage,
                   1398: respectively.
                   1399: All other options have the same meaning as in the
                   1400: .Ic new-window
                   1401: command.
                   1402: .Pp
                   1403: A few notes with regard to panes:
                   1404: .Bl -enum -compact
                   1405: .It
                   1406: If attempting to split a window with less than eight lines, an error will be
                   1407: shown.
                   1408: .It
                   1409: If the window is resized, as many panes are shown as can fit without reducing
                   1410: them below four lines.
                   1411: .It
                   1412: The minimum pane size is four lines (including the separator line).
                   1413: .It
                   1414: The panes are indexed from top (0) to bottom, with no numbers skipped.
                   1415: .El
                   1416: .It Xo Ic start-server
                   1417: .Xc
                   1418: .D1 (alias: Ic start )
                   1419: Start the
                   1420: .Nm
                   1421: server, if not already running, without creating any sessions.
                   1422: .It Xo Ic suspend-client
                   1423: .Op Fl c target-client
                   1424: .Xc
                   1425: .D1 (alias: Ic suspendc )
1.6       jmc      1426: Suspend a client by sending
                   1427: .Dv SIGTSTP
                   1428: (tty stop).
1.1       nicm     1429: .It Xo Ic swap-pane
                   1430: .Op Fl dDU
                   1431: .Op Fl p Ar src-index
                   1432: .Op Fl t Ar target-window
                   1433: .Op Fl q Ar dst-index
                   1434: .Xc
                   1435: .D1 (alias: Ic swapp )
                   1436: Swap two panes within a window.
                   1437: If
                   1438: .Fl U
                   1439: is used, the pane is swapped with the pane above (before it numerically);
                   1440: .Fl D
                   1441: swaps with the pane below (the next numerically); or
                   1442: .Ar dst-index
                   1443: may be give to swap with a specific pane.
                   1444: .It Xo Ic swap-window
                   1445: .Op Fl d
                   1446: .Op Fl s Ar src-window
                   1447: .Op Fl t Ar dst-window
                   1448: .Xc
                   1449: .D1 (alias: Ic swapw )
                   1450: This is similar to
                   1451: .Ic link-window ,
                   1452: except the source and destination windows are swapped.
                   1453: It is an error if no window exists at
                   1454: .Ar src-window .
                   1455: .It Xo Ic switch-client
                   1456: .Op Fl c Ar target-client Fl t Ar target-session
                   1457: .Xc
                   1458: .D1 (alias: Ic switchc )
                   1459: Switch the current session for client
                   1460: .Ar target-client
                   1461: to
                   1462: .Ar target-session .
                   1463: .It Xo Ic unbind-key
                   1464: .Ar key
                   1465: .Xc
                   1466: .D1 (alias: Ic unbind )
                   1467: Unbind the key bound to
                   1468: .Ar key .
                   1469: .It Xo Ic unlink-window
                   1470: .Op Fl t Ar target-window
                   1471: .Xc
                   1472: .D1 (alias: Ic unlinkw )
                   1473: Unlink
                   1474: .Ar target-window .
                   1475: A window may be unlinked only if it is linked to multiple sessions - windows may
                   1476: not be linked to no sessions.
                   1477: .It Xo Ic up-pane
                   1478: .Op Fl p Ar pane-index
                   1479: .Op Fl t Ar target-window
                   1480: .Xc
                   1481: .D1 (alias: Ic upp )
                   1482: Move up a pane.
                   1483: .El
                   1484: .Sh FILES
1.6       jmc      1485: .Bl -tag -width "~/.tmux.confXXX" -compact
1.1       nicm     1486: .It Pa ~/.tmux.conf
1.6       jmc      1487: Default
1.1       nicm     1488: .Nm
1.6       jmc      1489: configuration file.
1.1       nicm     1490: .El
                   1491: .Sh SEE ALSO
                   1492: .Xr pty 4
                   1493: .Sh AUTHORS
                   1494: .An Nicholas Marriott Aq nicm@users.sourceforge.net