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