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