Annotation of src/usr.bin/tmux/tmux.1, Revision 1.100
1.100 ! nicm 1: .\" $OpenBSD: tmux.1,v 1.99 2009/10/09 07:27:00 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.100 ! nicm 17: .Dd $Mdocdate: October 9 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 copy mode
478: This permits a section of a window or its history to be copied to a
479: .Em paste buffer
480: for later insertion into another window.
481: This mode is entered with the
482: .Ic copy-mode
483: command, bound to
484: .Ql [
485: by default.
486: .El
487: .Pp
1.6 jmc 488: The keys available depend on whether emacs or vi mode is selected
489: (see the
1.1 nicm 490: .Ic mode-keys
491: option).
492: The following keys are supported as appropriate for the mode:
1.98 nicm 493: .Bl -column "FunctionXXXXXXXXXXXX" "viXXXXXXXXX" "emacs" -offset indent
1.1 nicm 494: .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
1.27 nicm 495: .It Li "Back to indentation" Ta "^" Ta "M-m"
1.1 nicm 496: .It Li "Clear selection" Ta "Escape" Ta "C-g"
497: .It Li "Copy selection" Ta "Enter" Ta "M-w"
498: .It Li "Cursor down" Ta "j" Ta "Down"
1.70 nicm 499: .It Li "Cursor left" Ta "h" Ta "Left"
500: .It Li "Cursor right" Ta "l" Ta "Right"
501: .It Li "Cursor up" Ta "k" Ta "Up"
1.71 nicm 502: .It Li "Delete entire line" Ta "d" Ta "C-u"
1.70 nicm 503: .It Li "Delete to end of line" Ta "D" Ta "C-k"
1.1 nicm 504: .It Li "End of line" Ta "$" Ta "C-e"
1.94 nicm 505: .It Li "Goto line" Ta ":" Ta "g"
1.1 nicm 506: .It Li "Next page" Ta "C-f" Ta "Page down"
507: .It Li "Next word" Ta "w" Ta "M-f"
1.70 nicm 508: .It Li "Paste buffer" Ta "p" Ta "C-y"
1.1 nicm 509: .It Li "Previous page" Ta "C-u" Ta "Page up"
510: .It Li "Previous word" Ta "b" Ta "M-b"
511: .It Li "Quit mode" Ta "q" Ta "Escape"
1.98 nicm 512: .It Li "Scroll down" Ta "C-Down or J" Ta "C-Down"
513: .It Li "Scroll up" Ta "C-Up or K" Ta "C-Up"
1.70 nicm 514: .It Li "Search again" Ta "n" Ta "n"
515: .It Li "Search backward" Ta "?" Ta "C-r"
516: .It Li "Search forward" Ta "/" Ta "C-s"
517: .It Li "Start of line" Ta "0" Ta "C-a"
1.1 nicm 518: .It Li "Start selection" Ta "Space" Ta "C-Space"
1.80 nicm 519: .It Li "Transpose chars" Ta "" Ta "C-t"
1.1 nicm 520: .El
521: .Pp
1.48 nicm 522: These key bindings are defined in a set of named tables:
523: .Em vi-edit
524: and
525: .Em emacs-edit
526: for keys used when line editing at the command prompt;
527: .Em vi-choice
528: and
529: .Em emacs-choice
530: for keys used when choosing from lists (such as produced by the
531: .Ic window-choose
532: command) or in output mode; and
533: .Em vi-copy
534: and
535: .Em emacs-copy
1.97 nicm 536: used in copy mode.
1.48 nicm 537: The tables may be viewed with the
538: .Ic list-keys
1.49 nicm 539: command and keys modified or removed with
540: .Ic bind-key
541: and
542: .Ic unbind-key .
1.48 nicm 543: .Pp
1.2 nicm 544: The paste buffer key pastes the first line from the top paste buffer on the
545: stack.
1.57 jmc 546: .Pp
547: The mode commands are as follows:
548: .Bl -tag -width Ds
549: .It Xo Ic copy-mode
550: .Op Fl u
1.72 nicm 551: .Op Fl t Ar target-pane
1.57 jmc 552: .Xc
553: Enter copy mode.
554: The
555: .Fl u
556: option scrolls one page up.
557: .El
1.18 nicm 558: .Pp
1.1 nicm 559: Each window displayed by
560: .Nm
561: may be split into one or more
562: .Em panes ;
563: each pane takes up a certain area of the display and is a separate terminal.
564: A window may be split into panes using the
565: .Ic split-window
566: command.
1.38 nicm 567: Windows may be split horizontally (with the
568: .Fl h
569: flag) or vertically.
570: Panes may be resized with the
571: .Ic resize-pane
1.1 nicm 572: command (bound to
1.38 nicm 573: .Ql C-up ,
574: .Ql C-down
575: .Ql C-left
576: and
577: .Ql C-right
1.1 nicm 578: by default), the current pane may be changed with the
579: .Ic up-pane
580: and
581: .Ic down-pane
582: commands and the
583: .Ic rotate-window
584: and
585: .Ic swap-pane
1.38 nicm 586: commands may be used to swap panes without changing their position.
587: Panes are numbered beginning from zero in the order they are created.
588: .Pp
589: A number of preset
590: .Em layouts
591: are available.
592: These may be selected with the
593: .Ic select-layout
594: command or cycled with
595: .Ic next-layout
596: (bound to
597: .Ql C-space
598: by default); once a layout is chosen, panes within it may be moved and resized as normal.
1.1 nicm 599: .Pp
600: The following layouts are supported:
601: .Bl -tag -width Ds
602: .It Ic even-horizontal
603: Panes are spread out evenly from left to right across the window.
604: .It Ic even-vertical
605: Panes are spread evenly from top to bottom.
1.2 nicm 606: .It Ic main-horizontal
607: A large (main) pane is shown at the top of the window and the remaining panes are
1.6 jmc 608: spread from left to right in the leftover space at the bottom.
1.2 nicm 609: Use the
610: .Em main-pane-height
611: window option to specify the height of the top pane.
1.1 nicm 612: .It Ic main-vertical
1.2 nicm 613: Similar to
614: .Ic main-horizontal
615: but the large pane is placed on the left and the others spread from top to
616: bottom along the right.
617: See the
618: .Em main-pane-width
619: window option.
1.1 nicm 620: .El
1.8 nicm 621: .Pp
1.57 jmc 622: Commands related to windows and panes are as follows:
623: .Bl -tag -width Ds
624: .It Xo Ic break-pane
625: .Op Fl d
626: .Op Fl t Ar target-pane
627: .Xc
628: .D1 (alias: Ic breakp )
629: Break
630: .Ar target-pane
631: off from its containing window to make it the only pane in a new window.
632: If
633: .Fl d
634: is given, the new window does not become the current window.
1.76 nicm 635: .It Xo
636: .Ic choose-client
637: .Op Fl t Ar target-window
638: .Op Ar template
639: .Xc
640: Put a window into client choice mode, allowing a client to be selected
641: interactively from a list.
642: After a client is chosen,
643: .Ql %%
644: is replaced by the client
645: .Xr pty 4
646: path in
647: .Ar template
648: and the result executed as a command.
649: If
650: .Ar template
651: is not given, "detach-client -t '%%'" is used.
1.57 jmc 652: This command works only from inside
653: .Nm .
1.76 nicm 654: .It Xo
655: .Ic choose-session
656: .Op Fl t Ar target-window
657: .Op Ar template
658: .Xc
659: Put a window into session choice mode, where a session may be selected
660: interactively from a list.
661: When one is chosen,
662: .Ql %%
663: is replaced by the session name in
664: .Ar template
665: and the result executed as a command.
666: If
667: .Ar template
668: is not given, "switch-client -t '%%'" is used.
669: This command works only from inside
670: .Nm .
671: .It Xo
672: .Ic choose-window
673: .Op Fl t Ar target-window
674: .Op Ar template
675: .Xc
676: Put a window into window choice mode, where a window may be chosen
677: interactively from a list.
678: After a window is selected,
679: .Ql %%
680: is replaced by the session name and window index in
681: .Ar template
682: and the result executed as a command.
683: If
684: .Ar template
685: is not given, "select-window -t '%%'" is used.
1.57 jmc 686: This command works only from inside
687: .Nm .
1.78 nicm 688: .It Ic display-panes Op Fl t Ar target-client
689: .D1 (alias: Ic displayp)
690: Display a visible indicator of each pane shown by
691: .Ar target-client .
692: See the
693: .Ic display-panes-time
694: and
695: .Ic display-panes-colour
696: session options.
1.84 nicm 697: While the indicator is on screen, a pane may be selected with the
698: .Ql 0
699: to
700: .Ql 9
701: keys.
1.57 jmc 702: .It Ic down-pane Op Fl t Ar target-pane
703: .D1 (alias: Ic downp )
704: Move down a pane.
705: .It Xo Ic find-window
706: .Op Fl t Ar target-window
707: .Ar match-string
708: .Xc
709: .D1 (alias: Ic findw )
710: Search for the
711: .Xr fnmatch 3
712: pattern
713: .Ar match-string
714: in window names, titles, and visible content (but not history).
715: If only one window is matched, it'll be automatically selected, otherwise a
716: choice list is shown.
717: This command only works from inside
1.1 nicm 718: .Nm .
1.57 jmc 719: .It Ic kill-pane Op Fl t Ar target-pane
720: .D1 (alias: Ic killp )
721: Destroy the given pane.
722: If no panes remain in the containing window, it is also destroyed.
723: .It Ic kill-window Op Fl t Ar target-window
724: .D1 (alias: Ic killw )
725: Kill the current window or the window at
726: .Ar target-window ,
1.1 nicm 727: removing it from any sessions to which it is linked.
1.56 jmc 728: .It Ic last-window Op Fl t Ar target-session
1.1 nicm 729: .D1 (alias: Ic last )
730: Select the last (previously selected) window.
731: If no
732: .Ar target-session
733: is specified, select the last window of the current session.
734: .It Xo Ic link-window
735: .Op Fl dk
736: .Op Fl s Ar src-window
737: .Op Fl t Ar dst-window
738: .Xc
739: .D1 (alias: Ic linkw )
740: Link the window at
741: .Ar src-window
742: to the specified
743: .Ar dst-window .
744: If
745: .Ar dst-window
746: is specified and no such window exists, the
747: .Ar src-window
748: is linked there.
749: If
750: .Fl k
751: is given and
752: .Ar dst-window
753: exists, it is killed, otherwise an error is generated.
754: If
755: .Fl d
756: is given, the newly linked window is not selected.
1.56 jmc 757: .It Ic list-windows Op Fl t Ar target-session
1.1 nicm 758: .D1 (alias: Ic lsw )
759: List windows in the current session or in
760: .Ar target-session .
761: .It Xo Ic move-window
762: .Op Fl d
763: .Op Fl s Ar src-window
764: .Op Fl t Ar dst-window
765: .Xc
766: .D1 (alias: Ic movew )
767: This is similar to
768: .Ic link-window ,
769: except the window at
770: .Ar src-window
771: is moved to
772: .Ar dst-window .
773: .It Xo Ic new-window
1.28 nicm 774: .Op Fl dk
1.1 nicm 775: .Op Fl n Ar window-name
776: .Op Fl t Ar target-window
777: .Op Ar command
778: .Xc
779: .D1 (alias: Ic neww )
780: Create a new window.
781: If
782: .Fl d
783: is given, the session does not make the new window the current window.
784: .Ar target-window
1.28 nicm 785: represents the window to be created; if the target already exists an error is
786: shown, unless the
787: .Fl k
788: flag is used, in which case it is destroyed.
1.1 nicm 789: .Ar command
790: is the command to execute.
791: If
792: .Ar command
793: is not specified, the default command is used.
794: .Pp
795: The
796: .Ev TERM
797: environment variable must be set to
798: .Dq screen
799: for all programs running
800: .Em inside
801: .Nm .
802: New windows will automatically have
803: .Dq TERM=screen
804: added to their environment, but care must be taken not to reset this in shell
805: start-up files.
1.56 jmc 806: .It Ic next-layout Op Fl t Ar target-window
1.1 nicm 807: .D1 (alias: Ic nextl )
808: Move a window to the next layout and rearrange the panes to fit.
809: .It Xo Ic next-window
1.9 nicm 810: .Op Fl a
1.1 nicm 811: .Op Fl t Ar target-session
812: .Xc
813: .D1 (alias: Ic next )
814: Move to the next window in the session.
1.9 nicm 815: If
1.12 jmc 816: .Fl a
1.9 nicm 817: is used, move to the next window with a bell, activity or content alert.
1.1 nicm 818: .It Xo Ic previous-window
1.9 nicm 819: .Op Fl a
1.1 nicm 820: .Op Fl t Ar target-session
821: .Xc
822: .D1 (alias: Ic prev )
823: Move to the previous window in the session.
1.9 nicm 824: With
825: .Fl a ,
826: move to the previous window with a bell, activity or content alert.
1.1 nicm 827: .It Xo Ic rename-window
828: .Op Fl t Ar target-window
829: .Ar new-name
830: .Xc
831: .D1 (alias: Ic renamew )
832: Rename the current window, or the window at
833: .Ar target-window
834: if specified, to
835: .Ar new-name .
836: .It Xo Ic resize-pane
1.39 jmc 837: .Op Fl DLRU
1.52 nicm 838: .Op Fl t Ar target-pane
1.1 nicm 839: .Op Ar adjustment
840: .Xc
841: .D1 (alias: Ic resizep )
1.57 jmc 842: Resize a pane, upward with
843: .Fl U
844: (the default), downward with
845: .Fl D ,
846: to the left with
847: .Fl L
848: and to the right with
849: .Fl R .
850: The
851: .Ar adjustment
852: is given in lines or cells (the default is 1).
853: .It Xo Ic respawn-window
854: .Op Fl k
855: .Op Fl t Ar target-window
856: .Op Ar command
857: .Xc
858: .D1 (alias: Ic respawnw )
859: Reactive a window in which the command has exited (see the
860: .Ic remain-on-exit
861: window option).
862: If
863: .Ar command
864: is not given, the command used when the window was created is executed.
865: The window must be already inactive, unless
866: .Fl k
867: is given, in which case any existing command is killed.
868: .It Xo Ic rotate-window
869: .Op Fl DU
870: .Op Fl t Ar target-window
871: .Xc
872: .D1 (alias: Ic rotatew )
873: Rotate the positions of the panes within a window, either upward (numerically
874: lower) with
875: .Fl U
876: or downward (numerically higher).
877: .It Xo Ic select-layout
878: .Op Fl t Ar target-window
879: .Op Ar layout-name
880: .Xc
881: .D1 (alias: selectl )
882: Choose a specific layout for a window.
883: If
884: .Ar layout-name
885: is not given, the last layout used (if any) is reapplied.
886: .It Ic select-pane Op Fl t Ar target-pane
887: .D1 (alias: Ic selectp )
888: Make pane
889: .Ar target-pane
890: the active pane in window
891: .Ar target-window .
892: .It Ic select-window Op Fl t Ar target-window
893: .D1 (alias: Ic selectw )
894: Select the window at
895: .Ar target-window .
896: .It Xo Ic split-window
897: .Op Fl dhv
898: .Oo Fl l
899: .Ar size |
900: .Fl p Ar percentage Oc
901: .Op Fl t Ar target-window
902: .Op Ar command
903: .Xc
904: .D1 (alias: splitw )
905: Creates a new pane by splitting the active pane:
906: .Fl h
907: does a horizontal split and
908: .Fl v
909: a vertical split; if neither is specified,
910: .Fl v
911: is assumed.
912: The
913: .Fl l
914: and
915: .Fl p
916: options specify the size of the new window in lines (for vertical split) or in
917: cells (for horizontal split), or as a percentage, respectively.
918: All other options have the same meaning as in the
919: .Ic new-window
920: command.
921: .It Xo Ic swap-pane
922: .Op Fl dDU
923: .Op Fl s Ar src-pane
924: .Op Fl t Ar dst-pane
925: .Xc
926: .D1 (alias: Ic swapp )
927: Swap two panes.
928: If
929: .Fl U
930: is used and no source pane is specified with
931: .Fl s ,
932: .Ar dst-pane
933: is swapped with the previous pane (before it numerically);
934: .Fl D
935: swaps with the next pane (after it numerically).
936: .It Xo Ic swap-window
937: .Op Fl d
938: .Op Fl s Ar src-window
939: .Op Fl t Ar dst-window
940: .Xc
941: .D1 (alias: Ic swapw )
942: This is similar to
943: .Ic link-window ,
944: except the source and destination windows are swapped.
945: It is an error if no window exists at
946: .Ar src-window .
947: .It Xo Ic unlink-window
1.1 nicm 948: .Op Fl k
949: .Op Fl t Ar target-window
950: .Xc
1.57 jmc 951: .D1 (alias: Ic unlinkw )
952: Unlink
953: .Ar target-window .
954: Unless
955: .Fl k
956: is given, a window may be unlinked only if it is linked to multiple sessions -
957: windows may not be linked to no sessions;
958: if
1.1 nicm 959: .Fl k
1.57 jmc 960: is specified and the window is linked to only one session, it is unlinked and
961: destroyed.
962: .It Ic up-pane Op Fl t Ar target-pane
963: .D1 (alias: Ic upp )
964: Move up a pane.
965: .El
966: .Sh KEY BINDINGS
1.93 nicm 967: .Nm
968: allows a command to be bound to most keys, with or without a prefix key.
969: When specifying keys, most represent themselves (for example
970: .Ql A
971: to
1.95 jmc 972: .Ql Z ) .
1.93 nicm 973: Ctrl keys may be prefixed with
974: .Ql C-
975: or
1.95 jmc 976: .Ql ^ ,
977: and Alt (meta) with
1.93 nicm 978: .Ql M- .
979: In addition, the following special key names are accepted:
980: .Em BSpace ,
981: .Em BTab ,
982: .Em DC
983: (Delete),
984: .Em End ,
985: .Em Enter ,
986: .Em Escape ,
987: .Em F1
988: to
989: .Em F20 ,
990: .Em Home ,
991: .Em IC
992: (Insert),
993: .Em NPage
994: (Page Up),
995: .Em PPage
996: (Page Down),
997: .Em Space ,
998: and
999: .Em Tab .
1000: Note that to bind the
1001: .Ql \&"
1002: or
1003: .Ql '
1004: keys, quotation marks are necessary, for example:
1005: .Bd -literal -offset indent
1006: bind-key '"' split-window
1007: bind-key "'" select-prompt
1008: .Ed
1009: .Pp
1.57 jmc 1010: Commands related to key bindings are as follows:
1011: .Bl -tag -width Ds
1012: .It Xo Ic bind-key
1013: .Op Fl cnr
1014: .Op Fl t Ar key-table
1015: .Ar key Ar command Op Ar arguments
1.1 nicm 1016: .Xc
1.57 jmc 1017: .D1 (alias: Ic bind )
1018: Bind key
1019: .Ar key
1020: to
1021: .Ar command .
1022: By default (without
1023: .Fl t )
1024: the primary key bindings are modified (those normally activated with the prefix
1025: key); in this case, if
1026: .Fl n
1027: is specified, it is not necessary to use the prefix key,
1028: .Ar command
1029: is bound to
1030: .Ar key
1031: alone.
1.1 nicm 1032: The
1.57 jmc 1033: .Fl r
1034: flag indicates this key may repeat, see the
1035: .Ic repeat-time
1036: option.
1037: .Pp
1038: If
1039: .Fl t
1040: is present,
1041: .Ar key
1042: is bound in
1043: .Ar key-table :
1044: the binding for command mode with
1045: .Fl c
1046: or for normal mode without.
1047: To view the default bindings and possible commands, see the
1048: .Ic list-keys
1049: command.
1050: .It Ic list-keys Op Fl t Ar key-table
1051: .D1 (alias: Ic lsk )
1052: List all key bindings.
1053: Without
1054: .Fl t
1055: the primary key bindings - those executed when preceded by the prefix key -
1056: are printed.
1057: Keys bound without the prefix key (see
1058: .Ic bind-key
1059: .Fl n )
1060: are enclosed in square brackets.
1061: .Pp
1062: With
1063: .Fl t ,
1064: the key bindings in
1065: .Ar key-table
1066: are listed; this may be one of:
1067: .Em vi-edit ,
1068: .Em emacs-edit ,
1069: .Em vi-choice ,
1070: .Em emacs-choice ,
1071: .Em vi-copy
1072: or
1073: .Em emacs-copy .
1074: .It Xo Ic send-keys
1.72 nicm 1075: .Op Fl t Ar target-pane
1.57 jmc 1076: .Ar key Ar ...
1.1 nicm 1077: .Xc
1.57 jmc 1078: .D1 (alias: Ic send )
1079: Send a key or keys to a window.
1080: Each argument
1081: .Ar key
1082: is the name of the key (such as
1083: .Ql C-a
1084: or
1085: .Ql npage
1086: ) to send; if the string is not recognised as a key, it is sent as a series of
1087: characters.
1088: All arguments are sent sequentially from first to last.
1.72 nicm 1089: .It Ic send-prefix Op Fl t Ar target-pane
1.57 jmc 1090: Send the prefix key to a window as if it was pressed.
1.89 nicm 1091: If multiple prefix keys are configured, only the first is sent.
1.57 jmc 1092: .It Xo Ic unbind-key
1093: .Op Fl cn
1094: .Op Fl t Ar key-table
1095: .Ar key
1.2 nicm 1096: .Xc
1.57 jmc 1097: .D1 (alias: Ic unbind )
1098: Unbind the command bound to
1099: .Ar key .
1100: Without
1101: .Fl t
1102: the primary key bindings are modified; in this case, if
1103: .Fl n
1104: is specified, the command bound to
1105: .Ar key
1106: without a prefix (if any) is removed.
1107: .Pp
1.47 nicm 1108: If
1.57 jmc 1109: .Fl t
1110: is present,
1111: .Ar key
1112: in
1113: .Ar key-table
1114: is unbound: the binding for command mode with
1115: .Fl c
1116: or for normal mode without.
1117: .El
1118: .Sh OPTIONS
1119: The appearance and behaviour of
1120: .Nm
1121: may be modified by changing the value of various options.
1122: There are two types of option:
1123: .Em session options
1124: and
1125: .Em window options .
1126: .Pp
1127: Each individual session may have a set of session options, and there is a
1128: separate set of global session options.
1129: Sessions which do not have a particular option configured inherit the value
1130: from the global session options.
1131: Session options are set or unset with the
1132: .Ic set-option
1133: command and may be listed with the
1134: .Ic show-options
1135: command.
1136: The available session options are listed under the
1137: .Ic set-option
1138: command.
1139: .Pp
1140: Similarly, a set of window options is attached to each window, and there is
1141: a set of global window options from which any unset options are inherited.
1142: Window options are altered with the
1143: .Ic set-window-option
1144: command and can be listed with the
1145: .Ic show-window-options
1146: command.
1147: All window options are documented with the
1148: .Ic set-window-option
1149: command.
1150: .Pp
1151: Commands which set options are as follows:
1152: .Bl -tag -width Ds
1.1 nicm 1153: .It Xo Ic set-option
1.58 nicm 1154: .Op Fl agu
1.1 nicm 1155: .Op Fl t Ar target-session
1156: .Ar option Ar value
1157: .Xc
1158: .D1 (alias: Ic set )
1.18 nicm 1159: Set a session option.
1.58 nicm 1160: With
1161: .Fl a ,
1162: and if the option expects a string,
1163: .Ar value
1164: is appended to the existing setting.
1.1 nicm 1165: If
1166: .Fl g
1.18 nicm 1167: is specified, the global session option is set.
1.1 nicm 1168: The
1169: .Fl u
1170: flag unsets an option, so a session inherits the option from the global
1171: options - it is not possible to unset a global option.
1172: .Pp
1.18 nicm 1173: Available session options are:
1.1 nicm 1174: .Bl -tag -width Ds
1.69 nicm 1175: .It Ic base-index Ar index
1176: Set the base index from which an unused index should be searched when a new
1177: window is created.
1178: The default is zero.
1.1 nicm 1179: .It Xo Ic bell-action
1.56 jmc 1180: .Op Ic any | none | current
1.1 nicm 1181: .Xc
1182: Set action on window bell.
1183: .Ic any
1184: means a bell in any window linked to a session causes a bell in the current
1185: window of that session,
1186: .Ic none
1187: means all bells are ignored and
1188: .Ic current
1189: means only bell in windows other than the current window are ignored.
1190: .It Ic buffer-limit Ar number
1191: Set the number of buffers kept for each session; as new buffers are added to
1192: the top of the stack, old ones are removed from the bottom if necessary to
1193: maintain this maximum length.
1194: .It Ic default-command Ar command
1195: Set the command used for new windows (if not specified when the window is
1196: created) to
1.79 nicm 1197: .Ar command ,
1198: which may be any
1199: .Xr sh 1
1200: command.
1.19 nicm 1201: The default is an empty string, which instructs
1202: .Nm
1.79 nicm 1203: to create a login shell using the value of the
1204: .Ic default-shell
1205: option.
1206: .It Ic default-shell Ar path
1207: Specify the default shell.
1208: This is used as the login shell for new windows when the
1209: .Ic default-command
1210: option is set to empty, and must be the full path of the executable.
1211: When started
1212: .Nm
1213: tries to set a default value from the first suitable of the
1.19 nicm 1214: .Ev SHELL
1.79 nicm 1215: environment variable, the shell returned by
1216: .Xr getpwuid 3 ,
1217: or
1218: .Pa /bin/sh .
1219: This option should be configured when
1220: .Nm
1221: is used as a login shell.
1.1 nicm 1222: .It Ic default-path Ar path
1223: Set the default working directory for processes created from keys, or
1224: interactively from the prompt.
1225: The default is the current working directory when the server is started.
1.22 nicm 1226: .It Ic default-terminal Ar terminal
1227: Set the default terminal for new windows created in this session - the
1228: default value of the
1229: .Ev TERM
1230: environment variable.
1231: For
1232: .Nm
1233: to work correctly, this
1234: .Em must
1235: be set to
1236: .Ql screen
1237: or a derivative of it.
1.78 nicm 1238: .It Ic display-panes-colour Ar colour
1239: Set the colour used for the
1240: .Ic display-panes
1241: command.
1242: .It Ic display-panes-time Ar time
1243: Set the time in milliseconds for which the indicators shown by the
1244: .Ic display-panes
1245: command appear.
1.21 nicm 1246: .It Ic display-time Ar time
1.78 nicm 1247: Set the amount of time for which status line messages and other on-screen
1248: indicators are displayed.
1.21 nicm 1249: .Ar time
1250: is in milliseconds.
1.1 nicm 1251: .It Ic history-limit Ar lines
1252: Set the maximum number of lines held in window history.
1253: This setting applies only to new windows - existing window histories are not
1254: resized and retain the limit at the point they were created.
1255: .It Ic lock-after-time Ar number
1.100 ! nicm 1256: Lock the session (like the
! 1257: .Ic lock-session
1.90 nicm 1258: command) after
1.1 nicm 1259: .Ar number
1.100 ! nicm 1260: seconds of inactivity, or the entire server (all sessions) if the
! 1261: .Ic lock-server
! 1262: option is set.
! 1263: The default is not to lock (set to 0).
1.90 nicm 1264: .It Ic lock-command Ar command
1265: Command to run when locking each client.
1266: The default is to run
1267: .Xr lock 1
1268: with
1269: .Fl np .
1.100 ! nicm 1270: .It Xo Ic lock-server
! 1271: .Op Ic on | off
! 1272: .Xc
! 1273: If this option is
! 1274: .Ic on
! 1275: (the default),
! 1276: instead of each session locking individually as each has been
! 1277: idle for
! 1278: .Ic lock-after-time
! 1279: , the entire server will lock after
! 1280: .Em all
! 1281: sessions would have locked.
! 1282: This has no effect as a session option; it must be set as a global option.
1.1 nicm 1283: .It Ic message-attr Ar attributes
1284: Set status line message attributes, where
1285: .Ar attributes
1286: is either
1287: .Ic default
1288: or a comma-delimited list of one or more of:
1289: .Ic bright
1290: (or
1291: .Ic bold ) ,
1292: .Ic dim ,
1293: .Ic underscore ,
1294: .Ic blink ,
1295: .Ic reverse ,
1296: .Ic hidden ,
1297: or
1298: .Ic italics .
1299: .It Ic message-bg Ar colour
1300: Set status line message background colour, where
1301: .Ar colour
1302: is one of:
1303: .Ic black ,
1304: .Ic red ,
1305: .Ic green ,
1306: .Ic yellow ,
1307: .Ic blue ,
1308: .Ic magenta ,
1309: .Ic cyan ,
1.85 nicm 1310: .Ic white ,
1311: .Ic colour0
1312: to
1313: .Ic colour255
1314: from the 256-colour palette, or
1.1 nicm 1315: .Ic default .
1316: .It Ic message-fg Ar colour
1317: Set status line message foreground colour.
1.89 nicm 1318: .It Ic prefix Ar keys
1319: Set the keys accepted as a prefix key.
1320: .Ar keys
1321: is a comma-separated list of key names, each of which individually behave as
1322: the prefix key.
1.21 nicm 1323: .It Ic repeat-time Ar time
1.1 nicm 1324: Allow multiple commands to be entered without pressing the prefix-key again
1325: in the specified
1.21 nicm 1326: .Ar time
1.1 nicm 1327: milliseconds (the default is 500).
1328: Whether a key repeats may be set when it is bound using the
1329: .Fl r
1330: flag to
1331: .Ic bind-key .
1.52 nicm 1332: Repeat is enabled for the default keys bound to the
1333: .Ic resize-pane
1334: command.
1.1 nicm 1335: .It Xo Ic set-remain-on-exit
1.56 jmc 1336: .Op Ic on | off
1.1 nicm 1337: .Xc
1338: Set the
1339: .Ic remain-on-exit
1340: window option for any windows first created in this session.
1341: .It Xo Ic set-titles
1.56 jmc 1342: .Op Ic on | off
1.1 nicm 1343: .Xc
1.77 stsp 1344: Attempt to set the window title using the \ee]2;...\e007 xterm code if
1.1 nicm 1345: the terminal appears to be an xterm.
1.11 nicm 1346: This option is off by default.
1.6 jmc 1347: Note that elinks
1.1 nicm 1348: will only attempt to set the window title if the STY environment
1349: variable is set.
1.86 nicm 1350: .It Ic set-titles-string Ar string
1351: String used to set the window title if
1352: .Ic set-titles
1353: is on.
1354: Character sequences are replaced as for the
1355: .Ic status-left
1356: option.
1.1 nicm 1357: .It Xo Ic status
1.56 jmc 1358: .Op Ic on | off
1.1 nicm 1359: .Xc
1360: Show or hide the status line.
1361: .It Ic status-attr Ar attributes
1362: Set status line attributes.
1363: .It Ic status-bg Ar colour
1364: Set status line background colour.
1365: .It Ic status-fg Ar colour
1366: Set status line foreground colour.
1367: .It Ic status-interval Ar interval
1368: Update the status bar every
1369: .Ar interval
1370: seconds.
1371: By default, updates will occur every 15 seconds.
1372: A setting of zero disables redrawing at interval.
1.41 nicm 1373: .It Xo Ic status-justify
1.56 jmc 1374: .Op Ic left | centre | right
1.41 nicm 1375: .Xc
1376: Set the position of the window list component of the status line: left, centre
1377: or right justified.
1.1 nicm 1378: .It Xo Ic status-keys
1.56 jmc 1379: .Op Ic vi | emacs
1.1 nicm 1380: .Xc
1.6 jmc 1381: Use vi or emacs-style
1.1 nicm 1382: key bindings in the status line, for example at the command prompt.
1383: Defaults to emacs.
1384: .It Ic status-left Ar string
1385: Display
1386: .Ar string
1387: to the left of the status bar.
1388: .Ar string
1389: will be passed through
1390: .Xr strftime 3
1391: before being used.
1392: By default, the session name is shown.
1393: .Ar string
1.83 nicm 1394: may contain any of the following special character sequences:
1.1 nicm 1395: .Bl -column "Character pair" "Replaced with" -offset indent
1396: .It Sy "Character pair" Ta Sy "Replaced with"
1397: .It Li "#(command)" Ta "First line of command's output"
1.83 nicm 1398: .It Li "#[attributes]" Ta "Colour or attribute change"
1.1 nicm 1399: .It Li "#H" Ta "Hostname of local host"
1.35 nicm 1400: .It Li "#I" Ta "Current window index"
1401: .It Li "#P" Ta "Current pane index"
1.1 nicm 1402: .It Li "#S" Ta "Session name"
1403: .It Li "#T" Ta "Current window title"
1.35 nicm 1404: .It Li "#W" Ta "Current window name"
1.1 nicm 1405: .It Li "##" Ta "A literal" Ql #
1406: .El
1.83 nicm 1407: .Pp
1408: The #(command) form executes
1409: .Ql command
1410: as a shell command and inserts the first line of its output.
1411: #[attributes] allows a comma-separated list of attributes to be specified,
1412: these may be
1413: .Ql fg=colour
1414: to set the foreground colour,
1415: .Ql bg=colour
1416: to set the background colour, or one of the attributes described under the
1417: .Ic message-attr
1418: option.
1419: Examples are:
1420: .Bd -literal -offset indent
1421: #(sysctl vm.loadavg)
1422: #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
1423: .Ed
1.1 nicm 1424: .Pp
1425: Where appropriate, these may be prefixed with a number to specify the maximum
1426: length, for example
1427: .Ql #24T .
1.10 nicm 1428: .Pp
1.12 jmc 1429: By default, UTF-8 in
1.10 nicm 1430: .Ar string
1431: is not interpreted, to enable UTF-8, use the
1432: .Ic status-utf8
1433: option.
1.62 nicm 1434: .It Ic status-left-attr Ar attributes
1.66 jmc 1435: Set the attribute of the left part of the status line.
1.62 nicm 1436: .It Ic status-left-fg Ar colour
1437: Set the foreground colour of the left part of the status line.
1438: .It Ic status-left-bg Ar colour
1439: Set the background colour of the left part of the status line.
1.1 nicm 1440: .It Ic status-left-length Ar length
1441: Set the maximum
1442: .Ar length
1443: of the left component of the status bar.
1444: The default is 10.
1445: .It Ic status-right Ar string
1446: Display
1447: .Ar string
1448: to the right of the status bar.
1449: By default, the date and time will be shown.
1450: As with
1451: .Ic status-left ,
1452: .Ar string
1453: will be passed to
1.10 nicm 1454: .Xr strftime 3 ,
1455: character pairs are replaced, and UTF-8 is dependent on the
1456: .Ic status-utf8
1457: option.
1.62 nicm 1458: .It Ic status-right-attr Ar attributes
1.66 jmc 1459: Set the attribute of the right part of the status line.
1.62 nicm 1460: .It Ic status-right-fg Ar colour
1461: Set the foreground colour of the right part of the status line.
1462: .It Ic status-right-bg Ar colour
1463: Set the background colour of the right part of the status line.
1.1 nicm 1464: .It Ic status-right-length Ar length
1465: Set the maximum
1466: .Ar length
1467: of the right component of the status bar.
1468: The default is 40.
1.10 nicm 1469: .Pp
1470: .It Xo Ic status-utf8
1.56 jmc 1471: .Op Ic on | off
1.10 nicm 1472: .Xc
1473: Instruct
1474: .Nm
1475: to treat top-bit-set characters in the
1476: .Ic status-left
1477: and
1478: .Ic status-right
1479: strings as UTF-8; notably, this is important for wide characters.
1480: This option defaults to off.
1.55 jmc 1481: .It Ic terminal-overrides Ar string
1.54 nicm 1482: Contains a list of entries which override terminal descriptions read using
1483: .Xr terminfo 5 .
1484: .Ar string
1485: is a comma-separated list of items each a colon-separated string made up of a
1486: terminal type pattern (matched using
1487: .Xr fnmatch 3 )
1488: and a set of
1489: .Em name=value
1490: entries.
1491: .Pp
1492: For example, to set the
1493: .Ql clear
1494: .Xr terminfo 5
1495: entry to
1496: .Ql \ee[H\ee[2J
1497: for all terminal types and the
1498: .Ql dch1
1499: entry to
1500: .Ql \ee[P
1.55 jmc 1501: for the
1.54 nicm 1502: .Ql rxvt
1503: terminal type, the option could be set to the string:
1504: .Bd -literal -offset indent
1505: "*:clear=\ee[H\ee[2J,rxvt:dch1=\ee[P"
1506: .Ed
1507: .Pp
1508: The terminal entry value is passed through
1509: .Xr strunvis 3
1510: before interpretation.
1511: The default value forcibly corrects the
1512: .Ql colors
1513: entry for terminals which support 88 or 256 colours:
1514: .Bd -literal -offset indent
1515: "*88col*:colors=88,*256col*:colors=256"
1516: .Ed
1.63 nicm 1517: .It Ic update-environment Ar variables
1518: Set a space-separated string containing a list of environment variables to be
1519: copied into the session environment when a new session is created or an
1520: existing session is attached.
1521: Any variables that do not exist in the source environment are set to be
1522: removed from the session environment (as if
1523: .Fl r
1524: was given to the
1525: .Ic set-environment
1526: command).
1527: The default is
1.75 nicm 1528: "DISPLAY WINDOWID SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION".
1.37 nicm 1529: .It Xo Ic visual-activity
1.56 jmc 1530: .Op Ic on | off
1.37 nicm 1531: .Xc
1532: If on, display a status line message when activity occurs in a window
1.39 jmc 1533: for which the
1.37 nicm 1534: .Ic monitor-activity
1535: window option is enabled.
1536: .It Xo Ic visual-bell
1.56 jmc 1537: .Op Ic on | off
1.37 nicm 1538: .Xc
1539: If this option is on, a message is shown on a bell instead of it being passed
1540: through to the terminal (which normally makes a sound).
1541: Also see the
1542: .Ic bell-action
1543: option.
1544: .It Xo Ic visual-content
1.56 jmc 1545: .Op Ic on | off
1.37 nicm 1546: .Xc
1547: Like
1548: .Ic visual-activity ,
1549: display a message when content is present in a window
1.39 jmc 1550: for which the
1.37 nicm 1551: .Ic monitor-content
1552: window option is enabled.
1.1 nicm 1553: .El
1554: .It Xo Ic set-window-option
1.58 nicm 1555: .Op Fl agu
1.1 nicm 1556: .Op Fl t Ar target-window
1557: .Ar option Ar value
1558: .Xc
1559: .D1 (alias: Ic setw )
1.18 nicm 1560: Set a window option.
1.1 nicm 1561: The
1.58 nicm 1562: .Fl a ,
1.1 nicm 1563: .Fl g
1564: and
1565: .Fl u
1566: flags work similarly to the
1567: .Ic set-option
1568: command.
1569: .Pp
1.18 nicm 1570: Supported window options are:
1.56 jmc 1571: .Pp
1572: .Bl -tag -width Ds -compact
1.1 nicm 1573: .It Xo Ic aggressive-resize
1.56 jmc 1574: .Op Ic on | off
1.1 nicm 1575: .Xc
1576: Aggressively resize the chosen window.
1577: This means that
1578: .Nm
1579: will resize the window to the size of the smallest session for which it is the
1580: current window, rather than the smallest session to which it is attached.
1581: The window may resize when the current window is changed on another sessions;
1.6 jmc 1582: this option is good for full-screen programs which support
1583: .Dv SIGWINCH
1584: and poor for interactive programs such as shells.
1.56 jmc 1585: .Pp
1.1 nicm 1586: .It Xo Ic automatic-rename
1.56 jmc 1587: .Op Ic on | off
1.1 nicm 1588: .Xc
1589: Control automatic window renaming.
1590: When this setting is enabled,
1591: .Nm
1592: will attempt - on supported platforms - to rename the window to reflect the
1593: command currently running in it.
1594: This flag is automatically disabled for an individual window when a name
1595: is specified at creation with
1596: .Ic new-window or
1597: .Ic new-session ,
1598: or later with
1599: .Ic rename-window .
1600: It may be switched off globally with:
1601: .Bd -literal -offset indent
1602: set-window-option -g automatic-rename off
1603: .Ed
1.56 jmc 1604: .Pp
1.1 nicm 1605: .It Ic clock-mode-colour Ar colour
1606: Set clock colour.
1.56 jmc 1607: .Pp
1.1 nicm 1608: .It Xo Ic clock-mode-style
1.56 jmc 1609: .Op Ic 12 | 24
1.1 nicm 1610: .Xc
1611: Set clock hour format.
1.56 jmc 1612: .Pp
1.1 nicm 1613: .It Ic force-height Ar height
1614: .It Ic force-width Ar width
1615: Prevent
1616: .Nm
1617: from resizing a window to greater than
1618: .Ar width
1619: or
1620: .Ar height .
1621: A value of zero restores the default unlimited setting.
1.56 jmc 1622: .Pp
1.2 nicm 1623: .It Ic main-pane-width Ar width
1624: .It Ic main-pane-height Ar height
1625: Set the width or height of the main (left or top) pane in the
1626: .Ic main-horizontal
1627: or
1628: .Ic main-vertical
1629: layouts.
1.56 jmc 1630: .Pp
1.1 nicm 1631: .It Ic mode-attr Ar attributes
1632: Set window modes attributes.
1.56 jmc 1633: .Pp
1.1 nicm 1634: .It Ic mode-bg Ar colour
1635: Set window modes background colour.
1.56 jmc 1636: .Pp
1.1 nicm 1637: .It Ic mode-fg Ar colour
1638: Set window modes foreground colour.
1.56 jmc 1639: .Pp
1.1 nicm 1640: .It Xo Ic mode-keys
1.56 jmc 1641: .Op Ic vi | emacs
1.1 nicm 1642: .Xc
1.50 nicm 1643: Use vi or emacs-style key bindings in scroll, copy and choice modes.
1.1 nicm 1644: Key bindings default to emacs.
1.56 jmc 1645: .Pp
1.50 nicm 1646: .It Xo Ic mode-mouse
1.56 jmc 1647: .Op Ic on | off
1.50 nicm 1648: .Xc
1.51 jmc 1649: Mouse state in modes.
1650: If on,
1.50 nicm 1651: .Nm
1652: will respond to mouse clicks by moving the cursor in copy mode or selecting an
1653: option in choice mode.
1.56 jmc 1654: .Pp
1.1 nicm 1655: .It Xo Ic monitor-activity
1.56 jmc 1656: .Op Ic on | off
1.1 nicm 1657: .Xc
1658: Monitor for activity in the window.
1659: Windows with activity are highlighted in the status line.
1.56 jmc 1660: .Pp
1661: .It Ic monitor-content Ar match-string
1.6 jmc 1662: Monitor content in the window.
1663: When
1.16 nicm 1664: .Xr fnmatch 3
1665: pattern
1.1 nicm 1666: .Ar match-string
1667: appears in the window, it is highlighted in the status line.
1.56 jmc 1668: .Pp
1.1 nicm 1669: .It Xo Ic remain-on-exit
1.56 jmc 1670: .Op Ic on | off
1.1 nicm 1671: .Xc
1672: A window with this flag set is not destroyed when the program running in it
1673: exits.
1674: The window may be reactivated with the
1675: .Ic respawn-window
1676: command.
1.56 jmc 1677: .Pp
1.99 nicm 1678: .It Xo Ic synchronize-panes
1679: .Op Ic on | off
1680: .Xc
1681: Duplicate input to any pane to all other panes in the same window, except
1682: for panes that are not in output mode.
1.1 nicm 1683: .It Xo Ic utf8
1.56 jmc 1684: .Op Ic on | off
1.1 nicm 1685: .Xc
1686: Instructs
1687: .Nm
1688: to expect UTF-8 sequences to appear in this window.
1.56 jmc 1689: .Pp
1.1 nicm 1690: .It Ic window-status-attr Ar attributes
1691: Set status line attributes for a single window.
1.56 jmc 1692: .Pp
1.1 nicm 1693: .It Ic window-status-bg Ar colour
1694: Set status line background colour for a single window.
1.56 jmc 1695: .Pp
1.1 nicm 1696: .It Ic window-status-fg Ar colour
1697: Set status line foreground colour for a single window.
1.56 jmc 1698: .Pp
1.40 nicm 1699: .It Ic window-status-current-attr Ar attributes
1700: Set status line attributes for the currently active window.
1.56 jmc 1701: .Pp
1.40 nicm 1702: .It Ic window-status-current-bg Ar colour
1703: Set status line background colour for the currently active window.
1.56 jmc 1704: .Pp
1.40 nicm 1705: .It Ic window-status-current-fg Ar colour
1706: Set status line foreground colour for the currently active window.
1.56 jmc 1707: .Pp
1.1 nicm 1708: .It Xo Ic xterm-keys
1.56 jmc 1709: .Op Ic on | off
1.1 nicm 1710: .Xc
1711: If this option is set,
1712: .Nm
1713: will generate
1.57 jmc 1714: .Xr xterm 1 -style
1715: function key sequences; these have a number included to indicate modifiers such
1716: as Shift, Alt or Ctrl.
1717: .El
1718: .It Xo Ic show-options
1719: .Op Fl g
1720: .Op Fl t Ar target-session
1721: .Xc
1722: .D1 (alias: Ic show )
1723: Show the session options for
1724: .Ar target session ,
1725: or the global session options with
1726: .Fl g .
1727: .It Xo Ic show-window-options
1728: .Op Fl g
1729: .Op Fl t Ar target-window
1730: .Xc
1731: .D1 (alias: Ic showw )
1732: List the window options for
1733: .Ar target-window ,
1734: or the global window options if
1735: .Fl g
1736: is used.
1.63 nicm 1737: .El
1738: .Sh ENVIRONMENT
1739: When the server is started,
1740: .Nm
1741: copies the environment into the
1742: .Em global environment ;
1743: in addition, each session has a
1744: .Em session environment .
1745: When a window is created, the session and global environments are merged with
1746: the session environment overriding any variable present in both.
1747: This is the initial environment passed to the new process.
1748: .Pp
1749: The
1750: .Ic update-environment
1751: session option may be used to update the session environment from the client
1752: when a new session is created or an old reattached.
1753: .Nm
1754: also initialises the
1755: .Ev TMUX
1756: variable with some internal information to allow commands to be executed
1757: from inside, and the
1758: .Ev TERM
1759: variable with the correct terminal setting of
1760: .Ql screen .
1761: .Pp
1762: Commands to alter and view the environment are:
1763: .Bl -tag -width Ds
1764: .It Xo Ic set-environment
1765: .Op Fl gru
1766: .Op Fl t Ar target-session
1767: .Ar name Op Ar value
1768: .Xc
1769: Set or unset an environment variable.
1770: If
1771: .Fl g
1772: is used, the change is made in the global environment; otherwise, it is applied
1773: to the session environment for
1774: .Ar target-session .
1775: The
1776: .Fl u
1777: flag unsets a variable.
1778: .Fl r
1779: indicates the variable is to be removed from the environment before starting a
1780: new process.
1781: .It Xo Ic show-environment
1782: .Op Fl g
1783: .Op Fl t Ar target-session
1784: .Xc
1785: Display the environment for
1786: .Ar target-session
1787: or the global environment with
1788: .Fl g .
1789: Variables removed from the environment are prefixed with
1790: .Ql - .
1.57 jmc 1791: .El
1792: .Sh STATUS LINE
1793: .Nm
1794: includes an optional status line which is displayed in the bottom line of each
1795: terminal.
1796: By default, the status line is enabled (it may be disabled with the
1797: .Ic status
1798: session option) and contains, from left-to-right: the name of the current
1799: session in square brackets; the window list; the current window title in double
1800: quotes; and the time and date.
1801: .Pp
1802: The status line is made of three parts: configurable left and right sections
1803: (which may contain dynamic content such as the time or output from a shell
1804: command, see the
1805: .Ic status-left ,
1806: .Ic status-left-length ,
1807: .Ic status-right ,
1808: and
1809: .Ic status-right-length
1810: options below), and a central window list.
1811: The window list shows the index, name and (if any) flag of the windows
1812: present in the current session in ascending numerical order.
1813: The flag is one of the following symbols appended to the window name:
1814: .Bl -column "Symbol" "Meaning" -offset indent
1815: .It Sy "Symbol" Ta Sy "Meaning"
1816: .It Li "*" Ta "Denotes the current window."
1817: .It Li "-" Ta "Marks the last window (previously selected)."
1818: .It Li "#" Ta "Window is monitored and activity has been detected."
1819: .It Li "!" Ta "A bell has occurred in the window."
1820: .It Li "+" Ta "Window is monitored for content and it has appeared."
1821: .El
1822: .Pp
1823: The # symbol relates to the
1824: .Ic monitor-activity
1825: and + to the
1826: .Ic monitor-content
1827: window options.
1828: The window name is printed in inverted colours if an alert (bell, activity or
1829: content) is present.
1830: .Pp
1831: The colour and attributes of the status line may be configured, the entire status line using
1832: the
1833: .Ic status-attr ,
1834: .Ic status-fg
1835: and
1836: .Ic status-bg
1837: session options and individual windows using the
1838: .Ic window-status-attr ,
1839: .Ic window-status-fg
1840: and
1841: .Ic window-status-bg
1842: window options.
1843: .Pp
1844: The status line is automatically refreshed at interval if it has changed, the interval may be
1845: controlled with the
1846: .Ic status-interval
1847: session option.
1848: .Pp
1849: Commands related to the status line are as follows:
1850: .Bl -tag -width Ds
1851: .It Xo Ic command-prompt
1.73 nicm 1852: .Op Fl p Ar prompts
1.57 jmc 1853: .Op Fl t Ar target-client
1854: .Op Ar template
1855: .Xc
1856: Open the command prompt in a client.
1857: This may be used from inside
1858: .Nm
1859: to execute commands interactively.
1860: If
1861: .Ar template
1.73 nicm 1862: is specified, it is used as the command.
1863: If
1864: .Fl p
1865: is given,
1866: .Ar prompts
1867: is a comma-separated list of prompts which are displayed in order; otherwise
1868: a single prompt is displayed, constructed from
1869: .Ar template
1870: if it is present, or
1871: .Ql \&:
1872: if not.
1873: Before the command is executed, the first occurrence of the string
1874: .Ql %%
1.74 jmc 1875: and all occurrences of
1.73 nicm 1876: .Ql %1
1877: are replaced by the response to the first prompt, the second
1878: .Ql %%
1879: and all
1880: .Ql %2
1881: are replaced with the response to the second prompt, and so on for further
1.74 jmc 1882: prompts.
1883: Up to nine prompt responses may be replaced
1884: .Po
1885: .Ql %1
1.73 nicm 1886: to
1.74 jmc 1887: .Ql %9
1888: .Pc .
1.57 jmc 1889: .It Xo Ic confirm-before
1890: .Op Fl t Ar target-client
1891: .Ar command
1892: .Xc
1893: .D1 (alias: Ic confirm )
1894: Ask for confirmation before executing
1895: .Ar command .
1896: This command works only from inside
1897: .Nm .
1898: .It Xo Ic display-message
1899: .Op Fl t Ar target-client
1900: .Op Ar message
1901: .Xc
1902: .D1 (alias: Ic display )
1903: Display a message (see the
1904: .Ic status-left
1905: option below)
1906: in the status line.
1907: .It Ic select-prompt Op Fl t Ar target-client
1908: Open a prompt inside
1909: .Ar target-client
1910: allowing a window index to be entered interactively.
1911: .El
1912: .Sh BUFFERS
1913: .Nm
1914: maintains a stack of
1915: .Em paste buffers
1916: for each session.
1917: Up to the value of the
1918: .Ic buffer-limit
1919: option are kept; when a new buffer is added, the buffer at the bottom of the
1920: stack is removed.
1921: Buffers may be added using
1922: .Ic copy-mode
1923: or the
1924: .Ic set-buffer
1925: command, and pasted into a window using the
1926: .Ic paste-buffer
1927: command.
1928: .Pp
1929: A configurable history buffer is also maintained for each window.
1930: By default, up to 2000 lines are kept; this can be altered with the
1931: .Ic history-limit
1932: option (see the
1933: .Ic set-option
1934: command above).
1935: .Pp
1936: The buffer commands are as follows:
1937: .Bl -tag -width Ds
1938: .It Ic clear-history Op Fl t Ar target-pane
1939: .D1 (alias: Ic clearhist )
1940: Remove and free the history for the specified pane.
1941: .It Xo Ic copy-buffer
1942: .Op Fl a Ar src-index
1943: .Op Fl b Ar dst-index
1944: .Op Fl s Ar src-session
1945: .Op Fl t Ar dst-session
1946: .Xc
1947: .D1 (alias: Ic copyb )
1948: Copy a session paste buffer to another session.
1949: If no sessions are specified, the current one is used instead.
1950: .It Xo Ic delete-buffer
1951: .Op Fl b Ar buffer-index
1952: .Op Fl t Ar target-session
1953: .Xc
1954: .D1 (alias: Ic deleteb )
1955: Delete the buffer at
1956: .Ar buffer-index ,
1957: or the top buffer if not specified.
1958: .It Ic list-buffers Op Fl t Ar target-session
1959: .D1 (alias: Ic lsb )
1960: List the buffers in the given session.
1961: .It Xo Ic load-buffer
1962: .Op Fl b Ar buffer-index
1963: .Op Fl t Ar target-session
1964: .Ar path
1965: .Xc
1966: .D1 (alias: Ic loadb )
1967: Load the contents of the specified paste buffer from
1968: .Ar path .
1969: .It Xo Ic paste-buffer
1970: .Op Fl dr
1971: .Op Fl b Ar buffer-index
1972: .Op Fl t Ar target-window
1973: .Xc
1974: .D1 (alias: Ic pasteb )
1975: Insert the contents of a paste buffer into the current window.
1976: With
1977: .Fl d ,
1978: also delete the paste buffer from the stack.
1979: When output, any linefeed (LF) characters in the paste buffer are replaced with
1980: carriage returns (CR).
1981: This translation may be disabled with the
1982: .Fl r
1983: flag.
1984: .It Xo Ic save-buffer
1985: .Op Fl a
1986: .Op Fl b Ar buffer-index
1987: .Op Fl t Ar target-session
1988: .Ar path
1989: .Xc
1990: .D1 (alias: Ic saveb )
1991: Save the contents of the specified paste buffer to
1992: .Ar path .
1993: The
1994: .Fl a
1995: option appends to rather than overwriting the file.
1996: .It Xo Ic set-buffer
1997: .Op Fl b Ar buffer-index
1998: .Op Fl t Ar target-session
1999: .Ar data
2000: .Xc
2001: .D1 (alias: Ic setb )
2002: Set the contents of the specified buffer to
2003: .Ar data .
1.1 nicm 2004: .It Xo Ic show-buffer
2005: .Op Fl b Ar buffer-index
2006: .Op Fl t Ar target-session
2007: .Xc
2008: .D1 (alias: Ic showb )
2009: Display the contents of the specified buffer.
1.57 jmc 2010: .El
2011: .Sh MISCELLANEOUS
2012: .Pp
2013: Miscellaneous commands are as follows:
2014: .Bl -tag -width Ds
1.72 nicm 2015: .It Ic clock-mode Op Fl t Ar target-pane
1.57 jmc 2016: Display a large clock.
2017: .It Ic if-shell Ar shell-command command
2018: .D1 (alias: Ic if )
2019: Execute
2020: .Ar command
2021: if
2022: .Ar shell-command
2023: returns success.
2024: .It Ic lock-server
2025: .D1 (alias: Ic lock )
1.90 nicm 2026: Lock each client individually by running the command specified by the
2027: .Ic lock-command
2028: option.
1.87 nicm 2029: .It Ic run-shell Ar command
2030: .D1 (alias: Ic run )
2031: Execute
2032: .Ar command
2033: without creating a window.
2034: Any output to stdout is displayed in output mode.
2035: If
1.88 jmc 2036: .Ar command
1.87 nicm 2037: doesn't return success, the exit status is also displayed.
1.57 jmc 2038: .It Ic server-info
2039: .D1 (alias: Ic info )
2040: Show server information and terminal details.
1.1 nicm 2041: .El
2042: .Sh FILES
1.26 nicm 2043: .Bl -tag -width "/etc/tmux.confXXX" -compact
1.1 nicm 2044: .It Pa ~/.tmux.conf
1.6 jmc 2045: Default
1.1 nicm 2046: .Nm
1.6 jmc 2047: configuration file.
1.26 nicm 2048: .It Pa /etc/tmux.conf
2049: System-wide configuration file.
1.1 nicm 2050: .El
1.57 jmc 2051: .Sh EXAMPLES
2052: To create a new
2053: .Nm
2054: session running
2055: .Xr vi 1 :
2056: .Pp
2057: .Dl $ tmux new-session vi
2058: .Pp
2059: Most commands have a shorter form, known as an alias.
2060: For new-session, this is
2061: .Ic new :
2062: .Pp
2063: .Dl $ tmux new vi
2064: .Pp
2065: Alternatively, the shortest unambiguous form of a command is accepted.
2066: If there are several options, they are listed:
2067: .Bd -literal -offset indent
2068: $ tmux n
2069: ambiguous command: n, could be: new-session, new-window, next-window
2070: .Ed
2071: .Pp
2072: Within an active session, a new window may be created by typing
2073: .Ql C-b c
2074: (Ctrl
2075: followed by the
2076: .Ql b
2077: key
2078: followed by the
2079: .Ql c
2080: key).
2081: .Pp
2082: Windows may be navigated with:
2083: .Ql C-b 0
2084: (to select window 0),
2085: .Ql C-b 1
2086: (to select window 1), and so on;
2087: .Ql C-b n
2088: to select the next window; and
2089: .Ql C-b p
2090: to select the previous window.
2091: .Pp
2092: A session may be detached using
2093: .Ql C-b d
1.64 nicm 2094: (or by an external event such as
2095: .Xr ssh 1
2096: disconnection) and reattached with:
1.57 jmc 2097: .Pp
2098: .Dl $ tmux attach-session
2099: .Pp
2100: Typing
2101: .Ql C-b \&?
2102: lists the current key bindings in the current window; up and down may be used
2103: to navigate the list or
2104: .Ql q
2105: to exit from it.
2106: .Pp
2107: Commands to be run when the
2108: .Nm
2109: server is started may be placed in the
2110: .Pa ~/.tmux.conf
2111: configuration file.
2112: Common examples include:
2113: .Pp
2114: Changing the default prefix key:
2115: .Bd -literal -offset indent
2116: set-option -g prefix C-a
2117: unbind-key C-b
2118: bind-key C-a send-prefix
2119: .Ed
2120: .Pp
2121: Turning the status line off, or changing its colour:
2122: .Bd -literal -offset indent
2123: set-option -g status off
2124: set-option -g status-bg blue
2125: .Ed
2126: .Pp
2127: Setting other options, such as the default command,
2128: or locking after 30 minutes of inactivity:
2129: .Bd -literal -offset indent
2130: set-option -g default-command "exec /bin/ksh"
2131: set-option -g lock-after-time 1800
2132: .Ed
2133: .Pp
2134: Creating new key bindings:
2135: .Bd -literal -offset indent
2136: bind-key b set-option status
2137: bind-key / command-prompt "split-window 'exec man %%'"
1.73 nicm 2138: bind-key S command-prompt "new-window -n %1 'ssh %1'"
1.57 jmc 2139: .Ed
1.1 nicm 2140: .Sh SEE ALSO
2141: .Xr pty 4
2142: .Sh AUTHORS
2143: .An Nicholas Marriott Aq nicm@users.sourceforge.net