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