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