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