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