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