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