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