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