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