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