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