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