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