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