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