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