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