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