Annotation of src/usr.bin/tmux/tmux.1, Revision 1.894
1.894 ! nicm 1: .\" $OpenBSD: tmux.1,v 1.893 2022/06/30 09:55:53 nicm Exp $
1.1 nicm 2: .\"
1.477 nicm 3: .\" Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
1.1 nicm 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.894 ! nicm 17: .Dd $Mdocdate: June 30 2022 $
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.767 nicm 26: .Op Fl 2CDluvV
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
1.744 nicm 31: .Op Fl T Ar features
1.1 nicm 32: .Op Ar command Op Ar flags
33: .Ek
34: .Sh DESCRIPTION
35: .Nm
1.59 jmc 36: is a terminal multiplexer:
37: it enables a number of terminals to be created, accessed, and
38: controlled from a single screen.
1.67 jmc 39: .Nm
40: may be detached from a screen
41: and continue running in the background,
42: then later reattached.
1.1 nicm 43: .Pp
1.60 nicm 44: When
45: .Nm
1.886 naddy 46: is started, it creates a new
1.60 nicm 47: .Em session
48: with a single
49: .Em window
50: and displays it on screen.
51: A status line at the bottom of the screen
52: shows information on the current session
53: and is used to enter interactive commands.
54: .Pp
55: A session is a single collection of
56: .Em pseudo terminals
57: under the management of
58: .Nm .
59: Each session has one or more
60: windows linked to it.
61: A window occupies the entire screen
62: and may be split into rectangular panes,
63: each of which is a separate pseudo terminal
64: (the
65: .Xr pty 4
66: manual page documents the technical details of pseudo terminals).
67: Any number of
68: .Nm
69: instances may connect to the same session,
70: and any number of windows may be present in the same session.
71: Once all sessions are killed,
72: .Nm
73: exits.
74: .Pp
1.64 nicm 75: Each session is persistent and will survive accidental disconnection
1.66 jmc 76: (such as
1.64 nicm 77: .Xr ssh 1
1.67 jmc 78: connection timeout) or intentional detaching (with the
1.64 nicm 79: .Ql C-b d
80: key strokes).
81: .Nm
82: may be reattached using:
83: .Pp
84: .Dl $ tmux attach
1.60 nicm 85: .Pp
1.64 nicm 86: In
87: .Nm ,
88: a session is displayed on screen by a
89: .Em client
90: and all sessions are managed by a single
91: .Em server .
92: The server and each client are separate processes which communicate through a
93: socket in
94: .Pa /tmp .
1.65 nicm 95: .Pp
1.1 nicm 96: The options are as follows:
97: .Bl -tag -width "XXXXXXXXXXXX"
98: .It Fl 2
99: Force
100: .Nm
101: to assume the terminal supports 256 colours.
1.744 nicm 102: This is equivalent to
103: .Fl T Ar 256 .
1.345 nicm 104: .It Fl C
1.369 nicm 105: Start in control mode (see the
106: .Sx CONTROL MODE
107: section).
1.345 nicm 108: Given twice
109: .Xo ( Fl CC ) Xc
110: disables echo.
1.91 nicm 111: .It Fl c Ar shell-command
112: Execute
113: .Ar shell-command
114: using the default shell.
115: If necessary, the
116: .Nm
117: server will be started to retrieve the
118: .Ic default-shell
119: option.
1.153 nicm 120: This option is for compatibility with
121: .Xr sh 1
122: when
123: .Nm
124: is used as a login shell.
1.767 nicm 125: .It Fl D
126: Do not start the
127: .Nm
128: server as a daemon.
129: This also turns the
130: .Ic exit-empty
131: option off.
132: With
133: .Fl D ,
134: .Ar command
135: may not be specified.
1.1 nicm 136: .It Fl f Ar file
137: Specify an alternative configuration file.
138: By default,
139: .Nm
1.26 nicm 140: loads the system configuration file from
141: .Pa /etc/tmux.conf ,
142: if present, then looks for a user configuration file at
1.1 nicm 143: .Pa ~/.tmux.conf .
1.306 nicm 144: .Pp
1.1 nicm 145: The configuration file is a set of
146: .Nm
147: commands which are executed in sequence when the server is first started.
1.306 nicm 148: .Nm
149: loads configuration files once when the server process has started.
150: The
151: .Ic source-file
152: command may be used to load a file later.
1.61 nicm 153: .Pp
154: .Nm
1.306 nicm 155: shows any error messages from commands in configuration files in the first
156: session created, and continues to process the rest of the configuration file.
1.1 nicm 157: .It Fl L Ar socket-name
158: .Nm
159: stores the server socket in a directory under
1.455 nicm 160: .Ev TMUX_TMPDIR
161: or
1.208 nicm 162: .Pa /tmp
1.455 nicm 163: if it is unset.
1.355 nicm 164: The default socket is named
1.1 nicm 165: .Em default .
166: This option allows a different socket name to be specified, allowing several
167: independent
168: .Nm
169: servers to be run.
170: Unlike
171: .Fl S
1.789 nicm 172: a full path is not necessary: the sockets are all created in a directory
173: .Pa tmux-UID
174: under the directory given by
175: .Ev TMUX_TMPDIR
176: or in
177: .Pa /tmp .
178: The
179: .Pa tmux-UID
180: directory is created by
181: .Nm
182: and must not be world readable, writable or executable.
1.2 nicm 183: .Pp
184: If the socket is accidentally removed, the
1.6 jmc 185: .Dv SIGUSR1
1.2 nicm 186: signal may be sent to the
187: .Nm
1.422 nicm 188: server process to recreate it (note that this will fail if any parent
189: directories are missing).
1.166 sobrado 190: .It Fl l
191: Behave as a login shell.
192: This flag currently has no effect and is for compatibility with other shells
193: when using tmux as a login shell.
1.811 nicm 194: .It Fl N
195: Do not start the server even if the command would normally do so (for example
196: .Ic new-session
197: or
198: .Ic start-server ) .
1.1 nicm 199: .It Fl S Ar socket-path
200: Specify a full alternative path to the server socket.
201: If
202: .Fl S
203: is specified, the default socket directory is not used and any
204: .Fl L
205: flag is ignored.
206: .It Fl u
1.644 schwarze 207: Write UTF-8 output to the terminal even if the first environment
208: variable of
1.14 nicm 209: .Ev LC_ALL ,
1.644 schwarze 210: .Ev LC_CTYPE ,
211: or
1.2 nicm 212: .Ev LANG
1.644 schwarze 213: that is set does not contain
214: .Qq UTF-8
215: or
216: .Qq UTF8 .
1.744 nicm 217: This is equivalent to
218: .Fl T Ar UTF-8 .
219: .It Fl T Ar features
220: Set terminal features for the client.
221: This is a comma-separated list of features.
222: See the
223: .Ic terminal-features
224: option.
1.1 nicm 225: .It Fl v
226: Request verbose logging.
227: Log messages will be saved into
228: .Pa tmux-client-PID.log
229: and
230: .Pa tmux-server-PID.log
231: files in the current directory, where
232: .Em PID
1.6 jmc 233: is the PID of the server or client process.
1.558 nicm 234: If
235: .Fl v
236: is specified twice, an additional
237: .Pa tmux-out-PID.log
238: file is generated with a copy of everything
239: .Nm
240: writes to the terminal.
241: .Pp
242: The
243: .Dv SIGUSR2
244: signal may be sent to the
245: .Nm
246: server process to toggle logging between on (as if
247: .Fl v
248: was given) and off.
1.708 nicm 249: .It Fl V
250: Report the
251: .Nm
252: version.
1.1 nicm 253: .It Ar command Op Ar flags
254: This specifies one of a set of commands used to control
255: .Nm ,
1.6 jmc 256: as described in the following sections.
1.59 jmc 257: If no commands are specified, the
1.1 nicm 258: .Ic new-session
259: command is assumed.
1.57 jmc 260: .El
1.627 nicm 261: .Sh DEFAULT KEY BINDINGS
1.64 nicm 262: .Nm
263: may be controlled from an attached client by using a key combination of a
264: prefix key,
265: .Ql C-b
266: (Ctrl-b) by default, followed by a command key.
267: .Pp
1.172 nicm 268: The default command key bindings are:
1.64 nicm 269: .Pp
1.171 nicm 270: .Bl -tag -width "XXXXXXXXXX" -offset indent -compact
271: .It C-b
272: Send the prefix key (C-b) through to the application.
273: .It C-o
274: Rotate the panes in the current window forwards.
275: .It C-z
276: Suspend the
277: .Nm
278: client.
279: .It !
280: Break the current pane out of the window.
281: .It \&"
1.625 nicm 282: .\" "
1.171 nicm 283: Split the current pane into two, top and bottom.
284: .It #
285: List all paste buffers.
1.236 nicm 286: .It $
287: Rename the current session.
1.171 nicm 288: .It %
289: Split the current pane into two, left and right.
290: .It &
291: Kill the current window.
292: .It '
293: Prompt for a window index to select.
1.412 nicm 294: .It \&(
295: Switch the attached client to the previous session.
296: .It \&)
297: Switch the attached client to the next session.
1.171 nicm 298: .It ,
299: Rename the current window.
300: .It -
301: Delete the most recently copied buffer of text.
302: .It .
303: Prompt for an index to move the current window.
304: .It 0 to 9
305: Select windows 0 to 9.
306: .It :
307: Enter the
308: .Nm
309: command prompt.
1.187 nicm 310: .It ;
311: Move to the previously active pane.
1.178 nicm 312: .It =
313: Choose which buffer to paste interactively from a list.
1.171 nicm 314: .It \&?
315: List all key bindings.
316: .It D
317: Choose a client to detach.
1.412 nicm 318: .It L
319: Switch the attached client back to the last session.
1.182 jmc 320: .It \&[
1.171 nicm 321: Enter copy mode to copy text or view the history.
1.182 jmc 322: .It \&]
1.171 nicm 323: Paste the most recently copied buffer of text.
1.64 nicm 324: .It c
1.65 nicm 325: Create a new window.
1.64 nicm 326: .It d
1.65 nicm 327: Detach the current client.
1.171 nicm 328: .It f
329: Prompt to search for text in open windows.
330: .It i
331: Display some information about the current window.
1.64 nicm 332: .It l
1.65 nicm 333: Move to the previously selected window.
1.684 nicm 334: .It m
335: Mark the current pane (see
336: .Ic select-pane
337: .Fl m ) .
338: .It M
339: Clear the marked pane.
1.64 nicm 340: .It n
1.65 nicm 341: Change to the next window.
1.171 nicm 342: .It o
343: Select the next pane in the current window.
1.64 nicm 344: .It p
1.65 nicm 345: Change to the previous window.
1.171 nicm 346: .It q
347: Briefly display pane indexes.
348: .It r
349: Force redraw of the attached client.
350: .It s
351: Select a new session for the attached client interactively.
352: .It t
353: Show the time.
354: .It w
355: Choose the current window interactively.
356: .It x
357: Kill the current pane.
1.412 nicm 358: .It z
359: Toggle zoom state of the current pane.
1.171 nicm 360: .It {
361: Swap the current pane with the previous pane.
362: .It }
363: Swap the current pane with the next pane.
364: .It ~
365: Show previous messages from
366: .Nm ,
367: if any.
368: .It Page Up
369: Enter copy mode and scroll one page up.
370: .It Up, Down
371: .It Left, Right
372: Change to the pane above, below, to the left, or to the right of the current
373: pane.
374: .It M-1 to M-5
375: Arrange panes in one of the five preset layouts: even-horizontal,
376: even-vertical, main-horizontal, main-vertical, or tiled.
1.412 nicm 377: .It Space
378: Arrange the current window in the next preset layout.
1.171 nicm 379: .It M-n
380: Move to the next window with a bell or activity marker.
381: .It M-o
382: Rotate the panes in the current window backwards.
383: .It M-p
384: Move to the previous window with a bell or activity marker.
385: .It C-Up, C-Down
386: .It C-Left, C-Right
387: Resize the current pane in steps of one cell.
388: .It M-Up, M-Down
389: .It M-Left, M-Right
390: Resize the current pane in steps of five cells.
1.64 nicm 391: .El
392: .Pp
393: Key bindings may be changed with the
394: .Ic bind-key
395: and
396: .Ic unbind-key
397: commands.
1.651 nicm 398: .Sh COMMAND PARSING AND EXECUTION
399: .Nm
400: supports a large number of commands which can be used to control its
401: behaviour.
402: Each command is named and can accept zero or more flags and arguments.
403: They may be bound to a key with the
404: .Ic bind-key
405: command or run from the shell prompt, a shell script, a configuration file or
406: the command prompt.
407: For example, the same
408: .Ic set-option
409: command run from the shell prompt, from
410: .Pa ~/.tmux.conf
411: and bound to a key may look like:
412: .Bd -literal -offset indent
413: $ tmux set-option -g status-style bg=cyan
414:
415: set-option -g status-style bg=cyan
416:
417: bind-key C set-option -g status-style bg=cyan
418: .Ed
419: .Pp
420: Here, the command name is
421: .Ql set-option ,
422: .Ql Fl g
423: is a flag and
424: .Ql status-style
425: and
426: .Ql bg=cyan
427: are arguments.
428: .Pp
429: .Nm
430: distinguishes between command parsing and execution.
431: In order to execute a command,
432: .Nm
433: needs it to be split up into its name and arguments.
434: This is command parsing.
435: If a command is run from the shell, the shell parses it; from inside
436: .Nm
437: or from a configuration file,
438: .Nm
439: does.
440: Examples of when
441: .Nm
442: parses commands are:
443: .Bl -dash -offset indent
444: .It
445: in a configuration file;
446: .It
447: typed at the command prompt (see
448: .Ic command-prompt ) ;
449: .It
450: given to
451: .Ic bind-key ;
452: .It
453: passed as arguments to
454: .Ic if-shell
455: or
456: .Ic confirm-before .
457: .El
458: .Pp
459: To execute commands, each client has a
460: .Ql command queue .
461: A global command queue not attached to any client is used on startup
462: for configuration files like
463: .Pa ~/.tmux.conf .
464: Parsed commands added to the queue are executed in order.
465: Some commands, like
466: .Ic if-shell
467: and
468: .Ic confirm-before ,
469: parse their argument to create a new command which is inserted immediately
470: after themselves.
471: This means that arguments can be parsed twice or more - once when the parent command (such as
472: .Ic if-shell )
473: is parsed and again when it parses and executes its command.
474: Commands like
475: .Ic if-shell ,
476: .Ic run-shell
477: and
478: .Ic display-panes
479: stop execution of subsequent commands on the queue until something happens -
480: .Ic if-shell
481: and
482: .Ic run-shell
483: until a shell command finishes and
484: .Ic display-panes
485: until a key is pressed.
486: For example, the following commands:
487: .Bd -literal -offset indent
488: new-session; new-window
489: if-shell "true" "split-window"
490: kill-session
491: .Ed
492: .Pp
493: Will execute
494: .Ic new-session ,
495: .Ic new-window ,
496: .Ic if-shell ,
497: the shell command
498: .Xr true 1 ,
1.671 nicm 499: .Ic split-window
1.651 nicm 500: and
501: .Ic kill-session
502: in that order.
503: .Pp
504: The
505: .Sx COMMANDS
506: section lists the
507: .Nm
508: commands and their arguments.
509: .Sh PARSING SYNTAX
510: This section describes the syntax of commands parsed by
511: .Nm ,
512: for example in a configuration file or at the command prompt.
1.671 nicm 513: Note that when commands are entered into the shell, they are parsed by the shell
1.651 nicm 514: - see for example
515: .Xr ksh 1
516: or
517: .Xr csh 1 .
518: .Pp
519: Each command is terminated by a newline or a semicolon (;).
520: Commands separated by semicolons together form a
521: .Ql command sequence
522: - if a command in the sequence encounters an error, no subsequent commands are
523: executed.
1.825 nicm 524: .Pp
525: It is recommended that a semicolon used as a command separator should be
526: written as an individual token, for example from
527: .Xr sh 1 :
528: .Bd -literal -offset indent
529: $ tmux neww \\; splitw
530: .Ed
531: .Pp
532: Or:
533: .Bd -literal -offset indent
534: $ tmux neww ';' splitw
535: .Ed
536: .Pp
537: Or from the tmux command prompt:
538: .Bd -literal -offset indent
539: neww ; splitw
540: .Ed
541: .Pp
542: However, a trailing semicolon is also interpreted as a command separator,
543: for example in these
544: .Xr sh 1
545: commands:
546: .Bd -literal -offset indent
1.826 jmc 547: $ tmux neww\e\e; splitw
1.825 nicm 548: .Ed
549: .Pp
550: Or:
551: .Bd -literal -offset indent
552: $ tmux 'neww;' splitw
553: .Ed
554: .Pp
555: As in these examples, when running tmux from the shell extra care must be taken
556: to properly quote semicolons:
557: .Bl -enum -offset Ds
558: .It
559: Semicolons that should be interpreted as a command separator
560: should be escaped according to the shell conventions.
561: For
562: .Xr sh 1
563: this typically means quoted (such as
564: .Ql neww ';' splitw )
565: or escaped (such as
1.826 jmc 566: .Ql neww \e\e\e\e; splitw ) .
1.825 nicm 567: .It
568: Individual semicolons or trailing semicolons that should be interpreted as
569: arguments should be escaped twice: once according to the shell conventions and
570: a second time for
571: .Nm ;
572: for example:
573: .Bd -literal -offset indent
1.826 jmc 574: $ tmux neww 'foo\e\e;' bar
575: $ tmux neww foo\e\e\e\e; bar
1.825 nicm 576: .Ed
577: .It
578: Semicolons that are not individual tokens or trailing another token should only
579: be escaped once according to shell conventions; for example:
580: .Bd -literal -offset indent
581: $ tmux neww 'foo-;-bar'
1.826 jmc 582: $ tmux neww foo-\e\e;-bar
1.825 nicm 583: .Ed
584: .El
1.651 nicm 585: .Pp
586: Comments are marked by the unquoted # character - any remaining text after a
587: comment is ignored until the end of the line.
588: .Pp
589: If the last character of a line is \e, the line is joined with the following
590: line (the \e and the newline are completely removed).
591: This is called line continuation and applies both inside and outside quoted
1.656 nicm 592: strings and in comments, but not inside braces.
1.651 nicm 593: .Pp
1.655 nicm 594: Command arguments may be specified as strings surrounded by single (') quotes,
595: double quotes (") or braces ({}).
1.651 nicm 596: .\" "
597: This is required when the argument contains any special character.
1.655 nicm 598: Single and double quoted strings cannot span multiple lines except with line
599: continuation.
600: Braces can span multiple lines.
1.651 nicm 601: .Pp
602: Outside of quotes and inside double quotes, these replacements are performed:
603: .Bl -dash -offset indent
604: .It
605: Environment variables preceded by $ are replaced with their value from the
606: global environment (see the
607: .Sx GLOBAL AND SESSION ENVIRONMENT
608: section).
609: .It
610: A leading ~ or ~user is expanded to the home directory of the current or
611: specified user.
612: .It
613: \euXXXX or \euXXXXXXXX is replaced by the Unicode codepoint corresponding to
614: the given four or eight digit hexadecimal number.
615: .It
616: When preceded (escaped) by a \e, the following characters are replaced: \ee by
617: the escape character; \er by a carriage return; \en by a newline; and \et by a
618: tab.
1.660 nicm 619: .It
620: \eooo is replaced by a character of the octal value ooo.
621: Three octal digits are required, for example \e001.
622: The largest valid character is \e377.
623: .It
1.651 nicm 624: Any other characters preceded by \e are replaced by themselves (that is, the \e
625: is removed) and are not treated as having any special meaning - so for example
626: \e; will not mark a command sequence and \e$ will not expand an environment
627: variable.
628: .El
629: .Pp
1.776 nicm 630: Braces are parsed as a configuration file (so conditions such as
631: .Ql %if
632: are processed) and then converted into a string.
633: They are designed to avoid the need for additional escaping when passing a
634: group of
1.655 nicm 635: .Nm
1.776 nicm 636: commands as an argument (for example to
637: .Ic if-shell ) .
1.655 nicm 638: These two examples produce an identical command - note that no escaping is
639: needed when using {}:
640: .Bd -literal -offset indent
641: if-shell true {
642: display -p 'brace-dollar-foo: }$foo'
643: }
644:
1.776 nicm 645: if-shell true "display -p 'brace-dollar-foo: }\e$foo'"
1.655 nicm 646: .Ed
647: .Pp
648: Braces may be enclosed inside braces, for example:
649: .Bd -literal -offset indent
650: bind x if-shell "true" {
651: if-shell "true" {
1.706 nicm 652: display "true!"
1.655 nicm 653: }
654: }
655: .Ed
656: .Pp
1.651 nicm 657: Environment variables may be set by using the syntax
658: .Ql name=value ,
659: for example
660: .Ql HOME=/home/user .
661: Variables set during parsing are added to the global environment.
1.728 nicm 662: A hidden variable may be set with
663: .Ql %hidden ,
664: for example:
665: .Bd -literal -offset indent
666: %hidden MYVAR=42
667: .Ed
668: .Pp
669: Hidden variables are not passed to the environment of processes created
670: by tmux.
671: See the
672: .Sx GLOBAL AND SESSION ENVIRONMENT
673: section.
1.651 nicm 674: .Pp
675: Commands may be parsed conditionally by surrounding them with
676: .Ql %if ,
677: .Ql %elif ,
678: .Ql %else
679: and
680: .Ql %endif .
681: The argument to
682: .Ql %if
683: and
684: .Ql %elif
685: is expanded as a format (see
686: .Sx FORMATS )
687: and if it evaluates to false (zero or empty), subsequent text is ignored until
688: the closing
689: .Ql %elif ,
690: .Ql %else
691: or
692: .Ql %endif .
693: For example:
694: .Bd -literal -offset indent
1.666 nicm 695: %if "#{==:#{host},myhost}"
1.651 nicm 696: set -g status-style bg=red
1.666 nicm 697: %elif "#{==:#{host},myotherhost}"
1.651 nicm 698: set -g status-style bg=green
699: %else
700: set -g status-style bg=blue
701: %endif
702: .Ed
703: .Pp
704: Will change the status line to red if running on
705: .Ql myhost ,
706: green if running on
707: .Ql myotherhost ,
708: or blue if running on another host.
709: Conditionals may be given on one line, for example:
710: .Bd -literal -offset indent
711: %if #{==:#{host},myhost} set -g status-style bg=red %endif
712: .Ed
1.57 jmc 713: .Sh COMMANDS
1.651 nicm 714: This section describes the commands supported by
1.57 jmc 715: .Nm .
716: Most commands accept the optional
717: .Fl t
1.432 nicm 718: (and sometimes
719: .Fl s )
1.57 jmc 720: argument with one of
721: .Ar target-client ,
1.678 nicm 722: .Ar target-session ,
1.57 jmc 723: .Ar target-window ,
724: or
725: .Ar target-pane .
726: These specify the client, session, window or pane which a command should affect.
1.423 nicm 727: .Pp
1.57 jmc 728: .Ar target-client
1.540 nicm 729: should be the name of the client,
730: typically the
1.57 jmc 731: .Xr pty 4
732: file to which the client is connected, for example either of
733: .Pa /dev/ttyp1
734: or
735: .Pa ttyp1
736: for the client attached to
737: .Pa /dev/ttyp1 .
1.423 nicm 738: If no client is specified,
739: .Nm
740: attempts to work out the client currently in use; if that fails, an error is
741: reported.
1.57 jmc 742: Clients may be listed with the
743: .Ic list-clients
744: command.
1.1 nicm 745: .Pp
1.57 jmc 746: .Ar target-session
1.423 nicm 747: is tried as, in order:
748: .Bl -enum -offset Ds
749: .It
750: A session ID prefixed with a $.
751: .It
752: An exact name of a session (as listed by the
1.57 jmc 753: .Ic list-sessions
1.423 nicm 754: command).
755: .It
756: The start of a session name, for example
757: .Ql mysess
758: would match a session named
759: .Ql mysession .
760: .It
761: An
1.57 jmc 762: .Xr fnmatch 3
1.423 nicm 763: pattern which is matched against the session name.
764: .El
765: .Pp
1.441 nicm 766: If the session name is prefixed with an
767: .Ql = ,
1.435 nicm 768: only an exact match is accepted (so
769: .Ql =mysess
770: will only match exactly
771: .Ql mysess ,
772: not
773: .Ql mysession ) .
1.441 nicm 774: .Pp
1.423 nicm 775: If a single session is found, it is used as the target session; multiple matches
1.57 jmc 776: produce an error.
777: If a session is omitted, the current session is used if available; if no
1.117 nicm 778: current session is available, the most recently used is chosen.
1.1 nicm 779: .Pp
1.57 jmc 780: .Ar target-window
1.472 nicm 781: (or
782: .Ar src-window
783: or
784: .Ar dst-window )
1.57 jmc 785: specifies a window in the form
786: .Em session Ns \&: Ns Em window .
787: .Em session
788: follows the same rules as for
789: .Ar target-session ,
790: and
791: .Em window
1.423 nicm 792: is looked for in order as:
793: .Bl -enum -offset Ds
794: .It
795: A special token, listed below.
796: .It
797: A window index, for example
798: .Ql mysession:1
799: is window 1 in session
800: .Ql mysession .
801: .It
802: A window ID, such as @1.
803: .It
804: An exact window name, such as
805: .Ql mysession:mywindow .
806: .It
807: The start of a window name, such as
808: .Ql mysession:mywin .
809: .It
810: As an
1.57 jmc 811: .Xr fnmatch 3
1.423 nicm 812: pattern matched against the window name.
813: .El
814: .Pp
1.435 nicm 815: Like sessions, a
816: .Ql =
817: prefix will do an exact match only.
1.57 jmc 818: An empty window name specifies the next unused index if appropriate (for
819: example the
820: .Ic new-window
821: and
822: .Ic link-window
823: commands)
824: otherwise the current window in
825: .Em session
826: is chosen.
1.423 nicm 827: .Pp
1.424 nicm 828: The following special tokens are available to indicate particular windows.
829: Each has a single-character alternative form.
1.423 nicm 830: .Bl -column "XXXXXXXXXX" "X"
831: .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
832: .It Li "{start}" Ta "^" Ta "The lowest-numbered window"
833: .It Li "{end}" Ta "$" Ta "The highest-numbered window"
834: .It Li "{last}" Ta "!" Ta "The last (previously current) window"
835: .It Li "{next}" Ta "+" Ta "The next window by number"
836: .It Li "{previous}" Ta "-" Ta "The previous window by number"
837: .El
1.1 nicm 838: .Pp
1.57 jmc 839: .Ar target-pane
1.472 nicm 840: (or
841: .Ar src-pane
842: or
843: .Ar dst-pane )
844: may be a pane ID or takes a similar form to
1.57 jmc 845: .Ar target-window
1.423 nicm 846: but with the optional addition of a period followed by a pane index or pane ID,
847: for example:
848: .Ql mysession:mywindow.1 .
1.57 jmc 849: If the pane index is omitted, the currently active pane in the specified
850: window is used.
1.423 nicm 851: The following special tokens are available for the pane index:
852: .Bl -column "XXXXXXXXXXXXXX" "X"
853: .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
854: .It Li "{last}" Ta "!" Ta "The last (previously active) pane"
855: .It Li "{next}" Ta "+" Ta "The next pane by number"
856: .It Li "{previous}" Ta "-" Ta "The previous pane by number"
857: .It Li "{top}" Ta "" Ta "The top pane"
858: .It Li "{bottom}" Ta "" Ta "The bottom pane"
859: .It Li "{left}" Ta "" Ta "The leftmost pane"
860: .It Li "{right}" Ta "" Ta "The rightmost pane"
861: .It Li "{top-left}" Ta "" Ta "The top-left pane"
862: .It Li "{top-right}" Ta "" Ta "The top-right pane"
863: .It Li "{bottom-left}" Ta "" Ta "The bottom-left pane"
864: .It Li "{bottom-right}" Ta "" Ta "The bottom-right pane"
1.447 nicm 865: .It Li "{up-of}" Ta "" Ta "The pane above the active pane"
866: .It Li "{down-of}" Ta "" Ta "The pane below the active pane"
867: .It Li "{left-of}" Ta "" Ta "The pane to the left of the active pane"
868: .It Li "{right-of}" Ta "" Ta "The pane to the right of the active pane"
1.423 nicm 869: .El
1.177 nicm 870: .Pp
1.423 nicm 871: The tokens
1.177 nicm 872: .Ql +
873: and
874: .Ql -
875: may be followed by an offset, for example:
876: .Bd -literal -offset indent
877: select-window -t:+2
878: .Ed
879: .Pp
1.432 nicm 880: In addition,
881: .Em target-session ,
882: .Em target-window
883: or
884: .Em target-pane
885: may consist entirely of the token
886: .Ql {mouse}
887: (alternative form
888: .Ql = )
1.678 nicm 889: to specify the session, window or pane where the most recent mouse event occurred
1.432 nicm 890: (see the
891: .Sx MOUSE SUPPORT
892: section)
893: or
894: .Ql {marked}
895: (alternative form
896: .Ql ~ )
897: to specify the marked pane (see
898: .Ic select-pane
899: .Fl m ) .
900: .Pp
1.423 nicm 901: Sessions, window and panes are each numbered with a unique ID; session IDs are
902: prefixed with a
903: .Ql $ ,
904: windows with a
905: .Ql @ ,
906: and panes with a
907: .Ql % .
908: These are unique and are unchanged for the life of the session, window or pane
909: in the
1.212 nicm 910: .Nm
1.423 nicm 911: server.
912: The pane ID is passed to the child process of the pane in the
1.212 nicm 913: .Ev TMUX_PANE
914: environment variable.
1.423 nicm 915: IDs may be displayed using the
916: .Ql session_id ,
917: .Ql window_id ,
918: or
919: .Ql pane_id
920: formats (see the
921: .Sx FORMATS
922: section) and the
923: .Ic display-message ,
924: .Ic list-sessions ,
925: .Ic list-windows
926: or
927: .Ic list-panes
928: commands.
1.15 jmc 929: .Pp
1.153 nicm 930: .Ar shell-command
931: arguments are
932: .Xr sh 1
933: commands.
1.394 nicm 934: This may be a single argument passed to the shell, for example:
1.153 nicm 935: .Bd -literal -offset indent
1.821 nicm 936: new-window 'vi ~/.tmux.conf'
1.153 nicm 937: .Ed
1.394 nicm 938: .Pp
939: Will run:
940: .Bd -literal -offset indent
1.821 nicm 941: /bin/sh -c 'vi ~/.tmux.conf'
1.394 nicm 942: .Ed
943: .Pp
944: Additionally, the
945: .Ic new-window ,
946: .Ic new-session ,
947: .Ic split-window ,
948: .Ic respawn-window
949: and
950: .Ic respawn-pane
951: commands allow
952: .Ar shell-command
953: to be given as multiple arguments and executed directly (without
954: .Ql sh -c ) .
955: This can avoid issues with shell quoting.
956: For example:
957: .Bd -literal -offset indent
1.821 nicm 958: $ tmux new-window vi ~/.tmux.conf
1.394 nicm 959: .Ed
960: .Pp
961: Will run
962: .Xr vi 1
963: directly without invoking the shell.
1.153 nicm 964: .Pp
965: .Ar command
966: .Op Ar arguments
967: refers to a
968: .Nm
1.655 nicm 969: command, either passed with the command and arguments separately, for example:
1.153 nicm 970: .Bd -literal -offset indent
1.629 nicm 971: bind-key F1 set-option status off
1.153 nicm 972: .Ed
973: .Pp
1.655 nicm 974: Or passed as a single string argument in
975: .Pa .tmux.conf ,
976: for example:
1.153 nicm 977: .Bd -literal -offset indent
1.655 nicm 978: bind-key F1 { set-option status off }
1.153 nicm 979: .Ed
980: .Pp
981: Example
982: .Nm
983: commands include:
1.13 nicm 984: .Bd -literal -offset indent
1.57 jmc 985: refresh-client -t/dev/ttyp2
986:
987: rename-session -tfirst newname
988:
1.668 nicm 989: set-option -wt:0 monitor-activity on
1.57 jmc 990:
991: new-window ; split-window -d
1.244 nicm 992:
993: bind-key R source-file ~/.tmux.conf \e; \e
994: display-message "source-file done"
1.13 nicm 995: .Ed
1.153 nicm 996: .Pp
997: Or from
998: .Xr sh 1 :
999: .Bd -literal -offset indent
1000: $ tmux kill-window -t :1
1001:
1.159 jmc 1002: $ tmux new-window \e; split-window -d
1.153 nicm 1003:
1.821 nicm 1004: $ tmux new-session -d 'vi ~/.tmux.conf' \e; split-window -d \e; attach
1.153 nicm 1005: .Ed
1.57 jmc 1006: .Sh CLIENTS AND SESSIONS
1.153 nicm 1007: The
1008: .Nm
1009: server manages clients, sessions, windows and panes.
1010: Clients are attached to sessions to interact with them, either
1011: when they are created with the
1012: .Ic new-session
1013: command, or later with the
1014: .Ic attach-session
1015: command.
1.188 nicm 1016: Each session has one or more windows
1.153 nicm 1017: .Em linked
1018: into it.
1019: Windows may be linked to multiple sessions and are made up of one or
1020: more panes,
1021: each of which contains a pseudo terminal.
1022: Commands for creating, linking and otherwise manipulating windows
1023: are covered
1024: in the
1025: .Sx WINDOWS AND PANES
1026: section.
1027: .Pp
1028: The following commands are available to manage clients and sessions:
1.57 jmc 1029: .Bl -tag -width Ds
1.858 kn 1030: .Tg attach
1.57 jmc 1031: .It Xo Ic attach-session
1.662 nicm 1032: .Op Fl dErx
1.372 nicm 1033: .Op Fl c Ar working-directory
1.762 nicm 1034: .Op Fl f Ar flags
1.57 jmc 1035: .Op Fl t Ar target-session
1036: .Xc
1.870 kn 1037: .D1 Pq alias: Ic attach
1.57 jmc 1038: If run from outside
1039: .Nm ,
1040: create a new client in the current terminal and attach it to
1041: .Ar target-session .
1042: If used from inside, switch the current client.
1043: If
1044: .Fl d
1045: is specified, any other clients attached to the session are detached.
1.662 nicm 1046: If
1047: .Fl x
1.703 nicm 1048: is given, send
1049: .Dv SIGHUP
1050: to the parent process of the client as well as
1.662 nicm 1051: detaching the client, typically causing it to exit.
1.762 nicm 1052: .Fl f
1053: sets a comma-separated list of client flags.
1054: The flags are:
1055: .Bl -tag -width Ds
1.778 nicm 1056: .It active-pane
1057: the client has an independent active pane
1.762 nicm 1058: .It ignore-size
1059: the client does not affect the size of other clients
1060: .It no-output
1061: the client does not receive pane output in control mode
1.778 nicm 1062: .It pause-after=seconds
1063: output is paused once the pane is
1064: .Ar seconds
1065: behind in control mode
1066: .It read-only
1067: the client is read-only
1.786 nicm 1068: .It wait-exit
1069: wait for an empty line input before exiting in control mode
1.762 nicm 1070: .El
1071: .Pp
1072: A leading
1.799 tim 1073: .Ql \&!
1.762 nicm 1074: turns a flag off if the client is already attached.
1.148 nicm 1075: .Fl r
1.762 nicm 1076: is an alias for
1077: .Fl f
1078: .Ar read-only,ignore-size .
1079: When a client is read-only, only keys bound to the
1.148 nicm 1080: .Ic detach-client
1.242 nicm 1081: or
1082: .Ic switch-client
1.762 nicm 1083: commands have any effect.
1.769 nicm 1084: A client with the
1085: .Ar active-pane
1086: flag allows the active pane to be selected independently of the window's active
1087: pane used by clients without the flag.
1088: This only affects the cursor position and commands issued from the client;
1089: other features such as hooks and styles continue to use the window's active
1090: pane.
1.13 nicm 1091: .Pp
1.57 jmc 1092: If no server is started,
1093: .Ic attach-session
1094: will attempt to start it; this will fail unless sessions are created in the
1095: configuration file.
1.217 nicm 1096: .Pp
1097: The
1098: .Ar target-session
1099: rules for
1100: .Ic attach-session
1101: are slightly adjusted: if
1102: .Nm
1103: needs to select the most recently used session, it will prefer the most
1104: recently used
1105: .Em unattached
1106: session.
1.372 nicm 1107: .Pp
1108: .Fl c
1109: will set the session working directory (used for new windows) to
1110: .Ar working-directory .
1.436 nicm 1111: .Pp
1112: If
1113: .Fl E
1.480 nicm 1114: is used, the
1.436 nicm 1115: .Ic update-environment
1116: option will not be applied.
1.858 kn 1117: .Tg detach
1.211 nicm 1118: .It Xo Ic detach-client
1.463 nicm 1119: .Op Fl aP
1.525 nicm 1120: .Op Fl E Ar shell-command
1.219 nicm 1121: .Op Fl s Ar target-session
1.211 nicm 1122: .Op Fl t Ar target-client
1123: .Xc
1.870 kn 1124: .D1 Pq alias: Ic detach
1.218 nicm 1125: Detach the current client if bound to a key, the client specified with
1126: .Fl t ,
1.258 jmc 1127: or all clients currently attached to the session specified by
1.218 nicm 1128: .Fl s .
1.296 nicm 1129: The
1130: .Fl a
1131: option kills all but the client given with
1132: .Fl t .
1.211 nicm 1133: If
1134: .Fl P
1.703 nicm 1135: is given, send
1136: .Dv SIGHUP
1137: to the parent process of the client, typically causing it
1.211 nicm 1138: to exit.
1.525 nicm 1139: With
1140: .Fl E ,
1141: run
1142: .Ar shell-command
1143: to replace the client.
1.858 kn 1144: .Tg has
1.57 jmc 1145: .It Ic has-session Op Fl t Ar target-session
1.870 kn 1146: .D1 Pq alias: Ic has
1.57 jmc 1147: Report an error and exit with 1 if the specified session does not exist.
1148: If it does exist, exit with 0.
1149: .It Ic kill-server
1150: Kill the
1.1 nicm 1151: .Nm
1.57 jmc 1152: server and clients and destroy all sessions.
1.369 nicm 1153: .It Xo Ic kill-session
1.464 nicm 1154: .Op Fl aC
1.297 nicm 1155: .Op Fl t Ar target-session
1.369 nicm 1156: .Xc
1.57 jmc 1157: Destroy the given session, closing any windows linked to it and no other
1158: sessions, and detaching all clients attached to it.
1.297 nicm 1159: If
1160: .Fl a
1161: is given, all sessions but the specified one is killed.
1.464 nicm 1162: The
1163: .Fl C
1.467 nicm 1164: flag clears alerts (bell, activity, or silence) in all windows linked to the
1.464 nicm 1165: session.
1.858 kn 1166: .Tg lsc
1.250 nicm 1167: .It Xo Ic list-clients
1168: .Op Fl F Ar format
1169: .Op Fl t Ar target-session
1170: .Xc
1.870 kn 1171: .D1 Pq alias: Ic lsc
1.221 jmc 1172: List all clients attached to the server.
1.250 nicm 1173: For the meaning of the
1174: .Fl F
1175: flag, see the
1.252 jmc 1176: .Sx FORMATS
1177: section.
1.221 jmc 1178: If
1.220 nicm 1179: .Ar target-session
1180: is specified, list only clients connected to that session.
1.858 kn 1181: .Tg lscm
1.489 nicm 1182: .It Xo Ic list-commands
1183: .Op Fl F Ar format
1.731 nicm 1184: .Op Ar command
1.489 nicm 1185: .Xc
1.870 kn 1186: .D1 Pq alias: Ic lscm
1.731 nicm 1187: List the syntax of
1188: .Ar command
1189: or - if omitted - of all commands supported by
1.57 jmc 1190: .Nm .
1.858 kn 1191: .Tg ls
1.738 nicm 1192: .It Xo Ic list-sessions
1193: .Op Fl F Ar format
1194: .Op Fl f Ar filter
1195: .Xc
1.870 kn 1196: .D1 Pq alias: Ic ls
1.57 jmc 1197: List all sessions managed by the server.
1.247 nicm 1198: .Fl F
1.738 nicm 1199: specifies the format of each line and
1200: .Fl f
1201: a filter.
1202: Only sessions for which the filter is true are shown.
1203: See the
1.247 nicm 1204: .Sx FORMATS
1205: section.
1.858 kn 1206: .Tg lockc
1.175 nicm 1207: .It Ic lock-client Op Fl t Ar target-client
1.870 kn 1208: .D1 Pq alias: Ic lockc
1.92 nicm 1209: Lock
1210: .Ar target-client ,
1211: see the
1212: .Ic lock-server
1213: command.
1.858 kn 1214: .Tg locks
1.175 nicm 1215: .It Ic lock-session Op Fl t Ar target-session
1.870 kn 1216: .D1 Pq alias: Ic locks
1.92 nicm 1217: Lock all clients attached to
1218: .Ar target-session .
1.858 kn 1219: .Tg new
1.57 jmc 1220: .It Xo Ic new-session
1.662 nicm 1221: .Op Fl AdDEPX
1.371 nicm 1222: .Op Fl c Ar start-directory
1.760 nicm 1223: .Op Fl e Ar environment
1.762 nicm 1224: .Op Fl f Ar flags
1.351 nicm 1225: .Op Fl F Ar format
1.57 jmc 1226: .Op Fl n Ar window-name
1227: .Op Fl s Ar session-name
1.536 nicm 1228: .Op Fl t Ar group-name
1.210 nicm 1229: .Op Fl x Ar width
1230: .Op Fl y Ar height
1.153 nicm 1231: .Op Ar shell-command
1.57 jmc 1232: .Xc
1.870 kn 1233: .D1 Pq alias: Ic new
1.57 jmc 1234: Create a new session with name
1235: .Ar session-name .
1.153 nicm 1236: .Pp
1.57 jmc 1237: The new session is attached to the current terminal unless
1238: .Fl d
1239: is given.
1240: .Ar window-name
1.1 nicm 1241: and
1.153 nicm 1242: .Ar shell-command
1243: are the name of and shell command to execute in the initial window.
1.552 nicm 1244: With
1245: .Fl d ,
1.642 nicm 1246: the initial size comes from the global
1247: .Ic default-size
1248: option;
1.210 nicm 1249: .Fl x
1250: and
1251: .Fl y
1.602 nicm 1252: can be used to specify a different size.
1253: .Ql -
1254: uses the size of the current client if any.
1.642 nicm 1255: If
1256: .Fl x
1257: or
1258: .Fl y
1259: is given, the
1260: .Ic default-size
1261: option is set for the session.
1.762 nicm 1262: .Fl f
1263: sets a comma-separated list of client flags (see
1264: .Ic attach-session ) .
1.68 nicm 1265: .Pp
1266: If run from a terminal, any
1267: .Xr termios 4
1268: special characters are saved and used for new windows in the new session.
1.338 nicm 1269: .Pp
1270: The
1271: .Fl A
1272: flag makes
1273: .Ic new-session
1274: behave like
1275: .Ic attach-session
1276: if
1277: .Ar session-name
1.416 nicm 1278: already exists; in this case,
1.338 nicm 1279: .Fl D
1280: behaves like
1281: .Fl d
1.662 nicm 1282: to
1283: .Ic attach-session ,
1284: and
1285: .Fl X
1286: behaves like
1287: .Fl x
1.338 nicm 1288: to
1289: .Ic attach-session .
1.101 nicm 1290: .Pp
1291: If
1292: .Fl t
1.536 nicm 1293: is given, it specifies a
1294: .Ic session group .
1295: Sessions in the same group share the same set of windows - new windows are
1.537 nicm 1296: linked to all sessions in the group and any windows closed removed from all
1.536 nicm 1297: sessions.
1.101 nicm 1298: The current and previous window and any session options remain independent and
1.536 nicm 1299: any session in a group may be killed without affecting the others.
1300: The
1301: .Ar group-name
1302: argument may be:
1303: .Bl -enum -width Ds
1304: .It
1305: the name of an existing group, in which case the new session is added to that
1306: group;
1307: .It
1308: the name of an existing session - the new session is added to the same group
1309: as that session, creating a new group if necessary;
1310: .It
1311: the name for a new group containing only the new session.
1312: .El
1313: .Pp
1.101 nicm 1314: .Fl n
1.480 nicm 1315: and
1.153 nicm 1316: .Ar shell-command
1.101 nicm 1317: are invalid if
1318: .Fl t
1319: is used.
1.351 nicm 1320: .Pp
1321: The
1322: .Fl P
1323: option prints information about the new session after it has been created.
1324: By default, it uses the format
1.683 nicm 1325: .Ql #{session_name}:\&
1.351 nicm 1326: but a different format may be specified with
1327: .Fl F .
1.436 nicm 1328: .Pp
1329: If
1330: .Fl E
1.480 nicm 1331: is used, the
1.436 nicm 1332: .Ic update-environment
1333: option will not be applied.
1.760 nicm 1334: .Fl e
1335: takes the form
1336: .Ql VARIABLE=value
1337: and sets an environment variable for the newly created session; it may be
1338: specified multiple times.
1.858 kn 1339: .Tg refresh
1.248 nicm 1340: .It Xo Ic refresh-client
1.881 nicm 1341: .Op Fl cDLRSU
1.773 nicm 1342: .Op Fl A Ar pane:state
1.788 nicm 1343: .Op Fl B Ar name:what:format
1.855 nicm 1344: .Op Fl C Ar size
1.762 nicm 1345: .Op Fl f Ar flags
1.881 nicm 1346: .Op Fl l Op Ar target-pane
1.248 nicm 1347: .Op Fl t Ar target-client
1.613 nicm 1348: .Op Ar adjustment
1.248 nicm 1349: .Xc
1.870 kn 1350: .D1 Pq alias: Ic refresh
1.57 jmc 1351: Refresh the current client if bound to a key, or a single client if one is given
1352: with
1353: .Fl t .
1.248 nicm 1354: If
1355: .Fl S
1.538 nicm 1356: is specified, only update the client's status line.
1.535 nicm 1357: .Pp
1.642 nicm 1358: The
1359: .Fl U ,
1360: .Fl D ,
1361: .Fl L
1362: .Fl R ,
1363: and
1364: .Fl c
1365: flags allow the visible portion of a window which is larger than the client
1366: to be changed.
1367: .Fl U
1368: moves the visible part up by
1369: .Ar adjustment
1370: rows and
1371: .Fl D
1372: down,
1373: .Fl L
1374: left by
1375: .Ar adjustment
1376: columns and
1377: .Fl R
1378: right.
1379: .Fl c
1380: returns to tracking the cursor automatically.
1381: If
1382: .Ar adjustment
1383: is omitted, 1 is used.
1384: Note that the visible position is a property of the client not of the
1385: window, changing the current window in the attached session will reset
1386: it.
1387: .Pp
1.535 nicm 1388: .Fl C
1.855 nicm 1389: sets the width and height of a control mode client or of a window for a
1390: control mode client,
1391: .Ar size
1392: must be one of
1393: .Ql widthxheight
1394: or
1395: .Ql window ID:widthxheight ,
1396: for example
1397: .Ql 80x24
1398: or
1399: .Ql @0:80x24 .
1.773 nicm 1400: .Fl A
1.778 nicm 1401: allows a control mode client to trigger actions on a pane.
1.773 nicm 1402: The argument is a pane ID (with leading
1403: .Ql % ) ,
1404: a colon, then one of
1.778 nicm 1405: .Ql on ,
1.781 nicm 1406: .Ql off ,
1407: .Ql continue
1.773 nicm 1408: or
1.781 nicm 1409: .Ql pause .
1.773 nicm 1410: If
1411: .Ql off ,
1412: .Nm
1413: will not send output from the pane to the client and if all clients have turned
1414: the pane off, will stop reading from the pane.
1.778 nicm 1415: If
1416: .Ql continue ,
1417: .Nm
1.781 nicm 1418: will return to sending output to the pane if it was paused (manually or with the
1.778 nicm 1419: .Ar pause-after
1420: flag).
1.781 nicm 1421: If
1422: .Ql pause ,
1423: .Nm
1424: will pause the pane.
1.773 nicm 1425: .Fl A
1.778 nicm 1426: may be given multiple times for different panes.
1.773 nicm 1427: .Pp
1.788 nicm 1428: .Fl B
1429: sets a subscription to a format for a control mode client.
1430: The argument is split into three items by colons:
1431: .Ar name
1432: is a name for the subscription;
1433: .Ar what
1434: is a type of item to subscribe to;
1435: .Ar format
1436: is the format.
1437: After a subscription is added, changes to the format are reported with the
1438: .Ic %subscription-changed
1439: notification, at most once a second.
1440: If only the name is given, the subscription is removed.
1441: .Ar what
1442: may be empty to check the format only for the attached session, or one of:
1443: a pane ID such as
1444: .Ql %0 ;
1445: .Ql %*
1446: for all panes in the attached session;
1.816 jmc 1447: a window ID such as
1.788 nicm 1448: .Ql @0 ;
1449: or
1450: .Ql @*
1451: for all windows in the attached session.
1452: .Pp
1.762 nicm 1453: .Fl f
1454: sets a comma-separated list of client flags, see
1455: .Ic attach-session .
1.677 nicm 1456: .Pp
1.612 nicm 1457: .Fl l
1458: requests the clipboard from the client using the
1459: .Xr xterm 1
1.881 nicm 1460: escape sequence.
1461: If
1462: Ar target-pane
1463: is given, the clipboard is sent (in encoded form), otherwise it is stored in a
1464: new paste buffer.
1.613 nicm 1465: .Pp
1466: .Fl L ,
1467: .Fl R ,
1468: .Fl U
1469: and
1470: .Fl D
1471: move the visible portion of the window left, right, up or down
1472: by
1473: .Ar adjustment ,
1474: if the window is larger than the client.
1475: .Fl c
1476: resets so that the position follows the cursor.
1477: See the
1478: .Ic window-size
1479: option.
1.858 kn 1480: .Tg rename
1.57 jmc 1481: .It Xo Ic rename-session
1482: .Op Fl t Ar target-session
1483: .Ar new-name
1484: .Xc
1.870 kn 1485: .D1 Pq alias: Ic rename
1.57 jmc 1486: Rename the session to
1487: .Ar new-name .
1.888 nicm 1488: .It Xo Ic server-access
1489: .Op Fl adlrw
1490: .Op Ar user
1491: .Xc
1492: Change the access or read/write permission of
1493: .Ar user .
1494: The user running the
1495: .Nm
1496: server (its owner) and the root user cannot be changed and are always
1497: permitted access.
1498: .Pp
1499: .Fl a
1500: and
1501: .Fl d
1502: are used to give or revoke access for the specified user.
1503: If the user is already attached, the
1504: .Fl d
1505: flag causes their clients to be detached.
1506: .Pp
1507: .Fl r
1508: and
1509: .Fl w
1510: change the permissions for
1511: .Ar user :
1512: .Fl r
1513: makes their clients read-only and
1514: .Fl w
1515: writable.
1516: .Fl l
1517: lists current access permissions.
1518: .Pp
1519: By default, the access list is empty and
1520: .Nm
1521: creates sockets with file system permissions preventing access by any user
1522: other than the owner (and root).
1523: These permissions must be changed manually.
1524: Great care should be taken not to allow access to untrusted users even
1525: read-only.
1.858 kn 1526: .Tg showmsgs
1.121 nicm 1527: .It Xo Ic show-messages
1.465 nicm 1528: .Op Fl JT
1.120 nicm 1529: .Op Fl t Ar target-client
1530: .Xc
1.870 kn 1531: .D1 Pq alias: Ic showmsgs
1.764 nicm 1532: Show server messages or information.
1533: Messages are stored, up to a maximum of the limit set by the
1.120 nicm 1534: .Ar message-limit
1.384 nicm 1535: server option.
1.377 nicm 1536: .Fl J
1537: and
1538: .Fl T
1.465 nicm 1539: show debugging information about jobs and terminals.
1.858 kn 1540: .Tg source
1.488 tim 1541: .It Xo Ic source-file
1.793 nicm 1542: .Op Fl Fnqv
1.488 tim 1543: .Ar path
1.659 nicm 1544: .Ar ...
1.488 tim 1545: .Xc
1.870 kn 1546: .D1 Pq alias: Ic source
1.659 nicm 1547: Execute commands from one or more files specified by
1.519 nicm 1548: .Ar path
1.659 nicm 1549: (which may be
1.607 kn 1550: .Xr glob 7
1.659 nicm 1551: patterns).
1.488 tim 1552: If
1.793 nicm 1553: .Fl F
1554: is present, then
1555: .Ar path
1556: is expanded as a format.
1557: If
1.488 tim 1558: .Fl q
1559: is given, no error will be returned if
1560: .Ar path
1561: does not exist.
1.651 nicm 1562: With
1563: .Fl n ,
1564: the file is parsed but no commands are executed.
1.663 nicm 1565: .Fl v
1566: shows the parsed commands and line numbers if possible.
1.858 kn 1567: .Tg start
1.57 jmc 1568: .It Ic start-server
1.870 kn 1569: .D1 Pq alias: Ic start
1.57 jmc 1570: Start the
1.1 nicm 1571: .Nm
1.57 jmc 1572: server, if not already running, without creating any sessions.
1.707 nicm 1573: .Pp
1574: Note that as by default the
1575: .Nm
1576: server will exit with no sessions, this is only useful if a session is created in
1577: .Pa ~/.tmux.conf ,
1578: .Ic exit-empty
1579: is turned off, or another command is run as part of the same command sequence.
1580: For example:
1581: .Bd -literal -offset indent
1582: $ tmux start \\; show -g
1583: .Ed
1.858 kn 1584: .Tg suspendc
1.57 jmc 1585: .It Xo Ic suspend-client
1.202 nicm 1586: .Op Fl t Ar target-client
1.57 jmc 1587: .Xc
1.870 kn 1588: .D1 Pq alias: Ic suspendc
1.57 jmc 1589: Suspend a client by sending
1590: .Dv SIGTSTP
1591: (tty stop).
1.858 kn 1592: .Tg switchc
1.57 jmc 1593: .It Xo Ic switch-client
1.681 nicm 1594: .Op Fl ElnprZ
1.57 jmc 1595: .Op Fl c Ar target-client
1596: .Op Fl t Ar target-session
1.421 nicm 1597: .Op Fl T Ar key-table
1.57 jmc 1598: .Xc
1.870 kn 1599: .D1 Pq alias: Ic switchc
1.57 jmc 1600: Switch the current session for client
1601: .Ar target-client
1602: to
1603: .Ar target-session .
1.635 nicm 1604: As a special case,
1605: .Fl t
1606: may refer to a pane (a target that contains
1.636 jmc 1607: .Ql \&: ,
1608: .Ql \&.
1.635 nicm 1609: or
1.636 jmc 1610: .Ql % ) ,
1.681 nicm 1611: to change session, window and pane.
1612: In that case,
1613: .Fl Z
1614: keeps the window zoomed if it was zoomed.
1.183 nicm 1615: If
1.197 jmc 1616: .Fl l ,
1.183 nicm 1617: .Fl n
1618: or
1619: .Fl p
1.194 nicm 1620: is used, the client is moved to the last, next or previous session
1621: respectively.
1.242 nicm 1622: .Fl r
1.762 nicm 1623: toggles the client
1624: .Ic read-only
1625: and
1626: .Ic ignore-size
1627: flags (see the
1.242 nicm 1628: .Ic attach-session
1629: command).
1.436 nicm 1630: .Pp
1631: If
1632: .Fl E
1633: is used,
1634: .Ic update-environment
1635: option will not be applied.
1.421 nicm 1636: .Pp
1637: .Fl T
1.706 nicm 1638: sets the client's key table; the next key from the client will be interpreted
1639: from
1.421 nicm 1640: .Ar key-table .
1641: This may be used to configure multiple prefix keys, or to bind commands to
1642: sequences of keys.
1643: For example, to make typing
1644: .Ql abc
1645: run the
1646: .Ic list-keys
1647: command:
1648: .Bd -literal -offset indent
1649: bind-key -Ttable2 c list-keys
1650: bind-key -Ttable1 b switch-client -Ttable2
1651: bind-key -Troot a switch-client -Ttable1
1652: .Ed
1.57 jmc 1653: .El
1654: .Sh WINDOWS AND PANES
1.679 nicm 1655: Each window displayed by
1656: .Nm
1657: may be split into one or more
1658: .Em panes ;
1659: each pane takes up a certain area of the display and is a separate terminal.
1660: A window may be split into panes using the
1661: .Ic split-window
1662: command.
1663: Windows may be split horizontally (with the
1664: .Fl h
1665: flag) or vertically.
1666: Panes may be resized with the
1667: .Ic resize-pane
1668: command (bound to
1669: .Ql C-Up ,
1670: .Ql C-Down
1671: .Ql C-Left
1672: and
1673: .Ql C-Right
1674: by default), the current pane may be changed with the
1675: .Ic select-pane
1676: command and the
1677: .Ic rotate-window
1678: and
1679: .Ic swap-pane
1680: commands may be used to swap panes without changing their position.
1681: Panes are numbered beginning from zero in the order they are created.
1682: .Pp
1683: By default, a
1.1 nicm 1684: .Nm
1.679 nicm 1685: pane permits direct access to the terminal contained in the pane.
1686: A pane may also be put into one of several modes:
1687: .Bl -dash -offset indent
1688: .It
1689: Copy mode, which permits a section of a window or its
1.164 nicm 1690: history to be copied to a
1.1 nicm 1691: .Em paste buffer
1692: for later insertion into another window.
1693: This mode is entered with the
1694: .Ic copy-mode
1695: command, bound to
1.113 nicm 1696: .Ql \&[
1.1 nicm 1697: by default.
1.734 nicm 1698: Copied text can be pasted with the
1699: .Ic paste-buffer
1700: command, bound to
1701: .Ql \&] .
1.679 nicm 1702: .It
1703: View mode, which is like copy mode but is entered when a command that produces
1704: output, such as
1.164 nicm 1705: .Ic list-keys ,
1706: is executed from a key binding.
1.679 nicm 1707: .It
1708: Choose mode, which allows an item to be chosen from a list.
1709: This may be a client, a session or window or pane, or a buffer.
1710: This mode is entered with the
1711: .Ic choose-buffer ,
1712: .Ic choose-client
1713: and
1714: .Ic choose-tree
1715: commands.
1716: .El
1.1 nicm 1717: .Pp
1.678 nicm 1718: In copy mode an indicator is displayed in the top-right corner of the pane with
1719: the current position and the number of lines in the history.
1720: .Pp
1.497 nicm 1721: Commands are sent to copy mode using the
1722: .Fl X
1723: flag to the
1724: .Ic send-keys
1725: command.
1726: When a key is pressed, copy mode automatically uses one of two key tables,
1727: depending on the
1.1 nicm 1728: .Ic mode-keys
1.497 nicm 1729: option:
1730: .Ic copy-mode
1731: for emacs, or
1732: .Ic copy-mode-vi
1733: for vi.
1734: Key tables may be viewed with the
1735: .Ic list-keys
1736: command.
1737: .Pp
1738: The following commands are supported in copy mode:
1.648 nicm 1739: .Bl -column "CommandXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXXXXXXXX" "emacs" -offset indent
1.497 nicm 1740: .It Sy "Command" Ta Sy "vi" Ta Sy "emacs"
1741: .It Li "append-selection" Ta "" Ta ""
1742: .It Li "append-selection-and-cancel" Ta "A" Ta ""
1743: .It Li "back-to-indentation" Ta "^" Ta "M-m"
1744: .It Li "begin-selection" Ta "Space" Ta "C-Space"
1745: .It Li "bottom-line" Ta "L" Ta ""
1746: .It Li "cancel" Ta "q" Ta "Escape"
1747: .It Li "clear-selection" Ta "Escape" Ta "C-g"
1.847 nicm 1748: .It Li "copy-end-of-line [<prefix>]" Ta "" Ta ""
1.849 nicm 1749: .It Li "copy-end-of-line-and-cancel [<prefix>]" Ta "" Ta ""
1750: .It Li "copy-pipe-end-of-line [<command>] [<prefix>]" Ta "" Ta ""
1751: .It Li "copy-pipe-end-of-line-and-cancel [<command>] [<prefix>]" Ta "D" Ta "C-k"
1.633 nicm 1752: .It Li "copy-line [<prefix>]" Ta "" Ta ""
1.847 nicm 1753: .It Li "copy-line-and-cancel [<prefix>]" Ta "" Ta ""
1.849 nicm 1754: .It Li "copy-pipe-line [<command>] [<prefix>]" Ta "" Ta ""
1755: .It Li "copy-pipe-line-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1.742 nicm 1756: .It Li "copy-pipe [<command>] [<prefix>]" Ta "" Ta ""
1757: .It Li "copy-pipe-no-clear [<command>] [<prefix>]" Ta "" Ta ""
1758: .It Li "copy-pipe-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1.633 nicm 1759: .It Li "copy-selection [<prefix>]" Ta "" Ta ""
1.638 nicm 1760: .It Li "copy-selection-no-clear [<prefix>]" Ta "" Ta ""
1.633 nicm 1761: .It Li "copy-selection-and-cancel [<prefix>]" Ta "Enter" Ta "M-w"
1.497 nicm 1762: .It Li "cursor-down" Ta "j" Ta "Down"
1.685 nicm 1763: .It Li "cursor-down-and-cancel" Ta "" Ta ""
1.497 nicm 1764: .It Li "cursor-left" Ta "h" Ta "Left"
1765: .It Li "cursor-right" Ta "l" Ta "Right"
1766: .It Li "cursor-up" Ta "k" Ta "Up"
1767: .It Li "end-of-line" Ta "$" Ta "C-e"
1768: .It Li "goto-line <line>" Ta ":" Ta "g"
1769: .It Li "halfpage-down" Ta "C-d" Ta "M-Down"
1.589 nicm 1770: .It Li "halfpage-down-and-cancel" Ta "" Ta ""
1.497 nicm 1771: .It Li "halfpage-up" Ta "C-u" Ta "M-Up"
1.589 nicm 1772: .It Li "history-bottom" Ta "G" Ta "M->"
1773: .It Li "history-top" Ta "g" Ta "M-<"
1.497 nicm 1774: .It Li "jump-again" Ta ";" Ta ";"
1775: .It Li "jump-backward <to>" Ta "F" Ta "F"
1776: .It Li "jump-forward <to>" Ta "f" Ta "f"
1777: .It Li "jump-reverse" Ta "," Ta ","
1778: .It Li "jump-to-backward <to>" Ta "T" Ta ""
1779: .It Li "jump-to-forward <to>" Ta "t" Ta ""
1.768 nicm 1780: .It Li "jump-to-mark" Ta "M-x" Ta "M-x"
1.497 nicm 1781: .It Li "middle-line" Ta "M" Ta "M-r"
1.678 nicm 1782: .It Li "next-matching-bracket" Ta "%" Ta "M-C-f"
1.497 nicm 1783: .It Li "next-paragraph" Ta "}" Ta "M-}"
1784: .It Li "next-space" Ta "W" Ta ""
1785: .It Li "next-space-end" Ta "E" Ta ""
1786: .It Li "next-word" Ta "w" Ta ""
1787: .It Li "next-word-end" Ta "e" Ta "M-f"
1788: .It Li "other-end" Ta "o" Ta ""
1789: .It Li "page-down" Ta "C-f" Ta "PageDown"
1.589 nicm 1790: .It Li "page-down-and-cancel" Ta "" Ta ""
1.497 nicm 1791: .It Li "page-up" Ta "C-b" Ta "PageUp"
1.820 nicm 1792: .It Li "pipe [<command>] [<prefix>]" Ta "" Ta ""
1793: .It Li "pipe-no-clear [<command>] [<prefix>]" Ta "" Ta ""
1794: .It Li "pipe-and-cancel [<command>] [<prefix>]" Ta "" Ta ""
1.678 nicm 1795: .It Li "previous-matching-bracket" Ta "" Ta "M-C-b"
1.497 nicm 1796: .It Li "previous-paragraph" Ta "{" Ta "M-{"
1797: .It Li "previous-space" Ta "B" Ta ""
1798: .It Li "previous-word" Ta "b" Ta "M-b"
1.813 nicm 1799: .It Li "rectangle-on" Ta "" Ta ""
1800: .It Li "rectangle-off" Ta "" Ta ""
1.497 nicm 1801: .It Li "rectangle-toggle" Ta "v" Ta "R"
1.732 nicm 1802: .It Li "refresh-from-pane" Ta "r" Ta "r"
1.497 nicm 1803: .It Li "scroll-down" Ta "C-e" Ta "C-Down"
1.589 nicm 1804: .It Li "scroll-down-and-cancel" Ta "" Ta ""
1.497 nicm 1805: .It Li "scroll-up" Ta "C-y" Ta "C-Up"
1806: .It Li "search-again" Ta "n" Ta "n"
1.517 nicm 1807: .It Li "search-backward <for>" Ta "?" Ta ""
1.726 nicm 1808: .It Li "search-backward-incremental <for>" Ta "" Ta "C-r"
1809: .It Li "search-backward-text <for>" Ta "" Ta ""
1.517 nicm 1810: .It Li "search-forward <for>" Ta "/" Ta ""
1811: .It Li "search-forward-incremental <for>" Ta "" Ta "C-s"
1.726 nicm 1812: .It Li "search-forward-text <for>" Ta "" Ta ""
1.497 nicm 1813: .It Li "search-reverse" Ta "N" Ta "N"
1814: .It Li "select-line" Ta "V" Ta ""
1.634 nicm 1815: .It Li "select-word" Ta "" Ta ""
1.768 nicm 1816: .It Li "set-mark" Ta "X" Ta "X"
1.497 nicm 1817: .It Li "start-of-line" Ta "0" Ta "C-a"
1.515 nicm 1818: .It Li "stop-selection" Ta "" Ta ""
1.876 nicm 1819: .It Li "toggle-position" Ta "P" Ta "P"
1.497 nicm 1820: .It Li "top-line" Ta "H" Ta "M-R"
1.1 nicm 1821: .El
1.726 nicm 1822: .Pp
1823: The search commands come in several varieties:
1824: .Ql search-forward
1825: and
1826: .Ql search-backward
1827: search for a regular expression;
1828: the
1829: .Ql -text
1830: variants search for a plain text string rather than a regular expression;
1831: .Ql -incremental
1832: perform an incremental search and expect to be used with the
1833: .Fl i
1834: flag to the
1835: .Ic command-prompt
1836: command.
1837: .Ql search-again
1838: repeats the last search and
1839: .Ql search-reverse
1840: does the same but reverses the direction (forward becomes backward and backward
1841: becomes forward).
1.589 nicm 1842: .Pp
1.633 nicm 1843: Copy commands may take an optional buffer prefix argument which is used
1844: to generate the buffer name (the default is
1845: .Ql buffer
1846: so buffers are named
1847: .Ql buffer0 ,
1848: .Ql buffer1
1849: and so on).
1850: Pipe commands take a command argument which is the command to which the
1.820 nicm 1851: selected text is piped.
1852: .Ql copy-pipe
1853: variants also copy the selection.
1.589 nicm 1854: The
1855: .Ql -and-cancel
1856: variants of some commands exit copy mode after they have completed (for copy
1857: commands) or when the cursor reaches the bottom (for scrolling commands).
1.638 nicm 1858: .Ql -no-clear
1859: variants do not clear the selection.
1.146 nicm 1860: .Pp
1.841 nicm 1861: The next and previous word keys skip over whitespace and treat consecutive
1862: runs of either word separators or other letters as words.
1863: Word separators can be customized with the
1.154 nicm 1864: .Em word-separators
1.255 nicm 1865: session option.
1.146 nicm 1866: Next word moves to the start of the next word, next word end to the end of the
1867: next word and previous word to the start of the previous word.
1868: The three next and previous space keys work similarly but use a space alone as
1869: the word separator.
1.841 nicm 1870: Setting
1871: .Em word-separators
1872: to the empty string makes next/previous word equivalent to next/previous space.
1.157 nicm 1873: .Pp
1874: The jump commands enable quick movement within a line.
1875: For instance, typing
1876: .Ql f
1877: followed by
1878: .Ql /
1879: will move the cursor to the next
1880: .Ql /
1881: character on the current line.
1882: A
1883: .Ql \&;
1884: will then jump to the next occurrence.
1.1 nicm 1885: .Pp
1.155 nicm 1886: Commands in copy mode may be prefaced by an optional repeat count.
1887: With vi key bindings, a prefix is entered using the number keys; with
1888: emacs, the Alt (meta) key and a number begins prefix entry.
1889: .Pp
1.164 nicm 1890: The synopsis for the
1891: .Ic copy-mode
1892: command is:
1.57 jmc 1893: .Bl -tag -width Ds
1894: .It Xo Ic copy-mode
1.720 nicm 1895: .Op Fl eHMqu
1.735 nicm 1896: .Op Fl s Ar src-pane
1.72 nicm 1897: .Op Fl t Ar target-pane
1.57 jmc 1898: .Xc
1899: Enter copy mode.
1900: The
1901: .Fl u
1902: option scrolls one page up.
1.419 nicm 1903: .Fl M
1904: begins a mouse drag (only valid if bound to a mouse key binding, see
1.420 jmc 1905: .Sx MOUSE SUPPORT ) .
1.716 nicm 1906: .Fl H
1907: hides the position indicator in the top right.
1.720 nicm 1908: .Fl q
1909: cancels copy mode and any other modes.
1.735 nicm 1910: .Fl s
1911: copies from
1912: .Ar src-pane
1913: instead of
1.736 nicm 1914: .Ar target-pane .
1.716 nicm 1915: .Pp
1.450 nicm 1916: .Fl e
1917: specifies that scrolling to the bottom of the history (to the visible screen)
1918: should exit copy mode.
1919: While in copy mode, pressing a key other than those used for scrolling will
1920: disable this behaviour.
1921: This is intended to allow fast scrolling through a pane's history, for
1922: example with:
1923: .Bd -literal -offset indent
1924: bind PageUp copy-mode -eu
1925: .Ed
1.57 jmc 1926: .El
1.18 nicm 1927: .Pp
1.679 nicm 1928: A number of preset arrangements of panes are available, these are called layouts.
1.38 nicm 1929: These may be selected with the
1930: .Ic select-layout
1931: command or cycled with
1932: .Ic next-layout
1933: (bound to
1.149 nicm 1934: .Ql Space
1.131 nicm 1935: by default); once a layout is chosen, panes within it may be moved and resized
1936: as normal.
1.1 nicm 1937: .Pp
1938: The following layouts are supported:
1939: .Bl -tag -width Ds
1940: .It Ic even-horizontal
1941: Panes are spread out evenly from left to right across the window.
1942: .It Ic even-vertical
1943: Panes are spread evenly from top to bottom.
1.2 nicm 1944: .It Ic main-horizontal
1.131 nicm 1945: A large (main) pane is shown at the top of the window and the remaining panes
1946: are spread from left to right in the leftover space at the bottom.
1.2 nicm 1947: Use the
1948: .Em main-pane-height
1949: window option to specify the height of the top pane.
1.1 nicm 1950: .It Ic main-vertical
1.2 nicm 1951: Similar to
1952: .Ic main-horizontal
1953: but the large pane is placed on the left and the others spread from top to
1954: bottom along the right.
1955: See the
1956: .Em main-pane-width
1957: window option.
1.165 nicm 1958: .It Ic tiled
1959: Panes are spread out as evenly as possible over the window in both rows and
1960: columns.
1.1 nicm 1961: .El
1.8 nicm 1962: .Pp
1.181 nicm 1963: In addition,
1964: .Ic select-layout
1965: may be used to apply a previously used layout - the
1966: .Ic list-windows
1967: command displays the layout of each window in a form suitable for use with
1968: .Ic select-layout .
1969: For example:
1970: .Bd -literal -offset indent
1971: $ tmux list-windows
1972: 0: ksh [159x48]
1973: layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1974: $ tmux select-layout bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1975: .Ed
1.196 nicm 1976: .Pp
1.181 nicm 1977: .Nm
1978: automatically adjusts the size of the layout for the current window size.
1979: Note that a layout cannot be applied to a window with more panes than that
1980: from which the layout was originally defined.
1981: .Pp
1.57 jmc 1982: Commands related to windows and panes are as follows:
1983: .Bl -tag -width Ds
1.858 kn 1984: .Tg breakp
1.57 jmc 1985: .It Xo Ic break-pane
1.784 nicm 1986: .Op Fl abdP
1.280 nicm 1987: .Op Fl F Ar format
1.532 nicm 1988: .Op Fl n Ar window-name
1.440 nicm 1989: .Op Fl s Ar src-pane
1.480 nicm 1990: .Op Fl t Ar dst-window
1.57 jmc 1991: .Xc
1.870 kn 1992: .D1 Pq alias: Ic breakp
1.57 jmc 1993: Break
1.440 nicm 1994: .Ar src-pane
1995: off from its containing window to make it the only pane in
1996: .Ar dst-window .
1.749 nicm 1997: With
1.784 nicm 1998: .Fl a
1999: or
2000: .Fl b ,
2001: the window is moved to the next index after or before (existing windows are
2002: moved if necessary).
1.57 jmc 2003: If
2004: .Fl d
2005: is given, the new window does not become the current window.
1.280 nicm 2006: The
2007: .Fl P
2008: option prints information about the new window after it has been created.
2009: By default, it uses the format
1.798 nicm 2010: .Ql #{session_name}:#{window_index}.#{pane_index}
1.280 nicm 2011: but a different format may be specified with
2012: .Fl F .
1.858 kn 2013: .Tg capturep
1.128 nicm 2014: .It Xo Ic capture-pane
1.680 nicm 2015: .Op Fl aepPqCJN
1.392 nicm 2016: .Op Fl b Ar buffer-name
1.213 nicm 2017: .Op Fl E Ar end-line
2018: .Op Fl S Ar start-line
1.128 nicm 2019: .Op Fl t Ar target-pane
2020: .Xc
1.870 kn 2021: .D1 Pq alias: Ic capturep
1.322 nicm 2022: Capture the contents of a pane.
2023: If
2024: .Fl p
1.325 nicm 2025: is given, the output goes to stdout, otherwise to the buffer specified with
1.322 nicm 2026: .Fl b
2027: or a new buffer if omitted.
1.339 nicm 2028: If
2029: .Fl a
2030: is given, the alternate screen is used, and the history is not accessible.
1.340 nicm 2031: If no alternate screen exists, an error will be returned unless
2032: .Fl q
2033: is given.
1.326 nicm 2034: If
2035: .Fl e
1.328 nicm 2036: is given, the output includes escape sequences for text and background
2037: attributes.
2038: .Fl C
1.330 nicm 2039: also escapes non-printable characters as octal \exxx.
1.680 nicm 2040: .Fl N
2041: preserves trailing spaces at each line's end and
1.328 nicm 2042: .Fl J
1.680 nicm 2043: preserves trailing spaces and joins any wrapped lines.
1.346 nicm 2044: .Fl P
2045: captures only any output that the pane has received that is the beginning of an
2046: as-yet incomplete escape sequence.
1.213 nicm 2047: .Pp
2048: .Fl S
2049: and
2050: .Fl E
2051: specify the starting and ending line numbers, zero is the first line of the
2052: visible pane and negative numbers are lines in the history.
1.397 nicm 2053: .Ql -
2054: to
2055: .Fl S
2056: is the start of the history and to
2057: .Fl E
2058: the end of the visible pane.
1.213 nicm 2059: The default is to capture only the visible contents of the pane.
1.76 nicm 2060: .It Xo
2061: .Ic choose-client
1.682 nicm 2062: .Op Fl NrZ
1.572 nicm 2063: .Op Fl F Ar format
1.562 nicm 2064: .Op Fl f Ar filter
1.833 nicm 2065: .Op Fl K Ar key-format
1.561 nicm 2066: .Op Fl O Ar sort-order
1.555 nicm 2067: .Op Fl t Ar target-pane
1.76 nicm 2068: .Op Ar template
2069: .Xc
1.555 nicm 2070: Put a pane into client mode, allowing a client to be selected interactively from
2071: a list.
1.833 nicm 2072: Each client is shown on one line.
2073: A shortcut key is shown on the left in brackets allowing for immediate choice,
2074: or the list may be navigated and an item chosen or otherwise manipulated using
2075: the keys below.
1.593 nicm 2076: .Fl Z
2077: zooms the pane.
1.555 nicm 2078: The following keys may be used in client mode:
2079: .Bl -column "Key" "Function" -offset indent
2080: .It Sy "Key" Ta Sy "Function"
2081: .It Li "Enter" Ta "Choose selected client"
2082: .It Li "Up" Ta "Select previous client"
2083: .It Li "Down" Ta "Select next client"
1.559 nicm 2084: .It Li "C-s" Ta "Search by name"
2085: .It Li "n" Ta "Repeat last search"
1.555 nicm 2086: .It Li "t" Ta "Toggle if client is tagged"
2087: .It Li "T" Ta "Tag no clients"
2088: .It Li "C-t" Ta "Tag all clients"
2089: .It Li "d" Ta "Detach selected client"
2090: .It Li "D" Ta "Detach tagged clients"
2091: .It Li "x" Ta "Detach and HUP selected client"
2092: .It Li "X" Ta "Detach and HUP tagged clients"
2093: .It Li "z" Ta "Suspend selected client"
2094: .It Li "Z" Ta "Suspend tagged clients"
1.562 nicm 2095: .It Li "f" Ta "Enter a format to filter items"
1.682 nicm 2096: .It Li "O" Ta "Change sort field"
2097: .It Li "r" Ta "Reverse sort order"
1.576 nicm 2098: .It Li "v" Ta "Toggle preview"
1.555 nicm 2099: .It Li "q" Ta "Exit mode"
2100: .El
2101: .Pp
1.76 nicm 2102: After a client is chosen,
2103: .Ql %%
1.555 nicm 2104: is replaced by the client name in
1.76 nicm 2105: .Ar template
2106: and the result executed as a command.
2107: If
2108: .Ar template
2109: is not given, "detach-client -t '%%'" is used.
1.555 nicm 2110: .Pp
1.561 nicm 2111: .Fl O
1.682 nicm 2112: specifies the initial sort field: one of
1.561 nicm 2113: .Ql name ,
2114: .Ql size ,
2115: .Ql creation ,
2116: or
2117: .Ql activity .
1.682 nicm 2118: .Fl r
2119: reverses the sort order.
1.562 nicm 2120: .Fl f
1.579 nicm 2121: specifies an initial filter: the filter is a format - if it evaluates to zero,
2122: the item in the list is not shown, otherwise it is shown.
2123: If a filter would lead to an empty list, it is ignored.
1.572 nicm 2124: .Fl F
1.833 nicm 2125: specifies the format for each item in the list and
2126: .Fl K
2127: a format for each shortcut key; both are evaluated once for each line.
1.576 nicm 2128: .Fl N
2129: starts without the preview.
1.314 nicm 2130: This command works only if at least one client is attached.
1.76 nicm 2131: .It Xo
1.555 nicm 2132: .Ic choose-tree
1.682 nicm 2133: .Op Fl GNrswZ
1.572 nicm 2134: .Op Fl F Ar format
1.562 nicm 2135: .Op Fl f Ar filter
1.833 nicm 2136: .Op Fl K Ar key-format
1.561 nicm 2137: .Op Fl O Ar sort-order
1.555 nicm 2138: .Op Fl t Ar target-pane
1.76 nicm 2139: .Op Ar template
2140: .Xc
1.555 nicm 2141: Put a pane into tree mode, where a session, window or pane may be chosen
1.833 nicm 2142: interactively from a tree.
2143: Each session, window or pane is shown on one line.
2144: A shortcut key is shown on the left in brackets allowing for immediate choice,
2145: or the tree may be navigated and an item chosen or otherwise manipulated using
2146: the keys below.
1.298 nicm 2147: .Fl s
1.555 nicm 2148: starts with sessions collapsed and
1.298 nicm 2149: .Fl w
1.555 nicm 2150: with windows collapsed.
1.593 nicm 2151: .Fl Z
2152: zooms the pane.
1.555 nicm 2153: The following keys may be used in tree mode:
2154: .Bl -column "Key" "Function" -offset indent
2155: .It Sy "Key" Ta Sy "Function"
2156: .It Li "Enter" Ta "Choose selected item"
2157: .It Li "Up" Ta "Select previous item"
2158: .It Li "Down" Ta "Select next item"
1.763 nicm 2159: .It Li "+" Ta "Expand selected item"
2160: .It Li "-" Ta "Collapse selected item"
2161: .It Li "M-+" Ta "Expand all items"
2162: .It Li "M--" Ta "Collapse all items"
1.594 nicm 2163: .It Li "x" Ta "Kill selected item"
2164: .It Li "X" Ta "Kill tagged items"
1.566 nicm 2165: .It Li "<" Ta "Scroll list of previews left"
2166: .It Li ">" Ta "Scroll list of previews right"
1.559 nicm 2167: .It Li "C-s" Ta "Search by name"
1.749 nicm 2168: .It Li "m" Ta "Set the marked pane"
2169: .It Li "M" Ta "Clear the marked pane"
1.559 nicm 2170: .It Li "n" Ta "Repeat last search"
1.555 nicm 2171: .It Li "t" Ta "Toggle if item is tagged"
2172: .It Li "T" Ta "Tag no items"
2173: .It Li "C-t" Ta "Tag all items"
1.557 nicm 2174: .It Li "\&:" Ta "Run a command for each tagged item"
1.555 nicm 2175: .It Li "f" Ta "Enter a format to filter items"
1.749 nicm 2176: .It Li "H" Ta "Jump to the starting pane"
1.682 nicm 2177: .It Li "O" Ta "Change sort field"
2178: .It Li "r" Ta "Reverse sort order"
1.576 nicm 2179: .It Li "v" Ta "Toggle preview"
1.555 nicm 2180: .It Li "q" Ta "Exit mode"
2181: .El
1.320 nicm 2182: .Pp
1.844 nicm 2183: After a session, window or pane is chosen, the first instance of
1.76 nicm 2184: .Ql %%
1.844 nicm 2185: and all instances of
2186: .Ql %1
2187: are replaced by the target in
1.76 nicm 2188: .Ar template
2189: and the result executed as a command.
2190: If
2191: .Ar template
1.555 nicm 2192: is not given, "switch-client -t '%%'" is used.
2193: .Pp
1.561 nicm 2194: .Fl O
1.682 nicm 2195: specifies the initial sort field: one of
1.561 nicm 2196: .Ql index ,
2197: .Ql name ,
2198: or
2199: .Ql time .
1.682 nicm 2200: .Fl r
2201: reverses the sort order.
1.562 nicm 2202: .Fl f
1.579 nicm 2203: specifies an initial filter: the filter is a format - if it evaluates to zero,
2204: the item in the list is not shown, otherwise it is shown.
2205: If a filter would lead to an empty list, it is ignored.
1.572 nicm 2206: .Fl F
1.833 nicm 2207: specifies the format for each item in the tree and
2208: .Fl K
2209: a format for each shortcut key; both are evaluated once for each line.
1.576 nicm 2210: .Fl N
2211: starts without the preview.
1.586 nicm 2212: .Fl G
2213: includes all sessions in any session groups in the tree rather than only the
2214: first.
1.766 nicm 2215: This command works only if at least one client is attached.
2216: .It Xo
2217: .Ic customize-mode
2218: .Op Fl NZ
2219: .Op Fl F Ar format
2220: .Op Fl f Ar filter
2221: .Op Fl t Ar target-pane
2222: .Op Ar template
2223: .Xc
2224: Put a pane into customize mode, where options and key bindings may be browsed
2225: and modified from a list.
2226: Option values in the list are shown for the active pane in the current window.
2227: .Fl Z
2228: zooms the pane.
2229: The following keys may be used in customize mode:
2230: .Bl -column "Key" "Function" -offset indent
2231: .It Sy "Key" Ta Sy "Function"
2232: .It Li "Enter" Ta "Set pane, window, session or global option value"
2233: .It Li "Up" Ta "Select previous item"
2234: .It Li "Down" Ta "Select next item"
2235: .It Li "+" Ta "Expand selected item"
2236: .It Li "-" Ta "Collapse selected item"
2237: .It Li "M-+" Ta "Expand all items"
2238: .It Li "M--" Ta "Collapse all items"
2239: .It Li "s" Ta "Set option value or key attribute"
2240: .It Li "S" Ta "Set global option value"
2241: .It Li "w" Ta "Set window option value, if option is for pane and window"
1.785 nicm 2242: .It Li "d" Ta "Set an option or key to the default"
2243: .It Li "D" Ta "Set tagged options and tagged keys to the default"
1.766 nicm 2244: .It Li "u" Ta "Unset an option (set to default value if global) or unbind a key"
2245: .It Li "U" Ta "Unset tagged options and unbind tagged keys"
2246: .It Li "C-s" Ta "Search by name"
2247: .It Li "n" Ta "Repeat last search"
2248: .It Li "t" Ta "Toggle if item is tagged"
2249: .It Li "T" Ta "Tag no items"
2250: .It Li "C-t" Ta "Tag all items"
2251: .It Li "f" Ta "Enter a format to filter items"
2252: .It Li "v" Ta "Toggle option information"
2253: .It Li "q" Ta "Exit mode"
2254: .El
2255: .Pp
2256: .Fl f
2257: specifies an initial filter: the filter is a format - if it evaluates to zero,
2258: the item in the list is not shown, otherwise it is shown.
2259: If a filter would lead to an empty list, it is ignored.
2260: .Fl F
2261: specifies the format for each item in the tree.
2262: .Fl N
2263: starts without the option information.
1.314 nicm 2264: This command works only if at least one client is attached.
1.491 nicm 2265: .It Xo
1.858 kn 2266: .Tg displayp
1.491 nicm 2267: .Ic display-panes
1.804 nicm 2268: .Op Fl bN
1.573 nicm 2269: .Op Fl d Ar duration
1.491 nicm 2270: .Op Fl t Ar target-client
2271: .Op Ar template
2272: .Xc
1.870 kn 2273: .D1 Pq alias: Ic displayp
1.78 nicm 2274: Display a visible indicator of each pane shown by
2275: .Ar target-client .
2276: See the
1.573 nicm 2277: .Ic display-panes-colour
1.78 nicm 2278: and
1.145 nicm 2279: .Ic display-panes-active-colour
1.78 nicm 2280: session options.
1.804 nicm 2281: The indicator is closed when a key is pressed (unless
1.805 nicm 2282: .Fl N
2283: is given) or
1.573 nicm 2284: .Ar duration
2285: milliseconds have passed.
2286: If
2287: .Fl d
2288: is not given,
2289: .Ic display-panes-time
2290: is used.
2291: A duration of zero means the indicator stays until a key is pressed.
1.491 nicm 2292: While the indicator is on screen, a pane may be chosen with the
1.84 nicm 2293: .Ql 0
2294: to
2295: .Ql 9
1.491 nicm 2296: keys, which will cause
2297: .Ar template
2298: to be executed as a command with
2299: .Ql %%
2300: substituted by the pane ID.
2301: The default
2302: .Ar template
2303: is "select-pane -t '%%'".
1.616 nicm 2304: With
2305: .Fl b ,
2306: other commands are not blocked from running until the indicator is closed.
1.858 kn 2307: .Tg findw
1.57 jmc 2308: .It Xo Ic find-window
1.775 nicm 2309: .Op Fl iCNrTZ
1.555 nicm 2310: .Op Fl t Ar target-pane
1.57 jmc 2311: .Ar match-string
2312: .Xc
1.870 kn 2313: .D1 Pq alias: Ic findw
1.670 nicm 2314: Search for a
1.57 jmc 2315: .Xr fnmatch 3
1.670 nicm 2316: pattern or, with
2317: .Fl r ,
2318: regular expression
1.57 jmc 2319: .Ar match-string
2320: in window names, titles, and visible content (but not history).
1.285 nicm 2321: The flags control matching behavior:
2322: .Fl C
2323: matches only visible window contents,
2324: .Fl N
2325: matches only the window name and
2326: .Fl T
2327: matches only the window title.
1.775 nicm 2328: .Fl i
2329: makes the search ignore case.
1.285 nicm 2330: The default is
2331: .Fl CNT .
1.608 nicm 2332: .Fl Z
2333: zooms the pane.
1.555 nicm 2334: .Pp
1.314 nicm 2335: This command works only if at least one client is attached.
1.858 kn 2336: .Tg joinp
1.137 nicm 2337: .It Xo Ic join-pane
1.697 nicm 2338: .Op Fl bdfhv
1.690 nicm 2339: .Op Fl l Ar size
1.137 nicm 2340: .Op Fl s Ar src-pane
2341: .Op Fl t Ar dst-pane
2342: .Xc
1.870 kn 2343: .D1 Pq alias: Ic joinp
1.137 nicm 2344: Like
2345: .Ic split-window ,
2346: but instead of splitting
2347: .Ar dst-pane
2348: and creating a new pane, split it and move
2349: .Ar src-pane
2350: into the space.
2351: This can be used to reverse
2352: .Ic break-pane .
1.277 nicm 2353: The
2354: .Fl b
2355: option causes
2356: .Ar src-pane
2357: to be joined to left of or above
2358: .Ar dst-pane .
1.432 nicm 2359: .Pp
2360: If
2361: .Fl s
2362: is omitted and a marked pane is present (see
2363: .Ic select-pane
2364: .Fl m ) ,
2365: the marked pane is used rather than the current pane.
1.858 kn 2366: .Tg killp
1.112 nicm 2367: .It Xo Ic kill-pane
2368: .Op Fl a
2369: .Op Fl t Ar target-pane
2370: .Xc
1.870 kn 2371: .D1 Pq alias: Ic killp
1.57 jmc 2372: Destroy the given pane.
2373: If no panes remain in the containing window, it is also destroyed.
1.112 nicm 2374: The
2375: .Fl a
2376: option kills all but the pane given with
2377: .Fl t .
1.858 kn 2378: .Tg killw
1.289 nicm 2379: .It Xo Ic kill-window
2380: .Op Fl a
2381: .Op Fl t Ar target-window
2382: .Xc
1.870 kn 2383: .D1 Pq alias: Ic killw
1.57 jmc 2384: Kill the current window or the window at
2385: .Ar target-window ,
1.1 nicm 2386: removing it from any sessions to which it is linked.
1.289 nicm 2387: The
2388: .Fl a
2389: option kills all but the window given with
2390: .Fl t .
1.858 kn 2391: .Tg lastp
1.398 nicm 2392: .It Xo Ic last-pane
1.681 nicm 2393: .Op Fl deZ
1.398 nicm 2394: .Op Fl t Ar target-window
2395: .Xc
1.870 kn 2396: .D1 Pq alias: Ic lastp
1.187 nicm 2397: Select the last (previously selected) pane.
1.681 nicm 2398: .Fl Z
2399: keeps the window zoomed if it was zoomed.
1.398 nicm 2400: .Fl e
2401: enables or
2402: .Fl d
2403: disables input to the pane.
1.858 kn 2404: .Tg last
1.56 jmc 2405: .It Ic last-window Op Fl t Ar target-session
1.870 kn 2406: .D1 Pq alias: Ic last
1.1 nicm 2407: Select the last (previously selected) window.
2408: If no
2409: .Ar target-session
2410: is specified, select the last window of the current session.
1.858 kn 2411: .Tg link
1.1 nicm 2412: .It Xo Ic link-window
1.784 nicm 2413: .Op Fl abdk
1.1 nicm 2414: .Op Fl s Ar src-window
2415: .Op Fl t Ar dst-window
2416: .Xc
1.870 kn 2417: .D1 Pq alias: Ic linkw
1.1 nicm 2418: Link the window at
2419: .Ar src-window
2420: to the specified
2421: .Ar dst-window .
2422: If
2423: .Ar dst-window
2424: is specified and no such window exists, the
2425: .Ar src-window
2426: is linked there.
1.439 nicm 2427: With
1.784 nicm 2428: .Fl a
2429: or
2430: .Fl b
2431: the window is moved to the next index after or before
2432: .Ar dst-window
2433: (existing windows are moved if necessary).
1.1 nicm 2434: If
2435: .Fl k
2436: is given and
2437: .Ar dst-window
2438: exists, it is killed, otherwise an error is generated.
2439: If
2440: .Fl d
2441: is given, the newly linked window is not selected.
1.858 kn 2442: .Tg lsp
1.214 nicm 2443: .It Xo Ic list-panes
2444: .Op Fl as
1.245 nicm 2445: .Op Fl F Ar format
1.738 nicm 2446: .Op Fl f Ar filter
1.214 nicm 2447: .Op Fl t Ar target
2448: .Xc
1.870 kn 2449: .D1 Pq alias: Ic lsp
1.214 nicm 2450: If
2451: .Fl a
2452: is given,
2453: .Ar target
2454: is ignored and all panes on the server are listed.
2455: If
2456: .Fl s
2457: is given,
2458: .Ar target
2459: is a session (or the current session).
2460: If neither is given,
2461: .Ar target
2462: is a window (or the current window).
1.247 nicm 2463: .Fl F
1.738 nicm 2464: specifies the format of each line and
2465: .Fl f
2466: a filter.
2467: Only panes for which the filter is true are shown.
2468: See the
1.247 nicm 2469: .Sx FORMATS
2470: section.
1.858 kn 2471: .Tg lsw
1.214 nicm 2472: .It Xo Ic list-windows
2473: .Op Fl a
1.245 nicm 2474: .Op Fl F Ar format
1.738 nicm 2475: .Op Fl f Ar filter
1.214 nicm 2476: .Op Fl t Ar target-session
2477: .Xc
1.870 kn 2478: .D1 Pq alias: Ic lsw
1.214 nicm 2479: If
2480: .Fl a
2481: is given, list all windows on the server.
2482: Otherwise, list windows in the current session or in
1.1 nicm 2483: .Ar target-session .
1.245 nicm 2484: .Fl F
1.738 nicm 2485: specifies the format of each line and
2486: .Fl f
2487: a filter.
2488: Only windows for which the filter is true are shown.
2489: See the
1.245 nicm 2490: .Sx FORMATS
2491: section.
1.858 kn 2492: .Tg movep
1.277 nicm 2493: .It Xo Ic move-pane
1.749 nicm 2494: .Op Fl bdfhv
1.690 nicm 2495: .Op Fl l Ar size
1.277 nicm 2496: .Op Fl s Ar src-pane
2497: .Op Fl t Ar dst-pane
2498: .Xc
1.870 kn 2499: .D1 Pq alias: Ic movep
1.749 nicm 2500: Does the same as
2501: .Ic join-pane .
1.858 kn 2502: .Tg movew
1.1 nicm 2503: .It Xo Ic move-window
1.784 nicm 2504: .Op Fl abrdk
1.1 nicm 2505: .Op Fl s Ar src-window
2506: .Op Fl t Ar dst-window
2507: .Xc
1.870 kn 2508: .D1 Pq alias: Ic movew
1.1 nicm 2509: This is similar to
2510: .Ic link-window ,
2511: except the window at
2512: .Ar src-window
2513: is moved to
2514: .Ar dst-window .
1.291 nicm 2515: With
2516: .Fl r ,
2517: all windows in the session are renumbered in sequential order, respecting
2518: the
2519: .Ic base-index
2520: option.
1.858 kn 2521: .Tg neww
1.1 nicm 2522: .It Xo Ic new-window
1.817 nicm 2523: .Op Fl abdkPS
1.272 nicm 2524: .Op Fl c Ar start-directory
1.641 nicm 2525: .Op Fl e Ar environment
1.351 nicm 2526: .Op Fl F Ar format
1.1 nicm 2527: .Op Fl n Ar window-name
2528: .Op Fl t Ar target-window
1.153 nicm 2529: .Op Ar shell-command
1.1 nicm 2530: .Xc
1.870 kn 2531: .D1 Pq alias: Ic neww
1.1 nicm 2532: Create a new window.
1.160 nicm 2533: With
1.784 nicm 2534: .Fl a
2535: or
2536: .Fl b ,
2537: the new window is inserted at the next index after or before the specified
1.160 nicm 2538: .Ar target-window ,
1.784 nicm 2539: moving windows up if necessary;
1.160 nicm 2540: otherwise
2541: .Ar target-window
2542: is the new window location.
2543: .Pp
1.1 nicm 2544: If
2545: .Fl d
2546: is given, the session does not make the new window the current window.
2547: .Ar target-window
1.28 nicm 2548: represents the window to be created; if the target already exists an error is
2549: shown, unless the
2550: .Fl k
2551: flag is used, in which case it is destroyed.
1.817 nicm 2552: If
2553: .Fl S
2554: is given and a window named
2555: .Ar window-name
2556: already exists, it is selected (unless
2557: .Fl d
2558: is also given in which case the command does nothing).
2559: .Pp
1.153 nicm 2560: .Ar shell-command
1.1 nicm 2561: is the command to execute.
2562: If
1.153 nicm 2563: .Ar shell-command
2564: is not specified, the value of the
2565: .Ic default-command
2566: option is used.
1.272 nicm 2567: .Fl c
2568: specifies the working directory in which the new window is created.
1.153 nicm 2569: .Pp
2570: When the shell command completes, the window closes.
2571: See the
2572: .Ic remain-on-exit
2573: option to change this behaviour.
1.1 nicm 2574: .Pp
1.641 nicm 2575: .Fl e
2576: takes the form
2577: .Ql VARIABLE=value
2578: and sets an environment variable for the newly created window; it may be
2579: specified multiple times.
2580: .Pp
1.1 nicm 2581: The
2582: .Ev TERM
2583: environment variable must be set to
1.523 nicm 2584: .Ql screen
2585: or
2586: .Ql tmux
1.1 nicm 2587: for all programs running
2588: .Em inside
2589: .Nm .
2590: New windows will automatically have
1.523 nicm 2591: .Ql TERM=screen
1.1 nicm 2592: added to their environment, but care must be taken not to reset this in shell
1.641 nicm 2593: start-up files or by the
2594: .Fl e
2595: option.
1.201 nicm 2596: .Pp
2597: The
2598: .Fl P
1.279 nicm 2599: option prints information about the new window after it has been created.
2600: By default, it uses the format
2601: .Ql #{session_name}:#{window_index}
2602: but a different format may be specified with
2603: .Fl F .
1.858 kn 2604: .Tg nextl
1.56 jmc 2605: .It Ic next-layout Op Fl t Ar target-window
1.870 kn 2606: .D1 Pq alias: Ic nextl
1.1 nicm 2607: Move a window to the next layout and rearrange the panes to fit.
1.858 kn 2608: .Tg next
1.1 nicm 2609: .It Xo Ic next-window
1.9 nicm 2610: .Op Fl a
1.1 nicm 2611: .Op Fl t Ar target-session
2612: .Xc
1.870 kn 2613: .D1 Pq alias: Ic next
1.1 nicm 2614: Move to the next window in the session.
1.9 nicm 2615: If
1.12 jmc 2616: .Fl a
1.295 nicm 2617: is used, move to the next window with an alert.
1.858 kn 2618: .Tg pipep
1.107 nicm 2619: .It Xo Ic pipe-pane
1.591 nicm 2620: .Op Fl IOo
1.107 nicm 2621: .Op Fl t Ar target-pane
1.153 nicm 2622: .Op Ar shell-command
1.107 nicm 2623: .Xc
1.870 kn 2624: .D1 Pq alias: Ic pipep
1.591 nicm 2625: Pipe output sent by the program in
1.107 nicm 2626: .Ar target-pane
1.591 nicm 2627: to a shell command or vice versa.
2628: A pane may only be connected to one command at a time, any existing pipe is
1.107 nicm 2629: closed before
1.153 nicm 2630: .Ar shell-command
1.107 nicm 2631: is executed.
1.174 nicm 2632: The
2633: .Ar shell-command
2634: string may contain the special character sequences supported by the
2635: .Ic status-left
1.231 nicm 2636: option.
1.107 nicm 2637: If no
1.153 nicm 2638: .Ar shell-command
1.107 nicm 2639: is given, the current pipe (if any) is closed.
1.591 nicm 2640: .Pp
2641: .Fl I
2642: and
2643: .Fl O
2644: specify which of the
2645: .Ar shell-command
2646: output streams are connected to the pane:
2647: with
2648: .Fl I
2649: stdout is connected (so anything
2650: .Ar shell-command
2651: prints is written to the pane as if it were typed);
2652: with
2653: .Fl O
2654: stdin is connected (so any output in the pane is piped to
2655: .Ar shell-command ) .
2656: Both may be used together and if neither are specified,
2657: .Fl O
2658: is used.
1.107 nicm 2659: .Pp
2660: The
2661: .Fl o
2662: option only opens a new pipe if no previous pipe exists, allowing a pipe to
2663: be toggled with a single key, for example:
2664: .Bd -literal -offset indent
1.174 nicm 2665: bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
1.107 nicm 2666: .Ed
1.858 kn 2667: .Tg prevl
1.176 nicm 2668: .It Xo Ic previous-layout
2669: .Op Fl t Ar target-window
2670: .Xc
1.870 kn 2671: .D1 Pq alias: Ic prevl
1.176 nicm 2672: Move to the previous layout in the session.
1.858 kn 2673: .Tg prev
1.1 nicm 2674: .It Xo Ic previous-window
1.9 nicm 2675: .Op Fl a
1.1 nicm 2676: .Op Fl t Ar target-session
2677: .Xc
1.870 kn 2678: .D1 Pq alias: Ic prev
1.1 nicm 2679: Move to the previous window in the session.
1.9 nicm 2680: With
2681: .Fl a ,
1.295 nicm 2682: move to the previous window with an alert.
1.858 kn 2683: .Tg renamew
1.1 nicm 2684: .It Xo Ic rename-window
2685: .Op Fl t Ar target-window
2686: .Ar new-name
2687: .Xc
1.870 kn 2688: .D1 Pq alias: Ic renamew
1.1 nicm 2689: Rename the current window, or the window at
2690: .Ar target-window
2691: if specified, to
2692: .Ar new-name .
1.858 kn 2693: .Tg resizep
1.1 nicm 2694: .It Xo Ic resize-pane
1.727 nicm 2695: .Op Fl DLMRTUZ
1.52 nicm 2696: .Op Fl t Ar target-pane
1.324 nicm 2697: .Op Fl x Ar width
2698: .Op Fl y Ar height
1.1 nicm 2699: .Op Ar adjustment
2700: .Xc
1.870 kn 2701: .D1 Pq alias: Ic resizep
1.324 nicm 2702: Resize a pane, up, down, left or right by
2703: .Ar adjustment
2704: with
2705: .Fl U ,
1.57 jmc 2706: .Fl D ,
2707: .Fl L
1.324 nicm 2708: or
2709: .Fl R ,
2710: or
2711: to an absolute size
2712: with
2713: .Fl x
2714: or
2715: .Fl y .
1.57 jmc 2716: The
2717: .Ar adjustment
1.690 nicm 2718: is given in lines or columns (the default is 1);
2719: .Fl x
2720: and
2721: .Fl y
2722: may be a given as a number of lines or columns or followed by
2723: .Ql %
2724: for a percentage of the window size (for example
2725: .Ql -x 10% ) .
1.337 nicm 2726: With
2727: .Fl Z ,
1.349 nicm 2728: the active pane is toggled between zoomed (occupying the whole of the window)
2729: and unzoomed (its normal position in the layout).
1.419 nicm 2730: .Pp
2731: .Fl M
2732: begins mouse resizing (only valid if bound to a mouse key binding, see
1.420 jmc 2733: .Sx MOUSE SUPPORT ) .
1.729 nicm 2734: .Pp
2735: .Fl T
1.727 nicm 2736: trims all lines below the current cursor position and moves lines out of the
2737: history to replace them.
1.858 kn 2738: .Tg resizew
1.629 nicm 2739: .It Xo Ic resize-window
2740: .Op Fl aADLRU
2741: .Op Fl t Ar target-window
2742: .Op Fl x Ar width
2743: .Op Fl y Ar height
2744: .Op Ar adjustment
2745: .Xc
1.870 kn 2746: .D1 Pq alias: Ic resizew
1.629 nicm 2747: Resize a window, up, down, left or right by
2748: .Ar adjustment
2749: with
2750: .Fl U ,
2751: .Fl D ,
2752: .Fl L
2753: or
2754: .Fl R ,
2755: or
2756: to an absolute size
2757: with
2758: .Fl x
2759: or
2760: .Fl y .
2761: The
2762: .Ar adjustment
2763: is given in lines or cells (the default is 1).
2764: .Fl A
2765: sets the size of the largest session containing the window;
2766: .Fl a
2767: the size of the smallest.
2768: This command will automatically set
2769: .Ic window-size
2770: to manual in the window options.
1.858 kn 2771: .Tg respawnp
1.234 nicm 2772: .It Xo Ic respawn-pane
1.641 nicm 2773: .Op Fl k
1.568 nicm 2774: .Op Fl c Ar start-directory
1.641 nicm 2775: .Op Fl e Ar environment
1.234 nicm 2776: .Op Fl t Ar target-pane
2777: .Op Ar shell-command
2778: .Xc
1.870 kn 2779: .D1 Pq alias: Ic respawnp
1.234 nicm 2780: Reactivate a pane in which the command has exited (see the
2781: .Ic remain-on-exit
2782: window option).
2783: If
2784: .Ar shell-command
1.777 nicm 2785: is not given, the command used when the pane was created or last respawned is
2786: executed.
1.234 nicm 2787: The pane must be already inactive, unless
2788: .Fl k
2789: is given, in which case any existing command is killed.
1.568 nicm 2790: .Fl c
2791: specifies a new working directory for the pane.
1.641 nicm 2792: The
2793: .Fl e
2794: option has the same meaning as for the
2795: .Ic new-window
2796: command.
1.858 kn 2797: .Tg respawnw
1.57 jmc 2798: .It Xo Ic respawn-window
1.641 nicm 2799: .Op Fl k
1.568 nicm 2800: .Op Fl c Ar start-directory
1.641 nicm 2801: .Op Fl e Ar environment
1.57 jmc 2802: .Op Fl t Ar target-window
1.153 nicm 2803: .Op Ar shell-command
1.57 jmc 2804: .Xc
1.870 kn 2805: .D1 Pq alias: Ic respawnw
1.153 nicm 2806: Reactivate a window in which the command has exited (see the
1.57 jmc 2807: .Ic remain-on-exit
2808: window option).
2809: If
1.153 nicm 2810: .Ar shell-command
1.777 nicm 2811: is not given, the command used when the window was created or last respawned is
2812: executed.
1.57 jmc 2813: The window must be already inactive, unless
2814: .Fl k
2815: is given, in which case any existing command is killed.
1.568 nicm 2816: .Fl c
2817: specifies a new working directory for the window.
1.641 nicm 2818: The
2819: .Fl e
2820: option has the same meaning as for the
2821: .Ic new-window
2822: command.
1.858 kn 2823: .Tg rotatew
1.57 jmc 2824: .It Xo Ic rotate-window
1.681 nicm 2825: .Op Fl DUZ
1.57 jmc 2826: .Op Fl t Ar target-window
2827: .Xc
1.870 kn 2828: .D1 Pq alias: Ic rotatew
1.57 jmc 2829: Rotate the positions of the panes within a window, either upward (numerically
2830: lower) with
2831: .Fl U
2832: or downward (numerically higher).
1.681 nicm 2833: .Fl Z
2834: keeps the window zoomed if it was zoomed.
1.858 kn 2835: .Tg selectl
1.57 jmc 2836: .It Xo Ic select-layout
1.588 nicm 2837: .Op Fl Enop
2838: .Op Fl t Ar target-pane
1.57 jmc 2839: .Op Ar layout-name
2840: .Xc
1.870 kn 2841: .D1 Pq alias: Ic selectl
1.57 jmc 2842: Choose a specific layout for a window.
2843: If
2844: .Ar layout-name
1.181 nicm 2845: is not given, the last preset layout used (if any) is reapplied.
1.204 nicm 2846: .Fl n
2847: and
2848: .Fl p
2849: are equivalent to the
2850: .Ic next-layout
2851: and
2852: .Ic previous-layout
2853: commands.
1.424 nicm 2854: .Fl o
2855: applies the last set layout if possible (undoes the most recent layout change).
1.588 nicm 2856: .Fl E
2857: spreads the current pane and any panes next to it out evenly.
1.858 kn 2858: .Tg selectp
1.156 nicm 2859: .It Xo Ic select-pane
1.681 nicm 2860: .Op Fl DdeLlMmRUZ
1.577 nicm 2861: .Op Fl T Ar title
1.156 nicm 2862: .Op Fl t Ar target-pane
2863: .Xc
1.870 kn 2864: .D1 Pq alias: Ic selectp
1.57 jmc 2865: Make pane
2866: .Ar target-pane
1.774 nicm 2867: the active pane in its window.
1.156 nicm 2868: If one of
2869: .Fl D ,
2870: .Fl L ,
2871: .Fl R ,
2872: or
2873: .Fl U
2874: is used, respectively the pane below, to the left, to the right, or above the
2875: target pane is used.
1.681 nicm 2876: .Fl Z
2877: keeps the window zoomed if it was zoomed.
1.204 nicm 2878: .Fl l
2879: is the same as using the
2880: .Ic last-pane
2881: command.
1.398 nicm 2882: .Fl e
2883: enables or
2884: .Fl d
2885: disables input to the pane.
1.668 nicm 2886: .Fl T
2887: sets the pane title.
1.418 nicm 2888: .Pp
1.432 nicm 2889: .Fl m
2890: and
2891: .Fl M
2892: are used to set and clear the
2893: .Em marked pane .
2894: There is one marked pane at a time, setting a new marked pane clears the last.
2895: The marked pane is the default target for
2896: .Fl s
2897: to
2898: .Ic join-pane ,
1.783 nicm 2899: .Ic move-pane ,
1.432 nicm 2900: .Ic swap-pane
2901: and
2902: .Ic swap-window .
1.858 kn 2903: .Tg selectw
1.204 nicm 2904: .It Xo Ic select-window
1.310 nicm 2905: .Op Fl lnpT
1.204 nicm 2906: .Op Fl t Ar target-window
2907: .Xc
1.870 kn 2908: .D1 Pq alias: Ic selectw
1.57 jmc 2909: Select the window at
2910: .Ar target-window .
1.204 nicm 2911: .Fl l ,
2912: .Fl n
2913: and
2914: .Fl p
2915: are equivalent to the
2916: .Ic last-window ,
2917: .Ic next-window
2918: and
2919: .Ic previous-window
2920: commands.
1.310 nicm 2921: If
2922: .Fl T
2923: is given and the selected window is already the current window,
2924: the command behaves like
2925: .Ic last-window .
1.858 kn 2926: .Tg splitw
1.57 jmc 2927: .It Xo Ic split-window
1.828 nicm 2928: .Op Fl bdfhIvPZ
1.272 nicm 2929: .Op Fl c Ar start-directory
1.641 nicm 2930: .Op Fl e Ar environment
1.690 nicm 2931: .Op Fl l Ar size
1.136 nicm 2932: .Op Fl t Ar target-pane
1.153 nicm 2933: .Op Ar shell-command
1.279 nicm 2934: .Op Fl F Ar format
1.57 jmc 2935: .Xc
1.870 kn 2936: .D1 Pq alias: Ic splitw
1.136 nicm 2937: Create a new pane by splitting
2938: .Ar target-pane :
1.57 jmc 2939: .Fl h
2940: does a horizontal split and
2941: .Fl v
2942: a vertical split; if neither is specified,
2943: .Fl v
2944: is assumed.
2945: The
2946: .Fl l
1.690 nicm 2947: option specifies the size of the new pane in lines (for vertical split) or in
2948: columns (for horizontal split);
2949: .Ar size
2950: may be followed by
2951: .Ql %
2952: to specify a percentage of the available space.
1.408 nicm 2953: The
2954: .Fl b
2955: option causes the new pane to be created to the left of or above
2956: .Ar target-pane .
1.494 nicm 2957: The
2958: .Fl f
2959: option creates a new pane spanning the full window height (with
2960: .Fl h )
2961: or full window width (with
2962: .Fl v ) ,
2963: instead of splitting the active pane.
1.828 nicm 2964: .Fl Z
2965: zooms if the window is not zoomed, or keeps it zoomed if already zoomed.
1.643 nicm 2966: .Pp
2967: An empty
2968: .Ar shell-command
2969: ('') will create a pane with no command running in it.
2970: Output can be sent to such a pane with the
2971: .Ic display-message
2972: command.
2973: The
2974: .Fl I
2975: flag (if
2976: .Ar shell-command
2977: is not specified or empty)
2978: will create an empty pane and forward any output from stdin to it.
2979: For example:
2980: .Bd -literal -offset indent
2981: $ make 2>&1|tmux splitw -dI &
2982: .Ed
2983: .Pp
1.136 nicm 2984: All other options have the same meaning as for the
1.57 jmc 2985: .Ic new-window
2986: command.
1.858 kn 2987: .Tg swapp
1.57 jmc 2988: .It Xo Ic swap-pane
1.681 nicm 2989: .Op Fl dDUZ
1.57 jmc 2990: .Op Fl s Ar src-pane
2991: .Op Fl t Ar dst-pane
2992: .Xc
1.870 kn 2993: .D1 Pq alias: Ic swapp
1.57 jmc 2994: Swap two panes.
2995: If
2996: .Fl U
2997: is used and no source pane is specified with
2998: .Fl s ,
2999: .Ar dst-pane
3000: is swapped with the previous pane (before it numerically);
3001: .Fl D
3002: swaps with the next pane (after it numerically).
1.138 nicm 3003: .Fl d
3004: instructs
3005: .Nm
1.681 nicm 3006: not to change the active pane and
3007: .Fl Z
3008: keeps the window zoomed if it was zoomed.
1.432 nicm 3009: .Pp
3010: If
3011: .Fl s
3012: is omitted and a marked pane is present (see
3013: .Ic select-pane
3014: .Fl m ) ,
3015: the marked pane is used rather than the current pane.
1.858 kn 3016: .Tg swapw
1.57 jmc 3017: .It Xo Ic swap-window
3018: .Op Fl d
3019: .Op Fl s Ar src-window
3020: .Op Fl t Ar dst-window
3021: .Xc
1.870 kn 3022: .D1 Pq alias: Ic swapw
1.57 jmc 3023: This is similar to
3024: .Ic link-window ,
3025: except the source and destination windows are swapped.
3026: It is an error if no window exists at
3027: .Ar src-window .
1.705 nicm 3028: If
3029: .Fl d
3030: is given, the new window does not become the current window.
1.432 nicm 3031: .Pp
1.705 nicm 3032: If
1.432 nicm 3033: .Fl s
3034: is omitted and a marked pane is present (see
3035: .Ic select-pane
3036: .Fl m ) ,
3037: the window containing the marked pane is used rather than the current window.
1.858 kn 3038: .Tg unlinkw
1.57 jmc 3039: .It Xo Ic unlink-window
1.1 nicm 3040: .Op Fl k
3041: .Op Fl t Ar target-window
3042: .Xc
1.870 kn 3043: .D1 Pq alias: Ic unlinkw
1.57 jmc 3044: Unlink
3045: .Ar target-window .
3046: Unless
3047: .Fl k
3048: is given, a window may be unlinked only if it is linked to multiple sessions -
3049: windows may not be linked to no sessions;
3050: if
1.1 nicm 3051: .Fl k
1.57 jmc 3052: is specified and the window is linked to only one session, it is unlinked and
3053: destroyed.
3054: .El
3055: .Sh KEY BINDINGS
1.93 nicm 3056: .Nm
3057: allows a command to be bound to most keys, with or without a prefix key.
3058: When specifying keys, most represent themselves (for example
3059: .Ql A
3060: to
1.95 jmc 3061: .Ql Z ) .
1.93 nicm 3062: Ctrl keys may be prefixed with
3063: .Ql C-
3064: or
1.95 jmc 3065: .Ql ^ ,
1.838 nicm 3066: Shift keys with
3067: .Ql S-
1.95 jmc 3068: and Alt (meta) with
1.93 nicm 3069: .Ql M- .
3070: In addition, the following special key names are accepted:
1.126 nicm 3071: .Em Up ,
3072: .Em Down ,
3073: .Em Left ,
3074: .Em Right ,
1.93 nicm 3075: .Em BSpace ,
3076: .Em BTab ,
3077: .Em DC
3078: (Delete),
3079: .Em End ,
3080: .Em Enter ,
3081: .Em Escape ,
3082: .Em F1
3083: to
1.402 nicm 3084: .Em F12 ,
1.93 nicm 3085: .Em Home ,
3086: .Em IC
3087: (Insert),
1.254 nicm 3088: .Em NPage/PageDown/PgDn ,
3089: .Em PPage/PageUp/PgUp ,
1.93 nicm 3090: .Em Space ,
3091: and
3092: .Em Tab .
3093: Note that to bind the
3094: .Ql \&"
3095: or
3096: .Ql '
3097: keys, quotation marks are necessary, for example:
3098: .Bd -literal -offset indent
3099: bind-key '"' split-window
1.167 nicm 3100: bind-key "'" new-window
1.93 nicm 3101: .Ed
1.693 nicm 3102: .Pp
3103: A command bound to the
3104: .Em Any
3105: key will execute for all keys which do not have a more specific binding.
1.93 nicm 3106: .Pp
1.57 jmc 3107: Commands related to key bindings are as follows:
3108: .Bl -tag -width Ds
1.858 kn 3109: .Tg bind
1.57 jmc 3110: .It Xo Ic bind-key
1.501 nicm 3111: .Op Fl nr
1.706 nicm 3112: .Op Fl N Ar note
1.421 nicm 3113: .Op Fl T Ar key-table
1.750 jmc 3114: .Ar key command Op Ar arguments
1.1 nicm 3115: .Xc
1.870 kn 3116: .D1 Pq alias: Ic bind
1.57 jmc 3117: Bind key
3118: .Ar key
3119: to
3120: .Ar command .
1.421 nicm 3121: Keys are bound in a key table.
3122: By default (without -T), the key is bound in
3123: the
3124: .Em prefix
3125: key table.
3126: This table is used for keys pressed after the prefix key (for example,
3127: by default
3128: .Ql c
3129: is bound to
3130: .Ic new-window
3131: in the
3132: .Em prefix
3133: table, so
3134: .Ql C-b c
3135: creates a new window).
3136: The
3137: .Em root
3138: table is used for keys pressed without the prefix key: binding
3139: .Ql c
3140: to
3141: .Ic new-window
3142: in the
3143: .Em root
3144: table (not recommended) means a plain
3145: .Ql c
3146: will create a new window.
1.57 jmc 3147: .Fl n
1.421 nicm 3148: is an alias
3149: for
3150: .Fl T Ar root .
3151: Keys may also be bound in custom key tables and the
3152: .Ic switch-client
3153: .Fl T
3154: command used to switch to them from a key binding.
1.1 nicm 3155: The
1.57 jmc 3156: .Fl r
3157: flag indicates this key may repeat, see the
3158: .Ic repeat-time
3159: option.
1.706 nicm 3160: .Fl N
3161: attaches a note to the key (shown with
3162: .Ic list-keys
3163: .Fl N ) .
1.57 jmc 3164: .Pp
3165: To view the default bindings and possible commands, see the
3166: .Ic list-keys
3167: command.
1.858 kn 3168: .Tg lsk
1.421 nicm 3169: .It Xo Ic list-keys
1.712 nicm 3170: .Op Fl 1aN
1.706 nicm 3171: .Op Fl P Ar prefix-string Fl T Ar key-table
1.731 nicm 3172: .Op Ar key
1.421 nicm 3173: .Xc
1.870 kn 3174: .D1 Pq alias: Ic lsk
1.710 nicm 3175: List key bindings.
3176: There are two forms: the default lists keys as
1.706 nicm 3177: .Ic bind-key
1.710 nicm 3178: commands;
3179: .Fl N
3180: lists only keys with attached notes and shows only the key and note for each
3181: key.
3182: .Pp
3183: With the default form, all key tables are listed by default.
3184: .Fl T
3185: lists only keys in
3186: .Ar key-table .
3187: .Pp
3188: With the
1.706 nicm 3189: .Fl N
1.710 nicm 3190: form, only keys in the
1.706 nicm 3191: .Em root
3192: and
3193: .Em prefix
1.710 nicm 3194: key tables are listed by default;
3195: .Fl T
3196: also lists only keys in
3197: .Ar key-table .
1.706 nicm 3198: .Fl P
1.710 nicm 3199: specifies a prefix to print before each key and
1.706 nicm 3200: .Fl 1
1.710 nicm 3201: lists only the first matching key.
1.712 nicm 3202: .Fl a
1.787 nicm 3203: lists the command for keys that do not have a note rather than skipping them.
1.858 kn 3204: .Tg send
1.57 jmc 3205: .It Xo Ic send-keys
1.694 nicm 3206: .Op Fl FHlMRX
1.497 nicm 3207: .Op Fl N Ar repeat-count
1.72 nicm 3208: .Op Fl t Ar target-pane
1.57 jmc 3209: .Ar key Ar ...
1.1 nicm 3210: .Xc
1.870 kn 3211: .D1 Pq alias: Ic send
1.57 jmc 3212: Send a key or keys to a window.
3213: Each argument
3214: .Ar key
3215: is the name of the key (such as
3216: .Ql C-a
3217: or
1.523 nicm 3218: .Ql NPage )
3219: to send; if the string is not recognised as a key, it is sent as a series of
1.57 jmc 3220: characters.
1.676 nicm 3221: All arguments are sent sequentially from first to last.
1.856 nicm 3222: If no keys are given and the command is bound to a key, then that key is used.
1.676 nicm 3223: .Pp
1.273 nicm 3224: The
3225: .Fl l
1.676 nicm 3226: flag disables key name lookup and processes the keys as literal UTF-8
3227: characters.
3228: The
3229: .Fl H
3230: flag expects each key to be a hexadecimal number for an ASCII character.
3231: .Pp
1.265 nicm 3232: The
3233: .Fl R
3234: flag causes the terminal state to be reset.
1.419 nicm 3235: .Pp
3236: .Fl M
3237: passes through a mouse event (only valid if bound to a mouse key binding, see
1.420 jmc 3238: .Sx MOUSE SUPPORT ) .
1.497 nicm 3239: .Pp
3240: .Fl X
3241: is used to send a command into copy mode - see
3242: the
3243: .Sx WINDOWS AND PANES
3244: section.
3245: .Fl N
1.694 nicm 3246: specifies a repeat count and
3247: .Fl F
3248: expands formats in arguments where appropriate.
1.267 nicm 3249: .It Xo Ic send-prefix
3250: .Op Fl 2
3251: .Op Fl t Ar target-pane
3252: .Xc
3253: Send the prefix key, or with
3254: .Fl 2
3255: the secondary prefix key, to a window as if it was pressed.
1.858 kn 3256: .Tg unbind
1.57 jmc 3257: .It Xo Ic unbind-key
1.795 nicm 3258: .Op Fl anq
1.421 nicm 3259: .Op Fl T Ar key-table
1.57 jmc 3260: .Ar key
1.2 nicm 3261: .Xc
1.870 kn 3262: .D1 Pq alias: Ic unbind
1.57 jmc 3263: Unbind the command bound to
3264: .Ar key .
1.530 nicm 3265: .Fl n
3266: and
1.421 nicm 3267: .Fl T
3268: are the same as for
3269: .Ic bind-key .
1.189 nicm 3270: If
3271: .Fl a
3272: is present, all key bindings are removed.
1.795 nicm 3273: The
3274: .Fl q
3275: option prevents errors being returned.
1.57 jmc 3276: .El
3277: .Sh OPTIONS
3278: The appearance and behaviour of
3279: .Nm
3280: may be modified by changing the value of various options.
1.668 nicm 3281: There are four types of option:
1.133 nicm 3282: .Em server options ,
1.831 nicm 3283: .Em session options ,
3284: .Em window options ,
1.57 jmc 3285: and
1.668 nicm 3286: .Em pane options .
1.57 jmc 3287: .Pp
1.133 nicm 3288: The
3289: .Nm
1.686 nicm 3290: server has a set of global server options which do not apply to any particular
1.668 nicm 3291: window or session or pane.
1.133 nicm 3292: These are altered with the
3293: .Ic set-option
3294: .Fl s
3295: command, or displayed with the
3296: .Ic show-options
3297: .Fl s
3298: command.
3299: .Pp
3300: In addition, each individual session may have a set of session options, and
3301: there is a separate set of global session options.
1.57 jmc 3302: Sessions which do not have a particular option configured inherit the value
3303: from the global session options.
3304: Session options are set or unset with the
3305: .Ic set-option
3306: command and may be listed with the
3307: .Ic show-options
3308: command.
1.133 nicm 3309: The available server and session options are listed under the
1.57 jmc 3310: .Ic set-option
3311: command.
3312: .Pp
1.668 nicm 3313: Similarly, a set of window options is attached to each window and a set of pane
3314: options to each pane.
3315: Pane options inherit from window options.
3316: This means any pane option may be set as a window option to apply the option to
3317: all panes in the window without the option set, for example these commands will
3318: set the background colour to red for all panes except pane 0:
3319: .Bd -literal -offset indent
3320: set -w window-style bg=red
3321: set -pt:.0 window-style bg=blue
3322: .Ed
3323: .Pp
3324: There is also a set of global window options from which any unset window or
3325: pane options are inherited.
3326: Window and pane options are altered with
3327: .Ic set-option
3328: .Fl w
3329: and
3330: .Fl p
3331: commands and displayed with
3332: .Ic show-option
3333: .Fl w
3334: and
3335: .Fl p .
1.318 nicm 3336: .Pp
3337: .Nm
3338: also supports user options which are prefixed with a
3339: .Ql \&@ .
1.321 jmc 3340: User options may have any name, so long as they are prefixed with
3341: .Ql \&@ ,
1.318 nicm 3342: and be set to any string.
1.418 nicm 3343: For example:
1.318 nicm 3344: .Bd -literal -offset indent
1.774 nicm 3345: $ tmux set -wq @foo "abc123"
3346: $ tmux show -wv @foo
1.318 nicm 3347: abc123
3348: .Ed
1.57 jmc 3349: .Pp
3350: Commands which set options are as follows:
3351: .Bl -tag -width Ds
1.858 kn 3352: .Tg set
1.1 nicm 3353: .It Xo Ic set-option
1.808 nicm 3354: .Op Fl aFgopqsuUw
1.668 nicm 3355: .Op Fl t Ar target-pane
1.1 nicm 3356: .Ar option Ar value
3357: .Xc
1.870 kn 3358: .D1 Pq alias: Ic set
1.668 nicm 3359: Set a pane option with
3360: .Fl p ,
3361: a window option with
3362: .Fl w ,
1.133 nicm 3363: a server option with
3364: .Fl s ,
3365: otherwise a session option.
1.637 nicm 3366: If the option is not a user option,
3367: .Fl w
1.668 nicm 3368: or
1.637 nicm 3369: .Fl s
1.668 nicm 3370: may be unnecessary -
1.637 nicm 3371: .Nm
1.668 nicm 3372: will infer the type from the option name, assuming
3373: .Fl w
3374: for pane options.
1.133 nicm 3375: If
3376: .Fl g
1.433 nicm 3377: is given, the global session or window option is set.
1.637 nicm 3378: .Pp
1.550 nicm 3379: .Fl F
3380: expands formats in the option value.
1.1 nicm 3381: The
3382: .Fl u
3383: flag unsets an option, so a session inherits the option from the global
1.433 nicm 3384: options (or with
3385: .Fl g ,
3386: restores a global option to the default).
1.808 nicm 3387: .Fl U
3388: unsets an option (like
3389: .Fl u )
3390: but if the option is a pane option also unsets the option on any panes in the
3391: window.
1.796 nicm 3392: .Ar value
3393: depends on the option and may be a number, a string, or a flag (on, off, or
3394: omitted to toggle).
1.336 nicm 3395: .Pp
3396: The
3397: .Fl o
1.446 nicm 3398: flag prevents setting an option that is already set and the
1.281 nicm 3399: .Fl q
1.446 nicm 3400: flag suppresses errors about unknown or ambiguous options.
1.281 nicm 3401: .Pp
1.378 nicm 3402: With
3403: .Fl a ,
3404: and if the option expects a string or a style,
3405: .Ar value
3406: is appended to the existing setting.
3407: For example:
3408: .Bd -literal -offset indent
3409: set -g status-left "foo"
3410: set -ag status-left "bar"
3411: .Ed
3412: .Pp
3413: Will result in
3414: .Ql foobar .
3415: And:
3416: .Bd -literal -offset indent
3417: set -g status-style "bg=red"
3418: set -ag status-style "fg=blue"
3419: .Ed
3420: .Pp
3421: Will result in a red background
3422: .Em and
3423: blue foreground.
3424: Without
3425: .Fl a ,
3426: the result would be the default background and a blue foreground.
1.858 kn 3427: .Tg show
1.668 nicm 3428: .It Xo Ic show-options
3429: .Op Fl AgHpqsvw
3430: .Op Fl t Ar target-pane
3431: .Op Ar option
3432: .Xc
1.870 kn 3433: .D1 Pq alias: Ic show
1.668 nicm 3434: Show the pane options (or a single option if
3435: .Ar option
3436: is provided) with
3437: .Fl p ,
3438: the window options with
3439: .Fl w ,
3440: the server options with
3441: .Fl s ,
3442: otherwise the session options.
3443: If the option is not a user option,
3444: .Fl w
3445: or
3446: .Fl s
3447: may be unnecessary -
3448: .Nm
3449: will infer the type from the option name, assuming
3450: .Fl w
3451: for pane options.
3452: Global session or window options are listed if
3453: .Fl g
3454: is used.
3455: .Fl v
3456: shows only the option value, not the name.
3457: If
3458: .Fl q
3459: is set, no error will be returned if
3460: .Ar option
3461: is unset.
3462: .Fl H
3463: includes hooks (omitted by default).
3464: .Fl A
3465: includes options inherited from a parent set of options, such options are
3466: marked with an asterisk.
3467: .El
1.133 nicm 3468: .Pp
3469: Available server options are:
3470: .Bl -tag -width Ds
1.695 nicm 3471: .It Ic backspace Ar key
3472: Set the key sent by
3473: .Nm
3474: for backspace.
1.198 nicm 3475: .It Ic buffer-limit Ar number
3476: Set the number of buffers; as new buffers are added to the top of the stack,
3477: old ones are removed from the bottom if necessary to maintain this maximum
3478: length.
1.526 nicm 3479: .It Xo Ic command-alias[]
3480: .Ar name=value
3481: .Xc
3482: This is an array of custom aliases for commands.
3483: If an unknown command matches
3484: .Ar name ,
3485: it is replaced with
3486: .Ar value .
3487: For example, after:
3488: .Pp
1.565 nicm 3489: .Dl set -s command-alias[100] zoom='resize-pane -Z'
1.526 nicm 3490: .Pp
3491: Using:
3492: .Pp
3493: .Dl zoom -t:.1
3494: .Pp
3495: Is equivalent to:
3496: .Pp
3497: .Dl resize-pane -Z -t:.1
3498: .Pp
3499: Note that aliases are expanded when a command is parsed rather than when it is
3500: executed, so binding an alias with
3501: .Ic bind-key
3502: will bind the expanded form.
1.425 nicm 3503: .It Ic default-terminal Ar terminal
3504: Set the default terminal for new windows created in this session - the
3505: default value of the
3506: .Ev TERM
3507: environment variable.
3508: For
3509: .Nm
3510: to work correctly, this
3511: .Em must
3512: be set to
3513: .Ql screen ,
3514: .Ql tmux
3515: or a derivative of them.
1.742 nicm 3516: .It Ic copy-command Ar shell-command
3517: Give the command to pipe to if the
3518: .Ic copy-pipe
3519: copy mode command is used without arguments.
1.239 nicm 3520: .It Ic escape-time Ar time
3521: Set the time in milliseconds for which
3522: .Nm
3523: waits after an escape is input to determine if it is part of a function or meta
3524: key sequences.
3525: The default is 500 milliseconds.
1.759 nicm 3526: .It Ic editor Ar shell-command
3527: Set the command used when
3528: .Nm
3529: runs an editor.
1.592 nicm 3530: .It Xo Ic exit-empty
3531: .Op Ic on | off
3532: .Xc
3533: If enabled (the default), the server will exit when there are no active
3534: sessions.
1.239 nicm 3535: .It Xo Ic exit-unattached
3536: .Op Ic on | off
3537: .Xc
3538: If enabled, the server will exit when there are no attached clients.
1.772 nicm 3539: .It Xo Ic extended-keys
1.836 nicm 3540: .Op Ic on | off | always
1.772 nicm 3541: .Xc
1.836 nicm 3542: When
3543: .Ic on
3544: or
3545: .Ic always ,
3546: the escape sequence to enable extended keys is sent to the terminal, if
3547: .Nm
3548: knows that it is supported.
3549: .Nm
3550: always recognises extended keys itself.
3551: If this option is
3552: .Ic on ,
3553: .Nm
3554: will only forward extended keys to applications when they request them; if
3555: .Ic always ,
3556: .Nm
3557: will always forward the keys.
1.362 nicm 3558: .It Xo Ic focus-events
3559: .Op Ic on | off
3560: .Xc
3561: When enabled, focus events are requested from the terminal if supported and
3562: passed through to applications running in
3563: .Nm .
3564: Attached clients should be detached and attached again after changing this
3565: option.
1.445 nicm 3566: .It Ic history-file Ar path
3567: If not empty, a file to which
3568: .Nm
3569: will write command prompt history on exit and load it from on start.
1.384 nicm 3570: .It Ic message-limit Ar number
3571: Set the number of error or information messages to save in the message log for
3572: each client.
1.839 nicm 3573: .It Ic prompt-history-limit Ar number
3574: Set the number of history items to save in the history file for each type of
3575: command prompt.
1.228 nicm 3576: .It Xo Ic set-clipboard
1.556 nicm 3577: .Op Ic on | external | off
1.228 nicm 3578: .Xc
3579: Attempt to set the terminal clipboard content using the
3580: .Xr xterm 1
1.560 nicm 3581: escape sequence, if there is an
1.228 nicm 3582: .Em \&Ms
3583: entry in the
3584: .Xr terminfo 5
1.560 nicm 3585: description (see the
3586: .Sx TERMINFO EXTENSIONS
3587: section).
3588: .Pp
1.556 nicm 3589: If set to
3590: .Ic on ,
3591: .Nm
3592: will both accept the escape sequence to create a buffer and attempt to set
3593: the terminal clipboard.
3594: If set to
3595: .Ic external ,
3596: .Nm
3597: will attempt to set the terminal clipboard but ignore attempts
3598: by applications to set
3599: .Nm
3600: buffers.
3601: If
3602: .Ic off ,
3603: .Nm
3604: will neither accept the clipboard escape sequence nor attempt to set the
3605: clipboard.
3606: .Pp
1.228 nicm 3607: Note that this feature needs to be enabled in
3608: .Xr xterm 1
3609: by setting the resource:
3610: .Bd -literal -offset indent
3611: disallowedWindowOps: 20,21,SetXprop
3612: .Ed
3613: .Pp
3614: Or changing this property from the
3615: .Xr xterm 1
3616: interactive menu when required.
1.744 nicm 3617: .It Ic terminal-features[] Ar string
3618: Set terminal features for terminal types read from
3619: .Xr terminfo 5 .
3620: .Nm
3621: has a set of named terminal features.
3622: Each will apply appropriate changes to the
3623: .Xr terminfo 5
3624: entry in use.
3625: .Pp
3626: .Nm
3627: can detect features for a few common terminals; this option can be used to
3628: easily tell tmux about features supported by terminals it cannot detect.
3629: The
3630: .Ic terminal-overrides
3631: option allows individual
3632: .Xr terminfo 5
3633: capabilities to be set instead,
3634: .Ic terminal-features
3635: is intended for classes of functionality supported in a standard way but not
3636: reported by
3637: .Xr terminfo 5 .
1.836 nicm 3638: Care must be taken to configure this only with features the terminal actually
3639: supports.
1.744 nicm 3640: .Pp
3641: This is an array option where each entry is a colon-separated string made up
3642: of a terminal type pattern (matched using
3643: .Xr fnmatch 3 )
3644: followed by a list of terminal features.
3645: The available features are:
3646: .Bl -tag -width Ds
3647: .It 256
3648: Supports 256 colours with the SGR escape sequences.
3649: .It clipboard
3650: Allows setting the system clipboard.
3651: .It ccolour
3652: Allows setting the cursor colour.
3653: .It cstyle
3654: Allows setting the cursor style.
1.778 nicm 3655: .It extkeys
3656: Supports extended keys.
3657: .It focus
3658: Supports focus reporting.
1.893 nicm 3659: .It hyperlinks
3660: Supports OSC 8 hyperlinks.
1.891 nicm 3661: .It ignorefkeys
3662: Ignore function keys from
3663: .Xr terminfo 5
3664: and use the
3665: .Nm
3666: internal set only.
1.744 nicm 3667: .It margins
3668: Supports DECSLRM margins.
1.842 nicm 3669: .It mouse
3670: Supports
3671: .Xr xterm 1
3672: mouse sequences.
1.885 nicm 3673: .It osc7
3674: Supports the OSC 7 working directory extension.
1.744 nicm 3675: .It overline
3676: Supports the overline SGR attribute.
3677: .It rectfill
3678: Supports the DECFRA rectangle fill escape sequence.
3679: .It RGB
3680: Supports RGB colour with the SGR escape sequences.
1.778 nicm 3681: .It strikethrough
3682: Supports the strikethrough SGR escape sequence.
1.744 nicm 3683: .It sync
3684: Supports synchronized updates.
3685: .It title
3686: Supports
3687: .Xr xterm 1
3688: title setting.
3689: .It usstyle
3690: Allows underscore style and colour to be set.
3691: .El
1.528 nicm 3692: .It Ic terminal-overrides[] Ar string
3693: Allow terminal descriptions read using
3694: .Xr terminfo 5
1.531 nicm 3695: to be overridden.
1.528 nicm 3696: Each entry is a colon-separated string made up of a terminal type pattern
3697: (matched using
1.381 nicm 3698: .Xr fnmatch 3 )
3699: and a set of
3700: .Em name=value
3701: entries.
3702: .Pp
3703: For example, to set the
3704: .Ql clear
3705: .Xr terminfo 5
3706: entry to
3707: .Ql \ee[H\ee[2J
1.528 nicm 3708: for all terminal types matching
3709: .Ql rxvt* :
3710: .Pp
3711: .Dl "rxvt*:clear=\ee[H\ee[2J"
1.381 nicm 3712: .Pp
3713: The terminal entry value is passed through
3714: .Xr strunvis 3
3715: before interpretation.
1.678 nicm 3716: .It Ic user-keys[] Ar key
3717: Set list of user-defined key escape sequences.
3718: Each item is associated with a key named
3719: .Ql User0 ,
3720: .Ql User1 ,
3721: and so on.
3722: .Pp
3723: For example:
3724: .Bd -literal -offset indent
3725: set -s user-keys[0] "\ee[5;30012~"
3726: bind User0 resize-pane -L 3
3727: .Ed
1.133 nicm 3728: .El
1.129 nicm 3729: .Pp
1.18 nicm 3730: Available session options are:
1.1 nicm 3731: .Bl -tag -width Ds
1.569 nicm 3732: .It Xo Ic activity-action
3733: .Op Ic any | none | current | other
3734: .Xc
3735: Set action on window activity when
3736: .Ic monitor-activity
3737: is on.
3738: .Ic any
3739: means activity in any window linked to a session causes a bell or message
3740: (depending on
3741: .Ic visual-activity )
3742: in the current window of that session,
3743: .Ic none
3744: means all activity is ignored (equivalent to
3745: .Ic monitor-activity
3746: being off),
3747: .Ic current
3748: means only activity in windows other than the current window are ignored and
3749: .Ic other
3750: means activity in the current window is ignored but not those in other windows.
1.312 nicm 3751: .It Ic assume-paste-time Ar milliseconds
3752: If keys are entered faster than one in
3753: .Ar milliseconds ,
3754: they are assumed to have been pasted rather than typed and
3755: .Nm
3756: key bindings are not processed.
3757: The default is one millisecond and zero disables.
1.69 nicm 3758: .It Ic base-index Ar index
3759: Set the base index from which an unused index should be searched when a new
3760: window is created.
3761: The default is zero.
1.1 nicm 3762: .It Xo Ic bell-action
1.429 nicm 3763: .Op Ic any | none | current | other
1.1 nicm 3764: .Xc
1.574 nicm 3765: Set action on a bell in a window when
3766: .Ic monitor-bell
3767: is on.
1.569 nicm 3768: The values are the same as those for
3769: .Ic activity-action .
1.153 nicm 3770: .It Ic default-command Ar shell-command
1.1 nicm 3771: Set the command used for new windows (if not specified when the window is
3772: created) to
1.153 nicm 3773: .Ar shell-command ,
1.79 nicm 3774: which may be any
3775: .Xr sh 1
3776: command.
1.19 nicm 3777: The default is an empty string, which instructs
3778: .Nm
1.79 nicm 3779: to create a login shell using the value of the
3780: .Ic default-shell
3781: option.
3782: .It Ic default-shell Ar path
3783: Specify the default shell.
3784: This is used as the login shell for new windows when the
3785: .Ic default-command
3786: option is set to empty, and must be the full path of the executable.
3787: When started
3788: .Nm
3789: tries to set a default value from the first suitable of the
1.19 nicm 3790: .Ev SHELL
1.79 nicm 3791: environment variable, the shell returned by
3792: .Xr getpwuid 3 ,
3793: or
3794: .Pa /bin/sh .
3795: This option should be configured when
3796: .Nm
3797: is used as a login shell.
1.629 nicm 3798: .It Ic default-size Ar XxY
1.642 nicm 3799: Set the default size of new windows when the
1.643 nicm 3800: .Ic window-size
1.642 nicm 3801: option is set to manual or when a session is created with
3802: .Ic new-session
3803: .Fl d .
3804: The value is the width and height separated by an
3805: .Ql x
3806: character.
3807: The default is 80x24.
1.206 nicm 3808: .It Xo Ic destroy-unattached
3809: .Op Ic on | off
3810: .Xc
1.185 nicm 3811: If enabled and the session is no longer attached to any clients, it is
3812: destroyed.
1.206 nicm 3813: .It Xo Ic detach-on-destroy
1.815 nicm 3814: .Op Ic off | on | no-detached
1.206 nicm 3815: .Xc
1.184 nicm 3816: If on (the default), the client is detached when the session it is attached to
3817: is destroyed.
3818: If off, the client is switched to the most recently active of the remaining
3819: sessions.
1.815 nicm 3820: If
3821: .Ic no-detached ,
3822: the client is detached only if there are no detached sessions; if detached
3823: sessions exist, the client is switched to the most recently active.
1.145 nicm 3824: .It Ic display-panes-active-colour Ar colour
3825: Set the colour used by the
3826: .Ic display-panes
3827: command to show the indicator for the active pane.
1.78 nicm 3828: .It Ic display-panes-colour Ar colour
1.145 nicm 3829: Set the colour used by the
1.78 nicm 3830: .Ic display-panes
1.145 nicm 3831: command to show the indicators for inactive panes.
1.78 nicm 3832: .It Ic display-panes-time Ar time
3833: Set the time in milliseconds for which the indicators shown by the
3834: .Ic display-panes
3835: command appear.
1.21 nicm 3836: .It Ic display-time Ar time
1.78 nicm 3837: Set the amount of time for which status line messages and other on-screen
3838: indicators are displayed.
1.462 tim 3839: If set to 0, messages and indicators are displayed until a key is pressed.
1.21 nicm 3840: .Ar time
3841: is in milliseconds.
1.1 nicm 3842: .It Ic history-limit Ar lines
3843: Set the maximum number of lines held in window history.
3844: This setting applies only to new windows - existing window histories are not
3845: resized and retain the limit at the point they were created.
1.474 nicm 3846: .It Ic key-table Ar key-table
3847: Set the default key table to
3848: .Ar key-table
3849: instead of
3850: .Em root .
1.1 nicm 3851: .It Ic lock-after-time Ar number
1.100 nicm 3852: Lock the session (like the
3853: .Ic lock-session
1.90 nicm 3854: command) after
1.1 nicm 3855: .Ar number
1.448 nicm 3856: seconds of inactivity.
1.100 nicm 3857: The default is not to lock (set to 0).
1.153 nicm 3858: .It Ic lock-command Ar shell-command
1.90 nicm 3859: Command to run when locking each client.
3860: The default is to run
3861: .Xr lock 1
3862: with
3863: .Fl np .
1.378 nicm 3864: .It Ic message-command-style Ar style
1.623 nicm 3865: Set status line message command style.
1.737 nicm 3866: This is used for the command prompt with
3867: .Xr vi 1
3868: keys when in command mode.
1.623 nicm 3869: For how to specify
3870: .Ar style ,
3871: see the
3872: .Sx STYLES
3873: section.
1.378 nicm 3874: .It Ic message-style Ar style
3875: Set status line message style.
1.737 nicm 3876: This is used for messages and for the command prompt.
1.378 nicm 3877: For how to specify
3878: .Ar style ,
3879: see the
1.623 nicm 3880: .Sx STYLES
3881: section.
1.419 nicm 3882: .It Xo Ic mouse
1.226 nicm 3883: .Op Ic on | off
3884: .Xc
3885: If on,
3886: .Nm
1.419 nicm 3887: captures the mouse and allows mouse events to be bound as key bindings.
3888: See the
3889: .Sx MOUSE SUPPORT
3890: section for details.
1.267 nicm 3891: .It Ic prefix Ar key
3892: Set the key accepted as a prefix key.
1.473 nicm 3893: In addition to the standard keys described under
3894: .Sx KEY BINDINGS ,
3895: .Ic prefix
3896: can be set to the special key
3897: .Ql None
3898: to set no prefix.
1.267 nicm 3899: .It Ic prefix2 Ar key
3900: Set a secondary key accepted as a prefix key.
1.473 nicm 3901: Like
3902: .Ic prefix ,
3903: .Ic prefix2
3904: can be set to
3905: .Ql None .
1.291 nicm 3906: .It Xo Ic renumber-windows
3907: .Op Ic on | off
3908: .Xc
3909: If on, when a window is closed in a session, automatically renumber the other
3910: windows in numerical order.
3911: This respects the
3912: .Ic base-index
3913: option if it has been set.
3914: If off, do not renumber the windows.
1.21 nicm 3915: .It Ic repeat-time Ar time
1.1 nicm 3916: Allow multiple commands to be entered without pressing the prefix-key again
3917: in the specified
1.21 nicm 3918: .Ar time
1.1 nicm 3919: milliseconds (the default is 500).
3920: Whether a key repeats may be set when it is bound using the
3921: .Fl r
3922: flag to
3923: .Ic bind-key .
1.52 nicm 3924: Repeat is enabled for the default keys bound to the
3925: .Ic resize-pane
3926: command.
1.1 nicm 3927: .It Xo Ic set-titles
1.56 jmc 3928: .Op Ic on | off
1.1 nicm 3929: .Xc
1.261 nicm 3930: Attempt to set the client terminal title using the
3931: .Em tsl
3932: and
3933: .Em fsl
3934: .Xr terminfo 5
3935: entries if they exist.
3936: .Nm
1.444 nicm 3937: automatically sets these to the \ee]0;...\e007 sequence if
3938: the terminal appears to be
3939: .Xr xterm 1 .
1.11 nicm 3940: This option is off by default.
1.86 nicm 3941: .It Ic set-titles-string Ar string
1.678 nicm 3942: String used to set the client terminal title if
1.86 nicm 3943: .Ic set-titles
3944: is on.
1.414 nicm 3945: Formats are expanded, see the
3946: .Sx FORMATS
3947: section.
1.569 nicm 3948: .It Xo Ic silence-action
3949: .Op Ic any | none | current | other
3950: .Xc
3951: Set action on window silence when
3952: .Ic monitor-silence
3953: is on.
3954: The values are the same as those for
3955: .Ic activity-action .
1.1 nicm 3956: .It Xo Ic status
1.625 nicm 3957: .Op Ic off | on | 2 | 3 | 4 | 5
1.1 nicm 3958: .Xc
1.625 nicm 3959: Show or hide the status line or specify its size.
3960: Using
3961: .Ic on
3962: gives a status line one row in height;
3963: .Ic 2 ,
3964: .Ic 3 ,
3965: .Ic 4
3966: or
3967: .Ic 5
3968: more rows.
3969: .It Ic status-format[] Ar format
3970: Specify the format to be used for each line of the status line.
3971: The default builds the top status line from the various individual status
3972: options below.
1.1 nicm 3973: .It Ic status-interval Ar interval
1.538 nicm 3974: Update the status line every
1.1 nicm 3975: .Ar interval
3976: seconds.
3977: By default, updates will occur every 15 seconds.
3978: A setting of zero disables redrawing at interval.
1.41 nicm 3979: .It Xo Ic status-justify
1.829 nicm 3980: .Op Ic left | centre | right | absolute-centre
1.41 nicm 3981: .Xc
1.829 nicm 3982: Set the position of the window list in the status line: left, centre or right.
3983: centre puts the window list in the relative centre of the available free space;
3984: absolute-centre uses the centre of the entire horizontal space.
1.1 nicm 3985: .It Xo Ic status-keys
1.56 jmc 3986: .Op Ic vi | emacs
1.1 nicm 3987: .Xc
1.6 jmc 3988: Use vi or emacs-style
1.1 nicm 3989: key bindings in the status line, for example at the command prompt.
1.191 nicm 3990: The default is emacs, unless the
3991: .Ev VISUAL
3992: or
3993: .Ev EDITOR
3994: environment variables are set and contain the string
3995: .Ql vi .
1.1 nicm 3996: .It Ic status-left Ar string
3997: Display
3998: .Ar string
1.538 nicm 3999: (by default the session name) to the left of the status line.
1.1 nicm 4000: .Ar string
4001: will be passed through
1.623 nicm 4002: .Xr strftime 3 .
4003: Also see the
4004: .Sx FORMATS
4005: and
4006: .Sx STYLES
4007: sections.
1.83 nicm 4008: .Pp
1.263 nicm 4009: For details on how the names and titles can be set see the
1.261 nicm 4010: .Sx "NAMES AND TITLES"
4011: section.
1.109 nicm 4012: .Pp
1.83 nicm 4013: Examples are:
4014: .Bd -literal -offset indent
4015: #(sysctl vm.loadavg)
4016: #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
4017: .Ed
1.10 nicm 4018: .Pp
1.405 nicm 4019: The default is
4020: .Ql "[#S] " .
1.1 nicm 4021: .It Ic status-left-length Ar length
4022: Set the maximum
4023: .Ar length
1.538 nicm 4024: of the left component of the status line.
1.1 nicm 4025: The default is 10.
1.378 nicm 4026: .It Ic status-left-style Ar style
4027: Set the style of the left part of the status line.
4028: For how to specify
4029: .Ar style ,
4030: see the
1.623 nicm 4031: .Sx STYLES
4032: section.
1.269 nicm 4033: .It Xo Ic status-position
4034: .Op Ic top | bottom
4035: .Xc
4036: Set the position of the status line.
1.1 nicm 4037: .It Ic status-right Ar string
4038: Display
4039: .Ar string
1.538 nicm 4040: to the right of the status line.
1.577 nicm 4041: By default, the current pane title in double quotes, the date and the time
1.151 nicm 4042: are shown.
1.1 nicm 4043: As with
4044: .Ic status-left ,
4045: .Ar string
4046: will be passed to
1.459 jmc 4047: .Xr strftime 3
4048: and character pairs are replaced.
1.1 nicm 4049: .It Ic status-right-length Ar length
4050: Set the maximum
4051: .Ar length
1.538 nicm 4052: of the right component of the status line.
1.1 nicm 4053: The default is 40.
1.378 nicm 4054: .It Ic status-right-style Ar style
4055: Set the style of the right part of the status line.
4056: For how to specify
4057: .Ar style ,
4058: see the
1.623 nicm 4059: .Sx STYLES
4060: section.
1.378 nicm 4061: .It Ic status-style Ar style
4062: Set status line style.
4063: For how to specify
4064: .Ar style ,
4065: see the
1.623 nicm 4066: .Sx STYLES
4067: section.
1.529 nicm 4068: .It Ic update-environment[] Ar variable
4069: Set list of environment variables to be copied into the session environment
4070: when a new session is created or an existing session is attached.
1.63 nicm 4071: Any variables that do not exist in the source environment are set to be
4072: removed from the session environment (as if
4073: .Fl r
4074: was given to the
4075: .Ic set-environment
4076: command).
1.37 nicm 4077: .It Xo Ic visual-activity
1.569 nicm 4078: .Op Ic on | off | both
1.37 nicm 4079: .Xc
1.569 nicm 4080: If on, display a message instead of sending a bell when activity occurs in a
4081: window for which the
1.37 nicm 4082: .Ic monitor-activity
4083: window option is enabled.
1.569 nicm 4084: If set to both, a bell and a message are produced.
1.37 nicm 4085: .It Xo Ic visual-bell
1.569 nicm 4086: .Op Ic on | off | both
1.37 nicm 4087: .Xc
1.574 nicm 4088: If on, a message is shown on a bell in a window for which the
4089: .Ic monitor-bell
4090: window option is enabled instead of it being passed through to the
1.569 nicm 4091: terminal (which normally makes a sound).
4092: If set to both, a bell and a message are produced.
1.37 nicm 4093: Also see the
4094: .Ic bell-action
4095: option.
1.192 nicm 4096: .It Xo Ic visual-silence
1.569 nicm 4097: .Op Ic on | off | both
1.192 nicm 4098: .Xc
4099: If
4100: .Ic monitor-silence
1.569 nicm 4101: is enabled, prints a message after the interval has expired on a given window
4102: instead of sending a bell.
4103: If set to both, a bell and a message are produced.
1.255 nicm 4104: .It Ic word-separators Ar string
4105: Sets the session's conception of what characters are considered word
4106: separators, for the purposes of the next and previous word commands in
4107: copy mode.
1.857 nicm 4108: .El
1.1 nicm 4109: .Pp
1.668 nicm 4110: Available window options are:
1.56 jmc 4111: .Pp
4112: .Bl -tag -width Ds -compact
1.1 nicm 4113: .It Xo Ic aggressive-resize
1.56 jmc 4114: .Op Ic on | off
1.1 nicm 4115: .Xc
4116: Aggressively resize the chosen window.
4117: This means that
4118: .Nm
1.642 nicm 4119: will resize the window to the size of the smallest or largest session
4120: (see the
4121: .Ic window-size
4122: option) for which it is the current window, rather than the session to
4123: which it is attached.
4124: The window may resize when the current window is changed on another
4125: session; this option is good for full-screen programs which support
1.6 jmc 4126: .Dv SIGWINCH
4127: and poor for interactive programs such as shells.
1.262 nicm 4128: .Pp
1.1 nicm 4129: .It Xo Ic automatic-rename
1.56 jmc 4130: .Op Ic on | off
1.1 nicm 4131: .Xc
4132: Control automatic window renaming.
4133: When this setting is enabled,
4134: .Nm
1.368 nicm 4135: will rename the window automatically using the format specified by
4136: .Ic automatic-rename-format .
1.1 nicm 4137: This flag is automatically disabled for an individual window when a name
4138: is specified at creation with
1.186 nicm 4139: .Ic new-window
4140: or
1.1 nicm 4141: .Ic new-session ,
4142: or later with
1.261 nicm 4143: .Ic rename-window ,
4144: or with a terminal escape sequence.
1.1 nicm 4145: It may be switched off globally with:
4146: .Bd -literal -offset indent
1.668 nicm 4147: set-option -wg automatic-rename off
1.1 nicm 4148: .Ed
1.368 nicm 4149: .Pp
4150: .It Ic automatic-rename-format Ar format
4151: The format (see
4152: .Sx FORMATS )
4153: used when the
4154: .Ic automatic-rename
4155: option is enabled.
1.56 jmc 4156: .Pp
1.1 nicm 4157: .It Ic clock-mode-colour Ar colour
4158: Set clock colour.
1.56 jmc 4159: .Pp
1.1 nicm 4160: .It Xo Ic clock-mode-style
1.56 jmc 4161: .Op Ic 12 | 24
1.1 nicm 4162: .Xc
4163: Set clock hour format.
1.883 nicm 4164: .Pp
4165: .It Ic fill-character Ar character
4166: Set the character used to fill areas of the terminal unused by a window.
1.56 jmc 4167: .Pp
1.196 nicm 4168: .It Ic main-pane-height Ar height
1.2 nicm 4169: .It Ic main-pane-width Ar width
4170: Set the width or height of the main (left or top) pane in the
4171: .Ic main-horizontal
4172: or
4173: .Ic main-vertical
4174: layouts.
1.747 nicm 4175: If suffixed by
4176: .Ql % ,
4177: this is a percentage of the window size.
1.757 nicm 4178: .Pp
4179: .It Ic copy-mode-match-style Ar style
4180: Set the style of search matches in copy mode.
1.768 nicm 4181: For how to specify
4182: .Ar style ,
4183: see the
4184: .Sx STYLES
4185: section.
4186: .Pp
4187: .It Ic copy-mode-mark-style Ar style
4188: Set the style of the line containing the mark in copy mode.
1.757 nicm 4189: For how to specify
4190: .Ar style ,
4191: see the
4192: .Sx STYLES
4193: section.
4194: .Pp
4195: .It Ic copy-mode-current-match-style Ar style
4196: Set the style of the current search match in copy mode.
4197: For how to specify
4198: .Ar style ,
4199: see the
4200: .Sx STYLES
4201: section.
1.56 jmc 4202: .Pp
1.1 nicm 4203: .It Xo Ic mode-keys
1.56 jmc 4204: .Op Ic vi | emacs
1.1 nicm 4205: .Xc
1.500 nicm 4206: Use vi or emacs-style key bindings in copy mode.
4207: The default is emacs, unless
1.191 nicm 4208: .Ev VISUAL
4209: or
4210: .Ev EDITOR
4211: contains
4212: .Ql vi .
1.56 jmc 4213: .Pp
1.378 nicm 4214: .It Ic mode-style Ar style
4215: Set window modes style.
4216: For how to specify
4217: .Ar style ,
4218: see the
1.623 nicm 4219: .Sx STYLES
4220: section.
1.378 nicm 4221: .Pp
1.1 nicm 4222: .It Xo Ic monitor-activity
1.56 jmc 4223: .Op Ic on | off
1.1 nicm 4224: .Xc
4225: Monitor for activity in the window.
4226: Windows with activity are highlighted in the status line.
1.56 jmc 4227: .Pp
1.574 nicm 4228: .It Xo Ic monitor-bell
4229: .Op Ic on | off
4230: .Xc
4231: Monitor for a bell in the window.
4232: Windows with a bell are highlighted in the status line.
4233: .Pp
1.192 nicm 4234: .It Xo Ic monitor-silence
4235: .Op Ic interval
4236: .Xc
4237: Monitor for silence (no activity) in the window within
4238: .Ic interval
4239: seconds.
4240: Windows that have been silent for the interval are highlighted in the
4241: status line.
4242: An interval of zero disables the monitoring.
1.195 nicm 4243: .Pp
4244: .It Ic other-pane-height Ar height
4245: Set the height of the other panes (not the main pane) in the
4246: .Ic main-horizontal
4247: layout.
4248: If this option is set to 0 (the default), it will have no effect.
4249: If both the
4250: .Ic main-pane-height
4251: and
4252: .Ic other-pane-height
4253: options are set, the main pane will grow taller to make the other panes the
4254: specified height, but will never shrink to do so.
1.747 nicm 4255: If suffixed by
4256: .Ql % ,
4257: this is a percentage of the window size.
1.195 nicm 4258: .Pp
4259: .It Ic other-pane-width Ar width
4260: Like
4261: .Ic other-pane-height ,
4262: but set the width of other panes in the
4263: .Ic main-vertical
4264: layout.
1.243 nicm 4265: .Pp
1.413 nicm 4266: .It Ic pane-active-border-style Ar style
4267: Set the pane border style for the currently active pane.
4268: For how to specify
4269: .Ar style ,
4270: see the
1.623 nicm 4271: .Sx STYLES
4272: section.
1.413 nicm 4273: Attributes are ignored.
1.866 nicm 4274: .Pp
1.243 nicm 4275: .It Ic pane-base-index Ar index
4276: Like
4277: .Ic base-index ,
4278: but set the starting index for pane numbers.
1.484 nicm 4279: .Pp
4280: .It Ic pane-border-format Ar format
4281: Set the text shown in pane border status lines.
1.875 nicm 4282: .Pp
4283: .It Xo Ic pane-border-indicators
4284: .Op Ic off | colour | arrows | both
4285: .Xc
4286: Indicate active pane by colouring only half of the border in windows with
4287: exactly two panes, by displaying arrow markers, by drawing both or neither.
1.770 nicm 4288: .Pp
4289: .It Ic pane-border-lines Ar type
4290: Set the type of characters used for drawing pane borders.
4291: .Ar type
4292: may be one of:
4293: .Bl -tag -width Ds
4294: .It single
4295: single lines using ACS or UTF-8 characters
4296: .It double
4297: double lines using UTF-8 characters
4298: .It heavy
4299: heavy lines using UTF-8 characters
4300: .It simple
4301: simple ASCII characters
4302: .It number
4303: the pane number
4304: .El
4305: .Pp
4306: .Ql double
4307: and
4308: .Ql heavy
4309: will fall back to standard ACS line drawing when UTF-8 is not supported.
1.484 nicm 4310: .Pp
4311: .It Xo Ic pane-border-status
4312: .Op Ic off | top | bottom
4313: .Xc
4314: Turn pane border status lines off or set their position.
1.413 nicm 4315: .Pp
4316: .It Ic pane-border-style Ar style
4317: Set the pane border style for panes aside from the active pane.
4318: For how to specify
4319: .Ar style ,
4320: see the
1.623 nicm 4321: .Sx STYLES
4322: section.
1.413 nicm 4323: Attributes are ignored.
1.192 nicm 4324: .Pp
1.862 nicm 4325: .It Ic popup-style Ar style
4326: Set the popup style.
4327: For how to specify
4328: .Ar style ,
4329: see the
4330: .Sx STYLES
4331: section.
4332: Attributes are ignored.
4333: .Pp
4334: .It Ic popup-border-style Ar style
4335: Set the popup border style.
4336: For how to specify
4337: .Ar style ,
4338: see the
4339: .Sx STYLES
4340: section.
4341: Attributes are ignored.
4342: .Pp
4343: .It Ic popup-border-lines Ar type
4344: Set the type of characters used for drawing popup borders.
4345: .Ar type
4346: may be one of:
4347: .Bl -tag -width Ds
4348: .It single
4349: single lines using ACS or UTF-8 characters (default)
4350: .It rounded
4351: variation of single with rounded corners using UTF-8 characters
4352: .It double
4353: double lines using UTF-8 characters
4354: .It heavy
4355: heavy lines using UTF-8 characters
4356: .It simple
4357: simple ASCII characters
4358: .It padded
4359: simple ASCII space character
4360: .It none
4361: no border
4362: .El
4363: .Pp
4364: .Ql double
4365: and
4366: .Ql heavy
4367: will fall back to standard ACS line drawing when UTF-8 is not supported.
4368: .Pp
1.378 nicm 4369: .It Ic window-status-activity-style Ar style
4370: Set status line style for windows with an activity alert.
4371: For how to specify
4372: .Ar style ,
4373: see the
1.623 nicm 4374: .Sx STYLES
4375: section.
1.169 nicm 4376: .Pp
1.378 nicm 4377: .It Ic window-status-bell-style Ar style
4378: Set status line style for windows with a bell alert.
4379: For how to specify
4380: .Ar style ,
4381: see the
1.623 nicm 4382: .Sx STYLES
4383: section.
1.169 nicm 4384: .Pp
1.125 nicm 4385: .It Ic window-status-current-format Ar string
4386: Like
4387: .Ar window-status-format ,
4388: but is the format used when the window is the current window.
1.307 nicm 4389: .Pp
1.378 nicm 4390: .It Ic window-status-current-style Ar style
4391: Set status line style for the currently active window.
4392: For how to specify
4393: .Ar style ,
4394: see the
1.623 nicm 4395: .Sx STYLES
4396: section.
1.239 nicm 4397: .Pp
4398: .It Ic window-status-format Ar string
4399: Set the format in which the window is displayed in the status line window list.
4400: See the
1.623 nicm 4401: .Sx FORMATS
4402: and
4403: .Sx STYLES
4404: sections.
1.290 nicm 4405: .Pp
1.378 nicm 4406: .It Ic window-status-last-style Ar style
4407: Set status line style for the last active window.
4408: For how to specify
4409: .Ar style ,
4410: see the
1.623 nicm 4411: .Sx STYLES
4412: section.
1.378 nicm 4413: .Pp
1.290 nicm 4414: .It Ic window-status-separator Ar string
4415: Sets the separator drawn between windows in the status line.
4416: The default is a single space character.
1.125 nicm 4417: .Pp
1.378 nicm 4418: .It Ic window-status-style Ar style
4419: Set status line style for a single window.
1.418 nicm 4420: For how to specify
4421: .Ar style ,
4422: see the
1.623 nicm 4423: .Sx STYLES
4424: section.
1.418 nicm 4425: .Pp
1.642 nicm 4426: .It Xo Ic window-size
1.689 nicm 4427: .Ar largest | Ar smallest | Ar manual | Ar latest
1.642 nicm 4428: .Xc
4429: Configure how
4430: .Nm
4431: determines the window size.
4432: If set to
4433: .Ar largest ,
4434: the size of the largest attached session is used; if
4435: .Ar smallest ,
4436: the size of the smallest.
4437: If
4438: .Ar manual ,
4439: the size of a new window is set from the
4440: .Ic default-size
4441: option and windows are resized automatically.
1.689 nicm 4442: With
4443: .Ar latest ,
4444: .Nm
4445: uses the size of the client that had the most recent activity.
1.642 nicm 4446: See also the
4447: .Ic resize-window
4448: command and the
4449: .Ic aggressive-resize
4450: option.
4451: .Pp
1.512 nicm 4452: .It Xo Ic wrap-search
4453: .Op Ic on | off
4454: .Xc
4455: If this option is set, searches will wrap around the end of the pane contents.
4456: The default is on.
1.57 jmc 4457: .El
1.668 nicm 4458: .Pp
4459: Available pane options are:
4460: .Pp
4461: .Bl -tag -width Ds -compact
1.877 nicm 4462: .It Xo Ic allow-passthrough
4463: .Op Ic on | off
4464: .Xc
4465: Allow programs in the pane to bypass
4466: .Nm
4467: using a terminal escape sequence (\eePtmux;...\ee\e\e).
4468: .Pp
1.669 nicm 4469: .It Xo Ic allow-rename
4470: .Op Ic on | off
4471: .Xc
4472: Allow programs in the pane to change the window name using a terminal escape
4473: sequence (\eek...\ee\e\e).
4474: .Pp
4475: .It Xo Ic alternate-screen
4476: .Op Ic on | off
4477: .Xc
4478: This option configures whether programs running inside the pane may use the
4479: terminal alternate screen feature, which allows the
4480: .Em smcup
4481: and
4482: .Em rmcup
4483: .Xr terminfo 5
4484: capabilities.
4485: The alternate screen feature preserves the contents of the window when an
4486: interactive application starts and restores it on exit, so that any output
4487: visible before the application starts reappears unchanged after it exits.
1.868 nicm 4488: .Pp
4489: .It Ic cursor-colour Ar colour
4490: Set the colour of the cursor.
1.850 nicm 4491: .Pp
4492: .It Ic pane-colours[] Ar colour
4493: The default colour palette.
4494: Each entry in the array defines the colour
4495: .Nm
4496: uses when the colour with that index is requested.
4497: The index may be from zero to 255.
1.869 nicm 4498: .Pp
4499: .It Ic cursor-style Ar style
1.871 nicm 4500: Set the style of the cursor.
4501: Available styles are:
1.869 nicm 4502: .Ic default ,
4503: .Ic blinking-block ,
4504: .Ic block ,
4505: .Ic blinking-underline ,
4506: .Ic underline ,
4507: .Ic blinking-bar ,
4508: .Ic bar .
1.669 nicm 4509: .Pp
1.668 nicm 4510: .It Xo Ic remain-on-exit
1.810 nicm 4511: .Op Ic on | off | failed
1.57 jmc 4512: .Xc
1.668 nicm 4513: A pane with this flag set is not destroyed when the program running in it
4514: exits.
1.810 nicm 4515: If set to
4516: .Ic failed ,
4517: then only when the program exit status is not zero.
1.668 nicm 4518: The pane may be reactivated with the
4519: .Ic respawn-pane
4520: command.
1.808 nicm 4521: .Pp
1.882 nicm 4522: .It Ic remain-on-exit-format Ar string
4523: Set the text shown at the bottom of exited panes when
4524: .Ic remain-on-exit
4525: is enabled.
1.884 nicm 4526: .Pp
4527: .It Xo Ic scroll-on-clear
4528: .Op Ic on | off
4529: .Xc
4530: When the entire screen is cleared and this option is on, scroll the contents of
4531: the screen into history before clearing it.
1.882 nicm 4532: .Pp
1.808 nicm 4533: .It Xo Ic synchronize-panes
4534: .Op Ic on | off
4535: .Xc
4536: Duplicate input to all other panes in the same window where this option is also
4537: on (only for panes that are not in any mode).
1.668 nicm 4538: .Pp
4539: .It Ic window-active-style Ar style
4540: Set the pane style when it is the active pane.
4541: For how to specify
4542: .Ar style ,
4543: see the
4544: .Sx STYLES
4545: section.
4546: .Pp
4547: .It Ic window-style Ar style
4548: Set the pane style.
4549: For how to specify
4550: .Ar style ,
4551: see the
4552: .Sx STYLES
4553: section.
1.843 jmc 4554: .El
1.469 nicm 4555: .Sh HOOKS
4556: .Nm
4557: allows commands to run on various triggers, called
4558: .Em hooks .
1.505 nicm 4559: Most
1.483 nicm 4560: .Nm
1.505 nicm 4561: commands have an
1.483 nicm 4562: .Em after
4563: hook and there are a number of hooks not associated with commands.
4564: .Pp
1.640 nicm 4565: Hooks are stored as array options, members of the array are executed in
4566: order when the hook is triggered.
1.740 nicm 4567: Like options different hooks may be global or belong to a session, window or pane.
1.640 nicm 4568: Hooks may be configured with the
4569: .Ic set-hook
4570: or
4571: .Ic set-option
4572: commands and displayed with
4573: .Ic show-hooks
4574: or
4575: .Ic show-options
4576: .Fl H .
4577: The following two commands are equivalent:
4578: .Bd -literal -offset indent.
4579: set-hook -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4580: set-option -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4581: .Ed
4582: .Pp
4583: Setting a hook without specifying an array index clears the hook and sets the
4584: first member of the array.
4585: .Pp
1.505 nicm 4586: A command's after
4587: hook is run after it completes, except when the command is run as part of a hook
1.483 nicm 4588: itself.
1.505 nicm 4589: They are named with an
1.483 nicm 4590: .Ql after-
4591: prefix.
4592: For example, the following command adds a hook to select the even-vertical
4593: layout after every
4594: .Ic split-window :
4595: .Bd -literal -offset indent
1.640 nicm 4596: set-hook -g after-split-window "selectl even-vertical"
1.483 nicm 4597: .Ed
4598: .Pp
1.584 nicm 4599: All the notifications listed in the
4600: .Sx CONTROL MODE
4601: section are hooks (without any arguments), except
4602: .Ic %exit .
4603: The following additional hooks are available:
1.560 nicm 4604: .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXX"
1.476 nicm 4605: .It alert-activity
4606: Run when a window has activity.
4607: See
4608: .Ic monitor-activity .
4609: .It alert-bell
4610: Run when a window has received a bell.
1.574 nicm 4611: See
4612: .Ic monitor-bell .
1.476 nicm 4613: .It alert-silence
4614: Run when a window has been silent.
4615: See
4616: .Ic monitor-silence .
1.845 nicm 4617: .It client-active
4618: Run when a client becomes the latest active client of its session.
1.469 nicm 4619: .It client-attached
4620: Run when a client is attached.
4621: .It client-detached
4622: Run when a client is detached
1.846 nicm 4623: .It client-focus-in
4624: Run when focus enters a client
4625: .It client-focus-out
4626: Run when focus exits a client
1.469 nicm 4627: .It client-resized
4628: Run when a client is resized.
1.511 nicm 4629: .It client-session-changed
4630: Run when a client's attached session is changed.
1.475 nicm 4631: .It pane-died
4632: Run when the program running in a pane exits, but
4633: .Ic remain-on-exit
4634: is on so the pane has not closed.
4635: .It pane-exited
4636: Run when the program running in a pane exits.
1.603 nicm 4637: .It pane-focus-in
4638: Run when the focus enters a pane, if the
4639: .Ic focus-events
4640: option is on.
4641: .It pane-focus-out
4642: Run when the focus exits a pane, if the
4643: .Ic focus-events
4644: option is on.
1.560 nicm 4645: .It pane-set-clipboard
4646: Run when the terminal clipboard is set using the
4647: .Xr xterm 1
4648: escape sequence.
1.510 nicm 4649: .It session-created
4650: Run when a new session created.
4651: .It session-closed
4652: Run when a session closed.
1.507 nicm 4653: .It session-renamed
4654: Run when a session is renamed.
1.511 nicm 4655: .It window-linked
4656: Run when a window is linked into a session.
1.507 nicm 4657: .It window-renamed
4658: Run when a window is renamed.
1.878 nicm 4659: .It window-resized
4660: Run when a window is resized.
4661: This may be after the
4662: .Ar client-resized
4663: hook is run.
1.511 nicm 4664: .It window-unlinked
4665: Run when a window is unlinked from a session.
1.469 nicm 4666: .El
4667: .Pp
4668: Hooks are managed with these commands:
4669: .Bl -tag -width Ds
4670: .It Xo Ic set-hook
1.740 nicm 4671: .Op Fl agpRuw
4672: .Op Fl t Ar target-pane
1.469 nicm 4673: .Ar hook-name
4674: .Ar command
4675: .Xc
1.604 nicm 4676: Without
1.605 jmc 4677: .Fl R ,
1.604 nicm 4678: sets (or with
1.496 nicm 4679: .Fl u
4680: unsets) hook
1.469 nicm 4681: .Ar hook-name
4682: to
4683: .Ar command .
1.740 nicm 4684: The flags are the same as for
4685: .Ic set-option .
1.604 nicm 4686: .Pp
4687: With
4688: .Fl R ,
4689: run
4690: .Ar hook-name
4691: immediately.
1.469 nicm 4692: .It Xo Ic show-hooks
1.740 nicm 4693: .Op Fl gpw
4694: .Op Fl t Ar target-pane
1.469 nicm 4695: .Xc
1.740 nicm 4696: Shows hooks.
4697: The flags are the same as for
4698: .Ic show-options .
1.470 jmc 4699: .El
1.419 nicm 4700: .Sh MOUSE SUPPORT
4701: If the
4702: .Ic mouse
4703: option is on (the default is off),
4704: .Nm
4705: allows mouse events to be bound as keys.
4706: The name of each key is made up of a mouse event (such as
4707: .Ql MouseUp1 )
1.632 nicm 4708: and a location suffix, one of the following:
4709: .Bl -column "XXXXXXXXXXXXX" -offset indent
4710: .It Li "Pane" Ta "the contents of a pane"
4711: .It Li "Border" Ta "a pane border"
4712: .It Li "Status" Ta "the status line window list"
4713: .It Li "StatusLeft" Ta "the left part of the status line"
4714: .It Li "StatusRight" Ta "the right part of the status line"
4715: .It Li "StatusDefault" Ta "any other part of the status line"
4716: .El
4717: .Pp
1.419 nicm 4718: The following mouse events are available:
4719: .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
1.498 nicm 4720: .It Li "WheelUp" Ta "WheelDown" Ta ""
1.481 nicm 4721: .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
4722: .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
4723: .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
1.724 nicm 4724: .It Li "SecondClick1" Ta "SecondClick2" Ta "SecondClick3"
1.590 nicm 4725: .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3"
4726: .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3"
1.419 nicm 4727: .El
1.724 nicm 4728: .Pp
4729: The
4730: .Ql SecondClick
4731: events are fired for the second click of a double click, even if there may be a
4732: third click which will fire
4733: .Ql TripleClick
4734: instead of
4735: .Ql DoubleClick .
1.419 nicm 4736: .Pp
4737: Each should be suffixed with a location, for example
4738: .Ql MouseDown1Status .
4739: .Pp
1.423 nicm 4740: The special token
4741: .Ql {mouse}
4742: or
1.419 nicm 4743: .Ql =
4744: may be used as
4745: .Ar target-window
4746: or
4747: .Ar target-pane
4748: in commands bound to mouse key bindings.
4749: It resolves to the window or pane over which the mouse event took place
4750: (for example, the window in the status line over which button 1 was released for a
4751: .Ql MouseUp1Status
4752: binding, or the pane over which the wheel was scrolled for a
4753: .Ql WheelDownPane
4754: binding).
4755: .Pp
4756: The
4757: .Ic send-keys
4758: .Fl M
4759: flag may be used to forward a mouse event to a pane.
4760: .Pp
4761: The default key bindings allow the mouse to be used to select and resize panes,
4762: to copy text and to change window using the status line.
4763: These take effect if the
4764: .Ic mouse
4765: option is turned on.
1.245 nicm 4766: .Sh FORMATS
1.294 nicm 4767: Certain commands accept the
1.245 nicm 4768: .Fl F
4769: flag with a
4770: .Ar format
4771: argument.
4772: This is a string which controls the output format of the command.
1.678 nicm 4773: Format variables are enclosed in
1.245 nicm 4774: .Ql #{
4775: and
4776: .Ql } ,
4777: for example
1.359 nicm 4778: .Ql #{session_name} .
1.409 nicm 4779: The possible variables are listed in the table below, or the name of a
4780: .Nm
4781: option may be used for an option's value.
4782: Some variables have a shorter alias such as
1.598 nicm 4783: .Ql #S ;
1.376 nicm 4784: .Ql ##
4785: is replaced by a single
1.598 nicm 4786: .Ql # ,
4787: .Ql #,
4788: by a
4789: .Ql \&,
4790: and
4791: .Ql #}
4792: by a
4793: .Ql } .
1.409 nicm 4794: .Pp
4795: Conditionals are available by prefixing with
1.246 jmc 4796: .Ql \&?
1.245 nicm 4797: and separating two alternatives with a comma;
4798: if the specified variable exists and is not zero, the first alternative
1.246 jmc 4799: is chosen, otherwise the second is used.
4800: For example
1.245 nicm 4801: .Ql #{?session_attached,attached,not attached}
4802: will include the string
4803: .Ql attached
4804: if the session is attached and the string
4805: .Ql not attached
1.409 nicm 4806: if it is unattached, or
4807: .Ql #{?automatic-rename,yes,no}
4808: will include
4809: .Ql yes
4810: if
4811: .Ic automatic-rename
4812: is enabled, or
4813: .Ql no
4814: if not.
1.599 nicm 4815: Conditionals can be nested arbitrarily.
4816: Inside a conditional,
4817: .Ql \&,
4818: and
4819: .Ql }
4820: must be escaped as
4821: .Ql #,
4822: and
4823: .Ql #} ,
4824: unless they are part of a
4825: .Ql #{...}
1.600 nicm 4826: replacement.
4827: For example:
1.599 nicm 4828: .Bd -literal -offset indent
4829: #{?pane_in_mode,#[fg=white#,bg=red],#[fg=red#,bg=white]}#W .
4830: .Ed
1.520 nicm 4831: .Pp
1.678 nicm 4832: String comparisons may be expressed by prefixing two comma-separated
1.520 nicm 4833: alternatives by
1.652 nicm 4834: .Ql == ,
4835: .Ql != ,
4836: .Ql < ,
4837: .Ql > ,
4838: .Ql <=
1.520 nicm 4839: or
1.652 nicm 4840: .Ql >=
1.520 nicm 4841: and a colon.
4842: For example
1.544 nicm 4843: .Ql #{==:#{host},myhost}
1.520 nicm 4844: will be replaced by
4845: .Ql 1
4846: if running on
4847: .Ql myhost ,
4848: otherwise by
1.554 nicm 4849: .Ql 0 .
4850: .Ql ||
4851: and
4852: .Ql &&
4853: evaluate to true if either or both of two comma-separated alternatives are
4854: true, for example
1.595 nicm 4855: .Ql #{||:#{pane_in_mode},#{alternate_on}} .
1.664 nicm 4856: .Pp
4857: An
4858: .Ql m
4859: specifies an
4860: .Xr fnmatch 3
4861: or regular expression comparison.
4862: The first argument is the pattern and the second the string to compare.
1.714 nicm 4863: An optional argument specifies flags:
1.664 nicm 4864: .Ql r
4865: means the pattern is a regular expression instead of the default
4866: .Xr fnmatch 3
4867: pattern, and
4868: .Ql i
4869: means to ignore case.
4870: For example:
4871: .Ql #{m:*foo*,#{host}}
4872: or
4873: .Ql #{m/ri:^A,MYVAR} .
1.554 nicm 4874: A
4875: .Ql C
4876: performs a search for an
4877: .Xr fnmatch 3
1.664 nicm 4878: pattern or regular expression in the pane content and evaluates to zero if not
4879: found, or a line number if found.
4880: Like
4881: .Ql m ,
1.665 jmc 4882: an
1.664 nicm 4883: .Ql r
4884: flag means search for a regular expression and
4885: .Ql i
4886: ignores case.
4887: For example:
4888: .Ql #{C/r:^Start}
1.714 nicm 4889: .Pp
4890: Numeric operators may be performed by prefixing two comma-separated alternatives with an
4891: .Ql e
4892: and an operator.
4893: An optional
4894: .Ql f
4895: flag may be given after the operator to use floating point numbers, otherwise integers are used.
4896: This may be followed by a number giving the number of decimal places to use for the result.
4897: The available operators are:
4898: addition
4899: .Ql + ,
4900: subtraction
4901: .Ql - ,
4902: multiplication
4903: .Ql * ,
4904: division
4905: .Ql / ,
1.801 nicm 4906: modulus
1.714 nicm 4907: .Ql m
4908: or
4909: .Ql %
4910: (note that
4911: .Ql %
4912: must be escaped as
4913: .Ql %%
4914: in formats which are also expanded by
1.801 nicm 4915: .Xr strftime 3 )
4916: and numeric comparison operators
4917: .Ql == ,
4918: .Ql != ,
4919: .Ql < ,
4920: .Ql <= ,
4921: .Ql >
4922: and
4923: .Ql >= .
1.714 nicm 4924: For example,
4925: .Ql #{e|*|f|4:5.5,3}
4926: multiplies 5.5 by 3 for a result with four decimal places and
4927: .Ql #{e|%%:7,3}
4928: returns the modulus of 7 and 3.
1.833 nicm 4929: .Ql a
4930: replaces a numeric argument by its ASCII equivalent, so
4931: .Ql #{a:98}
4932: results in
4933: .Ql b .
1.867 nicm 4934: .Ql c
4935: replaces a
4936: .Nm
4937: colour by its six-digit hexadecimal RGB value.
1.453 nicm 4938: .Pp
1.367 nicm 4939: A limit may be placed on the length of the resultant string by prefixing it
4940: by an
4941: .Ql = ,
1.479 nicm 4942: a number and a colon.
4943: Positive numbers count from the start of the string and negative from the end,
4944: so
4945: .Ql #{=5:pane_title}
1.653 nicm 4946: will include at most the first five characters of the pane title, or
1.479 nicm 4947: .Ql #{=-5:pane_title}
1.653 nicm 4948: the last five characters.
4949: A suffix or prefix may be given as a second argument - if provided then it is
4950: appended or prepended to the string if the length has been trimmed, for example
4951: .Ql #{=/5/...:pane_title}
4952: will append
4953: .Ql ...
4954: if the pane title is more than five characters.
1.698 nicm 4955: Similarly,
4956: .Ql p
4957: pads the string to a given width, for example
4958: .Ql #{p10:pane_title}
4959: will result in a width of at least 10 characters.
4960: A positive width pads on the left, a negative on the right.
1.791 nicm 4961: .Ql n
1.803 nicm 4962: expands to the length of the variable and
4963: .Ql w
4964: to its width when displayed, for example
1.791 nicm 4965: .Ql #{n:window_name} .
1.653 nicm 4966: .Pp
1.453 nicm 4967: Prefixing a time variable with
1.683 nicm 4968: .Ql t:\&
1.453 nicm 4969: will convert it to a string, so if
4970: .Ql #{window_activity}
4971: gives
1.454 jmc 4972: .Ql 1445765102 ,
1.453 nicm 4973: .Ql #{t:window_activity}
4974: gives
4975: .Ql Sun Oct 25 09:25:02 2015 .
1.751 nicm 4976: Adding
4977: .Ql p (
4978: .Ql `t/p` )
4979: will use shorter but less accurate time format for times in the past.
1.765 nicm 4980: A custom format may be given using an
4981: .Ql f
4982: suffix (note that
4983: .Ql %
4984: must be escaped as
4985: .Ql %%
4986: if the format is separately being passed through
4987: .Xr strftime 3 ,
4988: for example in the
4989: .Ic status-left
4990: option):
4991: .Ql #{t/f/%%H#:%%M:window_activity} ,
4992: see
4993: .Xr strftime 3 .
4994: .Pp
1.453 nicm 4995: The
1.683 nicm 4996: .Ql b:\&
1.453 nicm 4997: and
1.683 nicm 4998: .Ql d:\&
1.453 nicm 4999: prefixes are
5000: .Xr basename 3
5001: and
5002: .Xr dirname 3
5003: of the variable respectively.
1.683 nicm 5004: .Ql q:\&
1.610 nicm 5005: will escape
5006: .Xr sh 1
1.812 nicm 5007: special characters or with a
5008: .Ql h
1.806 nicm 5009: suffix, escape hash characters (so
5010: .Ql #
5011: becomes
1.807 nicm 5012: .Ql ## ) .
1.683 nicm 5013: .Ql E:\&
1.617 nicm 5014: will expand the format twice, for example
5015: .Ql #{E:status-left}
5016: is the result of expanding the content of the
5017: .Ic status-left
1.671 nicm 5018: option rather than the option itself.
1.683 nicm 5019: .Ql T:\&
1.620 nicm 5020: is like
1.683 nicm 5021: .Ql E:\&
1.620 nicm 5022: but also expands
5023: .Xr strftime 3
5024: specifiers.
1.683 nicm 5025: .Ql S:\& ,
5026: .Ql W:\&
1.618 nicm 5027: or
1.683 nicm 5028: .Ql P:\&
1.618 nicm 5029: will loop over each session, window or pane and insert the format once
1.619 nicm 5030: for each.
5031: For windows and panes, two comma-separated formats may be given:
5032: the second is used for the current window or active pane.
5033: For example, to get a list of windows formatted like the status line:
1.618 nicm 5034: .Bd -literal -offset indent
5035: #{W:#{E:window-status-format} ,#{E:window-status-current-format} }
5036: .Ed
1.817 nicm 5037: .Pp
5038: .Ql N:\&
5039: checks if a window (without any suffix or with the
5040: .Ql w
5041: suffix) or a session (with the
5042: .Ql s
5043: suffix) name exists, for example
5044: .Ql `N/w:foo`
5045: is replaced with 1 if a window named
5046: .Ql foo
5047: exists.
1.625 nicm 5048: .Pp
1.461 nicm 5049: A prefix of the form
1.683 nicm 5050: .Ql s/foo/bar/:\&
1.461 nicm 5051: will substitute
5052: .Ql foo
5053: with
5054: .Ql bar
5055: throughout.
1.664 nicm 5056: The first argument may be an extended regular expression and a final argument may be
5057: .Ql i
5058: to ignore case, for example
1.683 nicm 5059: .Ql s/a(.)/\e1x/i:\&
1.664 nicm 5060: would change
5061: .Ql abABab
5062: into
5063: .Ql bxBxbx .
1.431 nicm 5064: .Pp
1.671 nicm 5065: In addition, the last line of a shell command's output may be inserted using
1.431 nicm 5066: .Ql #() .
5067: For example,
5068: .Ql #(uptime)
5069: will insert the system's uptime.
5070: When constructing formats,
5071: .Nm
5072: does not wait for
5073: .Ql #()
5074: commands to finish; instead, the previous result from running the same command is used,
5075: or a placeholder if the command has not been run before.
1.543 nicm 5076: If the command hasn't exited, the most recent line of output will be used, but the status
5077: line will not be updated more than once a second.
1.874 nicm 5078: Commands are executed using
5079: .Pa /bin/sh
5080: and with the
1.431 nicm 5081: .Nm
5082: global environment set (see the
1.644 schwarze 5083: .Sx GLOBAL AND SESSION ENVIRONMENT
1.431 nicm 5084: section).
1.671 nicm 5085: .Pp
5086: An
5087: .Ql l
5088: specifies that a string should be interpreted literally and not expanded.
5089: For example
5090: .Ql #{l:#{?pane_in_mode,yes,no}}
5091: will be replaced by
5092: .Ql #{?pane_in_mode,yes,no} .
1.245 nicm 5093: .Pp
5094: The following variables are available, where appropriate:
1.359 nicm 5095: .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
5096: .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
1.824 nicm 5097: .It Li "active_window_index" Ta "" Ta "Index of active window in session"
1.678 nicm 5098: .It Li "alternate_on" Ta "" Ta "1 if pane is in alternate screen"
1.359 nicm 5099: .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
5100: .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
1.572 nicm 5101: .It Li "buffer_created" Ta "" Ta "Time buffer created"
1.490 nicm 5102: .It Li "buffer_name" Ta "" Ta "Name of buffer"
1.386 nicm 5103: .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
1.359 nicm 5104: .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
1.572 nicm 5105: .It Li "client_activity" Ta "" Ta "Time client last had activity"
1.699 nicm 5106: .It Li "client_cell_height" Ta "" Ta "Height of each client cell in pixels"
5107: .It Li "client_cell_width" Ta "" Ta "Width of each client cell in pixels"
1.646 nicm 5108: .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
1.572 nicm 5109: .It Li "client_created" Ta "" Ta "Time client created"
1.542 nicm 5110: .It Li "client_discarded" Ta "" Ta "Bytes discarded when client behind"
1.762 nicm 5111: .It Li "client_flags" Ta "" Ta "List of client flags"
1.359 nicm 5112: .It Li "client_height" Ta "" Ta "Height of client"
1.451 nicm 5113: .It Li "client_key_table" Ta "" Ta "Current key table"
1.359 nicm 5114: .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
1.540 nicm 5115: .It Li "client_name" Ta "" Ta "Name of client"
1.437 nicm 5116: .It Li "client_pid" Ta "" Ta "PID of client process"
1.359 nicm 5117: .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
1.888 nicm 5118: .It Li "client_readonly" Ta "" Ta "1 if client is read-only"
1.359 nicm 5119: .It Li "client_session" Ta "" Ta "Name of the client's session"
1.822 nicm 5120: .It Li "client_termfeatures" Ta "" Ta "Terminal features of client, if any"
1.359 nicm 5121: .It Li "client_termname" Ta "" Ta "Terminal name of client"
1.754 nicm 5122: .It Li "client_termtype" Ta "" Ta "Terminal type of client, if available"
1.359 nicm 5123: .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
1.880 nicm 5124: .It Li "client_uid" Ta "" Ta "UID of client process"
5125: .It Li "client_user" Ta "" Ta "User of client process"
1.699 nicm 5126: .It Li "client_utf8" Ta "" Ta "1 if client supports UTF-8"
1.359 nicm 5127: .It Li "client_width" Ta "" Ta "Width of client"
1.541 nicm 5128: .It Li "client_written" Ta "" Ta "Bytes written to client"
1.509 nicm 5129: .It Li "command" Ta "" Ta "Name of command in use, if any"
1.646 nicm 5130: .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
1.489 nicm 5131: .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
5132: .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
1.824 nicm 5133: .It Li "config_files" Ta "" Ta "List of configuration files loaded"
1.692 nicm 5134: .It Li "copy_cursor_line" Ta "" Ta "Line the cursor is on in copy mode"
5135: .It Li "copy_cursor_word" Ta "" Ta "Word under cursor in copy mode"
1.691 nicm 5136: .It Li "copy_cursor_x" Ta "" Ta "Cursor X position in copy mode"
5137: .It Li "copy_cursor_y" Ta "" Ta "Cursor Y position in copy mode"
1.832 nicm 5138: .It Li "current_file" Ta "" Ta "Current configuration file"
1.646 nicm 5139: .It Li "cursor_character" Ta "" Ta "Character at cursor in pane"
1.359 nicm 5140: .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
5141: .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
5142: .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
5143: .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
5144: .It Li "history_limit" Ta "" Ta "Maximum window history lines"
1.581 nicm 5145: .It Li "history_size" Ta "" Ta "Size of history in lines"
1.509 nicm 5146: .It Li "hook" Ta "" Ta "Name of running hook, if any"
1.851 nicm 5147: .It Li "hook_client" Ta "" Ta "Name of client where hook was run, if any"
1.511 nicm 5148: .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
1.510 nicm 5149: .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
5150: .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
5151: .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
5152: .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
1.359 nicm 5153: .It Li "host" Ta "#H" Ta "Hostname of local host"
5154: .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
5155: .It Li "insert_flag" Ta "" Ta "Pane insert flag"
5156: .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
5157: .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
1.824 nicm 5158: .It Li "last_window_index" Ta "" Ta "Index of last window in session"
1.359 nicm 5159: .It Li "line" Ta "" Ta "Line number in the list"
1.646 nicm 5160: .It Li "mouse_all_flag" Ta "" Ta "Pane mouse all flag"
1.359 nicm 5161: .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
5162: .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
1.894 ! nicm 5163: .It Li "mouse_hyperlink" Ta "" Ta "Hyperlink under mouse, if any"
1.676 nicm 5164: .It Li "mouse_line" Ta "" Ta "Line under mouse, if any"
5165: .It Li "mouse_sgr_flag" Ta "" Ta "Pane mouse SGR flag"
1.359 nicm 5166: .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
1.676 nicm 5167: .It Li "mouse_utf8_flag" Ta "" Ta "Pane mouse UTF-8 flag"
5168: .It Li "mouse_word" Ta "" Ta "Word under mouse, if any"
1.654 nicm 5169: .It Li "mouse_x" Ta "" Ta "Mouse X position, if any"
5170: .It Li "mouse_y" Ta "" Ta "Mouse Y position, if any"
1.879 nicm 5171: .It Li "next_session_id" Ta "" Ta "Unique session ID for next new session"
1.676 nicm 5172: .It Li "origin_flag" Ta "" Ta "Pane origin flag"
1.359 nicm 5173: .It Li "pane_active" Ta "" Ta "1 if active pane"
1.570 nicm 5174: .It Li "pane_at_bottom" Ta "" Ta "1 if pane is at the bottom of window"
5175: .It Li "pane_at_left" Ta "" Ta "1 if pane is at the left of window"
5176: .It Li "pane_at_right" Ta "" Ta "1 if pane is at the right of window"
5177: .It Li "pane_at_top" Ta "" Ta "1 if pane is at the top of window"
1.822 nicm 5178: .It Li "pane_bg" Ta "" Ta "Pane background colour"
1.396 nicm 5179: .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
1.359 nicm 5180: .It Li "pane_current_command" Ta "" Ta "Current command if available"
1.733 nicm 5181: .It Li "pane_current_path" Ta "" Ta "Current path if available"
1.359 nicm 5182: .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
1.882 nicm 5183: .It Li "pane_dead_signal" Ta "" Ta "Exit signal of process in dead pane"
1.411 nicm 5184: .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
1.882 nicm 5185: .It Li "pane_dead_time" Ta "" Ta "Exit time of process in dead pane"
1.822 nicm 5186: .It Li "pane_fg" Ta "" Ta "Pane foreground colour"
1.696 nicm 5187: .It Li "pane_format" Ta "" Ta "1 if format is for a pane"
1.359 nicm 5188: .It Li "pane_height" Ta "" Ta "Height of pane"
5189: .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
1.678 nicm 5190: .It Li "pane_in_mode" Ta "" Ta "1 if pane is in a mode"
1.646 nicm 5191: .It Li "pane_index" Ta "#P" Ta "Index of pane"
1.678 nicm 5192: .It Li "pane_input_off" Ta "" Ta "1 if input to pane is disabled"
1.792 nicm 5193: .It Li "pane_last" Ta "" Ta "1 if last pane"
1.396 nicm 5194: .It Li "pane_left" Ta "" Ta "Left of pane"
1.650 nicm 5195: .It Li "pane_marked" Ta "" Ta "1 if this is the marked pane"
5196: .It Li "pane_marked_set" Ta "" Ta "1 if a marked pane is set"
1.678 nicm 5197: .It Li "pane_mode" Ta "" Ta "Name of pane mode, if any"
1.761 nicm 5198: .It Li "pane_path" Ta "" Ta "Path of pane (can be set by application)"
1.359 nicm 5199: .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
1.567 nicm 5200: .It Li "pane_pipe" Ta "" Ta "1 if pane is being piped"
1.396 nicm 5201: .It Li "pane_right" Ta "" Ta "Right of pane"
1.546 nicm 5202: .It Li "pane_search_string" Ta "" Ta "Last search string in copy mode"
1.359 nicm 5203: .It Li "pane_start_command" Ta "" Ta "Command pane started with"
1.890 nicm 5204: .It Li "pane_start_path" Ta "" Ta "Path pane started with"
1.678 nicm 5205: .It Li "pane_synchronized" Ta "" Ta "1 if pane is synchronized"
1.359 nicm 5206: .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
1.696 nicm 5207: .It Li "pane_title" Ta "#T" Ta "Title of pane (can be set by application)"
1.396 nicm 5208: .It Li "pane_top" Ta "" Ta "Top of pane"
1.359 nicm 5209: .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
5210: .It Li "pane_width" Ta "" Ta "Width of pane"
1.721 nicm 5211: .It Li "pid" Ta "" Ta "Server PID"
1.606 nicm 5212: .It Li "rectangle_toggle" Ta "" Ta "1 if rectangle selection is activated"
1.646 nicm 5213: .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
1.359 nicm 5214: .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
5215: .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
1.824 nicm 5216: .It Li "search_match" Ta "" Ta "Search match if any"
1.782 nicm 5217: .It Li "search_present" Ta "" Ta "1 if search started in copy mode"
1.713 nicm 5218: .It Li "selection_active" Ta "" Ta "1 if selection started and changes with the cursor in copy mode"
1.691 nicm 5219: .It Li "selection_end_x" Ta "" Ta "X position of the end of the selection"
5220: .It Li "selection_end_y" Ta "" Ta "Y position of the end of the selection"
1.571 nicm 5221: .It Li "selection_present" Ta "" Ta "1 if selection started in copy mode"
1.691 nicm 5222: .It Li "selection_start_x" Ta "" Ta "X position of the start of the selection"
5223: .It Li "selection_start_y" Ta "" Ta "Y position of the start of the selection"
1.646 nicm 5224: .It Li "session_activity" Ta "" Ta "Time of session last activity"
1.430 nicm 5225: .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
1.382 nicm 5226: .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
1.702 nicm 5227: .It Li "session_attached_list" Ta "" Ta "List of clients session is attached to"
1.572 nicm 5228: .It Li "session_created" Ta "" Ta "Time session created"
1.696 nicm 5229: .It Li "session_format" Ta "" Ta "1 if format is for a session"
1.536 nicm 5230: .It Li "session_group" Ta "" Ta "Name of session group"
1.702 nicm 5231: .It Li "session_group_attached" Ta "" Ta "Number of clients sessions in group are attached to"
5232: .It Li "session_group_attached_list" Ta "" Ta "List of clients sessions in group are attached to"
1.646 nicm 5233: .It Li "session_group_list" Ta "" Ta "List of sessions in group"
1.702 nicm 5234: .It Li "session_group_many_attached" Ta "" Ta "1 if multiple clients attached to sessions in group"
1.586 nicm 5235: .It Li "session_group_size" Ta "" Ta "Size of session group"
1.359 nicm 5236: .It Li "session_grouped" Ta "" Ta "1 if session in a group"
5237: .It Li "session_id" Ta "" Ta "Unique session ID"
1.646 nicm 5238: .It Li "session_last_attached" Ta "" Ta "Time session last attached"
1.382 nicm 5239: .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
1.748 nicm 5240: .It Li "session_marked" Ta "" Ta "1 if this session contains the marked pane"
1.359 nicm 5241: .It Li "session_name" Ta "#S" Ta "Name of session"
1.725 nicm 5242: .It Li "session_path" Ta "" Ta "Working directory of session"
1.548 nicm 5243: .It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
1.359 nicm 5244: .It Li "session_windows" Ta "" Ta "Number of windows in session"
1.487 nicm 5245: .It Li "socket_path" Ta "" Ta "Server socket path"
1.465 nicm 5246: .It Li "start_time" Ta "" Ta "Server start time"
1.880 nicm 5247: .It Li "uid" Ta "" Ta "Server UID"
5248: .It Li "user" Ta "" Ta "Server user"
1.708 nicm 5249: .It Li "version" Ta "" Ta "Server version"
1.646 nicm 5250: .It Li "window_active" Ta "" Ta "1 if window active"
1.702 nicm 5251: .It Li "window_active_clients" Ta "" Ta "Number of clients viewing this window"
5252: .It Li "window_active_clients_list" Ta "" Ta "List of clients viewing this window"
5253: .It Li "window_active_sessions" Ta "" Ta "Number of sessions on which this window is active"
5254: .It Li "window_active_sessions_list" Ta "" Ta "List of sessions on which this window is active"
1.572 nicm 5255: .It Li "window_activity" Ta "" Ta "Time of window last activity"
1.487 nicm 5256: .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
1.366 nicm 5257: .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
1.642 nicm 5258: .It Li "window_bigger" Ta "" Ta "1 if window is larger than client"
1.700 nicm 5259: .It Li "window_cell_height" Ta "" Ta "Height of each cell in pixels"
5260: .It Li "window_cell_width" Ta "" Ta "Width of each cell in pixels"
1.621 nicm 5261: .It Li "window_end_flag" Ta "" Ta "1 if window has the highest index"
1.812 nicm 5262: .It Li "window_flags" Ta "#F" Ta "Window flags with # escaped as ##"
1.696 nicm 5263: .It Li "window_format" Ta "" Ta "1 if format is for a window"
1.359 nicm 5264: .It Li "window_height" Ta "" Ta "Height of window"
5265: .It Li "window_id" Ta "" Ta "Unique window ID"
5266: .It Li "window_index" Ta "#I" Ta "Index of window"
1.400 nicm 5267: .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
1.460 nicm 5268: .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
1.426 nicm 5269: .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
1.702 nicm 5270: .It Li "window_linked_sessions" Ta "" Ta "Number of sessions this window is linked to"
5271: .It Li "window_linked_sessions_list" Ta "" Ta "List of sessions this window is linked to"
1.687 nicm 5272: .It Li "window_marked_flag" Ta "" Ta "1 if window contains the marked pane"
1.359 nicm 5273: .It Li "window_name" Ta "#W" Ta "Name of window"
1.642 nicm 5274: .It Li "window_offset_x" Ta "" Ta "X offset into window if larger than client"
5275: .It Li "window_offset_y" Ta "" Ta "Y offset into window if larger than client"
1.359 nicm 5276: .It Li "window_panes" Ta "" Ta "Number of panes in window"
1.880 nicm 5277: .It Li "window_raw_flags" Ta "" Ta "Window flags with nothing escaped"
1.366 nicm 5278: .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
1.548 nicm 5279: .It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
1.621 nicm 5280: .It Li "window_start_flag" Ta "" Ta "1 if window has the lowest index"
1.460 nicm 5281: .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
1.359 nicm 5282: .It Li "window_width" Ta "" Ta "Width of window"
1.400 nicm 5283: .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
1.359 nicm 5284: .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
1.245 nicm 5285: .El
1.623 nicm 5286: .Sh STYLES
5287: .Nm
5288: offers various options to specify the colour and attributes of aspects of the
5289: interface, for example
5290: .Ic status-style
5291: for the status line.
5292: In addition, embedded styles may be specified in format options, such as
1.701 nicm 5293: .Ic status-left ,
1.623 nicm 5294: by enclosing them in
5295: .Ql #[
5296: and
1.639 nicm 5297: .Ql \&] .
1.623 nicm 5298: .Pp
5299: A style may be the single term
5300: .Ql default
1.688 nicm 5301: to specify the default style (which may come from an option, for example
5302: .Ic status-style
5303: in the status line) or a space
1.630 nicm 5304: or comma separated list of the following:
1.623 nicm 5305: .Bl -tag -width Ds
5306: .It Ic fg=colour
5307: Set the foreground colour.
5308: The colour is one of:
5309: .Ic black ,
5310: .Ic red ,
5311: .Ic green ,
5312: .Ic yellow ,
5313: .Ic blue ,
5314: .Ic magenta ,
5315: .Ic cyan ,
5316: .Ic white ;
5317: if supported the bright variants
5318: .Ic brightred ,
5319: .Ic brightgreen ,
5320: .Ic brightyellow ;
5321: .Ic colour0
5322: to
5323: .Ic colour255
5324: from the 256-colour set;
5325: .Ic default
5326: for the default colour;
5327: .Ic terminal
5328: for the terminal default colour; or a hexadecimal RGB string such as
5329: .Ql #ffffff .
5330: .It Ic bg=colour
5331: Set the background colour.
5332: .It Ic none
5333: Set no attributes (turn off any active attributes).
1.752 nicm 5334: .It Xo Ic acs ,
5335: .Ic bright
1.625 nicm 5336: (or
5337: .Ic bold ) ,
1.623 nicm 5338: .Ic dim ,
5339: .Ic underscore ,
5340: .Ic blink ,
5341: .Ic reverse ,
5342: .Ic hidden ,
5343: .Ic italics ,
1.649 nicm 5344: .Ic overline ,
1.623 nicm 5345: .Ic strikethrough ,
5346: .Ic double-underscore ,
5347: .Ic curly-underscore ,
5348: .Ic dotted-underscore ,
5349: .Ic dashed-underscore
5350: .Xc
5351: Set an attribute.
5352: Any of the attributes may be prefixed with
5353: .Ql no
5354: to unset.
1.752 nicm 5355: .Ic acs
5356: is the terminal alternate character set.
1.625 nicm 5357: .It Xo Ic align=left
5358: (or
5359: .Ic noalign ) ,
5360: .Ic align=centre ,
5361: .Ic align=right
5362: .Xc
5363: Align text to the left, centre or right of the available space if appropriate.
1.675 nicm 5364: .It Ic fill=colour
1.674 nicm 5365: Fill the available space with a background colour if appropriate.
1.625 nicm 5366: .It Xo Ic list=on ,
5367: .Ic list=focus ,
5368: .Ic list=left-marker ,
1.661 nicm 5369: .Ic list=right-marker ,
1.625 nicm 5370: .Ic nolist
5371: .Xc
5372: Mark the position of the various window list components in the
5373: .Ic status-format
5374: option:
5375: .Ic list=on
5376: marks the start of the list;
5377: .Ic list=focus
5378: is the part of the list that should be kept in focus if the entire list won't fit
5379: in the available space (typically the current window);
5380: .Ic list=left-marker
5381: and
5382: .Ic list=right-marker
5383: mark the text to be used to mark that text has been trimmed from the left or
5384: right of the list if there is not enough space.
1.688 nicm 5385: .It Xo Ic push-default ,
5386: .Ic pop-default
5387: .Xc
5388: Store the current colours and attributes as the default or reset to the previous
5389: default.
5390: A
5391: .Ic push-default
5392: affects any subsequent use of the
5393: .Ic default
5394: term until a
5395: .Ic pop-default .
5396: Only one default may be pushed (each
5397: .Ic push-default
5398: replaces the previous saved default).
1.625 nicm 5399: .It Xo Ic range=left ,
5400: .Ic range=right ,
5401: .Ic range=window|X ,
5402: .Ic norange
5403: .Xc
5404: Mark a range in the
1.651 nicm 5405: .Ic status-format
1.625 nicm 5406: option.
5407: .Ic range=left
5408: and
5409: .Ic range=right
5410: are the text used for the
5411: .Ql StatusLeft
5412: and
5413: .Ql StatusRight
5414: mouse keys.
5415: .Ic range=window|X
5416: is the range for a window passed to the
5417: .Ql Status
5418: mouse key, where
5419: .Ql X
5420: is a window index.
1.623 nicm 5421: .El
5422: .Pp
5423: Examples are:
5424: .Bd -literal -offset indent
1.630 nicm 5425: fg=yellow bold underscore blink
1.623 nicm 5426: bg=black,fg=default,noreverse
5427: .Ed
1.261 nicm 5428: .Sh NAMES AND TITLES
5429: .Nm
5430: distinguishes between names and titles.
5431: Windows and sessions have names, which may be used to specify them in targets
5432: and are displayed in the status line and various lists: the name is the
5433: .Nm
5434: identifier for a window or session.
5435: Only panes have titles.
1.577 nicm 5436: A pane's title is typically set by the program running inside the pane using
5437: an escape sequence (like it would set the
1.261 nicm 5438: .Xr xterm 1
1.577 nicm 5439: window title in
1.578 nicm 5440: .Xr X 7 ) .
1.268 nicm 5441: Windows themselves do not have titles - a window's title is the title of its
1.261 nicm 5442: active pane.
5443: .Nm
5444: itself may set the title of the terminal in which the client is running, see
5445: the
5446: .Ic set-titles
5447: option.
5448: .Pp
5449: A session's name is set with the
5450: .Ic new-session
5451: and
5452: .Ic rename-session
5453: commands.
5454: A window's name is set with one of:
5455: .Bl -enum -width Ds
5456: .It
5457: A command argument (such as
5458: .Fl n
5459: for
5460: .Ic new-window
5461: or
5462: .Ic new-session ) .
5463: .It
1.597 nicm 5464: An escape sequence (if the
5465: .Ic allow-rename
5466: option is turned on):
1.261 nicm 5467: .Bd -literal -offset indent
5468: $ printf '\e033kWINDOW_NAME\e033\e\e'
5469: .Ed
5470: .It
5471: Automatic renaming, which sets the name to the active command in the window's
5472: active pane.
5473: See the
5474: .Ic automatic-rename
5475: option.
5476: .El
5477: .Pp
5478: When a pane is first created, its title is the hostname.
1.612 nicm 5479: A pane's title can be set via the title setting escape sequence, for example:
1.261 nicm 5480: .Bd -literal -offset indent
5481: $ printf '\e033]2;My Title\e033\e\e'
5482: .Ed
1.577 nicm 5483: .Pp
5484: It can also be modified with the
5485: .Ic select-pane
5486: .Fl T
5487: command.
1.644 schwarze 5488: .Sh GLOBAL AND SESSION ENVIRONMENT
1.63 nicm 5489: When the server is started,
5490: .Nm
5491: copies the environment into the
5492: .Em global environment ;
5493: in addition, each session has a
5494: .Em session environment .
1.193 nicm 5495: When a window is created, the session and global environments are merged.
5496: If a variable exists in both, the value from the session environment is used.
5497: The result is the initial environment passed to the new process.
1.63 nicm 5498: .Pp
5499: The
5500: .Ic update-environment
5501: session option may be used to update the session environment from the client
5502: when a new session is created or an old reattached.
5503: .Nm
5504: also initialises the
5505: .Ev TMUX
5506: variable with some internal information to allow commands to be executed
5507: from inside, and the
5508: .Ev TERM
5509: variable with the correct terminal setting of
5510: .Ql screen .
5511: .Pp
1.728 nicm 5512: Variables in both session and global environments may be marked as hidden.
5513: Hidden variables are not passed into the environment of new processes and
5514: instead can only be used by tmux itself (for example in formats, see the
5515: .Sx FORMATS
5516: section).
5517: .Pp
1.63 nicm 5518: Commands to alter and view the environment are:
5519: .Bl -tag -width Ds
1.858 kn 5520: .Tg setenv
1.63 nicm 5521: .It Xo Ic set-environment
1.793 nicm 5522: .Op Fl Fhgru
1.63 nicm 5523: .Op Fl t Ar target-session
5524: .Ar name Op Ar value
5525: .Xc
1.870 kn 5526: .D1 Pq alias: Ic setenv
1.63 nicm 5527: Set or unset an environment variable.
5528: If
5529: .Fl g
5530: is used, the change is made in the global environment; otherwise, it is applied
5531: to the session environment for
5532: .Ar target-session .
1.793 nicm 5533: If
5534: .Fl F
5535: is present, then
5536: .Ar value
5537: is expanded as a format.
1.63 nicm 5538: The
5539: .Fl u
5540: flag unsets a variable.
5541: .Fl r
5542: indicates the variable is to be removed from the environment before starting a
5543: new process.
1.728 nicm 5544: .Fl h
5545: marks the variable as hidden.
1.858 kn 5546: .Tg showenv
1.63 nicm 5547: .It Xo Ic show-environment
1.728 nicm 5548: .Op Fl hgs
1.63 nicm 5549: .Op Fl t Ar target-session
1.286 nicm 5550: .Op Ar variable
1.63 nicm 5551: .Xc
1.870 kn 5552: .D1 Pq alias: Ic showenv
1.63 nicm 5553: Display the environment for
5554: .Ar target-session
5555: or the global environment with
5556: .Fl g .
1.286 nicm 5557: If
5558: .Ar variable
5559: is omitted, all variables are shown.
1.63 nicm 5560: Variables removed from the environment are prefixed with
5561: .Ql - .
1.442 nicm 5562: If
5563: .Fl s
5564: is used, the output is formatted as a set of Bourne shell commands.
1.728 nicm 5565: .Fl h
5566: shows hidden variables (omitted by default).
1.57 jmc 5567: .El
5568: .Sh STATUS LINE
5569: .Nm
5570: includes an optional status line which is displayed in the bottom line of each
5571: terminal.
1.626 nicm 5572: .Pp
5573: By default, the status line is enabled and one line in height (it may be
5574: disabled or made multiple lines with the
1.57 jmc 5575: .Ic status
5576: session option) and contains, from left-to-right: the name of the current
1.261 nicm 5577: session in square brackets; the window list; the title of the active pane
5578: in double quotes; and the time and date.
1.57 jmc 5579: .Pp
1.626 nicm 5580: Each line of the status line is configured with the
5581: .Ic status-format
5582: option.
5583: The default is made of three parts: configurable left and right sections (which
5584: may contain dynamic content such as the time or output from a shell command,
5585: see the
1.57 jmc 5586: .Ic status-left ,
5587: .Ic status-left-length ,
5588: .Ic status-right ,
5589: and
5590: .Ic status-right-length
5591: options below), and a central window list.
1.125 nicm 5592: By default, the window list shows the index, name and (if any) flag of the
5593: windows present in the current session in ascending numerical order.
5594: It may be customised with the
5595: .Ar window-status-format
5596: and
5597: .Ar window-status-current-format
5598: options.
1.57 jmc 5599: The flag is one of the following symbols appended to the window name:
5600: .Bl -column "Symbol" "Meaning" -offset indent
5601: .It Sy "Symbol" Ta Sy "Meaning"
5602: .It Li "*" Ta "Denotes the current window."
5603: .It Li "-" Ta "Marks the last window (previously selected)."
1.574 nicm 5604: .It Li "#" Ta "Window activity is monitored and activity has been detected."
5605: .It Li "\&!" Ta "Window bells are monitored and a bell has occurred in the window."
1.192 nicm 5606: .It Li "~" Ta "The window has been silent for the monitor-silence interval."
1.432 nicm 5607: .It Li "M" Ta "The window contains the marked pane."
1.349 nicm 5608: .It Li "Z" Ta "The window's active pane is zoomed."
1.57 jmc 5609: .El
5610: .Pp
5611: The # symbol relates to the
5612: .Ic monitor-activity
1.388 nicm 5613: window option.
1.57 jmc 5614: The window name is printed in inverted colours if an alert (bell, activity or
1.388 nicm 5615: silence) is present.
1.57 jmc 5616: .Pp
1.131 nicm 5617: The colour and attributes of the status line may be configured, the entire
5618: status line using the
1.378 nicm 5619: .Ic status-style
5620: session option and individual windows using the
5621: .Ic window-status-style
5622: window option.
1.57 jmc 5623: .Pp
1.131 nicm 5624: The status line is automatically refreshed at interval if it has changed, the
5625: interval may be controlled with the
1.57 jmc 5626: .Ic status-interval
5627: session option.
5628: .Pp
5629: Commands related to the status line are as follows:
5630: .Bl -tag -width Ds
1.887 nicm 5631: .Tg clearphist
1.839 nicm 5632: .It Xo Ic clear-prompt-history
5633: .Op Fl T Ar prompt-type
5634: .Xc
1.887 nicm 5635: .D1 Pq alias: Ic clearphist
1.839 nicm 5636: Clear status prompt history for prompt type
5637: .Ar prompt-type .
5638: If
5639: .Fl T
5640: is omitted, then clear history for all types.
5641: See
5642: .Ic command-prompt
5643: for possible values for
5644: .Ar prompt-type .
1.57 jmc 5645: .It Xo Ic command-prompt
1.852 nicm 5646: .Op Fl 1bFikN
1.235 nicm 5647: .Op Fl I Ar inputs
1.73 nicm 5648: .Op Fl p Ar prompts
1.57 jmc 5649: .Op Fl t Ar target-client
1.839 nicm 5650: .Op Fl T Ar prompt-type
1.57 jmc 5651: .Op Ar template
5652: .Xc
5653: Open the command prompt in a client.
5654: This may be used from inside
5655: .Nm
5656: to execute commands interactively.
1.231 nicm 5657: .Pp
1.57 jmc 5658: If
5659: .Ar template
1.73 nicm 5660: is specified, it is used as the command.
1.840 nicm 5661: With
5662: .Fl F ,
5663: .Ar template
5664: is expanded as a format.
5665: .Pp
1.235 nicm 5666: If present,
5667: .Fl I
5668: is a comma-separated list of the initial text for each prompt.
1.73 nicm 5669: If
5670: .Fl p
5671: is given,
5672: .Ar prompts
5673: is a comma-separated list of prompts which are displayed in order; otherwise
5674: a single prompt is displayed, constructed from
5675: .Ar template
5676: if it is present, or
5677: .Ql \&:
5678: if not.
1.231 nicm 5679: .Pp
1.73 nicm 5680: Before the command is executed, the first occurrence of the string
5681: .Ql %%
1.74 jmc 5682: and all occurrences of
1.73 nicm 5683: .Ql %1
1.492 nicm 5684: are replaced by the response to the first prompt, all
1.73 nicm 5685: .Ql %2
5686: are replaced with the response to the second prompt, and so on for further
1.74 jmc 5687: prompts.
5688: Up to nine prompt responses may be replaced
5689: .Po
5690: .Ql %1
1.73 nicm 5691: to
1.74 jmc 5692: .Ql %9
5693: .Pc .
1.513 nicm 5694: .Ql %%%
5695: is like
5696: .Ql %%
5697: but any quotation marks are escaped.
1.497 nicm 5698: .Pp
5699: .Fl 1
5700: makes the prompt only accept one key press, in this case the resulting input
5701: is a single character.
1.706 nicm 5702: .Fl k
5703: is like
5704: .Fl 1
5705: but the key press is translated to a key name.
1.678 nicm 5706: .Fl N
5707: makes the prompt only accept numeric key presses.
1.517 nicm 5708: .Fl i
5709: executes the command every time the prompt input changes instead of when the
5710: user exits the command prompt.
1.839 nicm 5711: .Pp
1.758 nicm 5712: .Fl T
5713: tells
5714: .Nm
1.839 nicm 5715: the prompt type.
5716: This affects what completions are offered when
1.758 nicm 5717: .Em Tab
1.839 nicm 5718: is pressed.
5719: Available types are:
5720: .Ql command ,
5721: .Ql search ,
5722: .Ql target
5723: and
5724: .Ql window-target .
1.500 nicm 5725: .Pp
5726: The following keys have a special meaning in the command prompt, depending
5727: on the value of the
5728: .Ic status-keys
5729: option:
5730: .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
5731: .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
1.715 nicm 5732: .It Li "Cancel command prompt" Ta "q" Ta "Escape"
1.678 nicm 5733: .It Li "Delete from cursor to start of word" Ta "" Ta "C-w"
1.500 nicm 5734: .It Li "Delete entire command" Ta "d" Ta "C-u"
5735: .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
5736: .It Li "Execute command" Ta "Enter" Ta "Enter"
5737: .It Li "Get next command from history" Ta "" Ta "Down"
5738: .It Li "Get previous command from history" Ta "" Ta "Up"
5739: .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
5740: .It Li "Look for completions" Ta "Tab" Ta "Tab"
5741: .It Li "Move cursor left" Ta "h" Ta "Left"
5742: .It Li "Move cursor right" Ta "l" Ta "Right"
5743: .It Li "Move cursor to end" Ta "$" Ta "C-e"
5744: .It Li "Move cursor to next word" Ta "w" Ta "M-f"
5745: .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
5746: .It Li "Move cursor to start" Ta "0" Ta "C-a"
5747: .It Li "Transpose characters" Ta "" Ta "C-t"
1.854 nicm 5748: .El
1.852 nicm 5749: .Pp
5750: With
5751: .Fl b ,
5752: the prompt is shown in the background and the invoking client does not exit
5753: until it is dismissed.
1.858 kn 5754: .Tg confirm
1.57 jmc 5755: .It Xo Ic confirm-before
1.848 nicm 5756: .Op Fl b
1.238 nicm 5757: .Op Fl p Ar prompt
1.57 jmc 5758: .Op Fl t Ar target-client
5759: .Ar command
5760: .Xc
1.870 kn 5761: .D1 Pq alias: Ic confirm
1.57 jmc 5762: Ask for confirmation before executing
5763: .Ar command .
1.238 nicm 5764: If
5765: .Fl p
5766: is given,
5767: .Ar prompt
5768: is the prompt to display; otherwise a prompt is constructed from
5769: .Ar command .
5770: It may contain the special character sequences supported by the
5771: .Ic status-left
5772: option.
1.848 nicm 5773: With
5774: .Fl b ,
1.852 nicm 5775: the prompt is shown in the background and the invoking client does not exit
5776: until it is dismissed.
1.858 kn 5777: .Tg menu
1.646 nicm 5778: .It Xo Ic display-menu
1.800 nicm 5779: .Op Fl O
1.646 nicm 5780: .Op Fl c Ar target-client
5781: .Op Fl t Ar target-pane
5782: .Op Fl T Ar title
5783: .Op Fl x Ar position
5784: .Op Fl y Ar position
1.657 nicm 5785: .Ar name
5786: .Ar key
5787: .Ar command
5788: .Ar ...
1.646 nicm 5789: .Xc
1.870 kn 5790: .D1 Pq alias: Ic menu
1.646 nicm 5791: Display a menu on
5792: .Ar target-client .
5793: .Ar target-pane
5794: gives the target for any commands run from the menu.
5795: .Pp
1.657 nicm 5796: A menu is passed as a series of arguments: first the menu item name,
5797: second the key shortcut (or empty for none) and third the command
5798: to run when the menu item is chosen.
5799: The name and command are formats, see the
1.646 nicm 5800: .Sx FORMATS
5801: and
5802: .Sx STYLES
5803: sections.
1.658 nicm 5804: If the name begins with a hyphen (-), then the item is disabled (shown dim) and
5805: may not be chosen.
1.657 nicm 5806: The name may be empty for a separator line, in which case both the key and
5807: command should be omitted.
1.646 nicm 5808: .Pp
5809: .Fl T
5810: is a format for the menu title (see
5811: .Sx FORMATS ) .
5812: .Pp
5813: .Fl x
5814: and
5815: .Fl y
5816: give the position of the menu.
5817: Both may be a row or column number, or one of the following special values:
5818: .Bl -column "XXXXX" "XXXX" -offset indent
5819: .It Sy "Value" Ta Sy "Flag" Ta Sy "Meaning"
1.719 nicm 5820: .It Li "C" Ta "Both" Ta "The centre of the terminal"
1.646 nicm 5821: .It Li "R" Ta Fl x Ta "The right side of the terminal"
5822: .It Li "P" Ta "Both" Ta "The bottom left of the pane"
5823: .It Li "M" Ta "Both" Ta "The mouse position"
1.730 nicm 5824: .It Li "W" Ta "Both" Ta "The window position on the status line"
1.646 nicm 5825: .It Li "S" Ta Fl y Ta "The line above or below the status line"
1.802 nicm 5826: .El
5827: .Pp
5828: Or a format, which is expanded including the following additional variables:
5829: .Bl -column "XXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent
5830: .It Sy "Variable name" Ta Sy "Replaced with"
5831: .It Li "popup_centre_x" Ta "Centered in the client"
5832: .It Li "popup_centre_y" Ta "Centered in the client"
5833: .It Li "popup_height" Ta "Height of menu or popup"
5834: .It Li "popup_mouse_bottom" Ta "Bottom of at the mouse"
5835: .It Li "popup_mouse_centre_x" Ta "Horizontal centre at the mouse"
5836: .It Li "popup_mouse_centre_y" Ta "Vertical centre at the mouse"
5837: .It Li "popup_mouse_top" Ta "Top at the mouse"
5838: .It Li "popup_mouse_x" Ta "Mouse X position"
5839: .It Li "popup_mouse_y" Ta "Mouse Y position"
5840: .It Li "popup_pane_bottom" Ta "Bottom of the pane"
5841: .It Li "popup_pane_left" Ta "Left of the pane"
5842: .It Li "popup_pane_right" Ta "Right of the pane"
5843: .It Li "popup_pane_top" Ta "Top of the pane"
5844: .It Li "popup_status_line_y" Ta "Above or below the status line"
5845: .It Li "popup_width" Ta "Width of menu or popup"
5846: .It Li "popup_window_status_line_x" Ta "At the window position in status line"
5847: .It Li "popup_window_status_line_y" Ta "At the status line showing the window"
1.646 nicm 5848: .El
5849: .Pp
5850: Each menu consists of items followed by a key shortcut shown in brackets.
5851: If the menu is too large to fit on the terminal, it is not displayed.
5852: Pressing the key shortcut chooses the corresponding item.
1.800 nicm 5853: If the mouse is enabled and the menu is opened from a mouse key binding,
5854: releasing the mouse button with an item selected chooses that item and
5855: releasing the mouse button without an item selected closes the menu.
5856: .Fl O
5857: changes this behaviour so that the menu does not close when the mouse button is
5858: released without an item selected the menu is not closed and a mouse button
5859: must be clicked to choose an item.
5860: .Pp
1.646 nicm 5861: The following keys are also available:
5862: .Bl -column "Key" "Function" -offset indent
5863: .It Sy "Key" Ta Sy "Function"
5864: .It Li "Enter" Ta "Choose selected item"
5865: .It Li "Up" Ta "Select previous item"
5866: .It Li "Down" Ta "Select next item"
5867: .It Li "q" Ta "Exit menu"
5868: .El
1.858 kn 5869: .Tg display
1.57 jmc 5870: .It Xo Ic display-message
1.834 nicm 5871: .Op Fl aINpv
1.215 nicm 5872: .Op Fl c Ar target-client
1.790 nicm 5873: .Op Fl d Ar delay
1.215 nicm 5874: .Op Fl t Ar target-pane
1.57 jmc 5875: .Op Ar message
5876: .Xc
1.870 kn 5877: .D1 Pq alias: Ic display
1.127 nicm 5878: Display a message.
5879: If
5880: .Fl p
5881: is given, the output is printed to stdout, otherwise it is displayed in the
5882: .Ar target-client
1.790 nicm 5883: status line for up to
5884: .Ar delay
5885: milliseconds.
5886: If
5887: .Ar delay
5888: is not given, the
1.889 nicm 5889: .Ic display-time
1.790 nicm 5890: option is used; a delay of zero waits for a key press.
1.834 nicm 5891: .Ql N
5892: ignores key presses and closes only after the delay expires.
1.122 nicm 5893: The format of
1.124 jmc 5894: .Ar message
1.275 nicm 5895: is described in the
5896: .Sx FORMATS
5897: section; information is taken from
1.215 nicm 5898: .Ar target-pane
5899: if
5900: .Fl t
1.678 nicm 5901: is given, otherwise the active pane.
1.622 nicm 5902: .Pp
1.624 nicm 5903: .Fl v
5904: prints verbose logging as the format is parsed and
5905: .Fl a
5906: lists the format variables and their values.
1.643 nicm 5907: .Pp
5908: .Fl I
5909: forwards any input read from stdin to the empty pane given by
5910: .Ar target-pane .
1.858 kn 5911: .Tg popup
1.721 nicm 5912: .It Xo Ic display-popup
1.853 nicm 5913: .Op Fl BCE
1.862 nicm 5914: .Op Fl b Ar border-lines
1.721 nicm 5915: .Op Fl c Ar target-client
5916: .Op Fl d Ar start-directory
1.860 nicm 5917: .Op Fl e Ar environment
1.721 nicm 5918: .Op Fl h Ar height
1.865 nicm 5919: .Op Fl s Ar style
5920: .Op Fl S Ar border-style
1.721 nicm 5921: .Op Fl t Ar target-pane
1.864 nicm 5922: .Op Fl T Ar title
1.721 nicm 5923: .Op Fl w Ar width
5924: .Op Fl x Ar position
5925: .Op Fl y Ar position
1.827 nicm 5926: .Op Ar shell-command
1.721 nicm 5927: .Xc
1.870 kn 5928: .D1 Pq alias: Ic popup
1.827 nicm 5929: Display a popup running
5930: .Ar shell-command
5931: on
1.721 nicm 5932: .Ar target-client .
5933: A popup is a rectangular box drawn over the top of any panes.
5934: Panes are not updated while a popup is present.
5935: .Pp
5936: .Fl E
5937: closes the popup automatically when
5938: .Ar shell-command
5939: exits.
1.723 nicm 5940: Two
5941: .Fl E
5942: closes the popup only if
5943: .Ar shell-command
5944: exited with success.
1.721 nicm 5945: .Pp
5946: .Fl x
5947: and
5948: .Fl y
5949: give the position of the popup, they have the same meaning as for the
5950: .Ic display-menu
5951: command.
5952: .Fl w
5953: and
5954: .Fl h
5955: give the width and height - both may be a percentage (followed by
5956: .Ql % ) .
1.827 nicm 5957: If omitted, half of the terminal size is used.
1.862 nicm 5958: .Pp
1.853 nicm 5959: .Fl B
5960: does not surround the popup by a border.
1.862 nicm 5961: .Pp
5962: .Fl b
5963: sets the type of border line for the popup.
5964: When
5965: .Fl B
1.886 naddy 5966: is specified, the
1.862 nicm 5967: .Fl b
5968: option is ignored.
5969: See
5970: .Ic popup-border-lines
5971: for possible values for
5972: .Ar border-lines .
1.865 nicm 5973: .Pp
5974: .Fl s
5975: sets the style for the popup and
5976: .Fl S
5977: sets the style for the popup border.
5978: For how to specify
5979: .Ar style ,
5980: see the
5981: .Sx STYLES
5982: section.
1.860 nicm 5983: .Pp
5984: .Fl e
5985: takes the form
5986: .Ql VARIABLE=value
5987: and sets an environment variable for the popup; it may be specified multiple
5988: times.
1.864 nicm 5989: .Pp
5990: .Fl T
5991: is a format for the popup title (see
5992: .Sx FORMATS ) .
1.721 nicm 5993: .Pp
5994: The
5995: .Fl C
5996: flag closes any popup on the client.
1.858 kn 5997: .Tg showphist
1.839 nicm 5998: .It Xo Ic show-prompt-history
5999: .Op Fl T Ar prompt-type
6000: .Xc
1.870 kn 6001: .D1 Pq alias: Ic showphist
1.839 nicm 6002: Display status prompt history for prompt type
6003: .Ar prompt-type .
6004: If
6005: .Fl T
6006: is omitted, then show history for all types.
6007: See
6008: .Ic command-prompt
6009: for possible values for
6010: .Ar prompt-type .
1.57 jmc 6011: .El
6012: .Sh BUFFERS
6013: .Nm
1.392 nicm 6014: maintains a set of named
1.199 nicm 6015: .Em paste buffers .
1.392 nicm 6016: Each buffer may be either explicitly or automatically named.
6017: Explicitly named buffers are named when created with the
6018: .Ic set-buffer
6019: or
6020: .Ic load-buffer
6021: commands, or by renaming an automatically named buffer with
6022: .Ic set-buffer
6023: .Fl n .
6024: Automatically named buffers are given a name such as
6025: .Ql buffer0001 ,
6026: .Ql buffer0002
6027: and so on.
6028: When the
6029: .Ic buffer-limit
6030: option is reached, the oldest automatically named buffer is deleted.
1.493 nicm 6031: Explicitly named buffers are not subject to
1.57 jmc 6032: .Ic buffer-limit
1.709 nicm 6033: and may be deleted with the
1.392 nicm 6034: .Ic delete-buffer
6035: command.
6036: .Pp
1.57 jmc 6037: Buffers may be added using
6038: .Ic copy-mode
6039: or the
6040: .Ic set-buffer
1.392 nicm 6041: and
6042: .Ic load-buffer
6043: commands, and pasted into a window using the
1.57 jmc 6044: .Ic paste-buffer
6045: command.
1.392 nicm 6046: If a buffer command is used and no buffer is specified, the most
6047: recently added automatically named buffer is assumed.
1.57 jmc 6048: .Pp
6049: A configurable history buffer is also maintained for each window.
6050: By default, up to 2000 lines are kept; this can be altered with the
6051: .Ic history-limit
6052: option (see the
6053: .Ic set-option
6054: command above).
6055: .Pp
6056: The buffer commands are as follows:
6057: .Bl -tag -width Ds
1.178 nicm 6058: .It Xo
6059: .Ic choose-buffer
1.682 nicm 6060: .Op Fl NZr
1.572 nicm 6061: .Op Fl F Ar format
1.562 nicm 6062: .Op Fl f Ar filter
1.833 nicm 6063: .Op Fl K Ar key-format
1.561 nicm 6064: .Op Fl O Ar sort-order
1.555 nicm 6065: .Op Fl t Ar target-pane
1.178 nicm 6066: .Op Ar template
6067: .Xc
1.555 nicm 6068: Put a pane into buffer mode, where a buffer may be chosen interactively from
6069: a list.
1.833 nicm 6070: Each buffer is shown on one line.
6071: A shortcut key is shown on the left in brackets allowing for immediate choice,
6072: or the list may be navigated and an item chosen or otherwise manipulated using
6073: the keys below.
1.593 nicm 6074: .Fl Z
6075: zooms the pane.
1.555 nicm 6076: The following keys may be used in buffer mode:
6077: .Bl -column "Key" "Function" -offset indent
6078: .It Sy "Key" Ta Sy "Function"
1.582 nicm 6079: .It Li "Enter" Ta "Paste selected buffer"
1.555 nicm 6080: .It Li "Up" Ta "Select previous buffer"
6081: .It Li "Down" Ta "Select next buffer"
1.559 nicm 6082: .It Li "C-s" Ta "Search by name or content"
6083: .It Li "n" Ta "Repeat last search"
1.555 nicm 6084: .It Li "t" Ta "Toggle if buffer is tagged"
6085: .It Li "T" Ta "Tag no buffers"
6086: .It Li "C-t" Ta "Tag all buffers"
1.582 nicm 6087: .It Li "p" Ta "Paste selected buffer"
6088: .It Li "P" Ta "Paste tagged buffers"
1.555 nicm 6089: .It Li "d" Ta "Delete selected buffer"
6090: .It Li "D" Ta "Delete tagged buffers"
1.759 nicm 6091: .It Li "e" Ta "Open the buffer in an editor"
1.562 nicm 6092: .It Li "f" Ta "Enter a format to filter items"
1.682 nicm 6093: .It Li "O" Ta "Change sort field"
6094: .It Li "r" Ta "Reverse sort order"
1.576 nicm 6095: .It Li "v" Ta "Toggle preview"
1.555 nicm 6096: .It Li "q" Ta "Exit mode"
6097: .El
6098: .Pp
6099: After a buffer is chosen,
1.178 nicm 6100: .Ql %%
1.392 nicm 6101: is replaced by the buffer name in
1.178 nicm 6102: .Ar template
6103: and the result executed as a command.
6104: If
6105: .Ar template
6106: is not given, "paste-buffer -b '%%'" is used.
1.555 nicm 6107: .Pp
1.561 nicm 6108: .Fl O
1.682 nicm 6109: specifies the initial sort field: one of
1.561 nicm 6110: .Ql time ,
6111: .Ql name
6112: or
6113: .Ql size .
1.682 nicm 6114: .Fl r
6115: reverses the sort order.
1.562 nicm 6116: .Fl f
1.579 nicm 6117: specifies an initial filter: the filter is a format - if it evaluates to zero,
6118: the item in the list is not shown, otherwise it is shown.
6119: If a filter would lead to an empty list, it is ignored.
1.572 nicm 6120: .Fl F
1.833 nicm 6121: specifies the format for each item in the list and
6122: .Fl K
6123: a format for each shortcut key; both are evaluated once for each line.
1.576 nicm 6124: .Fl N
6125: starts without the preview.
1.314 nicm 6126: This command works only if at least one client is attached.
1.858 kn 6127: .Tg clearhist
1.893 nicm 6128: .It Xo Ic clear-history
6129: .Op Fl H
6130: .Op Fl t Ar target-pane
6131: .Xc
1.870 kn 6132: .D1 Pq alias: Ic clearhist
1.57 jmc 6133: Remove and free the history for the specified pane.
1.893 nicm 6134: .Fl H
6135: also removes all hyperlinks.
1.858 kn 6136: .Tg deleteb
1.392 nicm 6137: .It Ic delete-buffer Op Fl b Ar buffer-name
1.870 kn 6138: .D1 Pq alias: Ic deleteb
1.392 nicm 6139: Delete the buffer named
6140: .Ar buffer-name ,
6141: or the most recently added automatically named buffer if not specified.
1.858 kn 6142: .Tg lsb
1.294 nicm 6143: .It Xo Ic list-buffers
6144: .Op Fl F Ar format
1.738 nicm 6145: .Op Fl f Ar filter
1.294 nicm 6146: .Xc
1.870 kn 6147: .D1 Pq alias: Ic lsb
1.198 nicm 6148: List the global buffers.
1.294 nicm 6149: .Fl F
1.738 nicm 6150: specifies the format of each line and
6151: .Fl f
6152: a filter.
6153: Only buffers for which the filter is true are shown.
6154: See the
1.294 nicm 6155: .Sx FORMATS
6156: section.
1.200 jmc 6157: .It Xo Ic load-buffer
1.794 nicm 6158: .Op Fl w
1.392 nicm 6159: .Op Fl b Ar buffer-name
1.794 nicm 6160: .Op Fl t Ar target-client
1.57 jmc 6161: .Ar path
6162: .Xc
1.858 kn 6163: .Tg loadb
1.870 kn 6164: .D1 Pq alias: Ic loadb
1.57 jmc 6165: Load the contents of the specified paste buffer from
6166: .Ar path .
1.794 nicm 6167: If
6168: .Fl w
6169: is given, the buffer is also sent to the clipboard for
6170: .Ar target-client
6171: using the
6172: .Xr xterm 1
6173: escape sequence, if possible.
1.858 kn 6174: .Tg pasteb
1.57 jmc 6175: .It Xo Ic paste-buffer
1.278 nicm 6176: .Op Fl dpr
1.392 nicm 6177: .Op Fl b Ar buffer-name
1.170 nicm 6178: .Op Fl s Ar separator
1.158 nicm 6179: .Op Fl t Ar target-pane
1.57 jmc 6180: .Xc
1.870 kn 6181: .D1 Pq alias: Ic pasteb
1.158 nicm 6182: Insert the contents of a paste buffer into the specified pane.
6183: If not specified, paste into the current one.
1.57 jmc 6184: With
6185: .Fl d ,
1.392 nicm 6186: also delete the paste buffer.
1.57 jmc 6187: When output, any linefeed (LF) characters in the paste buffer are replaced with
1.170 nicm 6188: a separator, by default carriage return (CR).
6189: A custom separator may be specified using the
6190: .Fl s
6191: flag.
6192: The
1.57 jmc 6193: .Fl r
1.170 nicm 6194: flag means to do no replacement (equivalent to a separator of LF).
1.278 nicm 6195: If
6196: .Fl p
6197: is specified, paste bracket control codes are inserted around the
6198: buffer if the application has requested bracketed paste mode.
1.858 kn 6199: .Tg saveb
1.57 jmc 6200: .It Xo Ic save-buffer
6201: .Op Fl a
1.392 nicm 6202: .Op Fl b Ar buffer-name
1.57 jmc 6203: .Ar path
6204: .Xc
1.870 kn 6205: .D1 Pq alias: Ic saveb
1.57 jmc 6206: Save the contents of the specified paste buffer to
6207: .Ar path .
6208: The
6209: .Fl a
6210: option appends to rather than overwriting the file.
6211: .It Xo Ic set-buffer
1.794 nicm 6212: .Op Fl aw
1.392 nicm 6213: .Op Fl b Ar buffer-name
1.794 nicm 6214: .Op Fl t Ar target-client
1.858 kn 6215: .Tg setb
1.392 nicm 6216: .Op Fl n Ar new-buffer-name
1.57 jmc 6217: .Ar data
6218: .Xc
1.870 kn 6219: .D1 Pq alias: Ic setb
1.57 jmc 6220: Set the contents of the specified buffer to
6221: .Ar data .
1.794 nicm 6222: If
6223: .Fl w
6224: is given, the buffer is also sent to the clipboard for
6225: .Ar target-client
6226: using the
6227: .Xr xterm 1
6228: escape sequence, if possible.
1.383 nicm 6229: The
6230: .Fl a
6231: option appends to rather than overwriting the buffer.
1.392 nicm 6232: The
6233: .Fl n
6234: option renames the buffer to
6235: .Ar new-buffer-name .
1.858 kn 6236: .Tg showb
1.1 nicm 6237: .It Xo Ic show-buffer
1.392 nicm 6238: .Op Fl b Ar buffer-name
1.1 nicm 6239: .Xc
1.870 kn 6240: .D1 Pq alias: Ic showb
1.1 nicm 6241: Display the contents of the specified buffer.
1.57 jmc 6242: .El
6243: .Sh MISCELLANEOUS
6244: Miscellaneous commands are as follows:
6245: .Bl -tag -width Ds
1.72 nicm 6246: .It Ic clock-mode Op Fl t Ar target-pane
1.57 jmc 6247: Display a large clock.
1.858 kn 6248: .Tg if
1.334 nicm 6249: .It Xo Ic if-shell
1.410 nicm 6250: .Op Fl bF
1.334 nicm 6251: .Op Fl t Ar target-pane
6252: .Ar shell-command command
6253: .Op Ar command
6254: .Xc
1.870 kn 6255: .D1 Pq alias: Ic if
1.251 nicm 6256: Execute the first
1.57 jmc 6257: .Ar command
6258: if
6259: .Ar shell-command
1.874 nicm 6260: (run with
6261: .Pa /bin/sh )
1.251 nicm 6262: returns success or the second
6263: .Ar command
6264: otherwise.
1.410 nicm 6265: Before being executed,
6266: .Ar shell-command
6267: is expanded using the rules specified in the
1.334 nicm 6268: .Sx FORMATS
6269: section, including those relevant to
6270: .Ar target-pane .
1.335 nicm 6271: With
6272: .Fl b ,
6273: .Ar shell-command
6274: is run in the background.
1.410 nicm 6275: .Pp
6276: If
6277: .Fl F
6278: is given,
6279: .Ar shell-command
6280: is not executed but considered success if neither empty nor zero (after formats
6281: are expanded).
1.858 kn 6282: .Tg lock
1.57 jmc 6283: .It Ic lock-server
1.870 kn 6284: .D1 Pq alias: Ic lock
1.90 nicm 6285: Lock each client individually by running the command specified by the
6286: .Ic lock-command
6287: option.
1.858 kn 6288: .Tg run
1.308 nicm 6289: .It Xo Ic run-shell
1.809 nicm 6290: .Op Fl bC
1.717 nicm 6291: .Op Fl d Ar delay
1.308 nicm 6292: .Op Fl t Ar target-pane
1.718 nicm 6293: .Op Ar shell-command
1.308 nicm 6294: .Xc
1.870 kn 6295: .D1 Pq alias: Ic run
1.87 nicm 6296: Execute
1.153 nicm 6297: .Ar shell-command
1.874 nicm 6298: using
6299: .Pa /bin/sh
1.809 nicm 6300: or (with
6301: .Fl C )
6302: a
6303: .Nm
6304: command in the background without creating a window.
6305: Before being executed,
6306: .Ar shell-command
6307: is expanded using the rules specified in the
1.334 nicm 6308: .Sx FORMATS
6309: section.
1.335 nicm 6310: With
6311: .Fl b ,
6312: the command is run in the background.
1.717 nicm 6313: .Fl d
6314: waits for
6315: .Ar delay
6316: seconds before starting the command.
1.809 nicm 6317: If
6318: .Fl C
6319: is not given, any output to stdout is displayed in view mode (in the pane
6320: specified by
1.308 nicm 6321: .Fl t
1.809 nicm 6322: or the current pane if omitted) after the command finishes.
6323: If the command fails, the exit status is also displayed.
1.858 kn 6324: .Tg wait
1.342 nicm 6325: .It Xo Ic wait-for
1.370 nicm 6326: .Op Fl L | S | U
1.342 nicm 6327: .Ar channel
6328: .Xc
1.870 kn 6329: .D1 Pq alias: Ic wait
1.343 nicm 6330: When used without options, prevents the client from exiting until woken using
1.342 nicm 6331: .Ic wait-for
6332: .Fl S
6333: with the same channel.
1.343 nicm 6334: When
6335: .Fl L
6336: is used, the channel is locked and any clients that try to lock the same
6337: channel are made to wait until the channel is unlocked with
6338: .Ic wait-for
6339: .Fl U .
1.703 nicm 6340: .El
6341: .Sh EXIT MESSAGES
6342: When a
6343: .Nm
6344: client detaches, it prints a message.
6345: This may be one of:
6346: .Bl -tag -width Ds
1.780 nicm 6347: .It detached (from session ...)
1.703 nicm 6348: The client was detached normally.
1.780 nicm 6349: .It detached and SIGHUP
1.703 nicm 6350: The client was detached and its parent sent the
6351: .Dv SIGHUP
6352: signal (for example with
6353: .Ic detach-client
6354: .Fl P ) .
1.780 nicm 6355: .It lost tty
1.703 nicm 6356: The client's
6357: .Xr tty 4
6358: or
6359: .Xr pty 4
6360: was unexpectedly destroyed.
1.780 nicm 6361: .It terminated
1.703 nicm 6362: The client was killed with
6363: .Dv SIGTERM .
1.780 nicm 6364: .It too far behind
6365: The client is in control mode and became unable to keep up with the data from
6366: .Nm .
6367: .It exited
1.703 nicm 6368: The server exited when it had no sessions.
1.780 nicm 6369: .It server exited
1.703 nicm 6370: The server exited when it received
6371: .Dv SIGTERM .
1.780 nicm 6372: .It server exited unexpectedly
1.703 nicm 6373: The server crashed or otherwise exited without telling the client the reason.
1.228 nicm 6374: .El
6375: .Sh TERMINFO EXTENSIONS
6376: .Nm
1.478 nicm 6377: understands some unofficial extensions to
1.746 nicm 6378: .Xr terminfo 5 .
1.744 nicm 6379: It is not normally necessary to set these manually, instead the
6380: .Ic terminal-features
6381: option should be used.
1.228 nicm 6382: .Bl -tag -width Ds
1.756 nicm 6383: .It Em \&AX
6384: An existing extension that tells
6385: .Nm
6386: the terminal supports default colours.
1.818 nicm 6387: .It Em \&Bidi
6388: Tell
6389: .Nm
6390: that the terminal supports the VTE bidirectional text extensions.
1.739 nicm 6391: .It Em \&Cs , Cr
1.233 nicm 6392: Set the cursor colour.
1.232 jmc 6393: The first takes a single string argument and is used to set the colour;
6394: the second takes no arguments and restores the default cursor colour.
6395: If set, a sequence such as this may be used
6396: to change the cursor colour from inside
6397: .Nm :
6398: .Bd -literal -offset indent
6399: $ printf '\e033]12;red\e033\e\e'
6400: .Ed
1.872 nicm 6401: .Pp
6402: The colour is an
6403: .Xr X 7
6404: colour, see
6405: .Xr XParseColor 3 .
1.753 nicm 6406: .It Em \&Cmg, \&Clmg, \&Dsmg , \&Enmg
6407: Set, clear, disable or enable DECSLRM margins.
1.756 nicm 6408: These are set automatically if the terminal reports it is
6409: .Em VT420
6410: compatible.
1.755 nicm 6411: .It Em \&Dsbp , \&Enbp
6412: Disable and enable bracketed paste.
1.756 nicm 6413: These are set automatically if the
6414: .Em XT
6415: capability is present.
1.772 nicm 6416: .It Em \&Dseks , \&Eneks
6417: Disable and enable extended keys.
1.756 nicm 6418: .It Em \&Dsfcs , \&Enfcs
6419: Disable and enable focus reporting.
6420: These are set automatically if the
6421: .Em XT
6422: capability is present.
1.893 nicm 6423: .It Em \&Hls
6424: Set or clear a hyperlink annotation.
1.837 nicm 6425: .It Em \&Rect
6426: Tell
6427: .Nm
6428: that the terminal supports rectangle operations.
1.649 nicm 6429: .It Em \&Smol
6430: Enable the overline attribute.
1.611 nicm 6431: .It Em \&Smulx
1.672 nicm 6432: Set a styled underscore.
6433: The single parameter is one of: 0 for no underscore, 1 for normal
6434: underscore, 2 for double underscore, 3 for curly underscore, 4 for dotted
6435: underscore and 5 for dashed underscore.
1.797 nicm 6436: .It Em \&Setulc , \&ol
6437: Set the underscore colour or reset to the default.
1.672 nicm 6438: The argument is (red * 65536) + (green * 256) + blue where each is between 0
6439: and 255.
1.361 jmc 6440: .It Em \&Ss , Se
1.403 nicm 6441: Set or reset the cursor style.
1.232 jmc 6442: If set, a sequence such as this may be used
6443: to change the cursor to an underline:
1.230 nicm 6444: .Bd -literal -offset indent
6445: $ printf '\e033[4 q'
6446: .Ed
6447: .Pp
6448: If
1.403 nicm 6449: .Em Se
6450: is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
1.885 nicm 6451: .It Em \&Swd
6452: Set the opening sequence for the working directory notification.
6453: The sequence is terminated using the standard
6454: .Em fsl
6455: capability.
1.741 nicm 6456: .It Em \&Sync
1.745 nicm 6457: Start (parameter is 1) or end (parameter is 2) a synchronized update.
1.478 nicm 6458: .It Em \&Tc
6459: Indicate that the terminal supports the
6460: .Ql direct colour
6461: RGB escape sequence (for example, \ee[38;2;255;255;255m).
1.518 nicm 6462: .Pp
1.612 nicm 6463: If supported, this is used for the initialize colour escape sequence (which
1.518 nicm 6464: may be enabled by adding the
6465: .Ql initc
6466: and
6467: .Ql ccc
6468: capabilities to the
6469: .Nm
6470: .Xr terminfo 5
6471: entry).
1.739 nicm 6472: .Pp
6473: This is equivalent to the
6474: .Em RGB
6475: .Xr terminfo 5
6476: capability.
1.232 jmc 6477: .It Em \&Ms
1.478 nicm 6478: Store the current buffer in the host terminal's selection (clipboard).
1.232 jmc 6479: See the
6480: .Em set-clipboard
6481: option above and the
6482: .Xr xterm 1
6483: man page.
1.756 nicm 6484: .It Em \&XT
6485: This is an existing extension capability that tmux uses to mean that the
6486: terminal supports the
6487: .Xr xterm 1
6488: title set sequences and to automatically set some of the capabilities above.
1.345 nicm 6489: .El
6490: .Sh CONTROL MODE
6491: .Nm
6492: offers a textual interface called
6493: .Em control mode .
6494: This allows applications to communicate with
6495: .Nm
6496: using a simple text-only protocol.
6497: .Pp
6498: In control mode, a client sends
6499: .Nm
6500: commands or command sequences terminated by newlines on standard input.
6501: Each command will produce one block of output on standard output.
6502: An output block consists of a
6503: .Em %begin
6504: line followed by the output (which may be empty).
6505: The output block ends with a
6506: .Em %end
6507: or
6508: .Em %error .
6509: .Em %begin
6510: and matching
6511: .Em %end
6512: or
6513: .Em %error
1.835 nicm 6514: have three arguments: an integer time (as seconds from epoch), command number and
6515: flags (currently not used).
1.345 nicm 6516: For example:
6517: .Bd -literal -offset indent
1.835 nicm 6518: %begin 1363006971 2 1
1.345 nicm 6519: 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
1.835 nicm 6520: %end 1363006971 2 1
1.345 nicm 6521: .Ed
1.535 nicm 6522: .Pp
6523: The
6524: .Ic refresh-client
6525: .Fl C
6526: command may be used to set the size of a client in control mode.
1.345 nicm 6527: .Pp
6528: In control mode,
6529: .Nm
6530: outputs notifications.
6531: A notification will never occur inside an output block.
6532: .Pp
6533: The following notifications are defined:
6534: .Bl -tag -width Ds
1.830 nicm 6535: .It Ic %client-detached Ar client
6536: The client has detached.
1.750 jmc 6537: .It Ic %client-session-changed Ar client session-id name
1.547 nicm 6538: The client is now attached to the session with ID
6539: .Ar session-id ,
6540: which is named
6541: .Ar name .
1.892 nicm 6542: .It Ic %config-error Ar error
6543: An error has happened in a configuration file.
1.778 nicm 6544: .It Ic %continue Ar pane-id
6545: The pane has been continued after being paused (if the
6546: .Ar pause-after
6547: flag is set, see
6548: .Ic refresh-client
6549: .Fl A ) .
1.345 nicm 6550: .It Ic %exit Op Ar reason
6551: The
6552: .Nm
6553: client is exiting immediately, either because it is not attached to any session
6554: or an error occurred.
6555: If present,
6556: .Ar reason
6557: describes why the client exited.
1.788 nicm 6558: .It Ic %extended-output Ar pane-id Ar age Ar ... \& : Ar value
1.779 nicm 6559: New form of
6560: .Ic %output
6561: sent when the
6562: .Ar pause-after
6563: flag is set.
6564: .Ar age
6565: is the time in milliseconds for which tmux had buffered the output before it was sent.
6566: Any subsequent arguments up until a single
6567: .Ql \&:
6568: are for future use and should be ignored.
1.460 nicm 6569: .It Ic %layout-change Ar window-id Ar window-layout Ar window-visible-layout Ar window-flags
1.345 nicm 6570: The layout of a window with ID
6571: .Ar window-id
6572: changed.
6573: The new layout is
6574: .Ar window-layout .
1.460 nicm 6575: The window's visible layout is
6576: .Ar window-visible-layout
6577: and the window flags are
6578: .Ar window-flags .
1.347 nicm 6579: .It Ic %output Ar pane-id Ar value
6580: A window pane produced output.
1.345 nicm 6581: .Ar value
1.350 nicm 6582: escapes non-printable characters and backslash as octal \\xxx.
1.547 nicm 6583: .It Ic %pane-mode-changed Ar pane-id
6584: The pane with ID
6585: .Ar pane-id
6586: has changed mode.
1.778 nicm 6587: .It Ic %pause Ar pane-id
6588: The pane has been paused (if the
6589: .Ar pause-after
6590: flag is set).
1.345 nicm 6591: .It Ic %session-changed Ar session-id Ar name
6592: The client is now attached to the session with ID
6593: .Ar session-id ,
6594: which is named
6595: .Ar name .
6596: .It Ic %session-renamed Ar name
6597: The current session was renamed to
6598: .Ar name .
1.547 nicm 6599: .It Ic %session-window-changed Ar session-id Ar window-id
6600: The session with ID
6601: .Ar session-id
6602: changed its active window to the window with ID
6603: .Ar window-id .
1.345 nicm 6604: .It Ic %sessions-changed
6605: A session was created or destroyed.
1.788 nicm 6606: .It Xo Ic %subscription-changed
6607: .Ar name
6608: .Ar session-id
6609: .Ar window-id
6610: .Ar window-index
6611: .Ar pane-id ... \& :
6612: .Ar value
6613: .Xc
6614: The value of the format associated with subscription
6615: .Ar name
6616: has changed to
6617: .Ar value .
6618: See
6619: .Ic refresh-client
6620: .Fl B .
6621: Any arguments after
6622: .Ar pane-id
6623: up until a single
6624: .Ql \&:
6625: are for future use and should be ignored.
1.345 nicm 6626: .It Ic %unlinked-window-add Ar window-id
6627: The window with ID
6628: .Ar window-id
6629: was created but is not linked to the current session.
1.873 nicm 6630: .It Ic %unlinked-window-close Ar window-id
6631: The window with ID
6632: .Ar window-id ,
6633: which is not linked to the current session, was closed.
6634: .It Ic %unlinked-window-renamed Ar window-id
6635: The window with ID
6636: .Ar window-id ,
6637: which is not linked to the current session, was renamed.
1.345 nicm 6638: .It Ic %window-add Ar window-id
6639: The window with ID
6640: .Ar window-id
6641: was linked to the current session.
6642: .It Ic %window-close Ar window-id
6643: The window with ID
6644: .Ar window-id
6645: closed.
1.547 nicm 6646: .It Ic %window-pane-changed Ar window-id Ar pane-id
6647: The active pane in the window with ID
6648: .Ar window-id
6649: changed to the pane with ID
6650: .Ar pane-id .
1.345 nicm 6651: .It Ic %window-renamed Ar window-id Ar name
6652: The window with ID
6653: .Ar window-id
6654: was renamed to
6655: .Ar name .
1.644 schwarze 6656: .El
6657: .Sh ENVIRONMENT
6658: When
6659: .Nm
6660: is started, it inspects the following environment variables:
6661: .Bl -tag -width LC_CTYPE
6662: .It Ev EDITOR
6663: If the command specified in this variable contains the string
6664: .Ql vi
6665: and
6666: .Ev VISUAL
6667: is unset, use vi-style key bindings.
6668: Overridden by the
6669: .Ic mode-keys
6670: and
6671: .Ic status-keys
6672: options.
6673: .It Ev HOME
6674: The user's login directory.
6675: If unset, the
6676: .Xr passwd 5
6677: database is consulted.
6678: .It Ev LC_CTYPE
6679: The character encoding
6680: .Xr locale 1 .
6681: It is used for two separate purposes.
6682: For output to the terminal, UTF-8 is used if the
6683: .Fl u
6684: option is given or if
6685: .Ev LC_CTYPE
6686: contains
6687: .Qq UTF-8
6688: or
6689: .Qq UTF8 .
6690: Otherwise, only ASCII characters are written and non-ASCII characters
6691: are replaced with underscores
6692: .Pq Ql _ .
6693: For input,
6694: .Nm
6695: always runs with a UTF-8 locale.
1.886 naddy 6696: If en_US.UTF-8 is provided by the operating system, it is used and
1.644 schwarze 6697: .Ev LC_CTYPE
6698: is ignored for input.
6699: Otherwise,
6700: .Ev LC_CTYPE
6701: tells
6702: .Nm
6703: what the UTF-8 locale is called on the current system.
6704: If the locale specified by
6705: .Ev LC_CTYPE
6706: is not available or is not a UTF-8 locale,
6707: .Nm
6708: exits with an error message.
6709: .It Ev LC_TIME
6710: The date and time format
6711: .Xr locale 1 .
6712: It is used for locale-dependent
6713: .Xr strftime 3
6714: format specifiers.
6715: .It Ev PWD
6716: The current working directory to be set in the global environment.
6717: This may be useful if it contains symbolic links.
6718: If the value of the variable does not match the current working
6719: directory, the variable is ignored and the result of
6720: .Xr getcwd 3
6721: is used instead.
6722: .It Ev SHELL
6723: The absolute path to the default shell for new windows.
6724: See the
6725: .Ic default-shell
6726: option for details.
6727: .It Ev TMUX_TMPDIR
6728: The parent directory of the directory containing the server sockets.
6729: See the
6730: .Fl L
6731: option for details.
6732: .It Ev VISUAL
6733: If the command specified in this variable contains the string
6734: .Ql vi ,
6735: use vi-style key bindings.
6736: Overridden by the
6737: .Ic mode-keys
6738: and
6739: .Ic status-keys
6740: options.
1.1 nicm 6741: .El
6742: .Sh FILES
1.26 nicm 6743: .Bl -tag -width "/etc/tmux.confXXX" -compact
1.1 nicm 6744: .It Pa ~/.tmux.conf
1.6 jmc 6745: Default
1.1 nicm 6746: .Nm
1.6 jmc 6747: configuration file.
1.26 nicm 6748: .It Pa /etc/tmux.conf
6749: System-wide configuration file.
1.1 nicm 6750: .El
1.57 jmc 6751: .Sh EXAMPLES
6752: To create a new
6753: .Nm
6754: session running
6755: .Xr vi 1 :
6756: .Pp
6757: .Dl $ tmux new-session vi
6758: .Pp
6759: Most commands have a shorter form, known as an alias.
6760: For new-session, this is
6761: .Ic new :
6762: .Pp
6763: .Dl $ tmux new vi
6764: .Pp
6765: Alternatively, the shortest unambiguous form of a command is accepted.
6766: If there are several options, they are listed:
6767: .Bd -literal -offset indent
6768: $ tmux n
6769: ambiguous command: n, could be: new-session, new-window, next-window
6770: .Ed
6771: .Pp
6772: Within an active session, a new window may be created by typing
6773: .Ql C-b c
6774: (Ctrl
6775: followed by the
6776: .Ql b
6777: key
6778: followed by the
6779: .Ql c
6780: key).
6781: .Pp
6782: Windows may be navigated with:
6783: .Ql C-b 0
6784: (to select window 0),
6785: .Ql C-b 1
6786: (to select window 1), and so on;
6787: .Ql C-b n
6788: to select the next window; and
6789: .Ql C-b p
6790: to select the previous window.
6791: .Pp
6792: A session may be detached using
6793: .Ql C-b d
1.64 nicm 6794: (or by an external event such as
6795: .Xr ssh 1
6796: disconnection) and reattached with:
1.57 jmc 6797: .Pp
6798: .Dl $ tmux attach-session
6799: .Pp
6800: Typing
6801: .Ql C-b \&?
6802: lists the current key bindings in the current window; up and down may be used
6803: to navigate the list or
6804: .Ql q
6805: to exit from it.
6806: .Pp
6807: Commands to be run when the
6808: .Nm
6809: server is started may be placed in the
6810: .Pa ~/.tmux.conf
6811: configuration file.
6812: Common examples include:
6813: .Pp
6814: Changing the default prefix key:
6815: .Bd -literal -offset indent
6816: set-option -g prefix C-a
6817: unbind-key C-b
6818: bind-key C-a send-prefix
6819: .Ed
6820: .Pp
6821: Turning the status line off, or changing its colour:
6822: .Bd -literal -offset indent
6823: set-option -g status off
1.378 nicm 6824: set-option -g status-style bg=blue
1.57 jmc 6825: .Ed
6826: .Pp
6827: Setting other options, such as the default command,
6828: or locking after 30 minutes of inactivity:
6829: .Bd -literal -offset indent
6830: set-option -g default-command "exec /bin/ksh"
6831: set-option -g lock-after-time 1800
6832: .Ed
6833: .Pp
6834: Creating new key bindings:
6835: .Bd -literal -offset indent
6836: bind-key b set-option status
6837: bind-key / command-prompt "split-window 'exec man %%'"
1.73 nicm 6838: bind-key S command-prompt "new-window -n %1 'ssh %1'"
1.57 jmc 6839: .Ed
1.1 nicm 6840: .Sh SEE ALSO
6841: .Xr pty 4
6842: .Sh AUTHORS
1.477 nicm 6843: .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com