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