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