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