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