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