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