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