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