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