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