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