Annotation of src/usr.bin/tmux/tmux.1, Revision 1.128
1.128 ! nicm 1: .\" $OpenBSD: tmux.1,v 1.127 2009/11/24 19:16:11 nicm Exp $
1.1 nicm 2: .\"
3: .\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
8: .\"
9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: .\" WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
14: .\" IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
15: .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: .\"
1.128 ! nicm 17: .Dd $Mdocdate: November 24 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.58 nicm 1233: .Op Fl agu
1.1 nicm 1234: .Op Fl t Ar target-session
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.18 nicm 1252: Available session options are:
1.1 nicm 1253: .Bl -tag -width Ds
1.69 nicm 1254: .It Ic base-index Ar index
1255: Set the base index from which an unused index should be searched when a new
1256: window is created.
1257: The default is zero.
1.1 nicm 1258: .It Xo Ic bell-action
1.56 jmc 1259: .Op Ic any | none | current
1.1 nicm 1260: .Xc
1261: Set action on window bell.
1262: .Ic any
1263: means a bell in any window linked to a session causes a bell in the current
1264: window of that session,
1265: .Ic none
1266: means all bells are ignored and
1267: .Ic current
1268: means only bell in windows other than the current window are ignored.
1269: .It Ic buffer-limit Ar number
1270: Set the number of buffers kept for each session; as new buffers are added to
1271: the top of the stack, old ones are removed from the bottom if necessary to
1272: maintain this maximum length.
1273: .It Ic default-command Ar command
1274: Set the command used for new windows (if not specified when the window is
1275: created) to
1.79 nicm 1276: .Ar command ,
1277: which may be any
1278: .Xr sh 1
1279: command.
1.19 nicm 1280: The default is an empty string, which instructs
1281: .Nm
1.79 nicm 1282: to create a login shell using the value of the
1283: .Ic default-shell
1284: option.
1285: .It Ic default-shell Ar path
1286: Specify the default shell.
1287: This is used as the login shell for new windows when the
1288: .Ic default-command
1289: option is set to empty, and must be the full path of the executable.
1290: When started
1291: .Nm
1292: tries to set a default value from the first suitable of the
1.19 nicm 1293: .Ev SHELL
1.79 nicm 1294: environment variable, the shell returned by
1295: .Xr getpwuid 3 ,
1296: or
1297: .Pa /bin/sh .
1298: This option should be configured when
1299: .Nm
1300: is used as a login shell.
1.1 nicm 1301: .It Ic default-path Ar path
1302: Set the default working directory for processes created from keys, or
1303: interactively from the prompt.
1304: The default is the current working directory when the server is started.
1.22 nicm 1305: .It Ic default-terminal Ar terminal
1306: Set the default terminal for new windows created in this session - the
1307: default value of the
1308: .Ev TERM
1309: environment variable.
1310: For
1311: .Nm
1312: to work correctly, this
1313: .Em must
1314: be set to
1315: .Ql screen
1316: or a derivative of it.
1.78 nicm 1317: .It Ic display-panes-colour Ar colour
1318: Set the colour used for the
1319: .Ic display-panes
1320: command.
1321: .It Ic display-panes-time Ar time
1322: Set the time in milliseconds for which the indicators shown by the
1323: .Ic display-panes
1324: command appear.
1.21 nicm 1325: .It Ic display-time Ar time
1.78 nicm 1326: Set the amount of time for which status line messages and other on-screen
1327: indicators are displayed.
1.21 nicm 1328: .Ar time
1329: is in milliseconds.
1.1 nicm 1330: .It Ic history-limit Ar lines
1331: Set the maximum number of lines held in window history.
1332: This setting applies only to new windows - existing window histories are not
1333: resized and retain the limit at the point they were created.
1334: .It Ic lock-after-time Ar number
1.100 nicm 1335: Lock the session (like the
1336: .Ic lock-session
1.90 nicm 1337: command) after
1.1 nicm 1338: .Ar number
1.100 nicm 1339: seconds of inactivity, or the entire server (all sessions) if the
1340: .Ic lock-server
1341: option is set.
1342: The default is not to lock (set to 0).
1.90 nicm 1343: .It Ic lock-command Ar command
1344: Command to run when locking each client.
1345: The default is to run
1346: .Xr lock 1
1347: with
1348: .Fl np .
1.100 nicm 1349: .It Xo Ic lock-server
1350: .Op Ic on | off
1351: .Xc
1352: If this option is
1.102 nicm 1353: .Ic on
1.100 nicm 1354: (the default),
1355: instead of each session locking individually as each has been
1356: idle for
1.108 jmc 1357: .Ic lock-after-time ,
1358: the entire server will lock after
1.100 nicm 1359: .Em all
1360: sessions would have locked.
1361: This has no effect as a session option; it must be set as a global option.
1.1 nicm 1362: .It Ic message-attr Ar attributes
1363: Set status line message attributes, where
1364: .Ar attributes
1365: is either
1366: .Ic default
1367: or a comma-delimited list of one or more of:
1368: .Ic bright
1369: (or
1370: .Ic bold ) ,
1371: .Ic dim ,
1372: .Ic underscore ,
1373: .Ic blink ,
1374: .Ic reverse ,
1375: .Ic hidden ,
1376: or
1377: .Ic italics .
1378: .It Ic message-bg Ar colour
1379: Set status line message background colour, where
1380: .Ar colour
1381: is one of:
1382: .Ic black ,
1383: .Ic red ,
1384: .Ic green ,
1385: .Ic yellow ,
1386: .Ic blue ,
1387: .Ic magenta ,
1388: .Ic cyan ,
1.85 nicm 1389: .Ic white ,
1390: .Ic colour0
1391: to
1392: .Ic colour255
1393: from the 256-colour palette, or
1.1 nicm 1394: .Ic default .
1395: .It Ic message-fg Ar colour
1396: Set status line message foreground colour.
1.120 nicm 1397: .It Ic message-limit Ar number
1398: Set the number of error or information messages to save in the message log for
1399: each client.
1400: The default is 20.
1.102 nicm 1401: .It Xo Ic mouse-select-pane
1402: .Op Ic on | off
1403: .Xc
1404: If on,
1405: .Nm
1406: captures the mouse and when a window is split into multiple panes the mouse may
1407: be used to select the current pane.
1408: The mouse click is also passed through to the application as normal.
1.89 nicm 1409: .It Ic prefix Ar keys
1410: Set the keys accepted as a prefix key.
1411: .Ar keys
1412: is a comma-separated list of key names, each of which individually behave as
1413: the prefix key.
1.21 nicm 1414: .It Ic repeat-time Ar time
1.1 nicm 1415: Allow multiple commands to be entered without pressing the prefix-key again
1416: in the specified
1.21 nicm 1417: .Ar time
1.1 nicm 1418: milliseconds (the default is 500).
1419: Whether a key repeats may be set when it is bound using the
1420: .Fl r
1421: flag to
1422: .Ic bind-key .
1.52 nicm 1423: Repeat is enabled for the default keys bound to the
1424: .Ic resize-pane
1425: command.
1.1 nicm 1426: .It Xo Ic set-remain-on-exit
1.56 jmc 1427: .Op Ic on | off
1.1 nicm 1428: .Xc
1429: Set the
1430: .Ic remain-on-exit
1431: window option for any windows first created in this session.
1432: .It Xo Ic set-titles
1.56 jmc 1433: .Op Ic on | off
1.1 nicm 1434: .Xc
1.77 stsp 1435: Attempt to set the window title using the \ee]2;...\e007 xterm code if
1.1 nicm 1436: the terminal appears to be an xterm.
1.11 nicm 1437: This option is off by default.
1.6 jmc 1438: Note that elinks
1.1 nicm 1439: will only attempt to set the window title if the STY environment
1440: variable is set.
1.86 nicm 1441: .It Ic set-titles-string Ar string
1442: String used to set the window title if
1443: .Ic set-titles
1444: is on.
1445: Character sequences are replaced as for the
1446: .Ic status-left
1447: option.
1.1 nicm 1448: .It Xo Ic status
1.56 jmc 1449: .Op Ic on | off
1.1 nicm 1450: .Xc
1451: Show or hide the status line.
1452: .It Ic status-attr Ar attributes
1453: Set status line attributes.
1454: .It Ic status-bg Ar colour
1455: Set status line background colour.
1456: .It Ic status-fg Ar colour
1457: Set status line foreground colour.
1458: .It Ic status-interval Ar interval
1459: Update the status bar every
1460: .Ar interval
1461: seconds.
1462: By default, updates will occur every 15 seconds.
1463: A setting of zero disables redrawing at interval.
1.41 nicm 1464: .It Xo Ic status-justify
1.56 jmc 1465: .Op Ic left | centre | right
1.41 nicm 1466: .Xc
1467: Set the position of the window list component of the status line: left, centre
1468: or right justified.
1.1 nicm 1469: .It Xo Ic status-keys
1.56 jmc 1470: .Op Ic vi | emacs
1.1 nicm 1471: .Xc
1.6 jmc 1472: Use vi or emacs-style
1.1 nicm 1473: key bindings in the status line, for example at the command prompt.
1474: Defaults to emacs.
1475: .It Ic status-left Ar string
1476: Display
1477: .Ar string
1478: to the left of the status bar.
1479: .Ar string
1480: will be passed through
1481: .Xr strftime 3
1482: before being used.
1483: By default, the session name is shown.
1484: .Ar string
1.83 nicm 1485: may contain any of the following special character sequences:
1.1 nicm 1486: .Bl -column "Character pair" "Replaced with" -offset indent
1487: .It Sy "Character pair" Ta Sy "Replaced with"
1488: .It Li "#(command)" Ta "First line of command's output"
1.83 nicm 1489: .It Li "#[attributes]" Ta "Colour or attribute change"
1.1 nicm 1490: .It Li "#H" Ta "Hostname of local host"
1.125 nicm 1491: .It Li "#F" Ta "Current window flag"
1.35 nicm 1492: .It Li "#I" Ta "Current window index"
1493: .It Li "#P" Ta "Current pane index"
1.1 nicm 1494: .It Li "#S" Ta "Session name"
1495: .It Li "#T" Ta "Current window title"
1.35 nicm 1496: .It Li "#W" Ta "Current window name"
1.1 nicm 1497: .It Li "##" Ta "A literal" Ql #
1498: .El
1.83 nicm 1499: .Pp
1500: The #(command) form executes
1501: .Ql command
1502: as a shell command and inserts the first line of its output.
1.103 nicm 1503: Note that shell commands are only executed once at the interval specified by
1504: the
1505: .Ic status-interval
1506: option: if the status line is redrawn in the meantime, the previous result is
1507: used.
1.109 nicm 1508: .Pp
1.83 nicm 1509: #[attributes] allows a comma-separated list of attributes to be specified,
1510: these may be
1511: .Ql fg=colour
1512: to set the foreground colour,
1513: .Ql bg=colour
1.109 nicm 1514: to set the background colour, the name of one of the attributes (listed under the
1.83 nicm 1515: .Ic message-attr
1.109 nicm 1516: option) to turn an attribute on, or an attribute prefixed with
1517: .Ql no
1518: to turn one off, for example
1519: .Ic nobright .
1.83 nicm 1520: Examples are:
1521: .Bd -literal -offset indent
1522: #(sysctl vm.loadavg)
1523: #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
1524: .Ed
1.1 nicm 1525: .Pp
1.109 nicm 1526: Where appropriate, special character sequences may be prefixed with a number to
1527: specify the maximum length, for example
1.1 nicm 1528: .Ql #24T .
1.10 nicm 1529: .Pp
1.12 jmc 1530: By default, UTF-8 in
1.10 nicm 1531: .Ar string
1532: is not interpreted, to enable UTF-8, use the
1533: .Ic status-utf8
1534: option.
1.62 nicm 1535: .It Ic status-left-attr Ar attributes
1.66 jmc 1536: Set the attribute of the left part of the status line.
1.62 nicm 1537: .It Ic status-left-fg Ar colour
1538: Set the foreground colour of the left part of the status line.
1539: .It Ic status-left-bg Ar colour
1540: Set the background colour of the left part of the status line.
1.1 nicm 1541: .It Ic status-left-length Ar length
1542: Set the maximum
1543: .Ar length
1544: of the left component of the status bar.
1545: The default is 10.
1546: .It Ic status-right Ar string
1547: Display
1548: .Ar string
1549: to the right of the status bar.
1550: By default, the date and time will be shown.
1551: As with
1552: .Ic status-left ,
1553: .Ar string
1554: will be passed to
1.10 nicm 1555: .Xr strftime 3 ,
1556: character pairs are replaced, and UTF-8 is dependent on the
1557: .Ic status-utf8
1558: option.
1.62 nicm 1559: .It Ic status-right-attr Ar attributes
1.66 jmc 1560: Set the attribute of the right part of the status line.
1.62 nicm 1561: .It Ic status-right-fg Ar colour
1562: Set the foreground colour of the right part of the status line.
1563: .It Ic status-right-bg Ar colour
1564: Set the background colour of the right part of the status line.
1.1 nicm 1565: .It Ic status-right-length Ar length
1566: Set the maximum
1567: .Ar length
1568: of the right component of the status bar.
1569: The default is 40.
1.10 nicm 1570: .Pp
1571: .It Xo Ic status-utf8
1.56 jmc 1572: .Op Ic on | off
1.10 nicm 1573: .Xc
1574: Instruct
1575: .Nm
1576: to treat top-bit-set characters in the
1577: .Ic status-left
1578: and
1579: .Ic status-right
1580: strings as UTF-8; notably, this is important for wide characters.
1581: This option defaults to off.
1.55 jmc 1582: .It Ic terminal-overrides Ar string
1.54 nicm 1583: Contains a list of entries which override terminal descriptions read using
1584: .Xr terminfo 5 .
1585: .Ar string
1586: is a comma-separated list of items each a colon-separated string made up of a
1587: terminal type pattern (matched using
1588: .Xr fnmatch 3 )
1589: and a set of
1590: .Em name=value
1591: entries.
1592: .Pp
1593: For example, to set the
1594: .Ql clear
1595: .Xr terminfo 5
1596: entry to
1597: .Ql \ee[H\ee[2J
1598: for all terminal types and the
1599: .Ql dch1
1600: entry to
1601: .Ql \ee[P
1.55 jmc 1602: for the
1.54 nicm 1603: .Ql rxvt
1604: terminal type, the option could be set to the string:
1605: .Bd -literal -offset indent
1606: "*:clear=\ee[H\ee[2J,rxvt:dch1=\ee[P"
1607: .Ed
1608: .Pp
1609: The terminal entry value is passed through
1610: .Xr strunvis 3
1611: before interpretation.
1612: The default value forcibly corrects the
1613: .Ql colors
1614: entry for terminals which support 88 or 256 colours:
1615: .Bd -literal -offset indent
1616: "*88col*:colors=88,*256col*:colors=256"
1617: .Ed
1.63 nicm 1618: .It Ic update-environment Ar variables
1619: Set a space-separated string containing a list of environment variables to be
1620: copied into the session environment when a new session is created or an
1621: existing session is attached.
1622: Any variables that do not exist in the source environment are set to be
1623: removed from the session environment (as if
1624: .Fl r
1625: was given to the
1626: .Ic set-environment
1627: command).
1628: The default is
1.75 nicm 1629: "DISPLAY WINDOWID SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION".
1.37 nicm 1630: .It Xo Ic visual-activity
1.56 jmc 1631: .Op Ic on | off
1.37 nicm 1632: .Xc
1633: If on, display a status line message when activity occurs in a window
1.39 jmc 1634: for which the
1.37 nicm 1635: .Ic monitor-activity
1636: window option is enabled.
1637: .It Xo Ic visual-bell
1.56 jmc 1638: .Op Ic on | off
1.37 nicm 1639: .Xc
1640: If this option is on, a message is shown on a bell instead of it being passed
1641: through to the terminal (which normally makes a sound).
1642: Also see the
1643: .Ic bell-action
1644: option.
1645: .It Xo Ic visual-content
1.56 jmc 1646: .Op Ic on | off
1.37 nicm 1647: .Xc
1648: Like
1649: .Ic visual-activity ,
1650: display a message when content is present in a window
1.39 jmc 1651: for which the
1.37 nicm 1652: .Ic monitor-content
1653: window option is enabled.
1.1 nicm 1654: .El
1655: .It Xo Ic set-window-option
1.58 nicm 1656: .Op Fl agu
1.1 nicm 1657: .Op Fl t Ar target-window
1658: .Ar option Ar value
1659: .Xc
1660: .D1 (alias: Ic setw )
1.18 nicm 1661: Set a window option.
1.1 nicm 1662: The
1.58 nicm 1663: .Fl a ,
1.1 nicm 1664: .Fl g
1665: and
1666: .Fl u
1667: flags work similarly to the
1668: .Ic set-option
1669: command.
1670: .Pp
1.18 nicm 1671: Supported window options are:
1.56 jmc 1672: .Pp
1673: .Bl -tag -width Ds -compact
1.1 nicm 1674: .It Xo Ic aggressive-resize
1.56 jmc 1675: .Op Ic on | off
1.1 nicm 1676: .Xc
1677: Aggressively resize the chosen window.
1678: This means that
1679: .Nm
1680: will resize the window to the size of the smallest session for which it is the
1681: current window, rather than the smallest session to which it is attached.
1682: The window may resize when the current window is changed on another sessions;
1.6 jmc 1683: this option is good for full-screen programs which support
1684: .Dv SIGWINCH
1685: and poor for interactive programs such as shells.
1.56 jmc 1686: .Pp
1.1 nicm 1687: .It Xo Ic automatic-rename
1.56 jmc 1688: .Op Ic on | off
1.1 nicm 1689: .Xc
1690: Control automatic window renaming.
1691: When this setting is enabled,
1692: .Nm
1693: will attempt - on supported platforms - to rename the window to reflect the
1694: command currently running in it.
1695: This flag is automatically disabled for an individual window when a name
1696: is specified at creation with
1697: .Ic new-window or
1698: .Ic new-session ,
1699: or later with
1700: .Ic rename-window .
1701: It may be switched off globally with:
1702: .Bd -literal -offset indent
1703: set-window-option -g automatic-rename off
1704: .Ed
1.56 jmc 1705: .Pp
1.1 nicm 1706: .It Ic clock-mode-colour Ar colour
1707: Set clock colour.
1.56 jmc 1708: .Pp
1.1 nicm 1709: .It Xo Ic clock-mode-style
1.56 jmc 1710: .Op Ic 12 | 24
1.1 nicm 1711: .Xc
1712: Set clock hour format.
1.56 jmc 1713: .Pp
1.1 nicm 1714: .It Ic force-height Ar height
1715: .It Ic force-width Ar width
1716: Prevent
1717: .Nm
1718: from resizing a window to greater than
1719: .Ar width
1720: or
1721: .Ar height .
1722: A value of zero restores the default unlimited setting.
1.56 jmc 1723: .Pp
1.2 nicm 1724: .It Ic main-pane-width Ar width
1725: .It Ic main-pane-height Ar height
1726: Set the width or height of the main (left or top) pane in the
1727: .Ic main-horizontal
1728: or
1729: .Ic main-vertical
1730: layouts.
1.56 jmc 1731: .Pp
1.1 nicm 1732: .It Ic mode-attr Ar attributes
1733: Set window modes attributes.
1.56 jmc 1734: .Pp
1.1 nicm 1735: .It Ic mode-bg Ar colour
1736: Set window modes background colour.
1.56 jmc 1737: .Pp
1.1 nicm 1738: .It Ic mode-fg Ar colour
1739: Set window modes foreground colour.
1.56 jmc 1740: .Pp
1.1 nicm 1741: .It Xo Ic mode-keys
1.56 jmc 1742: .Op Ic vi | emacs
1.1 nicm 1743: .Xc
1.105 nicm 1744: Use vi or emacs-style key bindings in copy and choice modes.
1.1 nicm 1745: Key bindings default to emacs.
1.56 jmc 1746: .Pp
1.50 nicm 1747: .It Xo Ic mode-mouse
1.56 jmc 1748: .Op Ic on | off
1.50 nicm 1749: .Xc
1.51 jmc 1750: Mouse state in modes.
1751: If on,
1.50 nicm 1752: .Nm
1753: will respond to mouse clicks by moving the cursor in copy mode or selecting an
1754: option in choice mode.
1.56 jmc 1755: .Pp
1.1 nicm 1756: .It Xo Ic monitor-activity
1.56 jmc 1757: .Op Ic on | off
1.1 nicm 1758: .Xc
1759: Monitor for activity in the window.
1760: Windows with activity are highlighted in the status line.
1.56 jmc 1761: .Pp
1762: .It Ic monitor-content Ar match-string
1.6 jmc 1763: Monitor content in the window.
1764: When
1.16 nicm 1765: .Xr fnmatch 3
1766: pattern
1.1 nicm 1767: .Ar match-string
1768: appears in the window, it is highlighted in the status line.
1.56 jmc 1769: .Pp
1.1 nicm 1770: .It Xo Ic remain-on-exit
1.56 jmc 1771: .Op Ic on | off
1.1 nicm 1772: .Xc
1773: A window with this flag set is not destroyed when the program running in it
1774: exits.
1775: The window may be reactivated with the
1776: .Ic respawn-window
1777: command.
1.56 jmc 1778: .Pp
1.99 nicm 1779: .It Xo Ic synchronize-panes
1780: .Op Ic on | off
1781: .Xc
1782: Duplicate input to any pane to all other panes in the same window, except
1783: for panes that are not in output mode.
1.1 nicm 1784: .It Xo Ic utf8
1.56 jmc 1785: .Op Ic on | off
1.1 nicm 1786: .Xc
1787: Instructs
1788: .Nm
1789: to expect UTF-8 sequences to appear in this window.
1.56 jmc 1790: .Pp
1.1 nicm 1791: .It Ic window-status-attr Ar attributes
1792: Set status line attributes for a single window.
1.56 jmc 1793: .Pp
1.1 nicm 1794: .It Ic window-status-bg Ar colour
1795: Set status line background colour for a single window.
1.56 jmc 1796: .Pp
1.1 nicm 1797: .It Ic window-status-fg Ar colour
1798: Set status line foreground colour for a single window.
1.56 jmc 1799: .Pp
1.125 nicm 1800: .It Ic window-status-format Ar string
1801: Set the format in which the window is displayed in the status line window list.
1802: See the
1803: .Ar status-left
1804: option for details of special character sequences available.
1805: The default is
1806: .Ql #I:#W#F .
1807: .Pp
1.40 nicm 1808: .It Ic window-status-current-attr Ar attributes
1809: Set status line attributes for the currently active window.
1.56 jmc 1810: .Pp
1.40 nicm 1811: .It Ic window-status-current-bg Ar colour
1812: Set status line background colour for the currently active window.
1.56 jmc 1813: .Pp
1.40 nicm 1814: .It Ic window-status-current-fg Ar colour
1815: Set status line foreground colour for the currently active window.
1.56 jmc 1816: .Pp
1.125 nicm 1817: .It Ic window-status-current-format Ar string
1818: Like
1819: .Ar window-status-format ,
1820: but is the format used when the window is the current window.
1821: .Pp
1.1 nicm 1822: .It Xo Ic xterm-keys
1.56 jmc 1823: .Op Ic on | off
1.1 nicm 1824: .Xc
1825: If this option is set,
1826: .Nm
1827: will generate
1.57 jmc 1828: .Xr xterm 1 -style
1829: function key sequences; these have a number included to indicate modifiers such
1830: as Shift, Alt or Ctrl.
1.123 nicm 1831: The default is off.
1.57 jmc 1832: .El
1833: .It Xo Ic show-options
1834: .Op Fl g
1835: .Op Fl t Ar target-session
1836: .Xc
1837: .D1 (alias: Ic show )
1838: Show the session options for
1839: .Ar target session ,
1840: or the global session options with
1841: .Fl g .
1842: .It Xo Ic show-window-options
1843: .Op Fl g
1844: .Op Fl t Ar target-window
1845: .Xc
1846: .D1 (alias: Ic showw )
1847: List the window options for
1848: .Ar target-window ,
1849: or the global window options if
1850: .Fl g
1851: is used.
1.63 nicm 1852: .El
1853: .Sh ENVIRONMENT
1854: When the server is started,
1855: .Nm
1856: copies the environment into the
1857: .Em global environment ;
1858: in addition, each session has a
1859: .Em session environment .
1860: When a window is created, the session and global environments are merged with
1861: the session environment overriding any variable present in both.
1862: This is the initial environment passed to the new process.
1863: .Pp
1864: The
1865: .Ic update-environment
1866: session option may be used to update the session environment from the client
1867: when a new session is created or an old reattached.
1868: .Nm
1869: also initialises the
1870: .Ev TMUX
1871: variable with some internal information to allow commands to be executed
1872: from inside, and the
1873: .Ev TERM
1874: variable with the correct terminal setting of
1875: .Ql screen .
1876: .Pp
1877: Commands to alter and view the environment are:
1878: .Bl -tag -width Ds
1879: .It Xo Ic set-environment
1880: .Op Fl gru
1881: .Op Fl t Ar target-session
1882: .Ar name Op Ar value
1883: .Xc
1.115 nicm 1884: .D1 (alias: Ic setenv )
1.63 nicm 1885: Set or unset an environment variable.
1886: If
1887: .Fl g
1888: is used, the change is made in the global environment; otherwise, it is applied
1889: to the session environment for
1890: .Ar target-session .
1891: The
1892: .Fl u
1893: flag unsets a variable.
1894: .Fl r
1895: indicates the variable is to be removed from the environment before starting a
1896: new process.
1897: .It Xo Ic show-environment
1898: .Op Fl g
1899: .Op Fl t Ar target-session
1900: .Xc
1.115 nicm 1901: .D1 (alias: Ic showenv )
1.63 nicm 1902: Display the environment for
1903: .Ar target-session
1904: or the global environment with
1905: .Fl g .
1906: Variables removed from the environment are prefixed with
1907: .Ql - .
1.57 jmc 1908: .El
1909: .Sh STATUS LINE
1910: .Nm
1911: includes an optional status line which is displayed in the bottom line of each
1912: terminal.
1913: By default, the status line is enabled (it may be disabled with the
1914: .Ic status
1915: session option) and contains, from left-to-right: the name of the current
1916: session in square brackets; the window list; the current window title in double
1917: quotes; and the time and date.
1918: .Pp
1919: The status line is made of three parts: configurable left and right sections
1920: (which may contain dynamic content such as the time or output from a shell
1921: command, see the
1922: .Ic status-left ,
1923: .Ic status-left-length ,
1924: .Ic status-right ,
1925: and
1926: .Ic status-right-length
1927: options below), and a central window list.
1.125 nicm 1928: By default, the window list shows the index, name and (if any) flag of the
1929: windows present in the current session in ascending numerical order.
1930: It may be customised with the
1931: .Ar window-status-format
1932: and
1933: .Ar window-status-current-format
1934: options.
1.57 jmc 1935: The flag is one of the following symbols appended to the window name:
1936: .Bl -column "Symbol" "Meaning" -offset indent
1937: .It Sy "Symbol" Ta Sy "Meaning"
1938: .It Li "*" Ta "Denotes the current window."
1939: .It Li "-" Ta "Marks the last window (previously selected)."
1940: .It Li "#" Ta "Window is monitored and activity has been detected."
1941: .It Li "!" Ta "A bell has occurred in the window."
1942: .It Li "+" Ta "Window is monitored for content and it has appeared."
1943: .El
1944: .Pp
1945: The # symbol relates to the
1946: .Ic monitor-activity
1947: and + to the
1948: .Ic monitor-content
1949: window options.
1950: The window name is printed in inverted colours if an alert (bell, activity or
1951: content) is present.
1952: .Pp
1953: The colour and attributes of the status line may be configured, the entire status line using
1954: the
1955: .Ic status-attr ,
1956: .Ic status-fg
1957: and
1958: .Ic status-bg
1959: session options and individual windows using the
1960: .Ic window-status-attr ,
1961: .Ic window-status-fg
1962: and
1963: .Ic window-status-bg
1964: window options.
1965: .Pp
1966: The status line is automatically refreshed at interval if it has changed, the interval may be
1967: controlled with the
1968: .Ic status-interval
1969: session option.
1970: .Pp
1971: Commands related to the status line are as follows:
1972: .Bl -tag -width Ds
1973: .It Xo Ic command-prompt
1.73 nicm 1974: .Op Fl p Ar prompts
1.57 jmc 1975: .Op Fl t Ar target-client
1976: .Op Ar template
1977: .Xc
1978: Open the command prompt in a client.
1979: This may be used from inside
1980: .Nm
1981: to execute commands interactively.
1982: If
1983: .Ar template
1.73 nicm 1984: is specified, it is used as the command.
1985: If
1986: .Fl p
1987: is given,
1988: .Ar prompts
1989: is a comma-separated list of prompts which are displayed in order; otherwise
1990: a single prompt is displayed, constructed from
1991: .Ar template
1992: if it is present, or
1993: .Ql \&:
1994: if not.
1995: Before the command is executed, the first occurrence of the string
1996: .Ql %%
1.74 jmc 1997: and all occurrences of
1.73 nicm 1998: .Ql %1
1999: are replaced by the response to the first prompt, the second
2000: .Ql %%
2001: and all
2002: .Ql %2
2003: are replaced with the response to the second prompt, and so on for further
1.74 jmc 2004: prompts.
2005: Up to nine prompt responses may be replaced
2006: .Po
2007: .Ql %1
1.73 nicm 2008: to
1.74 jmc 2009: .Ql %9
2010: .Pc .
1.57 jmc 2011: .It Xo Ic confirm-before
2012: .Op Fl t Ar target-client
2013: .Ar command
2014: .Xc
2015: .D1 (alias: Ic confirm )
2016: Ask for confirmation before executing
2017: .Ar command .
2018: This command works only from inside
2019: .Nm .
2020: .It Xo Ic display-message
1.127 nicm 2021: .Op Fl p
1.57 jmc 2022: .Op Fl t Ar target-client
2023: .Op Ar message
2024: .Xc
2025: .D1 (alias: Ic display )
1.127 nicm 2026: Display a message.
2027: If
2028: .Fl p
2029: is given, the output is printed to stdout, otherwise it is displayed in the
2030: .Ar target-client
2031: status line.
1.122 nicm 2032: The format of
1.124 jmc 2033: .Ar message
2034: is as for
1.122 nicm 2035: .Ic status-left ,
2036: with the exception that #() are not handled.
1.57 jmc 2037: .It Ic select-prompt Op Fl t Ar target-client
2038: Open a prompt inside
2039: .Ar target-client
2040: allowing a window index to be entered interactively.
2041: .El
2042: .Sh BUFFERS
2043: .Nm
2044: maintains a stack of
2045: .Em paste buffers
2046: for each session.
2047: Up to the value of the
2048: .Ic buffer-limit
2049: option are kept; when a new buffer is added, the buffer at the bottom of the
2050: stack is removed.
2051: Buffers may be added using
2052: .Ic copy-mode
2053: or the
2054: .Ic set-buffer
2055: command, and pasted into a window using the
2056: .Ic paste-buffer
2057: command.
2058: .Pp
2059: A configurable history buffer is also maintained for each window.
2060: By default, up to 2000 lines are kept; this can be altered with the
2061: .Ic history-limit
2062: option (see the
2063: .Ic set-option
2064: command above).
2065: .Pp
2066: The buffer commands are as follows:
2067: .Bl -tag -width Ds
2068: .It Ic clear-history Op Fl t Ar target-pane
2069: .D1 (alias: Ic clearhist )
2070: Remove and free the history for the specified pane.
2071: .It Xo Ic copy-buffer
2072: .Op Fl a Ar src-index
2073: .Op Fl b Ar dst-index
2074: .Op Fl s Ar src-session
2075: .Op Fl t Ar dst-session
2076: .Xc
2077: .D1 (alias: Ic copyb )
2078: Copy a session paste buffer to another session.
2079: If no sessions are specified, the current one is used instead.
2080: .It Xo Ic delete-buffer
2081: .Op Fl b Ar buffer-index
2082: .Op Fl t Ar target-session
2083: .Xc
2084: .D1 (alias: Ic deleteb )
2085: Delete the buffer at
2086: .Ar buffer-index ,
2087: or the top buffer if not specified.
2088: .It Ic list-buffers Op Fl t Ar target-session
2089: .D1 (alias: Ic lsb )
2090: List the buffers in the given session.
2091: .It Xo Ic load-buffer
2092: .Op Fl b Ar buffer-index
2093: .Op Fl t Ar target-session
2094: .Ar path
2095: .Xc
2096: .D1 (alias: Ic loadb )
2097: Load the contents of the specified paste buffer from
2098: .Ar path .
2099: .It Xo Ic paste-buffer
2100: .Op Fl dr
2101: .Op Fl b Ar buffer-index
2102: .Op Fl t Ar target-window
2103: .Xc
2104: .D1 (alias: Ic pasteb )
2105: Insert the contents of a paste buffer into the current window.
2106: With
2107: .Fl d ,
2108: also delete the paste buffer from the stack.
2109: When output, any linefeed (LF) characters in the paste buffer are replaced with
2110: carriage returns (CR).
2111: This translation may be disabled with the
2112: .Fl r
2113: flag.
2114: .It Xo Ic save-buffer
2115: .Op Fl a
2116: .Op Fl b Ar buffer-index
2117: .Op Fl t Ar target-session
2118: .Ar path
2119: .Xc
2120: .D1 (alias: Ic saveb )
2121: Save the contents of the specified paste buffer to
2122: .Ar path .
2123: The
2124: .Fl a
2125: option appends to rather than overwriting the file.
2126: .It Xo Ic set-buffer
2127: .Op Fl b Ar buffer-index
2128: .Op Fl t Ar target-session
2129: .Ar data
2130: .Xc
2131: .D1 (alias: Ic setb )
2132: Set the contents of the specified buffer to
2133: .Ar data .
1.1 nicm 2134: .It Xo Ic show-buffer
2135: .Op Fl b Ar buffer-index
2136: .Op Fl t Ar target-session
2137: .Xc
2138: .D1 (alias: Ic showb )
2139: Display the contents of the specified buffer.
1.57 jmc 2140: .El
2141: .Sh MISCELLANEOUS
2142: .Pp
2143: Miscellaneous commands are as follows:
2144: .Bl -tag -width Ds
1.72 nicm 2145: .It Ic clock-mode Op Fl t Ar target-pane
1.57 jmc 2146: Display a large clock.
2147: .It Ic if-shell Ar shell-command command
2148: .D1 (alias: Ic if )
2149: Execute
2150: .Ar command
2151: if
2152: .Ar shell-command
2153: returns success.
2154: .It Ic lock-server
2155: .D1 (alias: Ic lock )
1.90 nicm 2156: Lock each client individually by running the command specified by the
2157: .Ic lock-command
2158: option.
1.87 nicm 2159: .It Ic run-shell Ar command
2160: .D1 (alias: Ic run )
2161: Execute
2162: .Ar command
1.106 nicm 2163: in the background without creating a window.
2164: After the command finishes, any output to stdout is displayed in output mode.
1.87 nicm 2165: If
1.88 jmc 2166: .Ar command
1.87 nicm 2167: doesn't return success, the exit status is also displayed.
1.57 jmc 2168: .It Ic server-info
2169: .D1 (alias: Ic info )
2170: Show server information and terminal details.
1.1 nicm 2171: .El
2172: .Sh FILES
1.26 nicm 2173: .Bl -tag -width "/etc/tmux.confXXX" -compact
1.1 nicm 2174: .It Pa ~/.tmux.conf
1.6 jmc 2175: Default
1.1 nicm 2176: .Nm
1.6 jmc 2177: configuration file.
1.26 nicm 2178: .It Pa /etc/tmux.conf
2179: System-wide configuration file.
1.1 nicm 2180: .El
1.57 jmc 2181: .Sh EXAMPLES
2182: To create a new
2183: .Nm
2184: session running
2185: .Xr vi 1 :
2186: .Pp
2187: .Dl $ tmux new-session vi
2188: .Pp
2189: Most commands have a shorter form, known as an alias.
2190: For new-session, this is
2191: .Ic new :
2192: .Pp
2193: .Dl $ tmux new vi
2194: .Pp
2195: Alternatively, the shortest unambiguous form of a command is accepted.
2196: If there are several options, they are listed:
2197: .Bd -literal -offset indent
2198: $ tmux n
2199: ambiguous command: n, could be: new-session, new-window, next-window
2200: .Ed
2201: .Pp
2202: Within an active session, a new window may be created by typing
2203: .Ql C-b c
2204: (Ctrl
2205: followed by the
2206: .Ql b
2207: key
2208: followed by the
2209: .Ql c
2210: key).
2211: .Pp
2212: Windows may be navigated with:
2213: .Ql C-b 0
2214: (to select window 0),
2215: .Ql C-b 1
2216: (to select window 1), and so on;
2217: .Ql C-b n
2218: to select the next window; and
2219: .Ql C-b p
2220: to select the previous window.
2221: .Pp
2222: A session may be detached using
2223: .Ql C-b d
1.64 nicm 2224: (or by an external event such as
2225: .Xr ssh 1
2226: disconnection) and reattached with:
1.57 jmc 2227: .Pp
2228: .Dl $ tmux attach-session
2229: .Pp
2230: Typing
2231: .Ql C-b \&?
2232: lists the current key bindings in the current window; up and down may be used
2233: to navigate the list or
2234: .Ql q
2235: to exit from it.
2236: .Pp
2237: Commands to be run when the
2238: .Nm
2239: server is started may be placed in the
2240: .Pa ~/.tmux.conf
2241: configuration file.
2242: Common examples include:
2243: .Pp
2244: Changing the default prefix key:
2245: .Bd -literal -offset indent
2246: set-option -g prefix C-a
2247: unbind-key C-b
2248: bind-key C-a send-prefix
2249: .Ed
2250: .Pp
2251: Turning the status line off, or changing its colour:
2252: .Bd -literal -offset indent
2253: set-option -g status off
2254: set-option -g status-bg blue
2255: .Ed
2256: .Pp
2257: Setting other options, such as the default command,
2258: or locking after 30 minutes of inactivity:
2259: .Bd -literal -offset indent
2260: set-option -g default-command "exec /bin/ksh"
2261: set-option -g lock-after-time 1800
2262: .Ed
2263: .Pp
2264: Creating new key bindings:
2265: .Bd -literal -offset indent
2266: bind-key b set-option status
2267: bind-key / command-prompt "split-window 'exec man %%'"
1.73 nicm 2268: bind-key S command-prompt "new-window -n %1 'ssh %1'"
1.57 jmc 2269: .Ed
1.1 nicm 2270: .Sh SEE ALSO
2271: .Xr pty 4
2272: .Sh AUTHORS
2273: .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