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