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