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