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