Annotation of src/usr.bin/tmux/tmux.1, Revision 1.813
1.813 ! nicm 1: .\" $OpenBSD: tmux.1,v 1.812 2021/01/20 07:16:54 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.813 ! nicm 17: .Dd $Mdocdate: January 20 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;
1365: an window ID such as
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.678 nicm 1656: .It Li "previous-matching-bracket" Ta "" Ta "M-C-b"
1.497 nicm 1657: .It Li "previous-paragraph" Ta "{" Ta "M-{"
1658: .It Li "previous-space" Ta "B" Ta ""
1659: .It Li "previous-word" Ta "b" Ta "M-b"
1.813 ! nicm 1660: .It Li "rectangle-on" Ta "" Ta ""
! 1661: .It Li "rectangle-off" Ta "" Ta ""
1.497 nicm 1662: .It Li "rectangle-toggle" Ta "v" Ta "R"
1.732 nicm 1663: .It Li "refresh-from-pane" Ta "r" Ta "r"
1.497 nicm 1664: .It Li "scroll-down" Ta "C-e" Ta "C-Down"
1.589 nicm 1665: .It Li "scroll-down-and-cancel" Ta "" Ta ""
1.497 nicm 1666: .It Li "scroll-up" Ta "C-y" Ta "C-Up"
1667: .It Li "search-again" Ta "n" Ta "n"
1.517 nicm 1668: .It Li "search-backward <for>" Ta "?" Ta ""
1.726 nicm 1669: .It Li "search-backward-incremental <for>" Ta "" Ta "C-r"
1670: .It Li "search-backward-text <for>" Ta "" Ta ""
1.517 nicm 1671: .It Li "search-forward <for>" Ta "/" Ta ""
1672: .It Li "search-forward-incremental <for>" Ta "" Ta "C-s"
1.726 nicm 1673: .It Li "search-forward-text <for>" Ta "" Ta ""
1.497 nicm 1674: .It Li "search-reverse" Ta "N" Ta "N"
1675: .It Li "select-line" Ta "V" Ta ""
1.634 nicm 1676: .It Li "select-word" Ta "" Ta ""
1.768 nicm 1677: .It Li "set-mark" Ta "X" Ta "X"
1.497 nicm 1678: .It Li "start-of-line" Ta "0" Ta "C-a"
1.515 nicm 1679: .It Li "stop-selection" Ta "" Ta ""
1.497 nicm 1680: .It Li "top-line" Ta "H" Ta "M-R"
1.1 nicm 1681: .El
1.726 nicm 1682: .Pp
1683: The search commands come in several varieties:
1684: .Ql search-forward
1685: and
1686: .Ql search-backward
1687: search for a regular expression;
1688: the
1689: .Ql -text
1690: variants search for a plain text string rather than a regular expression;
1691: .Ql -incremental
1692: perform an incremental search and expect to be used with the
1693: .Fl i
1694: flag to the
1695: .Ic command-prompt
1696: command.
1697: .Ql search-again
1698: repeats the last search and
1699: .Ql search-reverse
1700: does the same but reverses the direction (forward becomes backward and backward
1701: becomes forward).
1.589 nicm 1702: .Pp
1.633 nicm 1703: Copy commands may take an optional buffer prefix argument which is used
1704: to generate the buffer name (the default is
1705: .Ql buffer
1706: so buffers are named
1707: .Ql buffer0 ,
1708: .Ql buffer1
1709: and so on).
1710: Pipe commands take a command argument which is the command to which the
1711: copied text is piped.
1.589 nicm 1712: The
1713: .Ql -and-cancel
1714: variants of some commands exit copy mode after they have completed (for copy
1715: commands) or when the cursor reaches the bottom (for scrolling commands).
1.638 nicm 1716: .Ql -no-clear
1717: variants do not clear the selection.
1.146 nicm 1718: .Pp
1719: The next and previous word keys use space and the
1720: .Ql - ,
1.154 nicm 1721: .Ql _
1.146 nicm 1722: and
1723: .Ql @
1.154 nicm 1724: characters as word delimiters by default, but this can be adjusted by
1725: setting the
1726: .Em word-separators
1.255 nicm 1727: session option.
1.146 nicm 1728: Next word moves to the start of the next word, next word end to the end of the
1729: next word and previous word to the start of the previous word.
1730: The three next and previous space keys work similarly but use a space alone as
1731: the word separator.
1.157 nicm 1732: .Pp
1733: The jump commands enable quick movement within a line.
1734: For instance, typing
1735: .Ql f
1736: followed by
1737: .Ql /
1738: will move the cursor to the next
1739: .Ql /
1740: character on the current line.
1741: A
1742: .Ql \&;
1743: will then jump to the next occurrence.
1.1 nicm 1744: .Pp
1.155 nicm 1745: Commands in copy mode may be prefaced by an optional repeat count.
1746: With vi key bindings, a prefix is entered using the number keys; with
1747: emacs, the Alt (meta) key and a number begins prefix entry.
1748: .Pp
1.164 nicm 1749: The synopsis for the
1750: .Ic copy-mode
1751: command is:
1.57 jmc 1752: .Bl -tag -width Ds
1753: .It Xo Ic copy-mode
1.720 nicm 1754: .Op Fl eHMqu
1.735 nicm 1755: .Op Fl s Ar src-pane
1.72 nicm 1756: .Op Fl t Ar target-pane
1.57 jmc 1757: .Xc
1758: Enter copy mode.
1759: The
1760: .Fl u
1761: option scrolls one page up.
1.419 nicm 1762: .Fl M
1763: begins a mouse drag (only valid if bound to a mouse key binding, see
1.420 jmc 1764: .Sx MOUSE SUPPORT ) .
1.716 nicm 1765: .Fl H
1766: hides the position indicator in the top right.
1.720 nicm 1767: .Fl q
1768: cancels copy mode and any other modes.
1.735 nicm 1769: .Fl s
1770: copies from
1771: .Ar src-pane
1772: instead of
1.736 nicm 1773: .Ar target-pane .
1.716 nicm 1774: .Pp
1.450 nicm 1775: .Fl e
1776: specifies that scrolling to the bottom of the history (to the visible screen)
1777: should exit copy mode.
1778: While in copy mode, pressing a key other than those used for scrolling will
1779: disable this behaviour.
1780: This is intended to allow fast scrolling through a pane's history, for
1781: example with:
1782: .Bd -literal -offset indent
1783: bind PageUp copy-mode -eu
1784: .Ed
1.57 jmc 1785: .El
1.18 nicm 1786: .Pp
1.679 nicm 1787: A number of preset arrangements of panes are available, these are called layouts.
1.38 nicm 1788: These may be selected with the
1789: .Ic select-layout
1790: command or cycled with
1791: .Ic next-layout
1792: (bound to
1.149 nicm 1793: .Ql Space
1.131 nicm 1794: by default); once a layout is chosen, panes within it may be moved and resized
1795: as normal.
1.1 nicm 1796: .Pp
1797: The following layouts are supported:
1798: .Bl -tag -width Ds
1799: .It Ic even-horizontal
1800: Panes are spread out evenly from left to right across the window.
1801: .It Ic even-vertical
1802: Panes are spread evenly from top to bottom.
1.2 nicm 1803: .It Ic main-horizontal
1.131 nicm 1804: A large (main) pane is shown at the top of the window and the remaining panes
1805: are spread from left to right in the leftover space at the bottom.
1.2 nicm 1806: Use the
1807: .Em main-pane-height
1808: window option to specify the height of the top pane.
1.1 nicm 1809: .It Ic main-vertical
1.2 nicm 1810: Similar to
1811: .Ic main-horizontal
1812: but the large pane is placed on the left and the others spread from top to
1813: bottom along the right.
1814: See the
1815: .Em main-pane-width
1816: window option.
1.165 nicm 1817: .It Ic tiled
1818: Panes are spread out as evenly as possible over the window in both rows and
1819: columns.
1.1 nicm 1820: .El
1.8 nicm 1821: .Pp
1.181 nicm 1822: In addition,
1823: .Ic select-layout
1824: may be used to apply a previously used layout - the
1825: .Ic list-windows
1826: command displays the layout of each window in a form suitable for use with
1827: .Ic select-layout .
1828: For example:
1829: .Bd -literal -offset indent
1830: $ tmux list-windows
1831: 0: ksh [159x48]
1832: layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1833: $ tmux select-layout bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1834: .Ed
1.196 nicm 1835: .Pp
1.181 nicm 1836: .Nm
1837: automatically adjusts the size of the layout for the current window size.
1838: Note that a layout cannot be applied to a window with more panes than that
1839: from which the layout was originally defined.
1840: .Pp
1.57 jmc 1841: Commands related to windows and panes are as follows:
1842: .Bl -tag -width Ds
1843: .It Xo Ic break-pane
1.784 nicm 1844: .Op Fl abdP
1.280 nicm 1845: .Op Fl F Ar format
1.532 nicm 1846: .Op Fl n Ar window-name
1.440 nicm 1847: .Op Fl s Ar src-pane
1.480 nicm 1848: .Op Fl t Ar dst-window
1.57 jmc 1849: .Xc
1850: .D1 (alias: Ic breakp )
1851: Break
1.440 nicm 1852: .Ar src-pane
1853: off from its containing window to make it the only pane in
1854: .Ar dst-window .
1.749 nicm 1855: With
1.784 nicm 1856: .Fl a
1857: or
1858: .Fl b ,
1859: the window is moved to the next index after or before (existing windows are
1860: moved if necessary).
1.57 jmc 1861: If
1862: .Fl d
1863: is given, the new window does not become the current window.
1.280 nicm 1864: The
1865: .Fl P
1866: option prints information about the new window after it has been created.
1867: By default, it uses the format
1.798 nicm 1868: .Ql #{session_name}:#{window_index}.#{pane_index}
1.280 nicm 1869: but a different format may be specified with
1870: .Fl F .
1.128 nicm 1871: .It Xo Ic capture-pane
1.680 nicm 1872: .Op Fl aepPqCJN
1.392 nicm 1873: .Op Fl b Ar buffer-name
1.213 nicm 1874: .Op Fl E Ar end-line
1875: .Op Fl S Ar start-line
1.128 nicm 1876: .Op Fl t Ar target-pane
1877: .Xc
1878: .D1 (alias: Ic capturep )
1.322 nicm 1879: Capture the contents of a pane.
1880: If
1881: .Fl p
1.325 nicm 1882: is given, the output goes to stdout, otherwise to the buffer specified with
1.322 nicm 1883: .Fl b
1884: or a new buffer if omitted.
1.339 nicm 1885: If
1886: .Fl a
1887: is given, the alternate screen is used, and the history is not accessible.
1.340 nicm 1888: If no alternate screen exists, an error will be returned unless
1889: .Fl q
1890: is given.
1.326 nicm 1891: If
1892: .Fl e
1.328 nicm 1893: is given, the output includes escape sequences for text and background
1894: attributes.
1895: .Fl C
1.330 nicm 1896: also escapes non-printable characters as octal \exxx.
1.680 nicm 1897: .Fl N
1898: preserves trailing spaces at each line's end and
1.328 nicm 1899: .Fl J
1.680 nicm 1900: preserves trailing spaces and joins any wrapped lines.
1.346 nicm 1901: .Fl P
1902: captures only any output that the pane has received that is the beginning of an
1903: as-yet incomplete escape sequence.
1.213 nicm 1904: .Pp
1905: .Fl S
1906: and
1907: .Fl E
1908: specify the starting and ending line numbers, zero is the first line of the
1909: visible pane and negative numbers are lines in the history.
1.397 nicm 1910: .Ql -
1911: to
1912: .Fl S
1913: is the start of the history and to
1914: .Fl E
1915: the end of the visible pane.
1.213 nicm 1916: The default is to capture only the visible contents of the pane.
1.76 nicm 1917: .It Xo
1918: .Ic choose-client
1.682 nicm 1919: .Op Fl NrZ
1.572 nicm 1920: .Op Fl F Ar format
1.562 nicm 1921: .Op Fl f Ar filter
1.561 nicm 1922: .Op Fl O Ar sort-order
1.555 nicm 1923: .Op Fl t Ar target-pane
1.76 nicm 1924: .Op Ar template
1925: .Xc
1.555 nicm 1926: Put a pane into client mode, allowing a client to be selected interactively from
1927: a list.
1.593 nicm 1928: .Fl Z
1929: zooms the pane.
1.555 nicm 1930: The following keys may be used in client mode:
1931: .Bl -column "Key" "Function" -offset indent
1932: .It Sy "Key" Ta Sy "Function"
1933: .It Li "Enter" Ta "Choose selected client"
1934: .It Li "Up" Ta "Select previous client"
1935: .It Li "Down" Ta "Select next client"
1.559 nicm 1936: .It Li "C-s" Ta "Search by name"
1937: .It Li "n" Ta "Repeat last search"
1.555 nicm 1938: .It Li "t" Ta "Toggle if client is tagged"
1939: .It Li "T" Ta "Tag no clients"
1940: .It Li "C-t" Ta "Tag all clients"
1941: .It Li "d" Ta "Detach selected client"
1942: .It Li "D" Ta "Detach tagged clients"
1943: .It Li "x" Ta "Detach and HUP selected client"
1944: .It Li "X" Ta "Detach and HUP tagged clients"
1945: .It Li "z" Ta "Suspend selected client"
1946: .It Li "Z" Ta "Suspend tagged clients"
1.562 nicm 1947: .It Li "f" Ta "Enter a format to filter items"
1.682 nicm 1948: .It Li "O" Ta "Change sort field"
1949: .It Li "r" Ta "Reverse sort order"
1.576 nicm 1950: .It Li "v" Ta "Toggle preview"
1.555 nicm 1951: .It Li "q" Ta "Exit mode"
1952: .El
1953: .Pp
1.76 nicm 1954: After a client is chosen,
1955: .Ql %%
1.555 nicm 1956: is replaced by the client name in
1.76 nicm 1957: .Ar template
1958: and the result executed as a command.
1959: If
1960: .Ar template
1961: is not given, "detach-client -t '%%'" is used.
1.555 nicm 1962: .Pp
1.561 nicm 1963: .Fl O
1.682 nicm 1964: specifies the initial sort field: one of
1.561 nicm 1965: .Ql name ,
1966: .Ql size ,
1967: .Ql creation ,
1968: or
1969: .Ql activity .
1.682 nicm 1970: .Fl r
1971: reverses the sort order.
1.562 nicm 1972: .Fl f
1.579 nicm 1973: specifies an initial filter: the filter is a format - if it evaluates to zero,
1974: the item in the list is not shown, otherwise it is shown.
1975: If a filter would lead to an empty list, it is ignored.
1.572 nicm 1976: .Fl F
1977: specifies the format for each item in the list.
1.576 nicm 1978: .Fl N
1979: starts without the preview.
1.314 nicm 1980: This command works only if at least one client is attached.
1.76 nicm 1981: .It Xo
1.555 nicm 1982: .Ic choose-tree
1.682 nicm 1983: .Op Fl GNrswZ
1.572 nicm 1984: .Op Fl F Ar format
1.562 nicm 1985: .Op Fl f Ar filter
1.561 nicm 1986: .Op Fl O Ar sort-order
1.555 nicm 1987: .Op Fl t Ar target-pane
1.76 nicm 1988: .Op Ar template
1989: .Xc
1.555 nicm 1990: Put a pane into tree mode, where a session, window or pane may be chosen
1.76 nicm 1991: interactively from a list.
1.298 nicm 1992: .Fl s
1.555 nicm 1993: starts with sessions collapsed and
1.298 nicm 1994: .Fl w
1.555 nicm 1995: with windows collapsed.
1.593 nicm 1996: .Fl Z
1997: zooms the pane.
1.555 nicm 1998: The following keys may be used in tree mode:
1999: .Bl -column "Key" "Function" -offset indent
2000: .It Sy "Key" Ta Sy "Function"
2001: .It Li "Enter" Ta "Choose selected item"
2002: .It Li "Up" Ta "Select previous item"
2003: .It Li "Down" Ta "Select next item"
1.763 nicm 2004: .It Li "+" Ta "Expand selected item"
2005: .It Li "-" Ta "Collapse selected item"
2006: .It Li "M-+" Ta "Expand all items"
2007: .It Li "M--" Ta "Collapse all items"
1.594 nicm 2008: .It Li "x" Ta "Kill selected item"
2009: .It Li "X" Ta "Kill tagged items"
1.566 nicm 2010: .It Li "<" Ta "Scroll list of previews left"
2011: .It Li ">" Ta "Scroll list of previews right"
1.559 nicm 2012: .It Li "C-s" Ta "Search by name"
1.749 nicm 2013: .It Li "m" Ta "Set the marked pane"
2014: .It Li "M" Ta "Clear the marked pane"
1.559 nicm 2015: .It Li "n" Ta "Repeat last search"
1.555 nicm 2016: .It Li "t" Ta "Toggle if item is tagged"
2017: .It Li "T" Ta "Tag no items"
2018: .It Li "C-t" Ta "Tag all items"
1.557 nicm 2019: .It Li "\&:" Ta "Run a command for each tagged item"
1.555 nicm 2020: .It Li "f" Ta "Enter a format to filter items"
1.749 nicm 2021: .It Li "H" Ta "Jump to the starting pane"
1.682 nicm 2022: .It Li "O" Ta "Change sort field"
2023: .It Li "r" Ta "Reverse sort order"
1.576 nicm 2024: .It Li "v" Ta "Toggle preview"
1.555 nicm 2025: .It Li "q" Ta "Exit mode"
2026: .El
1.320 nicm 2027: .Pp
1.555 nicm 2028: After a session, window or pane is chosen,
1.76 nicm 2029: .Ql %%
1.555 nicm 2030: is replaced by the target in
1.76 nicm 2031: .Ar template
2032: and the result executed as a command.
2033: If
2034: .Ar template
1.555 nicm 2035: is not given, "switch-client -t '%%'" is used.
2036: .Pp
1.561 nicm 2037: .Fl O
1.682 nicm 2038: specifies the initial sort field: one of
1.561 nicm 2039: .Ql index ,
2040: .Ql name ,
2041: or
2042: .Ql time .
1.682 nicm 2043: .Fl r
2044: reverses the sort order.
1.562 nicm 2045: .Fl f
1.579 nicm 2046: specifies an initial filter: the filter is a format - if it evaluates to zero,
2047: the item in the list is not shown, otherwise it is shown.
2048: If a filter would lead to an empty list, it is ignored.
1.572 nicm 2049: .Fl F
2050: specifies the format for each item in the tree.
1.576 nicm 2051: .Fl N
2052: starts without the preview.
1.586 nicm 2053: .Fl G
2054: includes all sessions in any session groups in the tree rather than only the
2055: first.
1.766 nicm 2056: This command works only if at least one client is attached.
2057: .It Xo
2058: .Ic customize-mode
2059: .Op Fl NZ
2060: .Op Fl F Ar format
2061: .Op Fl f Ar filter
2062: .Op Fl t Ar target-pane
2063: .Op Ar template
2064: .Xc
2065: Put a pane into customize mode, where options and key bindings may be browsed
2066: and modified from a list.
2067: Option values in the list are shown for the active pane in the current window.
2068: .Fl Z
2069: zooms the pane.
2070: The following keys may be used in customize mode:
2071: .Bl -column "Key" "Function" -offset indent
2072: .It Sy "Key" Ta Sy "Function"
2073: .It Li "Enter" Ta "Set pane, window, session or global option value"
2074: .It Li "Up" Ta "Select previous item"
2075: .It Li "Down" Ta "Select next item"
2076: .It Li "+" Ta "Expand selected item"
2077: .It Li "-" Ta "Collapse selected item"
2078: .It Li "M-+" Ta "Expand all items"
2079: .It Li "M--" Ta "Collapse all items"
2080: .It Li "s" Ta "Set option value or key attribute"
2081: .It Li "S" Ta "Set global option value"
2082: .It Li "w" Ta "Set window option value, if option is for pane and window"
1.785 nicm 2083: .It Li "d" Ta "Set an option or key to the default"
2084: .It Li "D" Ta "Set tagged options and tagged keys to the default"
1.766 nicm 2085: .It Li "u" Ta "Unset an option (set to default value if global) or unbind a key"
2086: .It Li "U" Ta "Unset tagged options and unbind tagged keys"
2087: .It Li "C-s" Ta "Search by name"
2088: .It Li "n" Ta "Repeat last search"
2089: .It Li "t" Ta "Toggle if item is tagged"
2090: .It Li "T" Ta "Tag no items"
2091: .It Li "C-t" Ta "Tag all items"
2092: .It Li "f" Ta "Enter a format to filter items"
2093: .It Li "v" Ta "Toggle option information"
2094: .It Li "q" Ta "Exit mode"
2095: .El
2096: .Pp
2097: .Fl f
2098: specifies an initial filter: the filter is a format - if it evaluates to zero,
2099: the item in the list is not shown, otherwise it is shown.
2100: If a filter would lead to an empty list, it is ignored.
2101: .Fl F
2102: specifies the format for each item in the tree.
2103: .Fl N
2104: starts without the option information.
1.314 nicm 2105: This command works only if at least one client is attached.
1.491 nicm 2106: .It Xo
2107: .Ic display-panes
1.804 nicm 2108: .Op Fl bN
1.573 nicm 2109: .Op Fl d Ar duration
1.491 nicm 2110: .Op Fl t Ar target-client
2111: .Op Ar template
2112: .Xc
1.398 nicm 2113: .D1 (alias: Ic displayp )
1.78 nicm 2114: Display a visible indicator of each pane shown by
2115: .Ar target-client .
2116: See the
1.573 nicm 2117: .Ic display-panes-colour
1.78 nicm 2118: and
1.145 nicm 2119: .Ic display-panes-active-colour
1.78 nicm 2120: session options.
1.804 nicm 2121: The indicator is closed when a key is pressed (unless
1.805 nicm 2122: .Fl N
2123: is given) or
1.573 nicm 2124: .Ar duration
2125: milliseconds have passed.
2126: If
2127: .Fl d
2128: is not given,
2129: .Ic display-panes-time
2130: is used.
2131: A duration of zero means the indicator stays until a key is pressed.
1.491 nicm 2132: While the indicator is on screen, a pane may be chosen with the
1.84 nicm 2133: .Ql 0
2134: to
2135: .Ql 9
1.491 nicm 2136: keys, which will cause
2137: .Ar template
2138: to be executed as a command with
2139: .Ql %%
2140: substituted by the pane ID.
2141: The default
2142: .Ar template
2143: is "select-pane -t '%%'".
1.616 nicm 2144: With
2145: .Fl b ,
2146: other commands are not blocked from running until the indicator is closed.
1.57 jmc 2147: .It Xo Ic find-window
1.775 nicm 2148: .Op Fl iCNrTZ
1.555 nicm 2149: .Op Fl t Ar target-pane
1.57 jmc 2150: .Ar match-string
2151: .Xc
2152: .D1 (alias: Ic findw )
1.670 nicm 2153: Search for a
1.57 jmc 2154: .Xr fnmatch 3
1.670 nicm 2155: pattern or, with
2156: .Fl r ,
2157: regular expression
1.57 jmc 2158: .Ar match-string
2159: in window names, titles, and visible content (but not history).
1.285 nicm 2160: The flags control matching behavior:
2161: .Fl C
2162: matches only visible window contents,
2163: .Fl N
2164: matches only the window name and
2165: .Fl T
2166: matches only the window title.
1.775 nicm 2167: .Fl i
2168: makes the search ignore case.
1.285 nicm 2169: The default is
2170: .Fl CNT .
1.608 nicm 2171: .Fl Z
2172: zooms the pane.
1.555 nicm 2173: .Pp
1.314 nicm 2174: This command works only if at least one client is attached.
1.137 nicm 2175: .It Xo Ic join-pane
1.697 nicm 2176: .Op Fl bdfhv
1.690 nicm 2177: .Op Fl l Ar size
1.137 nicm 2178: .Op Fl s Ar src-pane
2179: .Op Fl t Ar dst-pane
2180: .Xc
2181: .D1 (alias: Ic joinp )
2182: Like
2183: .Ic split-window ,
2184: but instead of splitting
2185: .Ar dst-pane
2186: and creating a new pane, split it and move
2187: .Ar src-pane
2188: into the space.
2189: This can be used to reverse
2190: .Ic break-pane .
1.277 nicm 2191: The
2192: .Fl b
2193: option causes
2194: .Ar src-pane
2195: to be joined to left of or above
2196: .Ar dst-pane .
1.432 nicm 2197: .Pp
2198: If
2199: .Fl s
2200: is omitted and a marked pane is present (see
2201: .Ic select-pane
2202: .Fl m ) ,
2203: the marked pane is used rather than the current pane.
1.112 nicm 2204: .It Xo Ic kill-pane
2205: .Op Fl a
2206: .Op Fl t Ar target-pane
2207: .Xc
1.57 jmc 2208: .D1 (alias: Ic killp )
2209: Destroy the given pane.
2210: If no panes remain in the containing window, it is also destroyed.
1.112 nicm 2211: The
2212: .Fl a
2213: option kills all but the pane given with
2214: .Fl t .
1.289 nicm 2215: .It Xo Ic kill-window
2216: .Op Fl a
2217: .Op Fl t Ar target-window
2218: .Xc
1.57 jmc 2219: .D1 (alias: Ic killw )
2220: Kill the current window or the window at
2221: .Ar target-window ,
1.1 nicm 2222: removing it from any sessions to which it is linked.
1.289 nicm 2223: The
2224: .Fl a
2225: option kills all but the window given with
2226: .Fl t .
1.398 nicm 2227: .It Xo Ic last-pane
1.681 nicm 2228: .Op Fl deZ
1.398 nicm 2229: .Op Fl t Ar target-window
2230: .Xc
1.187 nicm 2231: .D1 (alias: Ic lastp )
2232: Select the last (previously selected) pane.
1.681 nicm 2233: .Fl Z
2234: keeps the window zoomed if it was zoomed.
1.398 nicm 2235: .Fl e
2236: enables or
2237: .Fl d
2238: disables input to the pane.
1.56 jmc 2239: .It Ic last-window Op Fl t Ar target-session
1.1 nicm 2240: .D1 (alias: Ic last )
2241: Select the last (previously selected) window.
2242: If no
2243: .Ar target-session
2244: is specified, select the last window of the current session.
2245: .It Xo Ic link-window
1.784 nicm 2246: .Op Fl abdk
1.1 nicm 2247: .Op Fl s Ar src-window
2248: .Op Fl t Ar dst-window
2249: .Xc
2250: .D1 (alias: Ic linkw )
2251: Link the window at
2252: .Ar src-window
2253: to the specified
2254: .Ar dst-window .
2255: If
2256: .Ar dst-window
2257: is specified and no such window exists, the
2258: .Ar src-window
2259: is linked there.
1.439 nicm 2260: With
1.784 nicm 2261: .Fl a
2262: or
2263: .Fl b
2264: the window is moved to the next index after or before
2265: .Ar dst-window
2266: (existing windows are moved if necessary).
1.1 nicm 2267: If
2268: .Fl k
2269: is given and
2270: .Ar dst-window
2271: exists, it is killed, otherwise an error is generated.
2272: If
2273: .Fl d
2274: is given, the newly linked window is not selected.
1.214 nicm 2275: .It Xo Ic list-panes
2276: .Op Fl as
1.245 nicm 2277: .Op Fl F Ar format
1.738 nicm 2278: .Op Fl f Ar filter
1.214 nicm 2279: .Op Fl t Ar target
2280: .Xc
1.104 nicm 2281: .D1 (alias: Ic lsp )
1.214 nicm 2282: If
2283: .Fl a
2284: is given,
2285: .Ar target
2286: is ignored and all panes on the server are listed.
2287: If
2288: .Fl s
2289: is given,
2290: .Ar target
2291: is a session (or the current session).
2292: If neither is given,
2293: .Ar target
2294: is a window (or the current window).
1.247 nicm 2295: .Fl F
1.738 nicm 2296: specifies the format of each line and
2297: .Fl f
2298: a filter.
2299: Only panes for which the filter is true are shown.
2300: See the
1.247 nicm 2301: .Sx FORMATS
2302: section.
1.214 nicm 2303: .It Xo Ic list-windows
2304: .Op Fl a
1.245 nicm 2305: .Op Fl F Ar format
1.738 nicm 2306: .Op Fl f Ar filter
1.214 nicm 2307: .Op Fl t Ar target-session
2308: .Xc
1.1 nicm 2309: .D1 (alias: Ic lsw )
1.214 nicm 2310: If
2311: .Fl a
2312: is given, list all windows on the server.
2313: Otherwise, list windows in the current session or in
1.1 nicm 2314: .Ar target-session .
1.245 nicm 2315: .Fl F
1.738 nicm 2316: specifies the format of each line and
2317: .Fl f
2318: a filter.
2319: Only windows for which the filter is true are shown.
2320: See the
1.245 nicm 2321: .Sx FORMATS
2322: section.
1.277 nicm 2323: .It Xo Ic move-pane
1.749 nicm 2324: .Op Fl bdfhv
1.690 nicm 2325: .Op Fl l Ar size
1.277 nicm 2326: .Op Fl s Ar src-pane
2327: .Op Fl t Ar dst-pane
2328: .Xc
2329: .D1 (alias: Ic movep )
1.749 nicm 2330: Does the same as
2331: .Ic join-pane .
1.1 nicm 2332: .It Xo Ic move-window
1.784 nicm 2333: .Op Fl abrdk
1.1 nicm 2334: .Op Fl s Ar src-window
2335: .Op Fl t Ar dst-window
2336: .Xc
2337: .D1 (alias: Ic movew )
2338: This is similar to
2339: .Ic link-window ,
2340: except the window at
2341: .Ar src-window
2342: is moved to
2343: .Ar dst-window .
1.291 nicm 2344: With
2345: .Fl r ,
2346: all windows in the session are renumbered in sequential order, respecting
2347: the
2348: .Ic base-index
2349: option.
1.1 nicm 2350: .It Xo Ic new-window
1.784 nicm 2351: .Op Fl abdkP
1.272 nicm 2352: .Op Fl c Ar start-directory
1.641 nicm 2353: .Op Fl e Ar environment
1.351 nicm 2354: .Op Fl F Ar format
1.1 nicm 2355: .Op Fl n Ar window-name
2356: .Op Fl t Ar target-window
1.153 nicm 2357: .Op Ar shell-command
1.1 nicm 2358: .Xc
2359: .D1 (alias: Ic neww )
2360: Create a new window.
1.160 nicm 2361: With
1.784 nicm 2362: .Fl a
2363: or
2364: .Fl b ,
2365: the new window is inserted at the next index after or before the specified
1.160 nicm 2366: .Ar target-window ,
1.784 nicm 2367: moving windows up if necessary;
1.160 nicm 2368: otherwise
2369: .Ar target-window
2370: is the new window location.
2371: .Pp
1.1 nicm 2372: If
2373: .Fl d
2374: is given, the session does not make the new window the current window.
2375: .Ar target-window
1.28 nicm 2376: represents the window to be created; if the target already exists an error is
2377: shown, unless the
2378: .Fl k
2379: flag is used, in which case it is destroyed.
1.153 nicm 2380: .Ar shell-command
1.1 nicm 2381: is the command to execute.
2382: If
1.153 nicm 2383: .Ar shell-command
2384: is not specified, the value of the
2385: .Ic default-command
2386: option is used.
1.272 nicm 2387: .Fl c
2388: specifies the working directory in which the new window is created.
1.153 nicm 2389: .Pp
2390: When the shell command completes, the window closes.
2391: See the
2392: .Ic remain-on-exit
2393: option to change this behaviour.
1.1 nicm 2394: .Pp
1.641 nicm 2395: .Fl e
2396: takes the form
2397: .Ql VARIABLE=value
2398: and sets an environment variable for the newly created window; it may be
2399: specified multiple times.
2400: .Pp
1.1 nicm 2401: The
2402: .Ev TERM
2403: environment variable must be set to
1.523 nicm 2404: .Ql screen
2405: or
2406: .Ql tmux
1.1 nicm 2407: for all programs running
2408: .Em inside
2409: .Nm .
2410: New windows will automatically have
1.523 nicm 2411: .Ql TERM=screen
1.1 nicm 2412: added to their environment, but care must be taken not to reset this in shell
1.641 nicm 2413: start-up files or by the
2414: .Fl e
2415: option.
1.201 nicm 2416: .Pp
2417: The
2418: .Fl P
1.279 nicm 2419: option prints information about the new window after it has been created.
2420: By default, it uses the format
2421: .Ql #{session_name}:#{window_index}
2422: but a different format may be specified with
2423: .Fl F .
1.56 jmc 2424: .It Ic next-layout Op Fl t Ar target-window
1.1 nicm 2425: .D1 (alias: Ic nextl )
2426: Move a window to the next layout and rearrange the panes to fit.
2427: .It Xo Ic next-window
1.9 nicm 2428: .Op Fl a
1.1 nicm 2429: .Op Fl t Ar target-session
2430: .Xc
2431: .D1 (alias: Ic next )
2432: Move to the next window in the session.
1.9 nicm 2433: If
1.12 jmc 2434: .Fl a
1.295 nicm 2435: is used, move to the next window with an alert.
1.107 nicm 2436: .It Xo Ic pipe-pane
1.591 nicm 2437: .Op Fl IOo
1.107 nicm 2438: .Op Fl t Ar target-pane
1.153 nicm 2439: .Op Ar shell-command
1.107 nicm 2440: .Xc
2441: .D1 (alias: Ic pipep )
1.591 nicm 2442: Pipe output sent by the program in
1.107 nicm 2443: .Ar target-pane
1.591 nicm 2444: to a shell command or vice versa.
2445: A pane may only be connected to one command at a time, any existing pipe is
1.107 nicm 2446: closed before
1.153 nicm 2447: .Ar shell-command
1.107 nicm 2448: is executed.
1.174 nicm 2449: The
2450: .Ar shell-command
2451: string may contain the special character sequences supported by the
2452: .Ic status-left
1.231 nicm 2453: option.
1.107 nicm 2454: If no
1.153 nicm 2455: .Ar shell-command
1.107 nicm 2456: is given, the current pipe (if any) is closed.
1.591 nicm 2457: .Pp
2458: .Fl I
2459: and
2460: .Fl O
2461: specify which of the
2462: .Ar shell-command
2463: output streams are connected to the pane:
2464: with
2465: .Fl I
2466: stdout is connected (so anything
2467: .Ar shell-command
2468: prints is written to the pane as if it were typed);
2469: with
2470: .Fl O
2471: stdin is connected (so any output in the pane is piped to
2472: .Ar shell-command ) .
2473: Both may be used together and if neither are specified,
2474: .Fl O
2475: is used.
1.107 nicm 2476: .Pp
2477: The
2478: .Fl o
2479: option only opens a new pipe if no previous pipe exists, allowing a pipe to
2480: be toggled with a single key, for example:
2481: .Bd -literal -offset indent
1.174 nicm 2482: bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
1.107 nicm 2483: .Ed
1.176 nicm 2484: .It Xo Ic previous-layout
2485: .Op Fl t Ar target-window
2486: .Xc
2487: .D1 (alias: Ic prevl )
2488: Move to the previous layout in the session.
1.1 nicm 2489: .It Xo Ic previous-window
1.9 nicm 2490: .Op Fl a
1.1 nicm 2491: .Op Fl t Ar target-session
2492: .Xc
2493: .D1 (alias: Ic prev )
2494: Move to the previous window in the session.
1.9 nicm 2495: With
2496: .Fl a ,
1.295 nicm 2497: move to the previous window with an alert.
1.1 nicm 2498: .It Xo Ic rename-window
2499: .Op Fl t Ar target-window
2500: .Ar new-name
2501: .Xc
2502: .D1 (alias: Ic renamew )
2503: Rename the current window, or the window at
2504: .Ar target-window
2505: if specified, to
2506: .Ar new-name .
2507: .It Xo Ic resize-pane
1.727 nicm 2508: .Op Fl DLMRTUZ
1.52 nicm 2509: .Op Fl t Ar target-pane
1.324 nicm 2510: .Op Fl x Ar width
2511: .Op Fl y Ar height
1.1 nicm 2512: .Op Ar adjustment
2513: .Xc
2514: .D1 (alias: Ic resizep )
1.324 nicm 2515: Resize a pane, up, down, left or right by
2516: .Ar adjustment
2517: with
2518: .Fl U ,
1.57 jmc 2519: .Fl D ,
2520: .Fl L
1.324 nicm 2521: or
2522: .Fl R ,
2523: or
2524: to an absolute size
2525: with
2526: .Fl x
2527: or
2528: .Fl y .
1.57 jmc 2529: The
2530: .Ar adjustment
1.690 nicm 2531: is given in lines or columns (the default is 1);
2532: .Fl x
2533: and
2534: .Fl y
2535: may be a given as a number of lines or columns or followed by
2536: .Ql %
2537: for a percentage of the window size (for example
2538: .Ql -x 10% ) .
1.337 nicm 2539: With
2540: .Fl Z ,
1.349 nicm 2541: the active pane is toggled between zoomed (occupying the whole of the window)
2542: and unzoomed (its normal position in the layout).
1.419 nicm 2543: .Pp
2544: .Fl M
2545: begins mouse resizing (only valid if bound to a mouse key binding, see
1.420 jmc 2546: .Sx MOUSE SUPPORT ) .
1.729 nicm 2547: .Pp
2548: .Fl T
1.727 nicm 2549: trims all lines below the current cursor position and moves lines out of the
2550: history to replace them.
1.629 nicm 2551: .It Xo Ic resize-window
2552: .Op Fl aADLRU
2553: .Op Fl t Ar target-window
2554: .Op Fl x Ar width
2555: .Op Fl y Ar height
2556: .Op Ar adjustment
2557: .Xc
2558: .D1 (alias: Ic resizew )
2559: Resize a window, up, down, left or right by
2560: .Ar adjustment
2561: with
2562: .Fl U ,
2563: .Fl D ,
2564: .Fl L
2565: or
2566: .Fl R ,
2567: or
2568: to an absolute size
2569: with
2570: .Fl x
2571: or
2572: .Fl y .
2573: The
2574: .Ar adjustment
2575: is given in lines or cells (the default is 1).
2576: .Fl A
2577: sets the size of the largest session containing the window;
2578: .Fl a
2579: the size of the smallest.
2580: This command will automatically set
2581: .Ic window-size
2582: to manual in the window options.
1.234 nicm 2583: .It Xo Ic respawn-pane
1.641 nicm 2584: .Op Fl k
1.568 nicm 2585: .Op Fl c Ar start-directory
1.641 nicm 2586: .Op Fl e Ar environment
1.234 nicm 2587: .Op Fl t Ar target-pane
2588: .Op Ar shell-command
2589: .Xc
2590: .D1 (alias: Ic respawnp )
2591: Reactivate a pane in which the command has exited (see the
2592: .Ic remain-on-exit
2593: window option).
2594: If
2595: .Ar shell-command
1.777 nicm 2596: is not given, the command used when the pane was created or last respawned is
2597: executed.
1.234 nicm 2598: The pane must be already inactive, unless
2599: .Fl k
2600: is given, in which case any existing command is killed.
1.568 nicm 2601: .Fl c
2602: specifies a new working directory for the pane.
1.641 nicm 2603: The
2604: .Fl e
2605: option has the same meaning as for the
2606: .Ic new-window
2607: command.
1.57 jmc 2608: .It Xo Ic respawn-window
1.641 nicm 2609: .Op Fl k
1.568 nicm 2610: .Op Fl c Ar start-directory
1.641 nicm 2611: .Op Fl e Ar environment
1.57 jmc 2612: .Op Fl t Ar target-window
1.153 nicm 2613: .Op Ar shell-command
1.57 jmc 2614: .Xc
2615: .D1 (alias: Ic respawnw )
1.153 nicm 2616: Reactivate a window in which the command has exited (see the
1.57 jmc 2617: .Ic remain-on-exit
2618: window option).
2619: If
1.153 nicm 2620: .Ar shell-command
1.777 nicm 2621: is not given, the command used when the window was created or last respawned is
2622: executed.
1.57 jmc 2623: The window must be already inactive, unless
2624: .Fl k
2625: is given, in which case any existing command is killed.
1.568 nicm 2626: .Fl c
2627: specifies a new working directory for the window.
1.641 nicm 2628: The
2629: .Fl e
2630: option has the same meaning as for the
2631: .Ic new-window
2632: command.
1.57 jmc 2633: .It Xo Ic rotate-window
1.681 nicm 2634: .Op Fl DUZ
1.57 jmc 2635: .Op Fl t Ar target-window
2636: .Xc
2637: .D1 (alias: Ic rotatew )
2638: Rotate the positions of the panes within a window, either upward (numerically
2639: lower) with
2640: .Fl U
2641: or downward (numerically higher).
1.681 nicm 2642: .Fl Z
2643: keeps the window zoomed if it was zoomed.
1.57 jmc 2644: .It Xo Ic select-layout
1.588 nicm 2645: .Op Fl Enop
2646: .Op Fl t Ar target-pane
1.57 jmc 2647: .Op Ar layout-name
2648: .Xc
1.176 nicm 2649: .D1 (alias: Ic selectl )
1.57 jmc 2650: Choose a specific layout for a window.
2651: If
2652: .Ar layout-name
1.181 nicm 2653: is not given, the last preset layout used (if any) is reapplied.
1.204 nicm 2654: .Fl n
2655: and
2656: .Fl p
2657: are equivalent to the
2658: .Ic next-layout
2659: and
2660: .Ic previous-layout
2661: commands.
1.424 nicm 2662: .Fl o
2663: applies the last set layout if possible (undoes the most recent layout change).
1.588 nicm 2664: .Fl E
2665: spreads the current pane and any panes next to it out evenly.
1.156 nicm 2666: .It Xo Ic select-pane
1.681 nicm 2667: .Op Fl DdeLlMmRUZ
1.577 nicm 2668: .Op Fl T Ar title
1.156 nicm 2669: .Op Fl t Ar target-pane
2670: .Xc
1.57 jmc 2671: .D1 (alias: Ic selectp )
2672: Make pane
2673: .Ar target-pane
1.774 nicm 2674: the active pane in its window.
1.156 nicm 2675: If one of
2676: .Fl D ,
2677: .Fl L ,
2678: .Fl R ,
2679: or
2680: .Fl U
2681: is used, respectively the pane below, to the left, to the right, or above the
2682: target pane is used.
1.681 nicm 2683: .Fl Z
2684: keeps the window zoomed if it was zoomed.
1.204 nicm 2685: .Fl l
2686: is the same as using the
2687: .Ic last-pane
2688: command.
1.398 nicm 2689: .Fl e
2690: enables or
2691: .Fl d
2692: disables input to the pane.
1.668 nicm 2693: .Fl T
2694: sets the pane title.
1.418 nicm 2695: .Pp
1.432 nicm 2696: .Fl m
2697: and
2698: .Fl M
2699: are used to set and clear the
2700: .Em marked pane .
2701: There is one marked pane at a time, setting a new marked pane clears the last.
2702: The marked pane is the default target for
2703: .Fl s
2704: to
2705: .Ic join-pane ,
1.783 nicm 2706: .Ic move-pane ,
1.432 nicm 2707: .Ic swap-pane
2708: and
2709: .Ic swap-window .
1.204 nicm 2710: .It Xo Ic select-window
1.310 nicm 2711: .Op Fl lnpT
1.204 nicm 2712: .Op Fl t Ar target-window
2713: .Xc
1.57 jmc 2714: .D1 (alias: Ic selectw )
2715: Select the window at
2716: .Ar target-window .
1.204 nicm 2717: .Fl l ,
2718: .Fl n
2719: and
2720: .Fl p
2721: are equivalent to the
2722: .Ic last-window ,
2723: .Ic next-window
2724: and
2725: .Ic previous-window
2726: commands.
1.310 nicm 2727: If
2728: .Fl T
2729: is given and the selected window is already the current window,
2730: the command behaves like
2731: .Ic last-window .
1.57 jmc 2732: .It Xo Ic split-window
1.643 nicm 2733: .Op Fl bdfhIvP
1.272 nicm 2734: .Op Fl c Ar start-directory
1.641 nicm 2735: .Op Fl e Ar environment
1.690 nicm 2736: .Op Fl l Ar size
1.136 nicm 2737: .Op Fl t Ar target-pane
1.153 nicm 2738: .Op Ar shell-command
1.279 nicm 2739: .Op Fl F Ar format
1.57 jmc 2740: .Xc
1.176 nicm 2741: .D1 (alias: Ic splitw )
1.136 nicm 2742: Create a new pane by splitting
2743: .Ar target-pane :
1.57 jmc 2744: .Fl h
2745: does a horizontal split and
2746: .Fl v
2747: a vertical split; if neither is specified,
2748: .Fl v
2749: is assumed.
2750: The
2751: .Fl l
1.690 nicm 2752: option specifies the size of the new pane in lines (for vertical split) or in
2753: columns (for horizontal split);
2754: .Ar size
2755: may be followed by
2756: .Ql %
2757: to specify a percentage of the available space.
1.408 nicm 2758: The
2759: .Fl b
2760: option causes the new pane to be created to the left of or above
2761: .Ar target-pane .
1.494 nicm 2762: The
2763: .Fl f
2764: option creates a new pane spanning the full window height (with
2765: .Fl h )
2766: or full window width (with
2767: .Fl v ) ,
2768: instead of splitting the active pane.
1.643 nicm 2769: .Pp
2770: An empty
2771: .Ar shell-command
2772: ('') will create a pane with no command running in it.
2773: Output can be sent to such a pane with the
2774: .Ic display-message
2775: command.
2776: The
2777: .Fl I
2778: flag (if
2779: .Ar shell-command
2780: is not specified or empty)
2781: will create an empty pane and forward any output from stdin to it.
2782: For example:
2783: .Bd -literal -offset indent
2784: $ make 2>&1|tmux splitw -dI &
2785: .Ed
2786: .Pp
1.136 nicm 2787: All other options have the same meaning as for the
1.57 jmc 2788: .Ic new-window
2789: command.
2790: .It Xo Ic swap-pane
1.681 nicm 2791: .Op Fl dDUZ
1.57 jmc 2792: .Op Fl s Ar src-pane
2793: .Op Fl t Ar dst-pane
2794: .Xc
2795: .D1 (alias: Ic swapp )
2796: Swap two panes.
2797: If
2798: .Fl U
2799: is used and no source pane is specified with
2800: .Fl s ,
2801: .Ar dst-pane
2802: is swapped with the previous pane (before it numerically);
2803: .Fl D
2804: swaps with the next pane (after it numerically).
1.138 nicm 2805: .Fl d
2806: instructs
2807: .Nm
1.681 nicm 2808: not to change the active pane and
2809: .Fl Z
2810: keeps the window zoomed if it was zoomed.
1.432 nicm 2811: .Pp
2812: If
2813: .Fl s
2814: is omitted and a marked pane is present (see
2815: .Ic select-pane
2816: .Fl m ) ,
2817: the marked pane is used rather than the current pane.
1.57 jmc 2818: .It Xo Ic swap-window
2819: .Op Fl d
2820: .Op Fl s Ar src-window
2821: .Op Fl t Ar dst-window
2822: .Xc
2823: .D1 (alias: Ic swapw )
2824: This is similar to
2825: .Ic link-window ,
2826: except the source and destination windows are swapped.
2827: It is an error if no window exists at
2828: .Ar src-window .
1.705 nicm 2829: If
2830: .Fl d
2831: is given, the new window does not become the current window.
1.432 nicm 2832: .Pp
1.705 nicm 2833: If
1.432 nicm 2834: .Fl s
2835: is omitted and a marked pane is present (see
2836: .Ic select-pane
2837: .Fl m ) ,
2838: the window containing the marked pane is used rather than the current window.
1.57 jmc 2839: .It Xo Ic unlink-window
1.1 nicm 2840: .Op Fl k
2841: .Op Fl t Ar target-window
2842: .Xc
1.57 jmc 2843: .D1 (alias: Ic unlinkw )
2844: Unlink
2845: .Ar target-window .
2846: Unless
2847: .Fl k
2848: is given, a window may be unlinked only if it is linked to multiple sessions -
2849: windows may not be linked to no sessions;
2850: if
1.1 nicm 2851: .Fl k
1.57 jmc 2852: is specified and the window is linked to only one session, it is unlinked and
2853: destroyed.
2854: .El
2855: .Sh KEY BINDINGS
1.93 nicm 2856: .Nm
2857: allows a command to be bound to most keys, with or without a prefix key.
2858: When specifying keys, most represent themselves (for example
2859: .Ql A
2860: to
1.95 jmc 2861: .Ql Z ) .
1.93 nicm 2862: Ctrl keys may be prefixed with
2863: .Ql C-
2864: or
1.95 jmc 2865: .Ql ^ ,
2866: and Alt (meta) with
1.93 nicm 2867: .Ql M- .
2868: In addition, the following special key names are accepted:
1.126 nicm 2869: .Em Up ,
2870: .Em Down ,
2871: .Em Left ,
2872: .Em Right ,
1.93 nicm 2873: .Em BSpace ,
2874: .Em BTab ,
2875: .Em DC
2876: (Delete),
2877: .Em End ,
2878: .Em Enter ,
2879: .Em Escape ,
2880: .Em F1
2881: to
1.402 nicm 2882: .Em F12 ,
1.93 nicm 2883: .Em Home ,
2884: .Em IC
2885: (Insert),
1.254 nicm 2886: .Em NPage/PageDown/PgDn ,
2887: .Em PPage/PageUp/PgUp ,
1.93 nicm 2888: .Em Space ,
2889: and
2890: .Em Tab .
2891: Note that to bind the
2892: .Ql \&"
2893: or
2894: .Ql '
2895: keys, quotation marks are necessary, for example:
2896: .Bd -literal -offset indent
2897: bind-key '"' split-window
1.167 nicm 2898: bind-key "'" new-window
1.93 nicm 2899: .Ed
1.693 nicm 2900: .Pp
2901: A command bound to the
2902: .Em Any
2903: key will execute for all keys which do not have a more specific binding.
1.93 nicm 2904: .Pp
1.57 jmc 2905: Commands related to key bindings are as follows:
2906: .Bl -tag -width Ds
2907: .It Xo Ic bind-key
1.501 nicm 2908: .Op Fl nr
1.706 nicm 2909: .Op Fl N Ar note
1.421 nicm 2910: .Op Fl T Ar key-table
1.750 jmc 2911: .Ar key command Op Ar arguments
1.1 nicm 2912: .Xc
1.57 jmc 2913: .D1 (alias: Ic bind )
2914: Bind key
2915: .Ar key
2916: to
2917: .Ar command .
1.421 nicm 2918: Keys are bound in a key table.
2919: By default (without -T), the key is bound in
2920: the
2921: .Em prefix
2922: key table.
2923: This table is used for keys pressed after the prefix key (for example,
2924: by default
2925: .Ql c
2926: is bound to
2927: .Ic new-window
2928: in the
2929: .Em prefix
2930: table, so
2931: .Ql C-b c
2932: creates a new window).
2933: The
2934: .Em root
2935: table is used for keys pressed without the prefix key: binding
2936: .Ql c
2937: to
2938: .Ic new-window
2939: in the
2940: .Em root
2941: table (not recommended) means a plain
2942: .Ql c
2943: will create a new window.
1.57 jmc 2944: .Fl n
1.421 nicm 2945: is an alias
2946: for
2947: .Fl T Ar root .
2948: Keys may also be bound in custom key tables and the
2949: .Ic switch-client
2950: .Fl T
2951: command used to switch to them from a key binding.
1.1 nicm 2952: The
1.57 jmc 2953: .Fl r
2954: flag indicates this key may repeat, see the
2955: .Ic repeat-time
2956: option.
1.706 nicm 2957: .Fl N
2958: attaches a note to the key (shown with
2959: .Ic list-keys
2960: .Fl N ) .
1.57 jmc 2961: .Pp
2962: To view the default bindings and possible commands, see the
2963: .Ic list-keys
2964: command.
1.421 nicm 2965: .It Xo Ic list-keys
1.712 nicm 2966: .Op Fl 1aN
1.706 nicm 2967: .Op Fl P Ar prefix-string Fl T Ar key-table
1.731 nicm 2968: .Op Ar key
1.421 nicm 2969: .Xc
1.57 jmc 2970: .D1 (alias: Ic lsk )
1.710 nicm 2971: List key bindings.
2972: There are two forms: the default lists keys as
1.706 nicm 2973: .Ic bind-key
1.710 nicm 2974: commands;
2975: .Fl N
2976: lists only keys with attached notes and shows only the key and note for each
2977: key.
2978: .Pp
2979: With the default form, all key tables are listed by default.
2980: .Fl T
2981: lists only keys in
2982: .Ar key-table .
2983: .Pp
2984: With the
1.706 nicm 2985: .Fl N
1.710 nicm 2986: form, only keys in the
1.706 nicm 2987: .Em root
2988: and
2989: .Em prefix
1.710 nicm 2990: key tables are listed by default;
2991: .Fl T
2992: also lists only keys in
2993: .Ar key-table .
1.706 nicm 2994: .Fl P
1.710 nicm 2995: specifies a prefix to print before each key and
1.706 nicm 2996: .Fl 1
1.710 nicm 2997: lists only the first matching key.
1.712 nicm 2998: .Fl a
1.787 nicm 2999: lists the command for keys that do not have a note rather than skipping them.
1.57 jmc 3000: .It Xo Ic send-keys
1.694 nicm 3001: .Op Fl FHlMRX
1.497 nicm 3002: .Op Fl N Ar repeat-count
1.72 nicm 3003: .Op Fl t Ar target-pane
1.57 jmc 3004: .Ar key Ar ...
1.1 nicm 3005: .Xc
1.57 jmc 3006: .D1 (alias: Ic send )
3007: Send a key or keys to a window.
3008: Each argument
3009: .Ar key
3010: is the name of the key (such as
3011: .Ql C-a
3012: or
1.523 nicm 3013: .Ql NPage )
3014: to send; if the string is not recognised as a key, it is sent as a series of
1.57 jmc 3015: characters.
1.676 nicm 3016: All arguments are sent sequentially from first to last.
3017: .Pp
1.273 nicm 3018: The
3019: .Fl l
1.676 nicm 3020: flag disables key name lookup and processes the keys as literal UTF-8
3021: characters.
3022: The
3023: .Fl H
3024: flag expects each key to be a hexadecimal number for an ASCII character.
3025: .Pp
1.265 nicm 3026: The
3027: .Fl R
3028: flag causes the terminal state to be reset.
1.419 nicm 3029: .Pp
3030: .Fl M
3031: passes through a mouse event (only valid if bound to a mouse key binding, see
1.420 jmc 3032: .Sx MOUSE SUPPORT ) .
1.497 nicm 3033: .Pp
3034: .Fl X
3035: is used to send a command into copy mode - see
3036: the
3037: .Sx WINDOWS AND PANES
3038: section.
3039: .Fl N
1.694 nicm 3040: specifies a repeat count and
3041: .Fl F
3042: expands formats in arguments where appropriate.
1.267 nicm 3043: .It Xo Ic send-prefix
3044: .Op Fl 2
3045: .Op Fl t Ar target-pane
3046: .Xc
3047: Send the prefix key, or with
3048: .Fl 2
3049: the secondary prefix key, to a window as if it was pressed.
1.57 jmc 3050: .It Xo Ic unbind-key
1.795 nicm 3051: .Op Fl anq
1.421 nicm 3052: .Op Fl T Ar key-table
1.57 jmc 3053: .Ar key
1.2 nicm 3054: .Xc
1.57 jmc 3055: .D1 (alias: Ic unbind )
3056: Unbind the command bound to
3057: .Ar key .
1.530 nicm 3058: .Fl n
3059: and
1.421 nicm 3060: .Fl T
3061: are the same as for
3062: .Ic bind-key .
1.189 nicm 3063: If
3064: .Fl a
3065: is present, all key bindings are removed.
1.795 nicm 3066: The
3067: .Fl q
3068: option prevents errors being returned.
1.57 jmc 3069: .El
3070: .Sh OPTIONS
3071: The appearance and behaviour of
3072: .Nm
3073: may be modified by changing the value of various options.
1.668 nicm 3074: There are four types of option:
1.133 nicm 3075: .Em server options ,
1.57 jmc 3076: .Em session options
1.668 nicm 3077: .Em window options
1.57 jmc 3078: and
1.668 nicm 3079: .Em pane options .
1.57 jmc 3080: .Pp
1.133 nicm 3081: The
3082: .Nm
1.686 nicm 3083: server has a set of global server options which do not apply to any particular
1.668 nicm 3084: window or session or pane.
1.133 nicm 3085: These are altered with the
3086: .Ic set-option
3087: .Fl s
3088: command, or displayed with the
3089: .Ic show-options
3090: .Fl s
3091: command.
3092: .Pp
3093: In addition, each individual session may have a set of session options, and
3094: there is a separate set of global session options.
1.57 jmc 3095: Sessions which do not have a particular option configured inherit the value
3096: from the global session options.
3097: Session options are set or unset with the
3098: .Ic set-option
3099: command and may be listed with the
3100: .Ic show-options
3101: command.
1.133 nicm 3102: The available server and session options are listed under the
1.57 jmc 3103: .Ic set-option
3104: command.
3105: .Pp
1.668 nicm 3106: Similarly, a set of window options is attached to each window and a set of pane
3107: options to each pane.
3108: Pane options inherit from window options.
3109: This means any pane option may be set as a window option to apply the option to
3110: all panes in the window without the option set, for example these commands will
3111: set the background colour to red for all panes except pane 0:
3112: .Bd -literal -offset indent
3113: set -w window-style bg=red
3114: set -pt:.0 window-style bg=blue
3115: .Ed
3116: .Pp
3117: There is also a set of global window options from which any unset window or
3118: pane options are inherited.
3119: Window and pane options are altered with
3120: .Ic set-option
3121: .Fl w
3122: and
3123: .Fl p
3124: commands and displayed with
3125: .Ic show-option
3126: .Fl w
3127: and
3128: .Fl p .
1.318 nicm 3129: .Pp
3130: .Nm
3131: also supports user options which are prefixed with a
3132: .Ql \&@ .
1.321 jmc 3133: User options may have any name, so long as they are prefixed with
3134: .Ql \&@ ,
1.318 nicm 3135: and be set to any string.
1.418 nicm 3136: For example:
1.318 nicm 3137: .Bd -literal -offset indent
1.774 nicm 3138: $ tmux set -wq @foo "abc123"
3139: $ tmux show -wv @foo
1.318 nicm 3140: abc123
3141: .Ed
1.57 jmc 3142: .Pp
3143: Commands which set options are as follows:
3144: .Bl -tag -width Ds
1.1 nicm 3145: .It Xo Ic set-option
1.808 nicm 3146: .Op Fl aFgopqsuUw
1.668 nicm 3147: .Op Fl t Ar target-pane
1.1 nicm 3148: .Ar option Ar value
3149: .Xc
3150: .D1 (alias: Ic set )
1.668 nicm 3151: Set a pane option with
3152: .Fl p ,
3153: a window option with
3154: .Fl w ,
1.133 nicm 3155: a server option with
3156: .Fl s ,
3157: otherwise a session option.
1.637 nicm 3158: If the option is not a user option,
3159: .Fl w
1.668 nicm 3160: or
1.637 nicm 3161: .Fl s
1.668 nicm 3162: may be unnecessary -
1.637 nicm 3163: .Nm
1.668 nicm 3164: will infer the type from the option name, assuming
3165: .Fl w
3166: for pane options.
1.133 nicm 3167: If
3168: .Fl g
1.433 nicm 3169: is given, the global session or window option is set.
1.637 nicm 3170: .Pp
1.550 nicm 3171: .Fl F
3172: expands formats in the option value.
1.1 nicm 3173: The
3174: .Fl u
3175: flag unsets an option, so a session inherits the option from the global
1.433 nicm 3176: options (or with
3177: .Fl g ,
3178: restores a global option to the default).
1.808 nicm 3179: .Fl U
3180: unsets an option (like
3181: .Fl u )
3182: but if the option is a pane option also unsets the option on any panes in the
3183: window.
1.796 nicm 3184: .Ar value
3185: depends on the option and may be a number, a string, or a flag (on, off, or
3186: omitted to toggle).
1.336 nicm 3187: .Pp
3188: The
3189: .Fl o
1.446 nicm 3190: flag prevents setting an option that is already set and the
1.281 nicm 3191: .Fl q
1.446 nicm 3192: flag suppresses errors about unknown or ambiguous options.
1.281 nicm 3193: .Pp
1.378 nicm 3194: With
3195: .Fl a ,
3196: and if the option expects a string or a style,
3197: .Ar value
3198: is appended to the existing setting.
3199: For example:
3200: .Bd -literal -offset indent
3201: set -g status-left "foo"
3202: set -ag status-left "bar"
3203: .Ed
3204: .Pp
3205: Will result in
3206: .Ql foobar .
3207: And:
3208: .Bd -literal -offset indent
3209: set -g status-style "bg=red"
3210: set -ag status-style "fg=blue"
3211: .Ed
3212: .Pp
3213: Will result in a red background
3214: .Em and
3215: blue foreground.
3216: Without
3217: .Fl a ,
3218: the result would be the default background and a blue foreground.
1.668 nicm 3219: .It Xo Ic show-options
3220: .Op Fl AgHpqsvw
3221: .Op Fl t Ar target-pane
3222: .Op Ar option
3223: .Xc
3224: .D1 (alias: Ic show )
3225: Show the pane options (or a single option if
3226: .Ar option
3227: is provided) with
3228: .Fl p ,
3229: the window options with
3230: .Fl w ,
3231: the server options with
3232: .Fl s ,
3233: otherwise the session options.
3234: If the option is not a user option,
3235: .Fl w
3236: or
3237: .Fl s
3238: may be unnecessary -
3239: .Nm
3240: will infer the type from the option name, assuming
3241: .Fl w
3242: for pane options.
3243: Global session or window options are listed if
3244: .Fl g
3245: is used.
3246: .Fl v
3247: shows only the option value, not the name.
3248: If
3249: .Fl q
3250: is set, no error will be returned if
3251: .Ar option
3252: is unset.
3253: .Fl H
3254: includes hooks (omitted by default).
3255: .Fl A
3256: includes options inherited from a parent set of options, such options are
3257: marked with an asterisk.
3258: .El
1.133 nicm 3259: .Pp
3260: Available server options are:
3261: .Bl -tag -width Ds
1.695 nicm 3262: .It Ic backspace Ar key
3263: Set the key sent by
3264: .Nm
3265: for backspace.
1.198 nicm 3266: .It Ic buffer-limit Ar number
3267: Set the number of buffers; as new buffers are added to the top of the stack,
3268: old ones are removed from the bottom if necessary to maintain this maximum
3269: length.
1.526 nicm 3270: .It Xo Ic command-alias[]
3271: .Ar name=value
3272: .Xc
3273: This is an array of custom aliases for commands.
3274: If an unknown command matches
3275: .Ar name ,
3276: it is replaced with
3277: .Ar value .
3278: For example, after:
3279: .Pp
1.565 nicm 3280: .Dl set -s command-alias[100] zoom='resize-pane -Z'
1.526 nicm 3281: .Pp
3282: Using:
3283: .Pp
3284: .Dl zoom -t:.1
3285: .Pp
3286: Is equivalent to:
3287: .Pp
3288: .Dl resize-pane -Z -t:.1
3289: .Pp
3290: Note that aliases are expanded when a command is parsed rather than when it is
3291: executed, so binding an alias with
3292: .Ic bind-key
3293: will bind the expanded form.
1.425 nicm 3294: .It Ic default-terminal Ar terminal
3295: Set the default terminal for new windows created in this session - the
3296: default value of the
3297: .Ev TERM
3298: environment variable.
3299: For
3300: .Nm
3301: to work correctly, this
3302: .Em must
3303: be set to
3304: .Ql screen ,
3305: .Ql tmux
3306: or a derivative of them.
1.742 nicm 3307: .It Ic copy-command Ar shell-command
3308: Give the command to pipe to if the
3309: .Ic copy-pipe
3310: copy mode command is used without arguments.
1.239 nicm 3311: .It Ic escape-time Ar time
3312: Set the time in milliseconds for which
3313: .Nm
3314: waits after an escape is input to determine if it is part of a function or meta
3315: key sequences.
3316: The default is 500 milliseconds.
1.759 nicm 3317: .It Ic editor Ar shell-command
3318: Set the command used when
3319: .Nm
3320: runs an editor.
1.592 nicm 3321: .It Xo Ic exit-empty
3322: .Op Ic on | off
3323: .Xc
3324: If enabled (the default), the server will exit when there are no active
3325: sessions.
1.239 nicm 3326: .It Xo Ic exit-unattached
3327: .Op Ic on | off
3328: .Xc
3329: If enabled, the server will exit when there are no attached clients.
1.772 nicm 3330: .It Xo Ic extended-keys
3331: .Op Ic on | off
3332: .Xc
3333: When enabled, extended keys are requested from the terminal and if supported
3334: are recognised by
3335: .Nm .
1.362 nicm 3336: .It Xo Ic focus-events
3337: .Op Ic on | off
3338: .Xc
3339: When enabled, focus events are requested from the terminal if supported and
3340: passed through to applications running in
3341: .Nm .
3342: Attached clients should be detached and attached again after changing this
3343: option.
1.445 nicm 3344: .It Ic history-file Ar path
3345: If not empty, a file to which
3346: .Nm
3347: will write command prompt history on exit and load it from on start.
1.384 nicm 3348: .It Ic message-limit Ar number
3349: Set the number of error or information messages to save in the message log for
3350: each client.
3351: The default is 100.
1.228 nicm 3352: .It Xo Ic set-clipboard
1.556 nicm 3353: .Op Ic on | external | off
1.228 nicm 3354: .Xc
3355: Attempt to set the terminal clipboard content using the
3356: .Xr xterm 1
1.560 nicm 3357: escape sequence, if there is an
1.228 nicm 3358: .Em \&Ms
3359: entry in the
3360: .Xr terminfo 5
1.560 nicm 3361: description (see the
3362: .Sx TERMINFO EXTENSIONS
3363: section).
3364: .Pp
1.556 nicm 3365: If set to
3366: .Ic on ,
3367: .Nm
3368: will both accept the escape sequence to create a buffer and attempt to set
3369: the terminal clipboard.
3370: If set to
3371: .Ic external ,
3372: .Nm
3373: will attempt to set the terminal clipboard but ignore attempts
3374: by applications to set
3375: .Nm
3376: buffers.
3377: If
3378: .Ic off ,
3379: .Nm
3380: will neither accept the clipboard escape sequence nor attempt to set the
3381: clipboard.
3382: .Pp
1.228 nicm 3383: Note that this feature needs to be enabled in
3384: .Xr xterm 1
3385: by setting the resource:
3386: .Bd -literal -offset indent
3387: disallowedWindowOps: 20,21,SetXprop
3388: .Ed
3389: .Pp
3390: Or changing this property from the
3391: .Xr xterm 1
3392: interactive menu when required.
1.744 nicm 3393: .It Ic terminal-features[] Ar string
3394: Set terminal features for terminal types read from
3395: .Xr terminfo 5 .
3396: .Nm
3397: has a set of named terminal features.
3398: Each will apply appropriate changes to the
3399: .Xr terminfo 5
3400: entry in use.
3401: .Pp
3402: .Nm
3403: can detect features for a few common terminals; this option can be used to
3404: easily tell tmux about features supported by terminals it cannot detect.
3405: The
3406: .Ic terminal-overrides
3407: option allows individual
3408: .Xr terminfo 5
3409: capabilities to be set instead,
3410: .Ic terminal-features
3411: is intended for classes of functionality supported in a standard way but not
3412: reported by
3413: .Xr terminfo 5 .
3414: Care must be taken only to configure this with features the terminal actually
3415: support.
3416: .Pp
3417: This is an array option where each entry is a colon-separated string made up
3418: of a terminal type pattern (matched using
3419: .Xr fnmatch 3 )
3420: followed by a list of terminal features.
3421: The available features are:
3422: .Bl -tag -width Ds
3423: .It 256
3424: Supports 256 colours with the SGR escape sequences.
3425: .It clipboard
3426: Allows setting the system clipboard.
3427: .It ccolour
3428: Allows setting the cursor colour.
3429: .It cstyle
3430: Allows setting the cursor style.
1.778 nicm 3431: .It extkeys
3432: Supports extended keys.
3433: .It focus
3434: Supports focus reporting.
1.744 nicm 3435: .It margins
3436: Supports DECSLRM margins.
3437: .It overline
3438: Supports the overline SGR attribute.
3439: .It rectfill
3440: Supports the DECFRA rectangle fill escape sequence.
3441: .It RGB
3442: Supports RGB colour with the SGR escape sequences.
1.778 nicm 3443: .It strikethrough
3444: Supports the strikethrough SGR escape sequence.
1.744 nicm 3445: .It sync
3446: Supports synchronized updates.
3447: .It title
3448: Supports
3449: .Xr xterm 1
3450: title setting.
3451: .It usstyle
3452: Allows underscore style and colour to be set.
3453: .It UTF-8
3454: Is able to handle UTF-8 output.
3455: .El
1.528 nicm 3456: .It Ic terminal-overrides[] Ar string
3457: Allow terminal descriptions read using
3458: .Xr terminfo 5
1.531 nicm 3459: to be overridden.
1.528 nicm 3460: Each entry is a colon-separated string made up of a terminal type pattern
3461: (matched using
1.381 nicm 3462: .Xr fnmatch 3 )
3463: and a set of
3464: .Em name=value
3465: entries.
3466: .Pp
3467: For example, to set the
3468: .Ql clear
3469: .Xr terminfo 5
3470: entry to
3471: .Ql \ee[H\ee[2J
1.528 nicm 3472: for all terminal types matching
3473: .Ql rxvt* :
3474: .Pp
3475: .Dl "rxvt*:clear=\ee[H\ee[2J"
1.381 nicm 3476: .Pp
3477: The terminal entry value is passed through
3478: .Xr strunvis 3
3479: before interpretation.
1.678 nicm 3480: .It Ic user-keys[] Ar key
3481: Set list of user-defined key escape sequences.
3482: Each item is associated with a key named
3483: .Ql User0 ,
3484: .Ql User1 ,
3485: and so on.
3486: .Pp
3487: For example:
3488: .Bd -literal -offset indent
3489: set -s user-keys[0] "\ee[5;30012~"
3490: bind User0 resize-pane -L 3
3491: .Ed
1.133 nicm 3492: .El
1.129 nicm 3493: .Pp
1.18 nicm 3494: Available session options are:
1.1 nicm 3495: .Bl -tag -width Ds
1.569 nicm 3496: .It Xo Ic activity-action
3497: .Op Ic any | none | current | other
3498: .Xc
3499: Set action on window activity when
3500: .Ic monitor-activity
3501: is on.
3502: .Ic any
3503: means activity in any window linked to a session causes a bell or message
3504: (depending on
3505: .Ic visual-activity )
3506: in the current window of that session,
3507: .Ic none
3508: means all activity is ignored (equivalent to
3509: .Ic monitor-activity
3510: being off),
3511: .Ic current
3512: means only activity in windows other than the current window are ignored and
3513: .Ic other
3514: means activity in the current window is ignored but not those in other windows.
1.312 nicm 3515: .It Ic assume-paste-time Ar milliseconds
3516: If keys are entered faster than one in
3517: .Ar milliseconds ,
3518: they are assumed to have been pasted rather than typed and
3519: .Nm
3520: key bindings are not processed.
3521: The default is one millisecond and zero disables.
1.69 nicm 3522: .It Ic base-index Ar index
3523: Set the base index from which an unused index should be searched when a new
3524: window is created.
3525: The default is zero.
1.1 nicm 3526: .It Xo Ic bell-action
1.429 nicm 3527: .Op Ic any | none | current | other
1.1 nicm 3528: .Xc
1.574 nicm 3529: Set action on a bell in a window when
3530: .Ic monitor-bell
3531: is on.
1.569 nicm 3532: The values are the same as those for
3533: .Ic activity-action .
1.153 nicm 3534: .It Ic default-command Ar shell-command
1.1 nicm 3535: Set the command used for new windows (if not specified when the window is
3536: created) to
1.153 nicm 3537: .Ar shell-command ,
1.79 nicm 3538: which may be any
3539: .Xr sh 1
3540: command.
1.19 nicm 3541: The default is an empty string, which instructs
3542: .Nm
1.79 nicm 3543: to create a login shell using the value of the
3544: .Ic default-shell
3545: option.
3546: .It Ic default-shell Ar path
3547: Specify the default shell.
3548: This is used as the login shell for new windows when the
3549: .Ic default-command
3550: option is set to empty, and must be the full path of the executable.
3551: When started
3552: .Nm
3553: tries to set a default value from the first suitable of the
1.19 nicm 3554: .Ev SHELL
1.79 nicm 3555: environment variable, the shell returned by
3556: .Xr getpwuid 3 ,
3557: or
3558: .Pa /bin/sh .
3559: This option should be configured when
3560: .Nm
3561: is used as a login shell.
1.629 nicm 3562: .It Ic default-size Ar XxY
1.642 nicm 3563: Set the default size of new windows when the
1.643 nicm 3564: .Ic window-size
1.642 nicm 3565: option is set to manual or when a session is created with
3566: .Ic new-session
3567: .Fl d .
3568: The value is the width and height separated by an
3569: .Ql x
3570: character.
3571: The default is 80x24.
1.206 nicm 3572: .It Xo Ic destroy-unattached
3573: .Op Ic on | off
3574: .Xc
1.185 nicm 3575: If enabled and the session is no longer attached to any clients, it is
3576: destroyed.
1.206 nicm 3577: .It Xo Ic detach-on-destroy
3578: .Op Ic on | off
3579: .Xc
1.184 nicm 3580: If on (the default), the client is detached when the session it is attached to
3581: is destroyed.
3582: If off, the client is switched to the most recently active of the remaining
3583: sessions.
1.145 nicm 3584: .It Ic display-panes-active-colour Ar colour
3585: Set the colour used by the
3586: .Ic display-panes
3587: command to show the indicator for the active pane.
1.78 nicm 3588: .It Ic display-panes-colour Ar colour
1.145 nicm 3589: Set the colour used by the
1.78 nicm 3590: .Ic display-panes
1.145 nicm 3591: command to show the indicators for inactive panes.
1.78 nicm 3592: .It Ic display-panes-time Ar time
3593: Set the time in milliseconds for which the indicators shown by the
3594: .Ic display-panes
3595: command appear.
1.21 nicm 3596: .It Ic display-time Ar time
1.78 nicm 3597: Set the amount of time for which status line messages and other on-screen
3598: indicators are displayed.
1.462 tim 3599: If set to 0, messages and indicators are displayed until a key is pressed.
1.21 nicm 3600: .Ar time
3601: is in milliseconds.
1.1 nicm 3602: .It Ic history-limit Ar lines
3603: Set the maximum number of lines held in window history.
3604: This setting applies only to new windows - existing window histories are not
3605: resized and retain the limit at the point they were created.
1.474 nicm 3606: .It Ic key-table Ar key-table
3607: Set the default key table to
3608: .Ar key-table
3609: instead of
3610: .Em root .
1.1 nicm 3611: .It Ic lock-after-time Ar number
1.100 nicm 3612: Lock the session (like the
3613: .Ic lock-session
1.90 nicm 3614: command) after
1.1 nicm 3615: .Ar number
1.448 nicm 3616: seconds of inactivity.
1.100 nicm 3617: The default is not to lock (set to 0).
1.153 nicm 3618: .It Ic lock-command Ar shell-command
1.90 nicm 3619: Command to run when locking each client.
3620: The default is to run
3621: .Xr lock 1
3622: with
3623: .Fl np .
1.378 nicm 3624: .It Ic message-command-style Ar style
1.623 nicm 3625: Set status line message command style.
1.737 nicm 3626: This is used for the command prompt with
3627: .Xr vi 1
3628: keys when in command mode.
1.623 nicm 3629: For how to specify
3630: .Ar style ,
3631: see the
3632: .Sx STYLES
3633: section.
1.378 nicm 3634: .It Ic message-style Ar style
3635: Set status line message style.
1.737 nicm 3636: This is used for messages and for the command prompt.
1.378 nicm 3637: For how to specify
3638: .Ar style ,
3639: see the
1.623 nicm 3640: .Sx STYLES
3641: section.
1.419 nicm 3642: .It Xo Ic mouse
1.226 nicm 3643: .Op Ic on | off
3644: .Xc
3645: If on,
3646: .Nm
1.419 nicm 3647: captures the mouse and allows mouse events to be bound as key bindings.
3648: See the
3649: .Sx MOUSE SUPPORT
3650: section for details.
1.267 nicm 3651: .It Ic prefix Ar key
3652: Set the key accepted as a prefix key.
1.473 nicm 3653: In addition to the standard keys described under
3654: .Sx KEY BINDINGS ,
3655: .Ic prefix
3656: can be set to the special key
3657: .Ql None
3658: to set no prefix.
1.267 nicm 3659: .It Ic prefix2 Ar key
3660: Set a secondary key accepted as a prefix key.
1.473 nicm 3661: Like
3662: .Ic prefix ,
3663: .Ic prefix2
3664: can be set to
3665: .Ql None .
1.291 nicm 3666: .It Xo Ic renumber-windows
3667: .Op Ic on | off
3668: .Xc
3669: If on, when a window is closed in a session, automatically renumber the other
3670: windows in numerical order.
3671: This respects the
3672: .Ic base-index
3673: option if it has been set.
3674: If off, do not renumber the windows.
1.21 nicm 3675: .It Ic repeat-time Ar time
1.1 nicm 3676: Allow multiple commands to be entered without pressing the prefix-key again
3677: in the specified
1.21 nicm 3678: .Ar time
1.1 nicm 3679: milliseconds (the default is 500).
3680: Whether a key repeats may be set when it is bound using the
3681: .Fl r
3682: flag to
3683: .Ic bind-key .
1.52 nicm 3684: Repeat is enabled for the default keys bound to the
3685: .Ic resize-pane
3686: command.
1.1 nicm 3687: .It Xo Ic set-titles
1.56 jmc 3688: .Op Ic on | off
1.1 nicm 3689: .Xc
1.261 nicm 3690: Attempt to set the client terminal title using the
3691: .Em tsl
3692: and
3693: .Em fsl
3694: .Xr terminfo 5
3695: entries if they exist.
3696: .Nm
1.444 nicm 3697: automatically sets these to the \ee]0;...\e007 sequence if
3698: the terminal appears to be
3699: .Xr xterm 1 .
1.11 nicm 3700: This option is off by default.
1.86 nicm 3701: .It Ic set-titles-string Ar string
1.678 nicm 3702: String used to set the client terminal title if
1.86 nicm 3703: .Ic set-titles
3704: is on.
1.414 nicm 3705: Formats are expanded, see the
3706: .Sx FORMATS
3707: section.
1.569 nicm 3708: .It Xo Ic silence-action
3709: .Op Ic any | none | current | other
3710: .Xc
3711: Set action on window silence when
3712: .Ic monitor-silence
3713: is on.
3714: The values are the same as those for
3715: .Ic activity-action .
1.1 nicm 3716: .It Xo Ic status
1.625 nicm 3717: .Op Ic off | on | 2 | 3 | 4 | 5
1.1 nicm 3718: .Xc
1.625 nicm 3719: Show or hide the status line or specify its size.
3720: Using
3721: .Ic on
3722: gives a status line one row in height;
3723: .Ic 2 ,
3724: .Ic 3 ,
3725: .Ic 4
3726: or
3727: .Ic 5
3728: more rows.
3729: .It Ic status-format[] Ar format
3730: Specify the format to be used for each line of the status line.
3731: The default builds the top status line from the various individual status
3732: options below.
1.1 nicm 3733: .It Ic status-interval Ar interval
1.538 nicm 3734: Update the status line every
1.1 nicm 3735: .Ar interval
3736: seconds.
3737: By default, updates will occur every 15 seconds.
3738: A setting of zero disables redrawing at interval.
1.41 nicm 3739: .It Xo Ic status-justify
1.56 jmc 3740: .Op Ic left | centre | right
1.41 nicm 3741: .Xc
3742: Set the position of the window list component of the status line: left, centre
3743: or right justified.
1.1 nicm 3744: .It Xo Ic status-keys
1.56 jmc 3745: .Op Ic vi | emacs
1.1 nicm 3746: .Xc
1.6 jmc 3747: Use vi or emacs-style
1.1 nicm 3748: key bindings in the status line, for example at the command prompt.
1.191 nicm 3749: The default is emacs, unless the
3750: .Ev VISUAL
3751: or
3752: .Ev EDITOR
3753: environment variables are set and contain the string
3754: .Ql vi .
1.1 nicm 3755: .It Ic status-left Ar string
3756: Display
3757: .Ar string
1.538 nicm 3758: (by default the session name) to the left of the status line.
1.1 nicm 3759: .Ar string
3760: will be passed through
1.623 nicm 3761: .Xr strftime 3 .
3762: Also see the
3763: .Sx FORMATS
3764: and
3765: .Sx STYLES
3766: sections.
1.83 nicm 3767: .Pp
1.263 nicm 3768: For details on how the names and titles can be set see the
1.261 nicm 3769: .Sx "NAMES AND TITLES"
3770: section.
1.109 nicm 3771: .Pp
1.83 nicm 3772: Examples are:
3773: .Bd -literal -offset indent
3774: #(sysctl vm.loadavg)
3775: #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
3776: .Ed
1.10 nicm 3777: .Pp
1.405 nicm 3778: The default is
3779: .Ql "[#S] " .
1.1 nicm 3780: .It Ic status-left-length Ar length
3781: Set the maximum
3782: .Ar length
1.538 nicm 3783: of the left component of the status line.
1.1 nicm 3784: The default is 10.
1.378 nicm 3785: .It Ic status-left-style Ar style
3786: Set the style of the left part of the status line.
3787: For how to specify
3788: .Ar style ,
3789: see the
1.623 nicm 3790: .Sx STYLES
3791: section.
1.269 nicm 3792: .It Xo Ic status-position
3793: .Op Ic top | bottom
3794: .Xc
3795: Set the position of the status line.
1.1 nicm 3796: .It Ic status-right Ar string
3797: Display
3798: .Ar string
1.538 nicm 3799: to the right of the status line.
1.577 nicm 3800: By default, the current pane title in double quotes, the date and the time
1.151 nicm 3801: are shown.
1.1 nicm 3802: As with
3803: .Ic status-left ,
3804: .Ar string
3805: will be passed to
1.459 jmc 3806: .Xr strftime 3
3807: and character pairs are replaced.
1.1 nicm 3808: .It Ic status-right-length Ar length
3809: Set the maximum
3810: .Ar length
1.538 nicm 3811: of the right component of the status line.
1.1 nicm 3812: The default is 40.
1.378 nicm 3813: .It Ic status-right-style Ar style
3814: Set the style of the right part of the status line.
3815: For how to specify
3816: .Ar style ,
3817: see the
1.623 nicm 3818: .Sx STYLES
3819: section.
1.378 nicm 3820: .It Ic status-style Ar style
3821: Set status line style.
3822: For how to specify
3823: .Ar style ,
3824: see the
1.623 nicm 3825: .Sx STYLES
3826: section.
1.529 nicm 3827: .It Ic update-environment[] Ar variable
3828: Set list of environment variables to be copied into the session environment
3829: when a new session is created or an existing session is attached.
1.63 nicm 3830: Any variables that do not exist in the source environment are set to be
3831: removed from the session environment (as if
3832: .Fl r
3833: was given to the
3834: .Ic set-environment
3835: command).
1.37 nicm 3836: .It Xo Ic visual-activity
1.569 nicm 3837: .Op Ic on | off | both
1.37 nicm 3838: .Xc
1.569 nicm 3839: If on, display a message instead of sending a bell when activity occurs in a
3840: window for which the
1.37 nicm 3841: .Ic monitor-activity
3842: window option is enabled.
1.569 nicm 3843: If set to both, a bell and a message are produced.
1.37 nicm 3844: .It Xo Ic visual-bell
1.569 nicm 3845: .Op Ic on | off | both
1.37 nicm 3846: .Xc
1.574 nicm 3847: If on, a message is shown on a bell in a window for which the
3848: .Ic monitor-bell
3849: window option is enabled instead of it being passed through to the
1.569 nicm 3850: terminal (which normally makes a sound).
3851: If set to both, a bell and a message are produced.
1.37 nicm 3852: Also see the
3853: .Ic bell-action
3854: option.
1.192 nicm 3855: .It Xo Ic visual-silence
1.569 nicm 3856: .Op Ic on | off | both
1.192 nicm 3857: .Xc
3858: If
3859: .Ic monitor-silence
1.569 nicm 3860: is enabled, prints a message after the interval has expired on a given window
3861: instead of sending a bell.
3862: If set to both, a bell and a message are produced.
1.255 nicm 3863: .It Ic word-separators Ar string
3864: Sets the session's conception of what characters are considered word
3865: separators, for the purposes of the next and previous word commands in
3866: copy mode.
3867: The default is
3868: .Ql \ -_@ .
1.1 nicm 3869: .El
3870: .Pp
1.668 nicm 3871: Available window options are:
1.56 jmc 3872: .Pp
3873: .Bl -tag -width Ds -compact
1.1 nicm 3874: .It Xo Ic aggressive-resize
1.56 jmc 3875: .Op Ic on | off
1.1 nicm 3876: .Xc
3877: Aggressively resize the chosen window.
3878: This means that
3879: .Nm
1.642 nicm 3880: will resize the window to the size of the smallest or largest session
3881: (see the
3882: .Ic window-size
3883: option) for which it is the current window, rather than the session to
3884: which it is attached.
3885: The window may resize when the current window is changed on another
3886: session; this option is good for full-screen programs which support
1.6 jmc 3887: .Dv SIGWINCH
3888: and poor for interactive programs such as shells.
1.262 nicm 3889: .Pp
1.1 nicm 3890: .It Xo Ic automatic-rename
1.56 jmc 3891: .Op Ic on | off
1.1 nicm 3892: .Xc
3893: Control automatic window renaming.
3894: When this setting is enabled,
3895: .Nm
1.368 nicm 3896: will rename the window automatically using the format specified by
3897: .Ic automatic-rename-format .
1.1 nicm 3898: This flag is automatically disabled for an individual window when a name
3899: is specified at creation with
1.186 nicm 3900: .Ic new-window
3901: or
1.1 nicm 3902: .Ic new-session ,
3903: or later with
1.261 nicm 3904: .Ic rename-window ,
3905: or with a terminal escape sequence.
1.1 nicm 3906: It may be switched off globally with:
3907: .Bd -literal -offset indent
1.668 nicm 3908: set-option -wg automatic-rename off
1.1 nicm 3909: .Ed
1.368 nicm 3910: .Pp
3911: .It Ic automatic-rename-format Ar format
3912: The format (see
3913: .Sx FORMATS )
3914: used when the
3915: .Ic automatic-rename
3916: option is enabled.
1.56 jmc 3917: .Pp
1.1 nicm 3918: .It Ic clock-mode-colour Ar colour
3919: Set clock colour.
1.56 jmc 3920: .Pp
1.1 nicm 3921: .It Xo Ic clock-mode-style
1.56 jmc 3922: .Op Ic 12 | 24
1.1 nicm 3923: .Xc
3924: Set clock hour format.
1.56 jmc 3925: .Pp
1.196 nicm 3926: .It Ic main-pane-height Ar height
1.2 nicm 3927: .It Ic main-pane-width Ar width
3928: Set the width or height of the main (left or top) pane in the
3929: .Ic main-horizontal
3930: or
3931: .Ic main-vertical
3932: layouts.
1.747 nicm 3933: If suffixed by
3934: .Ql % ,
3935: this is a percentage of the window size.
1.757 nicm 3936: .Pp
3937: .It Ic copy-mode-match-style Ar style
3938: Set the style of search matches in copy mode.
1.768 nicm 3939: For how to specify
3940: .Ar style ,
3941: see the
3942: .Sx STYLES
3943: section.
3944: .Pp
3945: .It Ic copy-mode-mark-style Ar style
3946: Set the style of the line containing the mark in copy mode.
1.757 nicm 3947: For how to specify
3948: .Ar style ,
3949: see the
3950: .Sx STYLES
3951: section.
3952: .Pp
3953: .It Ic copy-mode-current-match-style Ar style
3954: Set the style of the current search match in copy mode.
3955: For how to specify
3956: .Ar style ,
3957: see the
3958: .Sx STYLES
3959: section.
1.56 jmc 3960: .Pp
1.1 nicm 3961: .It Xo Ic mode-keys
1.56 jmc 3962: .Op Ic vi | emacs
1.1 nicm 3963: .Xc
1.500 nicm 3964: Use vi or emacs-style key bindings in copy mode.
3965: The default is emacs, unless
1.191 nicm 3966: .Ev VISUAL
3967: or
3968: .Ev EDITOR
3969: contains
3970: .Ql vi .
1.56 jmc 3971: .Pp
1.378 nicm 3972: .It Ic mode-style Ar style
3973: Set window modes style.
3974: For how to specify
3975: .Ar style ,
3976: see the
1.623 nicm 3977: .Sx STYLES
3978: section.
1.378 nicm 3979: .Pp
1.1 nicm 3980: .It Xo Ic monitor-activity
1.56 jmc 3981: .Op Ic on | off
1.1 nicm 3982: .Xc
3983: Monitor for activity in the window.
3984: Windows with activity are highlighted in the status line.
1.56 jmc 3985: .Pp
1.574 nicm 3986: .It Xo Ic monitor-bell
3987: .Op Ic on | off
3988: .Xc
3989: Monitor for a bell in the window.
3990: Windows with a bell are highlighted in the status line.
3991: .Pp
1.192 nicm 3992: .It Xo Ic monitor-silence
3993: .Op Ic interval
3994: .Xc
3995: Monitor for silence (no activity) in the window within
3996: .Ic interval
3997: seconds.
3998: Windows that have been silent for the interval are highlighted in the
3999: status line.
4000: An interval of zero disables the monitoring.
1.195 nicm 4001: .Pp
4002: .It Ic other-pane-height Ar height
4003: Set the height of the other panes (not the main pane) in the
4004: .Ic main-horizontal
4005: layout.
4006: If this option is set to 0 (the default), it will have no effect.
4007: If both the
4008: .Ic main-pane-height
4009: and
4010: .Ic other-pane-height
4011: options are set, the main pane will grow taller to make the other panes the
4012: specified height, but will never shrink to do so.
1.747 nicm 4013: If suffixed by
4014: .Ql % ,
4015: this is a percentage of the window size.
1.195 nicm 4016: .Pp
4017: .It Ic other-pane-width Ar width
4018: Like
4019: .Ic other-pane-height ,
4020: but set the width of other panes in the
4021: .Ic main-vertical
4022: layout.
1.243 nicm 4023: .Pp
1.413 nicm 4024: .It Ic pane-active-border-style Ar style
4025: Set the pane border style for the currently active pane.
4026: For how to specify
4027: .Ar style ,
4028: see the
1.623 nicm 4029: .Sx STYLES
4030: section.
1.413 nicm 4031: Attributes are ignored.
4032: .Pp
1.243 nicm 4033: .It Ic pane-base-index Ar index
4034: Like
4035: .Ic base-index ,
4036: but set the starting index for pane numbers.
1.484 nicm 4037: .Pp
4038: .It Ic pane-border-format Ar format
4039: Set the text shown in pane border status lines.
1.770 nicm 4040: .Pp
4041: .It Ic pane-border-lines Ar type
4042: Set the type of characters used for drawing pane borders.
4043: .Ar type
4044: may be one of:
4045: .Bl -tag -width Ds
4046: .It single
4047: single lines using ACS or UTF-8 characters
4048: .It double
4049: double lines using UTF-8 characters
4050: .It heavy
4051: heavy lines using UTF-8 characters
4052: .It simple
4053: simple ASCII characters
4054: .It number
4055: the pane number
4056: .El
4057: .Pp
4058: .Ql double
4059: and
4060: .Ql heavy
4061: will fall back to standard ACS line drawing when UTF-8 is not supported.
1.484 nicm 4062: .Pp
4063: .It Xo Ic pane-border-status
4064: .Op Ic off | top | bottom
4065: .Xc
4066: Turn pane border status lines off or set their position.
1.413 nicm 4067: .Pp
4068: .It Ic pane-border-style Ar style
4069: Set the pane border style for panes aside from the active pane.
4070: For how to specify
4071: .Ar style ,
4072: see the
1.623 nicm 4073: .Sx STYLES
4074: section.
1.413 nicm 4075: Attributes are ignored.
1.192 nicm 4076: .Pp
1.378 nicm 4077: .It Ic window-status-activity-style Ar style
4078: Set status line style for windows with an activity alert.
4079: For how to specify
4080: .Ar style ,
4081: see the
1.623 nicm 4082: .Sx STYLES
4083: section.
1.169 nicm 4084: .Pp
1.378 nicm 4085: .It Ic window-status-bell-style Ar style
4086: Set status line style for windows with a bell alert.
4087: For how to specify
4088: .Ar style ,
4089: see the
1.623 nicm 4090: .Sx STYLES
4091: section.
1.169 nicm 4092: .Pp
1.125 nicm 4093: .It Ic window-status-current-format Ar string
4094: Like
4095: .Ar window-status-format ,
4096: but is the format used when the window is the current window.
1.307 nicm 4097: .Pp
1.378 nicm 4098: .It Ic window-status-current-style Ar style
4099: Set status line style for the currently active window.
4100: For how to specify
4101: .Ar style ,
4102: see the
1.623 nicm 4103: .Sx STYLES
4104: section.
1.239 nicm 4105: .Pp
4106: .It Ic window-status-format Ar string
4107: Set the format in which the window is displayed in the status line window list.
4108: See the
1.623 nicm 4109: .Sx FORMATS
4110: and
4111: .Sx STYLES
4112: sections.
1.290 nicm 4113: .Pp
1.378 nicm 4114: .It Ic window-status-last-style Ar style
4115: Set status line style for the last active window.
4116: For how to specify
4117: .Ar style ,
4118: see the
1.623 nicm 4119: .Sx STYLES
4120: section.
1.378 nicm 4121: .Pp
1.290 nicm 4122: .It Ic window-status-separator Ar string
4123: Sets the separator drawn between windows in the status line.
4124: The default is a single space character.
1.125 nicm 4125: .Pp
1.378 nicm 4126: .It Ic window-status-style Ar style
4127: Set status line style for a single window.
1.418 nicm 4128: For how to specify
4129: .Ar style ,
4130: see the
1.623 nicm 4131: .Sx STYLES
4132: section.
1.418 nicm 4133: .Pp
1.642 nicm 4134: .It Xo Ic window-size
1.689 nicm 4135: .Ar largest | Ar smallest | Ar manual | Ar latest
1.642 nicm 4136: .Xc
4137: Configure how
4138: .Nm
4139: determines the window size.
4140: If set to
4141: .Ar largest ,
4142: the size of the largest attached session is used; if
4143: .Ar smallest ,
4144: the size of the smallest.
4145: If
4146: .Ar manual ,
4147: the size of a new window is set from the
4148: .Ic default-size
4149: option and windows are resized automatically.
1.689 nicm 4150: With
4151: .Ar latest ,
4152: .Nm
4153: uses the size of the client that had the most recent activity.
1.642 nicm 4154: See also the
4155: .Ic resize-window
4156: command and the
4157: .Ic aggressive-resize
4158: option.
4159: .Pp
1.512 nicm 4160: .It Xo Ic wrap-search
4161: .Op Ic on | off
4162: .Xc
4163: If this option is set, searches will wrap around the end of the pane contents.
4164: The default is on.
1.57 jmc 4165: .El
1.668 nicm 4166: .Pp
4167: Available pane options are:
4168: .Pp
4169: .Bl -tag -width Ds -compact
1.669 nicm 4170: .It Xo Ic allow-rename
4171: .Op Ic on | off
4172: .Xc
4173: Allow programs in the pane to change the window name using a terminal escape
4174: sequence (\eek...\ee\e\e).
4175: .Pp
4176: .It Xo Ic alternate-screen
4177: .Op Ic on | off
4178: .Xc
4179: This option configures whether programs running inside the pane may use the
4180: terminal alternate screen feature, which allows the
4181: .Em smcup
4182: and
4183: .Em rmcup
4184: .Xr terminfo 5
4185: capabilities.
4186: The alternate screen feature preserves the contents of the window when an
4187: interactive application starts and restores it on exit, so that any output
4188: visible before the application starts reappears unchanged after it exits.
4189: .Pp
1.668 nicm 4190: .It Xo Ic remain-on-exit
1.810 nicm 4191: .Op Ic on | off | failed
1.57 jmc 4192: .Xc
1.668 nicm 4193: A pane with this flag set is not destroyed when the program running in it
4194: exits.
1.810 nicm 4195: If set to
4196: .Ic failed ,
4197: then only when the program exit status is not zero.
1.668 nicm 4198: The pane may be reactivated with the
4199: .Ic respawn-pane
4200: command.
1.808 nicm 4201: .Pp
4202: .It Xo Ic synchronize-panes
4203: .Op Ic on | off
4204: .Xc
4205: Duplicate input to all other panes in the same window where this option is also
4206: on (only for panes that are not in any mode).
1.668 nicm 4207: .Pp
4208: .It Ic window-active-style Ar style
4209: Set the pane style when it is the active pane.
4210: For how to specify
4211: .Ar style ,
4212: see the
4213: .Sx STYLES
4214: section.
4215: .Pp
4216: .It Ic window-style Ar style
4217: Set the pane style.
4218: For how to specify
4219: .Ar style ,
4220: see the
4221: .Sx STYLES
4222: section.
1.63 nicm 4223: .El
1.469 nicm 4224: .Sh HOOKS
4225: .Nm
4226: allows commands to run on various triggers, called
4227: .Em hooks .
1.505 nicm 4228: Most
1.483 nicm 4229: .Nm
1.505 nicm 4230: commands have an
1.483 nicm 4231: .Em after
4232: hook and there are a number of hooks not associated with commands.
4233: .Pp
1.640 nicm 4234: Hooks are stored as array options, members of the array are executed in
4235: order when the hook is triggered.
1.740 nicm 4236: Like options different hooks may be global or belong to a session, window or pane.
1.640 nicm 4237: Hooks may be configured with the
4238: .Ic set-hook
4239: or
4240: .Ic set-option
4241: commands and displayed with
4242: .Ic show-hooks
4243: or
4244: .Ic show-options
4245: .Fl H .
4246: The following two commands are equivalent:
4247: .Bd -literal -offset indent.
4248: set-hook -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4249: set-option -g pane-mode-changed[42] 'set -g status-left-style bg=red'
4250: .Ed
4251: .Pp
4252: Setting a hook without specifying an array index clears the hook and sets the
4253: first member of the array.
4254: .Pp
1.505 nicm 4255: A command's after
4256: hook is run after it completes, except when the command is run as part of a hook
1.483 nicm 4257: itself.
1.505 nicm 4258: They are named with an
1.483 nicm 4259: .Ql after-
4260: prefix.
4261: For example, the following command adds a hook to select the even-vertical
4262: layout after every
4263: .Ic split-window :
4264: .Bd -literal -offset indent
1.640 nicm 4265: set-hook -g after-split-window "selectl even-vertical"
1.483 nicm 4266: .Ed
4267: .Pp
1.584 nicm 4268: All the notifications listed in the
4269: .Sx CONTROL MODE
4270: section are hooks (without any arguments), except
4271: .Ic %exit .
4272: The following additional hooks are available:
1.560 nicm 4273: .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXX"
1.476 nicm 4274: .It alert-activity
4275: Run when a window has activity.
4276: See
4277: .Ic monitor-activity .
4278: .It alert-bell
4279: Run when a window has received a bell.
1.574 nicm 4280: See
4281: .Ic monitor-bell .
1.476 nicm 4282: .It alert-silence
4283: Run when a window has been silent.
4284: See
4285: .Ic monitor-silence .
1.469 nicm 4286: .It client-attached
4287: Run when a client is attached.
4288: .It client-detached
4289: Run when a client is detached
4290: .It client-resized
4291: Run when a client is resized.
1.511 nicm 4292: .It client-session-changed
4293: Run when a client's attached session is changed.
1.475 nicm 4294: .It pane-died
4295: Run when the program running in a pane exits, but
4296: .Ic remain-on-exit
4297: is on so the pane has not closed.
4298: .It pane-exited
4299: Run when the program running in a pane exits.
1.603 nicm 4300: .It pane-focus-in
4301: Run when the focus enters a pane, if the
4302: .Ic focus-events
4303: option is on.
4304: .It pane-focus-out
4305: Run when the focus exits a pane, if the
4306: .Ic focus-events
4307: option is on.
1.560 nicm 4308: .It pane-set-clipboard
4309: Run when the terminal clipboard is set using the
4310: .Xr xterm 1
4311: escape sequence.
1.510 nicm 4312: .It session-created
4313: Run when a new session created.
4314: .It session-closed
4315: Run when a session closed.
1.507 nicm 4316: .It session-renamed
4317: Run when a session is renamed.
1.511 nicm 4318: .It window-linked
4319: Run when a window is linked into a session.
1.507 nicm 4320: .It window-renamed
4321: Run when a window is renamed.
1.511 nicm 4322: .It window-unlinked
4323: Run when a window is unlinked from a session.
1.469 nicm 4324: .El
4325: .Pp
4326: Hooks are managed with these commands:
4327: .Bl -tag -width Ds
4328: .It Xo Ic set-hook
1.740 nicm 4329: .Op Fl agpRuw
4330: .Op Fl t Ar target-pane
1.469 nicm 4331: .Ar hook-name
4332: .Ar command
4333: .Xc
1.604 nicm 4334: Without
1.605 jmc 4335: .Fl R ,
1.604 nicm 4336: sets (or with
1.496 nicm 4337: .Fl u
4338: unsets) hook
1.469 nicm 4339: .Ar hook-name
4340: to
4341: .Ar command .
1.740 nicm 4342: The flags are the same as for
4343: .Ic set-option .
1.604 nicm 4344: .Pp
4345: With
4346: .Fl R ,
4347: run
4348: .Ar hook-name
4349: immediately.
1.469 nicm 4350: .It Xo Ic show-hooks
1.740 nicm 4351: .Op Fl gpw
4352: .Op Fl t Ar target-pane
1.469 nicm 4353: .Xc
1.740 nicm 4354: Shows hooks.
4355: The flags are the same as for
4356: .Ic show-options .
1.470 jmc 4357: .El
1.419 nicm 4358: .Sh MOUSE SUPPORT
4359: If the
4360: .Ic mouse
4361: option is on (the default is off),
4362: .Nm
4363: allows mouse events to be bound as keys.
4364: The name of each key is made up of a mouse event (such as
4365: .Ql MouseUp1 )
1.632 nicm 4366: and a location suffix, one of the following:
4367: .Bl -column "XXXXXXXXXXXXX" -offset indent
4368: .It Li "Pane" Ta "the contents of a pane"
4369: .It Li "Border" Ta "a pane border"
4370: .It Li "Status" Ta "the status line window list"
4371: .It Li "StatusLeft" Ta "the left part of the status line"
4372: .It Li "StatusRight" Ta "the right part of the status line"
4373: .It Li "StatusDefault" Ta "any other part of the status line"
4374: .El
4375: .Pp
1.419 nicm 4376: The following mouse events are available:
4377: .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
1.498 nicm 4378: .It Li "WheelUp" Ta "WheelDown" Ta ""
1.481 nicm 4379: .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
4380: .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
4381: .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
1.724 nicm 4382: .It Li "SecondClick1" Ta "SecondClick2" Ta "SecondClick3"
1.590 nicm 4383: .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3"
4384: .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3"
1.419 nicm 4385: .El
1.724 nicm 4386: .Pp
4387: The
4388: .Ql SecondClick
4389: events are fired for the second click of a double click, even if there may be a
4390: third click which will fire
4391: .Ql TripleClick
4392: instead of
4393: .Ql DoubleClick .
1.419 nicm 4394: .Pp
4395: Each should be suffixed with a location, for example
4396: .Ql MouseDown1Status .
4397: .Pp
1.423 nicm 4398: The special token
4399: .Ql {mouse}
4400: or
1.419 nicm 4401: .Ql =
4402: may be used as
4403: .Ar target-window
4404: or
4405: .Ar target-pane
4406: in commands bound to mouse key bindings.
4407: It resolves to the window or pane over which the mouse event took place
4408: (for example, the window in the status line over which button 1 was released for a
4409: .Ql MouseUp1Status
4410: binding, or the pane over which the wheel was scrolled for a
4411: .Ql WheelDownPane
4412: binding).
4413: .Pp
4414: The
4415: .Ic send-keys
4416: .Fl M
4417: flag may be used to forward a mouse event to a pane.
4418: .Pp
4419: The default key bindings allow the mouse to be used to select and resize panes,
4420: to copy text and to change window using the status line.
4421: These take effect if the
4422: .Ic mouse
4423: option is turned on.
1.245 nicm 4424: .Sh FORMATS
1.294 nicm 4425: Certain commands accept the
1.245 nicm 4426: .Fl F
4427: flag with a
4428: .Ar format
4429: argument.
4430: This is a string which controls the output format of the command.
1.678 nicm 4431: Format variables are enclosed in
1.245 nicm 4432: .Ql #{
4433: and
4434: .Ql } ,
4435: for example
1.359 nicm 4436: .Ql #{session_name} .
1.409 nicm 4437: The possible variables are listed in the table below, or the name of a
4438: .Nm
4439: option may be used for an option's value.
4440: Some variables have a shorter alias such as
1.598 nicm 4441: .Ql #S ;
1.376 nicm 4442: .Ql ##
4443: is replaced by a single
1.598 nicm 4444: .Ql # ,
4445: .Ql #,
4446: by a
4447: .Ql \&,
4448: and
4449: .Ql #}
4450: by a
4451: .Ql } .
1.409 nicm 4452: .Pp
4453: Conditionals are available by prefixing with
1.246 jmc 4454: .Ql \&?
1.245 nicm 4455: and separating two alternatives with a comma;
4456: if the specified variable exists and is not zero, the first alternative
1.246 jmc 4457: is chosen, otherwise the second is used.
4458: For example
1.245 nicm 4459: .Ql #{?session_attached,attached,not attached}
4460: will include the string
4461: .Ql attached
4462: if the session is attached and the string
4463: .Ql not attached
1.409 nicm 4464: if it is unattached, or
4465: .Ql #{?automatic-rename,yes,no}
4466: will include
4467: .Ql yes
4468: if
4469: .Ic automatic-rename
4470: is enabled, or
4471: .Ql no
4472: if not.
1.599 nicm 4473: Conditionals can be nested arbitrarily.
4474: Inside a conditional,
4475: .Ql \&,
4476: and
4477: .Ql }
4478: must be escaped as
4479: .Ql #,
4480: and
4481: .Ql #} ,
4482: unless they are part of a
4483: .Ql #{...}
1.600 nicm 4484: replacement.
4485: For example:
1.599 nicm 4486: .Bd -literal -offset indent
4487: #{?pane_in_mode,#[fg=white#,bg=red],#[fg=red#,bg=white]}#W .
4488: .Ed
1.520 nicm 4489: .Pp
1.678 nicm 4490: String comparisons may be expressed by prefixing two comma-separated
1.520 nicm 4491: alternatives by
1.652 nicm 4492: .Ql == ,
4493: .Ql != ,
4494: .Ql < ,
4495: .Ql > ,
4496: .Ql <=
1.520 nicm 4497: or
1.652 nicm 4498: .Ql >=
1.520 nicm 4499: and a colon.
4500: For example
1.544 nicm 4501: .Ql #{==:#{host},myhost}
1.520 nicm 4502: will be replaced by
4503: .Ql 1
4504: if running on
4505: .Ql myhost ,
4506: otherwise by
1.554 nicm 4507: .Ql 0 .
4508: .Ql ||
4509: and
4510: .Ql &&
4511: evaluate to true if either or both of two comma-separated alternatives are
4512: true, for example
1.595 nicm 4513: .Ql #{||:#{pane_in_mode},#{alternate_on}} .
1.664 nicm 4514: .Pp
4515: An
4516: .Ql m
4517: specifies an
4518: .Xr fnmatch 3
4519: or regular expression comparison.
4520: The first argument is the pattern and the second the string to compare.
1.714 nicm 4521: An optional argument specifies flags:
1.664 nicm 4522: .Ql r
4523: means the pattern is a regular expression instead of the default
4524: .Xr fnmatch 3
4525: pattern, and
4526: .Ql i
4527: means to ignore case.
4528: For example:
4529: .Ql #{m:*foo*,#{host}}
4530: or
4531: .Ql #{m/ri:^A,MYVAR} .
1.554 nicm 4532: A
4533: .Ql C
4534: performs a search for an
4535: .Xr fnmatch 3
1.664 nicm 4536: pattern or regular expression in the pane content and evaluates to zero if not
4537: found, or a line number if found.
4538: Like
4539: .Ql m ,
1.665 jmc 4540: an
1.664 nicm 4541: .Ql r
4542: flag means search for a regular expression and
4543: .Ql i
4544: ignores case.
4545: For example:
4546: .Ql #{C/r:^Start}
1.714 nicm 4547: .Pp
4548: Numeric operators may be performed by prefixing two comma-separated alternatives with an
4549: .Ql e
4550: and an operator.
4551: An optional
4552: .Ql f
4553: flag may be given after the operator to use floating point numbers, otherwise integers are used.
4554: This may be followed by a number giving the number of decimal places to use for the result.
4555: The available operators are:
4556: addition
4557: .Ql + ,
4558: subtraction
4559: .Ql - ,
4560: multiplication
4561: .Ql * ,
4562: division
4563: .Ql / ,
1.801 nicm 4564: modulus
1.714 nicm 4565: .Ql m
4566: or
4567: .Ql %
4568: (note that
4569: .Ql %
4570: must be escaped as
4571: .Ql %%
4572: in formats which are also expanded by
1.801 nicm 4573: .Xr strftime 3 )
4574: and numeric comparison operators
4575: .Ql == ,
4576: .Ql != ,
4577: .Ql < ,
4578: .Ql <= ,
4579: .Ql >
4580: and
4581: .Ql >= .
1.714 nicm 4582: For example,
4583: .Ql #{e|*|f|4:5.5,3}
4584: multiplies 5.5 by 3 for a result with four decimal places and
4585: .Ql #{e|%%:7,3}
4586: returns the modulus of 7 and 3.
1.453 nicm 4587: .Pp
1.367 nicm 4588: A limit may be placed on the length of the resultant string by prefixing it
4589: by an
4590: .Ql = ,
1.479 nicm 4591: a number and a colon.
4592: Positive numbers count from the start of the string and negative from the end,
4593: so
4594: .Ql #{=5:pane_title}
1.653 nicm 4595: will include at most the first five characters of the pane title, or
1.479 nicm 4596: .Ql #{=-5:pane_title}
1.653 nicm 4597: the last five characters.
4598: A suffix or prefix may be given as a second argument - if provided then it is
4599: appended or prepended to the string if the length has been trimmed, for example
4600: .Ql #{=/5/...:pane_title}
4601: will append
4602: .Ql ...
4603: if the pane title is more than five characters.
1.698 nicm 4604: Similarly,
4605: .Ql p
4606: pads the string to a given width, for example
4607: .Ql #{p10:pane_title}
4608: will result in a width of at least 10 characters.
4609: A positive width pads on the left, a negative on the right.
1.791 nicm 4610: .Ql n
1.803 nicm 4611: expands to the length of the variable and
4612: .Ql w
4613: to its width when displayed, for example
1.791 nicm 4614: .Ql #{n:window_name} .
1.653 nicm 4615: .Pp
1.453 nicm 4616: Prefixing a time variable with
1.683 nicm 4617: .Ql t:\&
1.453 nicm 4618: will convert it to a string, so if
4619: .Ql #{window_activity}
4620: gives
1.454 jmc 4621: .Ql 1445765102 ,
1.453 nicm 4622: .Ql #{t:window_activity}
4623: gives
4624: .Ql Sun Oct 25 09:25:02 2015 .
1.751 nicm 4625: Adding
4626: .Ql p (
4627: .Ql `t/p` )
4628: will use shorter but less accurate time format for times in the past.
1.765 nicm 4629: A custom format may be given using an
4630: .Ql f
4631: suffix (note that
4632: .Ql %
4633: must be escaped as
4634: .Ql %%
4635: if the format is separately being passed through
4636: .Xr strftime 3 ,
4637: for example in the
4638: .Ic status-left
4639: option):
4640: .Ql #{t/f/%%H#:%%M:window_activity} ,
4641: see
4642: .Xr strftime 3 .
4643: .Pp
1.453 nicm 4644: The
1.683 nicm 4645: .Ql b:\&
1.453 nicm 4646: and
1.683 nicm 4647: .Ql d:\&
1.453 nicm 4648: prefixes are
4649: .Xr basename 3
4650: and
4651: .Xr dirname 3
4652: of the variable respectively.
1.683 nicm 4653: .Ql q:\&
1.610 nicm 4654: will escape
4655: .Xr sh 1
1.812 nicm 4656: special characters or with a
4657: .Ql h
1.806 nicm 4658: suffix, escape hash characters (so
4659: .Ql #
4660: becomes
1.807 nicm 4661: .Ql ## ) .
1.683 nicm 4662: .Ql E:\&
1.617 nicm 4663: will expand the format twice, for example
4664: .Ql #{E:status-left}
4665: is the result of expanding the content of the
4666: .Ic status-left
1.671 nicm 4667: option rather than the option itself.
1.683 nicm 4668: .Ql T:\&
1.620 nicm 4669: is like
1.683 nicm 4670: .Ql E:\&
1.620 nicm 4671: but also expands
4672: .Xr strftime 3
4673: specifiers.
1.683 nicm 4674: .Ql S:\& ,
4675: .Ql W:\&
1.618 nicm 4676: or
1.683 nicm 4677: .Ql P:\&
1.618 nicm 4678: will loop over each session, window or pane and insert the format once
1.619 nicm 4679: for each.
4680: For windows and panes, two comma-separated formats may be given:
4681: the second is used for the current window or active pane.
4682: For example, to get a list of windows formatted like the status line:
1.618 nicm 4683: .Bd -literal -offset indent
4684: #{W:#{E:window-status-format} ,#{E:window-status-current-format} }
4685: .Ed
1.625 nicm 4686: .Pp
1.461 nicm 4687: A prefix of the form
1.683 nicm 4688: .Ql s/foo/bar/:\&
1.461 nicm 4689: will substitute
4690: .Ql foo
4691: with
4692: .Ql bar
4693: throughout.
1.664 nicm 4694: The first argument may be an extended regular expression and a final argument may be
4695: .Ql i
4696: to ignore case, for example
1.683 nicm 4697: .Ql s/a(.)/\e1x/i:\&
1.664 nicm 4698: would change
4699: .Ql abABab
4700: into
4701: .Ql bxBxbx .
1.431 nicm 4702: .Pp
1.671 nicm 4703: In addition, the last line of a shell command's output may be inserted using
1.431 nicm 4704: .Ql #() .
4705: For example,
4706: .Ql #(uptime)
4707: will insert the system's uptime.
4708: When constructing formats,
4709: .Nm
4710: does not wait for
4711: .Ql #()
4712: commands to finish; instead, the previous result from running the same command is used,
4713: or a placeholder if the command has not been run before.
1.543 nicm 4714: If the command hasn't exited, the most recent line of output will be used, but the status
4715: line will not be updated more than once a second.
1.431 nicm 4716: Commands are executed with the
4717: .Nm
4718: global environment set (see the
1.644 schwarze 4719: .Sx GLOBAL AND SESSION ENVIRONMENT
1.431 nicm 4720: section).
1.671 nicm 4721: .Pp
4722: An
4723: .Ql l
4724: specifies that a string should be interpreted literally and not expanded.
4725: For example
4726: .Ql #{l:#{?pane_in_mode,yes,no}}
4727: will be replaced by
4728: .Ql #{?pane_in_mode,yes,no} .
1.245 nicm 4729: .Pp
4730: The following variables are available, where appropriate:
1.359 nicm 4731: .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
4732: .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
1.678 nicm 4733: .It Li "alternate_on" Ta "" Ta "1 if pane is in alternate screen"
1.359 nicm 4734: .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
4735: .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
1.572 nicm 4736: .It Li "buffer_created" Ta "" Ta "Time buffer created"
1.490 nicm 4737: .It Li "buffer_name" Ta "" Ta "Name of buffer"
1.386 nicm 4738: .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
1.359 nicm 4739: .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
1.572 nicm 4740: .It Li "client_activity" Ta "" Ta "Time client last had activity"
1.699 nicm 4741: .It Li "client_cell_height" Ta "" Ta "Height of each client cell in pixels"
4742: .It Li "client_cell_width" Ta "" Ta "Width of each client cell in pixels"
1.646 nicm 4743: .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
1.572 nicm 4744: .It Li "client_created" Ta "" Ta "Time client created"
1.542 nicm 4745: .It Li "client_discarded" Ta "" Ta "Bytes discarded when client behind"
1.762 nicm 4746: .It Li "client_flags" Ta "" Ta "List of client flags"
1.359 nicm 4747: .It Li "client_height" Ta "" Ta "Height of client"
1.451 nicm 4748: .It Li "client_key_table" Ta "" Ta "Current key table"
1.359 nicm 4749: .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
1.540 nicm 4750: .It Li "client_name" Ta "" Ta "Name of client"
1.437 nicm 4751: .It Li "client_pid" Ta "" Ta "PID of client process"
1.359 nicm 4752: .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
4753: .It Li "client_readonly" Ta "" Ta "1 if client is readonly"
4754: .It Li "client_session" Ta "" Ta "Name of the client's session"
4755: .It Li "client_termname" Ta "" Ta "Terminal name of client"
1.754 nicm 4756: .It Li "client_termtype" Ta "" Ta "Terminal type of client, if available"
4757: .It Li "client_termfeatures" Ta "" Ta "Terminal features of client, if any"
1.359 nicm 4758: .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
1.699 nicm 4759: .It Li "client_utf8" Ta "" Ta "1 if client supports UTF-8"
1.359 nicm 4760: .It Li "client_width" Ta "" Ta "Width of client"
1.541 nicm 4761: .It Li "client_written" Ta "" Ta "Bytes written to client"
1.509 nicm 4762: .It Li "command" Ta "" Ta "Name of command in use, if any"
1.646 nicm 4763: .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
1.489 nicm 4764: .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
4765: .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
1.692 nicm 4766: .It Li "copy_cursor_line" Ta "" Ta "Line the cursor is on in copy mode"
4767: .It Li "copy_cursor_word" Ta "" Ta "Word under cursor in copy mode"
1.691 nicm 4768: .It Li "copy_cursor_x" Ta "" Ta "Cursor X position in copy mode"
4769: .It Li "copy_cursor_y" Ta "" Ta "Cursor Y position in copy mode"
1.646 nicm 4770: .It Li "cursor_character" Ta "" Ta "Character at cursor in pane"
1.359 nicm 4771: .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
4772: .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
4773: .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
4774: .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
4775: .It Li "history_limit" Ta "" Ta "Maximum window history lines"
1.581 nicm 4776: .It Li "history_size" Ta "" Ta "Size of history in lines"
1.509 nicm 4777: .It Li "hook" Ta "" Ta "Name of running hook, if any"
1.511 nicm 4778: .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
1.510 nicm 4779: .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
4780: .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
4781: .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
4782: .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
1.359 nicm 4783: .It Li "host" Ta "#H" Ta "Hostname of local host"
4784: .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
4785: .It Li "insert_flag" Ta "" Ta "Pane insert flag"
4786: .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
4787: .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
4788: .It Li "line" Ta "" Ta "Line number in the list"
1.646 nicm 4789: .It Li "mouse_all_flag" Ta "" Ta "Pane mouse all flag"
1.359 nicm 4790: .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
4791: .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
1.676 nicm 4792: .It Li "mouse_line" Ta "" Ta "Line under mouse, if any"
4793: .It Li "mouse_sgr_flag" Ta "" Ta "Pane mouse SGR flag"
1.359 nicm 4794: .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
1.676 nicm 4795: .It Li "mouse_utf8_flag" Ta "" Ta "Pane mouse UTF-8 flag"
4796: .It Li "mouse_word" Ta "" Ta "Word under mouse, if any"
1.654 nicm 4797: .It Li "mouse_x" Ta "" Ta "Mouse X position, if any"
4798: .It Li "mouse_y" Ta "" Ta "Mouse Y position, if any"
1.676 nicm 4799: .It Li "origin_flag" Ta "" Ta "Pane origin flag"
1.359 nicm 4800: .It Li "pane_active" Ta "" Ta "1 if active pane"
1.570 nicm 4801: .It Li "pane_at_bottom" Ta "" Ta "1 if pane is at the bottom of window"
4802: .It Li "pane_at_left" Ta "" Ta "1 if pane is at the left of window"
4803: .It Li "pane_at_right" Ta "" Ta "1 if pane is at the right of window"
4804: .It Li "pane_at_top" Ta "" Ta "1 if pane is at the top of window"
1.396 nicm 4805: .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
1.359 nicm 4806: .It Li "pane_current_command" Ta "" Ta "Current command if available"
1.733 nicm 4807: .It Li "pane_current_path" Ta "" Ta "Current path if available"
1.359 nicm 4808: .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
1.411 nicm 4809: .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
1.696 nicm 4810: .It Li "pane_format" Ta "" Ta "1 if format is for a pane"
1.359 nicm 4811: .It Li "pane_height" Ta "" Ta "Height of pane"
4812: .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
1.678 nicm 4813: .It Li "pane_in_mode" Ta "" Ta "1 if pane is in a mode"
1.646 nicm 4814: .It Li "pane_index" Ta "#P" Ta "Index of pane"
1.678 nicm 4815: .It Li "pane_input_off" Ta "" Ta "1 if input to pane is disabled"
1.792 nicm 4816: .It Li "pane_last" Ta "" Ta "1 if last pane"
1.396 nicm 4817: .It Li "pane_left" Ta "" Ta "Left of pane"
1.650 nicm 4818: .It Li "pane_marked" Ta "" Ta "1 if this is the marked pane"
4819: .It Li "pane_marked_set" Ta "" Ta "1 if a marked pane is set"
1.678 nicm 4820: .It Li "pane_mode" Ta "" Ta "Name of pane mode, if any"
1.761 nicm 4821: .It Li "pane_path" Ta "" Ta "Path of pane (can be set by application)"
1.359 nicm 4822: .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
1.567 nicm 4823: .It Li "pane_pipe" Ta "" Ta "1 if pane is being piped"
1.396 nicm 4824: .It Li "pane_right" Ta "" Ta "Right of pane"
1.546 nicm 4825: .It Li "pane_search_string" Ta "" Ta "Last search string in copy mode"
1.743 nicm 4826: .It Li "pane_skipped" Ta "" Ta "Bytes skipped as not visible in pane"
1.359 nicm 4827: .It Li "pane_start_command" Ta "" Ta "Command pane started with"
1.678 nicm 4828: .It Li "pane_synchronized" Ta "" Ta "1 if pane is synchronized"
1.359 nicm 4829: .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
1.696 nicm 4830: .It Li "pane_title" Ta "#T" Ta "Title of pane (can be set by application)"
1.396 nicm 4831: .It Li "pane_top" Ta "" Ta "Top of pane"
1.359 nicm 4832: .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
4833: .It Li "pane_width" Ta "" Ta "Width of pane"
1.743 nicm 4834: .It Li "pane_written" Ta "" Ta "Bytes written by pane (aside from redrawing)"
1.721 nicm 4835: .It Li "pid" Ta "" Ta "Server PID"
4836: .It Li "popup_key" Ta "" Ta "Key pressed in popup"
4837: .It Li "popup_mouse_x" Ta "" Ta "Mouse X position in popup"
4838: .It Li "popup_mouse_y" Ta "" Ta "Mouse Y position in popup"
1.606 nicm 4839: .It Li "rectangle_toggle" Ta "" Ta "1 if rectangle selection is activated"
1.646 nicm 4840: .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
1.359 nicm 4841: .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
4842: .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
1.782 nicm 4843: .It Li "search_present" Ta "" Ta "1 if search started in copy mode"
4844: .It Li "search_match" Ta "" Ta "Search match if any"
1.713 nicm 4845: .It Li "selection_active" Ta "" Ta "1 if selection started and changes with the cursor in copy mode"
1.691 nicm 4846: .It Li "selection_end_x" Ta "" Ta "X position of the end of the selection"
4847: .It Li "selection_end_y" Ta "" Ta "Y position of the end of the selection"
1.571 nicm 4848: .It Li "selection_present" Ta "" Ta "1 if selection started in copy mode"
1.691 nicm 4849: .It Li "selection_start_x" Ta "" Ta "X position of the start of the selection"
4850: .It Li "selection_start_y" Ta "" Ta "Y position of the start of the selection"
1.646 nicm 4851: .It Li "session_activity" Ta "" Ta "Time of session last activity"
1.430 nicm 4852: .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
1.382 nicm 4853: .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
1.702 nicm 4854: .It Li "session_attached_list" Ta "" Ta "List of clients session is attached to"
1.572 nicm 4855: .It Li "session_created" Ta "" Ta "Time session created"
1.696 nicm 4856: .It Li "session_format" Ta "" Ta "1 if format is for a session"
1.536 nicm 4857: .It Li "session_group" Ta "" Ta "Name of session group"
1.702 nicm 4858: .It Li "session_group_attached" Ta "" Ta "Number of clients sessions in group are attached to"
4859: .It Li "session_group_attached_list" Ta "" Ta "List of clients sessions in group are attached to"
1.646 nicm 4860: .It Li "session_group_list" Ta "" Ta "List of sessions in group"
1.702 nicm 4861: .It Li "session_group_many_attached" Ta "" Ta "1 if multiple clients attached to sessions in group"
1.586 nicm 4862: .It Li "session_group_size" Ta "" Ta "Size of session group"
1.359 nicm 4863: .It Li "session_grouped" Ta "" Ta "1 if session in a group"
4864: .It Li "session_id" Ta "" Ta "Unique session ID"
1.646 nicm 4865: .It Li "session_last_attached" Ta "" Ta "Time session last attached"
1.382 nicm 4866: .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
1.748 nicm 4867: .It Li "session_marked" Ta "" Ta "1 if this session contains the marked pane"
1.359 nicm 4868: .It Li "session_name" Ta "#S" Ta "Name of session"
1.725 nicm 4869: .It Li "session_path" Ta "" Ta "Working directory of session"
1.548 nicm 4870: .It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
1.359 nicm 4871: .It Li "session_windows" Ta "" Ta "Number of windows in session"
1.487 nicm 4872: .It Li "socket_path" Ta "" Ta "Server socket path"
1.465 nicm 4873: .It Li "start_time" Ta "" Ta "Server start time"
1.708 nicm 4874: .It Li "version" Ta "" Ta "Server version"
1.646 nicm 4875: .It Li "window_active" Ta "" Ta "1 if window active"
1.702 nicm 4876: .It Li "window_active_clients" Ta "" Ta "Number of clients viewing this window"
4877: .It Li "window_active_clients_list" Ta "" Ta "List of clients viewing this window"
4878: .It Li "window_active_sessions" Ta "" Ta "Number of sessions on which this window is active"
4879: .It Li "window_active_sessions_list" Ta "" Ta "List of sessions on which this window is active"
1.572 nicm 4880: .It Li "window_activity" Ta "" Ta "Time of window last activity"
1.487 nicm 4881: .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
1.366 nicm 4882: .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
1.642 nicm 4883: .It Li "window_bigger" Ta "" Ta "1 if window is larger than client"
1.700 nicm 4884: .It Li "window_cell_height" Ta "" Ta "Height of each cell in pixels"
4885: .It Li "window_cell_width" Ta "" Ta "Width of each cell in pixels"
1.621 nicm 4886: .It Li "window_end_flag" Ta "" Ta "1 if window has the highest index"
1.812 nicm 4887: .It Li "window_flags" Ta "#F" Ta "Window flags with # escaped as ##"
4888: .It Li "window_raw_flags" Ta "" Ta "Window flags with nothing escaped"
1.696 nicm 4889: .It Li "window_format" Ta "" Ta "1 if format is for a window"
1.359 nicm 4890: .It Li "window_height" Ta "" Ta "Height of window"
4891: .It Li "window_id" Ta "" Ta "Unique window ID"
4892: .It Li "window_index" Ta "#I" Ta "Index of window"
1.400 nicm 4893: .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
1.460 nicm 4894: .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
1.426 nicm 4895: .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
1.702 nicm 4896: .It Li "window_linked_sessions" Ta "" Ta "Number of sessions this window is linked to"
4897: .It Li "window_linked_sessions_list" Ta "" Ta "List of sessions this window is linked to"
1.687 nicm 4898: .It Li "window_marked_flag" Ta "" Ta "1 if window contains the marked pane"
1.359 nicm 4899: .It Li "window_name" Ta "#W" Ta "Name of window"
1.642 nicm 4900: .It Li "window_offset_x" Ta "" Ta "X offset into window if larger than client"
4901: .It Li "window_offset_y" Ta "" Ta "Y offset into window if larger than client"
1.359 nicm 4902: .It Li "window_panes" Ta "" Ta "Number of panes in window"
1.366 nicm 4903: .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
1.548 nicm 4904: .It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
1.621 nicm 4905: .It Li "window_start_flag" Ta "" Ta "1 if window has the lowest index"
1.460 nicm 4906: .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
1.359 nicm 4907: .It Li "window_width" Ta "" Ta "Width of window"
1.400 nicm 4908: .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
1.359 nicm 4909: .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
1.245 nicm 4910: .El
1.623 nicm 4911: .Sh STYLES
4912: .Nm
4913: offers various options to specify the colour and attributes of aspects of the
4914: interface, for example
4915: .Ic status-style
4916: for the status line.
4917: In addition, embedded styles may be specified in format options, such as
1.701 nicm 4918: .Ic status-left ,
1.623 nicm 4919: by enclosing them in
4920: .Ql #[
4921: and
1.639 nicm 4922: .Ql \&] .
1.623 nicm 4923: .Pp
4924: A style may be the single term
4925: .Ql default
1.688 nicm 4926: to specify the default style (which may come from an option, for example
4927: .Ic status-style
4928: in the status line) or a space
1.630 nicm 4929: or comma separated list of the following:
1.623 nicm 4930: .Bl -tag -width Ds
4931: .It Ic fg=colour
4932: Set the foreground colour.
4933: The colour is one of:
4934: .Ic black ,
4935: .Ic red ,
4936: .Ic green ,
4937: .Ic yellow ,
4938: .Ic blue ,
4939: .Ic magenta ,
4940: .Ic cyan ,
4941: .Ic white ;
4942: if supported the bright variants
4943: .Ic brightred ,
4944: .Ic brightgreen ,
4945: .Ic brightyellow ;
4946: .Ic colour0
4947: to
4948: .Ic colour255
4949: from the 256-colour set;
4950: .Ic default
4951: for the default colour;
4952: .Ic terminal
4953: for the terminal default colour; or a hexadecimal RGB string such as
4954: .Ql #ffffff .
4955: .It Ic bg=colour
4956: Set the background colour.
4957: .It Ic none
4958: Set no attributes (turn off any active attributes).
1.752 nicm 4959: .It Xo Ic acs ,
4960: .Ic bright
1.625 nicm 4961: (or
4962: .Ic bold ) ,
1.623 nicm 4963: .Ic dim ,
4964: .Ic underscore ,
4965: .Ic blink ,
4966: .Ic reverse ,
4967: .Ic hidden ,
4968: .Ic italics ,
1.649 nicm 4969: .Ic overline ,
1.623 nicm 4970: .Ic strikethrough ,
4971: .Ic double-underscore ,
4972: .Ic curly-underscore ,
4973: .Ic dotted-underscore ,
4974: .Ic dashed-underscore
4975: .Xc
4976: Set an attribute.
4977: Any of the attributes may be prefixed with
4978: .Ql no
4979: to unset.
1.752 nicm 4980: .Ic acs
4981: is the terminal alternate character set.
1.625 nicm 4982: .It Xo Ic align=left
4983: (or
4984: .Ic noalign ) ,
4985: .Ic align=centre ,
4986: .Ic align=right
4987: .Xc
4988: Align text to the left, centre or right of the available space if appropriate.
1.675 nicm 4989: .It Ic fill=colour
1.674 nicm 4990: Fill the available space with a background colour if appropriate.
1.625 nicm 4991: .It Xo Ic list=on ,
4992: .Ic list=focus ,
4993: .Ic list=left-marker ,
1.661 nicm 4994: .Ic list=right-marker ,
1.625 nicm 4995: .Ic nolist
4996: .Xc
4997: Mark the position of the various window list components in the
4998: .Ic status-format
4999: option:
5000: .Ic list=on
5001: marks the start of the list;
5002: .Ic list=focus
5003: is the part of the list that should be kept in focus if the entire list won't fit
5004: in the available space (typically the current window);
5005: .Ic list=left-marker
5006: and
5007: .Ic list=right-marker
5008: mark the text to be used to mark that text has been trimmed from the left or
5009: right of the list if there is not enough space.
1.688 nicm 5010: .It Xo Ic push-default ,
5011: .Ic pop-default
5012: .Xc
5013: Store the current colours and attributes as the default or reset to the previous
5014: default.
5015: A
5016: .Ic push-default
5017: affects any subsequent use of the
5018: .Ic default
5019: term until a
5020: .Ic pop-default .
5021: Only one default may be pushed (each
5022: .Ic push-default
5023: replaces the previous saved default).
1.625 nicm 5024: .It Xo Ic range=left ,
5025: .Ic range=right ,
5026: .Ic range=window|X ,
5027: .Ic norange
5028: .Xc
5029: Mark a range in the
1.651 nicm 5030: .Ic status-format
1.625 nicm 5031: option.
5032: .Ic range=left
5033: and
5034: .Ic range=right
5035: are the text used for the
5036: .Ql StatusLeft
5037: and
5038: .Ql StatusRight
5039: mouse keys.
5040: .Ic range=window|X
5041: is the range for a window passed to the
5042: .Ql Status
5043: mouse key, where
5044: .Ql X
5045: is a window index.
1.623 nicm 5046: .El
5047: .Pp
5048: Examples are:
5049: .Bd -literal -offset indent
1.630 nicm 5050: fg=yellow bold underscore blink
1.623 nicm 5051: bg=black,fg=default,noreverse
5052: .Ed
1.261 nicm 5053: .Sh NAMES AND TITLES
5054: .Nm
5055: distinguishes between names and titles.
5056: Windows and sessions have names, which may be used to specify them in targets
5057: and are displayed in the status line and various lists: the name is the
5058: .Nm
5059: identifier for a window or session.
5060: Only panes have titles.
1.577 nicm 5061: A pane's title is typically set by the program running inside the pane using
5062: an escape sequence (like it would set the
1.261 nicm 5063: .Xr xterm 1
1.577 nicm 5064: window title in
1.578 nicm 5065: .Xr X 7 ) .
1.268 nicm 5066: Windows themselves do not have titles - a window's title is the title of its
1.261 nicm 5067: active pane.
5068: .Nm
5069: itself may set the title of the terminal in which the client is running, see
5070: the
5071: .Ic set-titles
5072: option.
5073: .Pp
5074: A session's name is set with the
5075: .Ic new-session
5076: and
5077: .Ic rename-session
5078: commands.
5079: A window's name is set with one of:
5080: .Bl -enum -width Ds
5081: .It
5082: A command argument (such as
5083: .Fl n
5084: for
5085: .Ic new-window
5086: or
5087: .Ic new-session ) .
5088: .It
1.597 nicm 5089: An escape sequence (if the
5090: .Ic allow-rename
5091: option is turned on):
1.261 nicm 5092: .Bd -literal -offset indent
5093: $ printf '\e033kWINDOW_NAME\e033\e\e'
5094: .Ed
5095: .It
5096: Automatic renaming, which sets the name to the active command in the window's
5097: active pane.
5098: See the
5099: .Ic automatic-rename
5100: option.
5101: .El
5102: .Pp
5103: When a pane is first created, its title is the hostname.
1.612 nicm 5104: A pane's title can be set via the title setting escape sequence, for example:
1.261 nicm 5105: .Bd -literal -offset indent
5106: $ printf '\e033]2;My Title\e033\e\e'
5107: .Ed
1.577 nicm 5108: .Pp
5109: It can also be modified with the
5110: .Ic select-pane
5111: .Fl T
5112: command.
1.644 schwarze 5113: .Sh GLOBAL AND SESSION ENVIRONMENT
1.63 nicm 5114: When the server is started,
5115: .Nm
5116: copies the environment into the
5117: .Em global environment ;
5118: in addition, each session has a
5119: .Em session environment .
1.193 nicm 5120: When a window is created, the session and global environments are merged.
5121: If a variable exists in both, the value from the session environment is used.
5122: The result is the initial environment passed to the new process.
1.63 nicm 5123: .Pp
5124: The
5125: .Ic update-environment
5126: session option may be used to update the session environment from the client
5127: when a new session is created or an old reattached.
5128: .Nm
5129: also initialises the
5130: .Ev TMUX
5131: variable with some internal information to allow commands to be executed
5132: from inside, and the
5133: .Ev TERM
5134: variable with the correct terminal setting of
5135: .Ql screen .
5136: .Pp
1.728 nicm 5137: Variables in both session and global environments may be marked as hidden.
5138: Hidden variables are not passed into the environment of new processes and
5139: instead can only be used by tmux itself (for example in formats, see the
5140: .Sx FORMATS
5141: section).
5142: .Pp
1.63 nicm 5143: Commands to alter and view the environment are:
5144: .Bl -tag -width Ds
5145: .It Xo Ic set-environment
1.793 nicm 5146: .Op Fl Fhgru
1.63 nicm 5147: .Op Fl t Ar target-session
5148: .Ar name Op Ar value
5149: .Xc
1.115 nicm 5150: .D1 (alias: Ic setenv )
1.63 nicm 5151: Set or unset an environment variable.
5152: If
5153: .Fl g
5154: is used, the change is made in the global environment; otherwise, it is applied
5155: to the session environment for
5156: .Ar target-session .
1.793 nicm 5157: If
5158: .Fl F
5159: is present, then
5160: .Ar value
5161: is expanded as a format.
1.63 nicm 5162: The
5163: .Fl u
5164: flag unsets a variable.
5165: .Fl r
5166: indicates the variable is to be removed from the environment before starting a
5167: new process.
1.728 nicm 5168: .Fl h
5169: marks the variable as hidden.
1.63 nicm 5170: .It Xo Ic show-environment
1.728 nicm 5171: .Op Fl hgs
1.63 nicm 5172: .Op Fl t Ar target-session
1.286 nicm 5173: .Op Ar variable
1.63 nicm 5174: .Xc
1.115 nicm 5175: .D1 (alias: Ic showenv )
1.63 nicm 5176: Display the environment for
5177: .Ar target-session
5178: or the global environment with
5179: .Fl g .
1.286 nicm 5180: If
5181: .Ar variable
5182: is omitted, all variables are shown.
1.63 nicm 5183: Variables removed from the environment are prefixed with
5184: .Ql - .
1.442 nicm 5185: If
5186: .Fl s
5187: is used, the output is formatted as a set of Bourne shell commands.
1.728 nicm 5188: .Fl h
5189: shows hidden variables (omitted by default).
1.57 jmc 5190: .El
5191: .Sh STATUS LINE
5192: .Nm
5193: includes an optional status line which is displayed in the bottom line of each
5194: terminal.
1.626 nicm 5195: .Pp
5196: By default, the status line is enabled and one line in height (it may be
5197: disabled or made multiple lines with the
1.57 jmc 5198: .Ic status
5199: session option) and contains, from left-to-right: the name of the current
1.261 nicm 5200: session in square brackets; the window list; the title of the active pane
5201: in double quotes; and the time and date.
1.57 jmc 5202: .Pp
1.626 nicm 5203: Each line of the status line is configured with the
5204: .Ic status-format
5205: option.
5206: The default is made of three parts: configurable left and right sections (which
5207: may contain dynamic content such as the time or output from a shell command,
5208: see the
1.57 jmc 5209: .Ic status-left ,
5210: .Ic status-left-length ,
5211: .Ic status-right ,
5212: and
5213: .Ic status-right-length
5214: options below), and a central window list.
1.125 nicm 5215: By default, the window list shows the index, name and (if any) flag of the
5216: windows present in the current session in ascending numerical order.
5217: It may be customised with the
5218: .Ar window-status-format
5219: and
5220: .Ar window-status-current-format
5221: options.
1.57 jmc 5222: The flag is one of the following symbols appended to the window name:
5223: .Bl -column "Symbol" "Meaning" -offset indent
5224: .It Sy "Symbol" Ta Sy "Meaning"
5225: .It Li "*" Ta "Denotes the current window."
5226: .It Li "-" Ta "Marks the last window (previously selected)."
1.574 nicm 5227: .It Li "#" Ta "Window activity is monitored and activity has been detected."
5228: .It Li "\&!" Ta "Window bells are monitored and a bell has occurred in the window."
1.192 nicm 5229: .It Li "~" Ta "The window has been silent for the monitor-silence interval."
1.432 nicm 5230: .It Li "M" Ta "The window contains the marked pane."
1.349 nicm 5231: .It Li "Z" Ta "The window's active pane is zoomed."
1.57 jmc 5232: .El
5233: .Pp
5234: The # symbol relates to the
5235: .Ic monitor-activity
1.388 nicm 5236: window option.
1.57 jmc 5237: The window name is printed in inverted colours if an alert (bell, activity or
1.388 nicm 5238: silence) is present.
1.57 jmc 5239: .Pp
1.131 nicm 5240: The colour and attributes of the status line may be configured, the entire
5241: status line using the
1.378 nicm 5242: .Ic status-style
5243: session option and individual windows using the
5244: .Ic window-status-style
5245: window option.
1.57 jmc 5246: .Pp
1.131 nicm 5247: The status line is automatically refreshed at interval if it has changed, the
5248: interval may be controlled with the
1.57 jmc 5249: .Ic status-interval
5250: session option.
5251: .Pp
5252: Commands related to the status line are as follows:
5253: .Bl -tag -width Ds
5254: .It Xo Ic command-prompt
1.758 nicm 5255: .Op Fl 1ikNTW
1.235 nicm 5256: .Op Fl I Ar inputs
1.73 nicm 5257: .Op Fl p Ar prompts
1.57 jmc 5258: .Op Fl t Ar target-client
5259: .Op Ar template
5260: .Xc
5261: Open the command prompt in a client.
5262: This may be used from inside
5263: .Nm
5264: to execute commands interactively.
1.231 nicm 5265: .Pp
1.57 jmc 5266: If
5267: .Ar template
1.73 nicm 5268: is specified, it is used as the command.
1.235 nicm 5269: If present,
5270: .Fl I
5271: is a comma-separated list of the initial text for each prompt.
1.73 nicm 5272: If
5273: .Fl p
5274: is given,
5275: .Ar prompts
5276: is a comma-separated list of prompts which are displayed in order; otherwise
5277: a single prompt is displayed, constructed from
5278: .Ar template
5279: if it is present, or
5280: .Ql \&:
5281: if not.
1.231 nicm 5282: .Pp
1.73 nicm 5283: Before the command is executed, the first occurrence of the string
5284: .Ql %%
1.74 jmc 5285: and all occurrences of
1.73 nicm 5286: .Ql %1
1.492 nicm 5287: are replaced by the response to the first prompt, all
1.73 nicm 5288: .Ql %2
5289: are replaced with the response to the second prompt, and so on for further
1.74 jmc 5290: prompts.
5291: Up to nine prompt responses may be replaced
5292: .Po
5293: .Ql %1
1.73 nicm 5294: to
1.74 jmc 5295: .Ql %9
5296: .Pc .
1.513 nicm 5297: .Ql %%%
5298: is like
5299: .Ql %%
5300: but any quotation marks are escaped.
1.497 nicm 5301: .Pp
5302: .Fl 1
5303: makes the prompt only accept one key press, in this case the resulting input
5304: is a single character.
1.706 nicm 5305: .Fl k
5306: is like
5307: .Fl 1
5308: but the key press is translated to a key name.
1.678 nicm 5309: .Fl N
5310: makes the prompt only accept numeric key presses.
1.517 nicm 5311: .Fl i
5312: executes the command every time the prompt input changes instead of when the
5313: user exits the command prompt.
1.758 nicm 5314: .Fl T
5315: tells
5316: .Nm
5317: that the prompt is for a target which affects what completions are offered when
5318: .Em Tab
5319: is pressed;
5320: .Fl W
5321: is similar but indicates the prompt is for a window.
1.500 nicm 5322: .Pp
5323: The following keys have a special meaning in the command prompt, depending
5324: on the value of the
5325: .Ic status-keys
5326: option:
5327: .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
5328: .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
1.715 nicm 5329: .It Li "Cancel command prompt" Ta "q" Ta "Escape"
1.678 nicm 5330: .It Li "Delete from cursor to start of word" Ta "" Ta "C-w"
1.500 nicm 5331: .It Li "Delete entire command" Ta "d" Ta "C-u"
5332: .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
5333: .It Li "Execute command" Ta "Enter" Ta "Enter"
5334: .It Li "Get next command from history" Ta "" Ta "Down"
5335: .It Li "Get previous command from history" Ta "" Ta "Up"
5336: .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
5337: .It Li "Look for completions" Ta "Tab" Ta "Tab"
5338: .It Li "Move cursor left" Ta "h" Ta "Left"
5339: .It Li "Move cursor right" Ta "l" Ta "Right"
5340: .It Li "Move cursor to end" Ta "$" Ta "C-e"
5341: .It Li "Move cursor to next word" Ta "w" Ta "M-f"
5342: .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
5343: .It Li "Move cursor to start" Ta "0" Ta "C-a"
5344: .It Li "Transpose characters" Ta "" Ta "C-t"
5345: .El
1.57 jmc 5346: .It Xo Ic confirm-before
1.238 nicm 5347: .Op Fl p Ar prompt
1.57 jmc 5348: .Op Fl t Ar target-client
5349: .Ar command
5350: .Xc
5351: .D1 (alias: Ic confirm )
5352: Ask for confirmation before executing
5353: .Ar command .
1.238 nicm 5354: If
5355: .Fl p
5356: is given,
5357: .Ar prompt
5358: is the prompt to display; otherwise a prompt is constructed from
5359: .Ar command .
5360: It may contain the special character sequences supported by the
5361: .Ic status-left
5362: option.
5363: .Pp
1.57 jmc 5364: This command works only from inside
5365: .Nm .
1.646 nicm 5366: .It Xo Ic display-menu
1.800 nicm 5367: .Op Fl O
1.646 nicm 5368: .Op Fl c Ar target-client
5369: .Op Fl t Ar target-pane
5370: .Op Fl T Ar title
5371: .Op Fl x Ar position
5372: .Op Fl y Ar position
1.657 nicm 5373: .Ar name
5374: .Ar key
5375: .Ar command
5376: .Ar ...
1.646 nicm 5377: .Xc
1.651 nicm 5378: .D1 (alias: Ic menu )
1.646 nicm 5379: Display a menu on
5380: .Ar target-client .
5381: .Ar target-pane
5382: gives the target for any commands run from the menu.
5383: .Pp
1.657 nicm 5384: A menu is passed as a series of arguments: first the menu item name,
5385: second the key shortcut (or empty for none) and third the command
5386: to run when the menu item is chosen.
5387: The name and command are formats, see the
1.646 nicm 5388: .Sx FORMATS
5389: and
5390: .Sx STYLES
5391: sections.
1.658 nicm 5392: If the name begins with a hyphen (-), then the item is disabled (shown dim) and
5393: may not be chosen.
1.657 nicm 5394: The name may be empty for a separator line, in which case both the key and
5395: command should be omitted.
1.646 nicm 5396: .Pp
5397: .Fl T
5398: is a format for the menu title (see
5399: .Sx FORMATS ) .
5400: .Pp
5401: .Fl x
5402: and
5403: .Fl y
5404: give the position of the menu.
5405: Both may be a row or column number, or one of the following special values:
5406: .Bl -column "XXXXX" "XXXX" -offset indent
5407: .It Sy "Value" Ta Sy "Flag" Ta Sy "Meaning"
1.719 nicm 5408: .It Li "C" Ta "Both" Ta "The centre of the terminal"
1.646 nicm 5409: .It Li "R" Ta Fl x Ta "The right side of the terminal"
5410: .It Li "P" Ta "Both" Ta "The bottom left of the pane"
5411: .It Li "M" Ta "Both" Ta "The mouse position"
1.730 nicm 5412: .It Li "W" Ta "Both" Ta "The window position on the status line"
1.646 nicm 5413: .It Li "S" Ta Fl y Ta "The line above or below the status line"
1.802 nicm 5414: .El
5415: .Pp
5416: Or a format, which is expanded including the following additional variables:
5417: .Bl -column "XXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent
5418: .It Sy "Variable name" Ta Sy "Replaced with"
5419: .It Li "popup_centre_x" Ta "Centered in the client"
5420: .It Li "popup_centre_y" Ta "Centered in the client"
5421: .It Li "popup_height" Ta "Height of menu or popup"
5422: .It Li "popup_mouse_bottom" Ta "Bottom of at the mouse"
5423: .It Li "popup_mouse_centre_x" Ta "Horizontal centre at the mouse"
5424: .It Li "popup_mouse_centre_y" Ta "Vertical centre at the mouse"
5425: .It Li "popup_mouse_top" Ta "Top at the mouse"
5426: .It Li "popup_mouse_x" Ta "Mouse X position"
5427: .It Li "popup_mouse_y" Ta "Mouse Y position"
5428: .It Li "popup_pane_bottom" Ta "Bottom of the pane"
5429: .It Li "popup_pane_left" Ta "Left of the pane"
5430: .It Li "popup_pane_right" Ta "Right of the pane"
5431: .It Li "popup_pane_top" Ta "Top of the pane"
5432: .It Li "popup_status_line_y" Ta "Above or below the status line"
5433: .It Li "popup_width" Ta "Width of menu or popup"
5434: .It Li "popup_window_status_line_x" Ta "At the window position in status line"
5435: .It Li "popup_window_status_line_y" Ta "At the status line showing the window"
1.646 nicm 5436: .El
5437: .Pp
5438: Each menu consists of items followed by a key shortcut shown in brackets.
5439: If the menu is too large to fit on the terminal, it is not displayed.
5440: Pressing the key shortcut chooses the corresponding item.
1.800 nicm 5441: If the mouse is enabled and the menu is opened from a mouse key binding,
5442: releasing the mouse button with an item selected chooses that item and
5443: releasing the mouse button without an item selected closes the menu.
5444: .Fl O
5445: changes this behaviour so that the menu does not close when the mouse button is
5446: released without an item selected the menu is not closed and a mouse button
5447: must be clicked to choose an item.
5448: .Pp
1.646 nicm 5449: The following keys are also available:
5450: .Bl -column "Key" "Function" -offset indent
5451: .It Sy "Key" Ta Sy "Function"
5452: .It Li "Enter" Ta "Choose selected item"
5453: .It Li "Up" Ta "Select previous item"
5454: .It Li "Down" Ta "Select next item"
5455: .It Li "q" Ta "Exit menu"
5456: .El
1.57 jmc 5457: .It Xo Ic display-message
1.643 nicm 5458: .Op Fl aIpv
1.215 nicm 5459: .Op Fl c Ar target-client
1.790 nicm 5460: .Op Fl d Ar delay
1.215 nicm 5461: .Op Fl t Ar target-pane
1.57 jmc 5462: .Op Ar message
5463: .Xc
5464: .D1 (alias: Ic display )
1.127 nicm 5465: Display a message.
5466: If
5467: .Fl p
5468: is given, the output is printed to stdout, otherwise it is displayed in the
5469: .Ar target-client
1.790 nicm 5470: status line for up to
5471: .Ar delay
5472: milliseconds.
5473: If
5474: .Ar delay
5475: is not given, the
5476: .Ic message-time
5477: option is used; a delay of zero waits for a key press.
1.122 nicm 5478: The format of
1.124 jmc 5479: .Ar message
1.275 nicm 5480: is described in the
5481: .Sx FORMATS
5482: section; information is taken from
1.215 nicm 5483: .Ar target-pane
5484: if
5485: .Fl t
1.678 nicm 5486: is given, otherwise the active pane.
1.622 nicm 5487: .Pp
1.624 nicm 5488: .Fl v
5489: prints verbose logging as the format is parsed and
5490: .Fl a
5491: lists the format variables and their values.
1.643 nicm 5492: .Pp
5493: .Fl I
5494: forwards any input read from stdin to the empty pane given by
5495: .Ar target-pane .
1.721 nicm 5496: .It Xo Ic display-popup
5497: .Op Fl CEK
5498: .Op Fl c Ar target-client
5499: .Op Fl d Ar start-directory
5500: .Op Fl h Ar height
5501: .Op Fl R Ar shell-command
5502: .Op Fl t Ar target-pane
5503: .Op Fl w Ar width
5504: .Op Fl x Ar position
5505: .Op Fl y Ar position
5506: .Op Ar command Ar line Ar ...
5507: .Xc
5508: .D1 (alias: Ic popup )
5509: Display a popup on
5510: .Ar target-client .
5511: A popup is a rectangular box drawn over the top of any panes.
5512: Panes are not updated while a popup is present.
5513: The popup content may be given in two ways:
5514: .Bl -enum -offset Ds
5515: .It
5516: A set of lines as arguments.
5517: Each line is a format which is expanded using
5518: .Ar target-pane
5519: as the target.
5520: If a line contains newlines it is split into multiple lines.
5521: Lines may use styles, see the
5522: .Sx STYLES
5523: section.
5524: .It
5525: A shell command given by
5526: .Fl R
5527: which is run and any output shown in the pane.
5528: .El
5529: .Pp
5530: The first argument,
5531: .Ar command ,
5532: is a
5533: .Nm
5534: command which is run when a key is pressed.
5535: The key is available in the
5536: .Ql popup_key
5537: format.
5538: After
5539: .Ar command
5540: is run, the popup is closed.
5541: It may be empty to discard any key presses.
5542: If
5543: .Fl K
5544: is given together with
1.722 nicm 5545: .Fl R ,
1.721 nicm 5546: key presses are instead passed to the
5547: .Fl R
5548: shell command.
5549: .Fl E
5550: closes the popup automatically when
5551: .Ar shell-command
5552: exits.
1.723 nicm 5553: Two
5554: .Fl E
5555: closes the popup only if
5556: .Ar shell-command
5557: exited with success.
1.721 nicm 5558: With
5559: .Fl K ,
5560: .Ql Escape
5561: and
5562: .Ql C-c
5563: close the popup unless
5564: .Fl E
5565: is also given.
5566: .Pp
5567: .Fl x
5568: and
5569: .Fl y
5570: give the position of the popup, they have the same meaning as for the
5571: .Ic display-menu
5572: command.
5573: .Fl w
5574: and
5575: .Fl h
5576: give the width and height - both may be a percentage (followed by
5577: .Ql % ) .
5578: If omitted, without
5579: .Fl R
5580: they are calculated from the given lines and with
5581: .Fl R
5582: they use half the terminal size.
5583: .Pp
5584: The
5585: .Fl C
5586: flag closes any popup on the client.
1.57 jmc 5587: .El
5588: .Sh BUFFERS
5589: .Nm
1.392 nicm 5590: maintains a set of named
1.199 nicm 5591: .Em paste buffers .
1.392 nicm 5592: Each buffer may be either explicitly or automatically named.
5593: Explicitly named buffers are named when created with the
5594: .Ic set-buffer
5595: or
5596: .Ic load-buffer
5597: commands, or by renaming an automatically named buffer with
5598: .Ic set-buffer
5599: .Fl n .
5600: Automatically named buffers are given a name such as
5601: .Ql buffer0001 ,
5602: .Ql buffer0002
5603: and so on.
5604: When the
5605: .Ic buffer-limit
5606: option is reached, the oldest automatically named buffer is deleted.
1.493 nicm 5607: Explicitly named buffers are not subject to
1.57 jmc 5608: .Ic buffer-limit
1.709 nicm 5609: and may be deleted with the
1.392 nicm 5610: .Ic delete-buffer
5611: command.
5612: .Pp
1.57 jmc 5613: Buffers may be added using
5614: .Ic copy-mode
5615: or the
5616: .Ic set-buffer
1.392 nicm 5617: and
5618: .Ic load-buffer
5619: commands, and pasted into a window using the
1.57 jmc 5620: .Ic paste-buffer
5621: command.
1.392 nicm 5622: If a buffer command is used and no buffer is specified, the most
5623: recently added automatically named buffer is assumed.
1.57 jmc 5624: .Pp
5625: A configurable history buffer is also maintained for each window.
5626: By default, up to 2000 lines are kept; this can be altered with the
5627: .Ic history-limit
5628: option (see the
5629: .Ic set-option
5630: command above).
5631: .Pp
5632: The buffer commands are as follows:
5633: .Bl -tag -width Ds
1.178 nicm 5634: .It Xo
5635: .Ic choose-buffer
1.682 nicm 5636: .Op Fl NZr
1.572 nicm 5637: .Op Fl F Ar format
1.562 nicm 5638: .Op Fl f Ar filter
1.561 nicm 5639: .Op Fl O Ar sort-order
1.555 nicm 5640: .Op Fl t Ar target-pane
1.178 nicm 5641: .Op Ar template
5642: .Xc
1.555 nicm 5643: Put a pane into buffer mode, where a buffer may be chosen interactively from
5644: a list.
1.593 nicm 5645: .Fl Z
5646: zooms the pane.
1.555 nicm 5647: The following keys may be used in buffer mode:
5648: .Bl -column "Key" "Function" -offset indent
5649: .It Sy "Key" Ta Sy "Function"
1.582 nicm 5650: .It Li "Enter" Ta "Paste selected buffer"
1.555 nicm 5651: .It Li "Up" Ta "Select previous buffer"
5652: .It Li "Down" Ta "Select next buffer"
1.559 nicm 5653: .It Li "C-s" Ta "Search by name or content"
5654: .It Li "n" Ta "Repeat last search"
1.555 nicm 5655: .It Li "t" Ta "Toggle if buffer is tagged"
5656: .It Li "T" Ta "Tag no buffers"
5657: .It Li "C-t" Ta "Tag all buffers"
1.582 nicm 5658: .It Li "p" Ta "Paste selected buffer"
5659: .It Li "P" Ta "Paste tagged buffers"
1.555 nicm 5660: .It Li "d" Ta "Delete selected buffer"
5661: .It Li "D" Ta "Delete tagged buffers"
1.759 nicm 5662: .It Li "e" Ta "Open the buffer in an editor"
1.562 nicm 5663: .It Li "f" Ta "Enter a format to filter items"
1.682 nicm 5664: .It Li "O" Ta "Change sort field"
5665: .It Li "r" Ta "Reverse sort order"
1.576 nicm 5666: .It Li "v" Ta "Toggle preview"
1.555 nicm 5667: .It Li "q" Ta "Exit mode"
5668: .El
5669: .Pp
5670: After a buffer is chosen,
1.178 nicm 5671: .Ql %%
1.392 nicm 5672: is replaced by the buffer name in
1.178 nicm 5673: .Ar template
5674: and the result executed as a command.
5675: If
5676: .Ar template
5677: is not given, "paste-buffer -b '%%'" is used.
1.555 nicm 5678: .Pp
1.561 nicm 5679: .Fl O
1.682 nicm 5680: specifies the initial sort field: one of
1.561 nicm 5681: .Ql time ,
5682: .Ql name
5683: or
5684: .Ql size .
1.682 nicm 5685: .Fl r
5686: reverses the sort order.
1.562 nicm 5687: .Fl f
1.579 nicm 5688: specifies an initial filter: the filter is a format - if it evaluates to zero,
5689: the item in the list is not shown, otherwise it is shown.
5690: If a filter would lead to an empty list, it is ignored.
1.572 nicm 5691: .Fl F
5692: specifies the format for each item in the list.
1.576 nicm 5693: .Fl N
5694: starts without the preview.
1.314 nicm 5695: This command works only if at least one client is attached.
1.57 jmc 5696: .It Ic clear-history Op Fl t Ar target-pane
5697: .D1 (alias: Ic clearhist )
5698: Remove and free the history for the specified pane.
1.392 nicm 5699: .It Ic delete-buffer Op Fl b Ar buffer-name
1.57 jmc 5700: .D1 (alias: Ic deleteb )
1.392 nicm 5701: Delete the buffer named
5702: .Ar buffer-name ,
5703: or the most recently added automatically named buffer if not specified.
1.294 nicm 5704: .It Xo Ic list-buffers
5705: .Op Fl F Ar format
1.738 nicm 5706: .Op Fl f Ar filter
1.294 nicm 5707: .Xc
1.57 jmc 5708: .D1 (alias: Ic lsb )
1.198 nicm 5709: List the global buffers.
1.294 nicm 5710: .Fl F
1.738 nicm 5711: specifies the format of each line and
5712: .Fl f
5713: a filter.
5714: Only buffers for which the filter is true are shown.
5715: See the
1.294 nicm 5716: .Sx FORMATS
5717: section.
1.200 jmc 5718: .It Xo Ic load-buffer
1.794 nicm 5719: .Op Fl w
1.392 nicm 5720: .Op Fl b Ar buffer-name
1.794 nicm 5721: .Op Fl t Ar target-client
1.57 jmc 5722: .Ar path
5723: .Xc
5724: .D1 (alias: Ic loadb )
5725: Load the contents of the specified paste buffer from
5726: .Ar path .
1.794 nicm 5727: If
5728: .Fl w
5729: is given, the buffer is also sent to the clipboard for
5730: .Ar target-client
5731: using the
5732: .Xr xterm 1
5733: escape sequence, if possible.
1.57 jmc 5734: .It Xo Ic paste-buffer
1.278 nicm 5735: .Op Fl dpr
1.392 nicm 5736: .Op Fl b Ar buffer-name
1.170 nicm 5737: .Op Fl s Ar separator
1.158 nicm 5738: .Op Fl t Ar target-pane
1.57 jmc 5739: .Xc
5740: .D1 (alias: Ic pasteb )
1.158 nicm 5741: Insert the contents of a paste buffer into the specified pane.
5742: If not specified, paste into the current one.
1.57 jmc 5743: With
5744: .Fl d ,
1.392 nicm 5745: also delete the paste buffer.
1.57 jmc 5746: When output, any linefeed (LF) characters in the paste buffer are replaced with
1.170 nicm 5747: a separator, by default carriage return (CR).
5748: A custom separator may be specified using the
5749: .Fl s
5750: flag.
5751: The
1.57 jmc 5752: .Fl r
1.170 nicm 5753: flag means to do no replacement (equivalent to a separator of LF).
1.278 nicm 5754: If
5755: .Fl p
5756: is specified, paste bracket control codes are inserted around the
5757: buffer if the application has requested bracketed paste mode.
1.57 jmc 5758: .It Xo Ic save-buffer
5759: .Op Fl a
1.392 nicm 5760: .Op Fl b Ar buffer-name
1.57 jmc 5761: .Ar path
5762: .Xc
5763: .D1 (alias: Ic saveb )
5764: Save the contents of the specified paste buffer to
5765: .Ar path .
5766: The
5767: .Fl a
5768: option appends to rather than overwriting the file.
5769: .It Xo Ic set-buffer
1.794 nicm 5770: .Op Fl aw
1.392 nicm 5771: .Op Fl b Ar buffer-name
1.794 nicm 5772: .Op Fl t Ar target-client
1.392 nicm 5773: .Op Fl n Ar new-buffer-name
1.57 jmc 5774: .Ar data
5775: .Xc
5776: .D1 (alias: Ic setb )
5777: Set the contents of the specified buffer to
5778: .Ar data .
1.794 nicm 5779: If
5780: .Fl w
5781: is given, the buffer is also sent to the clipboard for
5782: .Ar target-client
5783: using the
5784: .Xr xterm 1
5785: escape sequence, if possible.
1.383 nicm 5786: The
5787: .Fl a
5788: option appends to rather than overwriting the buffer.
1.392 nicm 5789: The
5790: .Fl n
5791: option renames the buffer to
5792: .Ar new-buffer-name .
1.1 nicm 5793: .It Xo Ic show-buffer
1.392 nicm 5794: .Op Fl b Ar buffer-name
1.1 nicm 5795: .Xc
5796: .D1 (alias: Ic showb )
5797: Display the contents of the specified buffer.
1.57 jmc 5798: .El
5799: .Sh MISCELLANEOUS
5800: Miscellaneous commands are as follows:
5801: .Bl -tag -width Ds
1.72 nicm 5802: .It Ic clock-mode Op Fl t Ar target-pane
1.57 jmc 5803: Display a large clock.
1.334 nicm 5804: .It Xo Ic if-shell
1.410 nicm 5805: .Op Fl bF
1.334 nicm 5806: .Op Fl t Ar target-pane
5807: .Ar shell-command command
5808: .Op Ar command
5809: .Xc
1.57 jmc 5810: .D1 (alias: Ic if )
1.251 nicm 5811: Execute the first
1.57 jmc 5812: .Ar command
5813: if
5814: .Ar shell-command
1.251 nicm 5815: returns success or the second
5816: .Ar command
5817: otherwise.
1.410 nicm 5818: Before being executed,
5819: .Ar shell-command
5820: is expanded using the rules specified in the
1.334 nicm 5821: .Sx FORMATS
5822: section, including those relevant to
5823: .Ar target-pane .
1.335 nicm 5824: With
5825: .Fl b ,
5826: .Ar shell-command
5827: is run in the background.
1.410 nicm 5828: .Pp
5829: If
5830: .Fl F
5831: is given,
5832: .Ar shell-command
5833: is not executed but considered success if neither empty nor zero (after formats
5834: are expanded).
1.57 jmc 5835: .It Ic lock-server
5836: .D1 (alias: Ic lock )
1.90 nicm 5837: Lock each client individually by running the command specified by the
5838: .Ic lock-command
5839: option.
1.308 nicm 5840: .It Xo Ic run-shell
1.809 nicm 5841: .Op Fl bC
1.717 nicm 5842: .Op Fl d Ar delay
1.308 nicm 5843: .Op Fl t Ar target-pane
1.718 nicm 5844: .Op Ar shell-command
1.308 nicm 5845: .Xc
1.87 nicm 5846: .D1 (alias: Ic run )
5847: Execute
1.153 nicm 5848: .Ar shell-command
1.809 nicm 5849: or (with
5850: .Fl C )
5851: a
5852: .Nm
5853: command in the background without creating a window.
5854: Before being executed,
5855: .Ar shell-command
5856: is expanded using the rules specified in the
1.334 nicm 5857: .Sx FORMATS
5858: section.
1.335 nicm 5859: With
5860: .Fl b ,
5861: the command is run in the background.
1.717 nicm 5862: .Fl d
5863: waits for
5864: .Ar delay
5865: seconds before starting the command.
1.809 nicm 5866: If
5867: .Fl C
5868: is not given, any output to stdout is displayed in view mode (in the pane
5869: specified by
1.308 nicm 5870: .Fl t
1.809 nicm 5871: or the current pane if omitted) after the command finishes.
5872: If the command fails, the exit status is also displayed.
1.342 nicm 5873: .It Xo Ic wait-for
1.370 nicm 5874: .Op Fl L | S | U
1.342 nicm 5875: .Ar channel
5876: .Xc
5877: .D1 (alias: Ic wait )
1.343 nicm 5878: When used without options, prevents the client from exiting until woken using
1.342 nicm 5879: .Ic wait-for
5880: .Fl S
5881: with the same channel.
1.343 nicm 5882: When
5883: .Fl L
5884: is used, the channel is locked and any clients that try to lock the same
5885: channel are made to wait until the channel is unlocked with
5886: .Ic wait-for
5887: .Fl U .
1.703 nicm 5888: .El
5889: .Sh EXIT MESSAGES
5890: When a
5891: .Nm
5892: client detaches, it prints a message.
5893: This may be one of:
5894: .Bl -tag -width Ds
1.780 nicm 5895: .It detached (from session ...)
1.703 nicm 5896: The client was detached normally.
1.780 nicm 5897: .It detached and SIGHUP
1.703 nicm 5898: The client was detached and its parent sent the
5899: .Dv SIGHUP
5900: signal (for example with
5901: .Ic detach-client
5902: .Fl P ) .
1.780 nicm 5903: .It lost tty
1.703 nicm 5904: The client's
5905: .Xr tty 4
5906: or
5907: .Xr pty 4
5908: was unexpectedly destroyed.
1.780 nicm 5909: .It terminated
1.703 nicm 5910: The client was killed with
5911: .Dv SIGTERM .
1.780 nicm 5912: .It too far behind
5913: The client is in control mode and became unable to keep up with the data from
5914: .Nm .
5915: .It exited
1.703 nicm 5916: The server exited when it had no sessions.
1.780 nicm 5917: .It server exited
1.703 nicm 5918: The server exited when it received
5919: .Dv SIGTERM .
1.780 nicm 5920: .It server exited unexpectedly
1.703 nicm 5921: The server crashed or otherwise exited without telling the client the reason.
1.228 nicm 5922: .El
5923: .Sh TERMINFO EXTENSIONS
5924: .Nm
1.478 nicm 5925: understands some unofficial extensions to
1.746 nicm 5926: .Xr terminfo 5 .
1.744 nicm 5927: It is not normally necessary to set these manually, instead the
5928: .Ic terminal-features
5929: option should be used.
1.228 nicm 5930: .Bl -tag -width Ds
1.756 nicm 5931: .It Em \&AX
5932: An existing extension that tells
5933: .Nm
5934: the terminal supports default colours.
1.739 nicm 5935: .It Em \&Cs , Cr
1.233 nicm 5936: Set the cursor colour.
1.232 jmc 5937: The first takes a single string argument and is used to set the colour;
5938: the second takes no arguments and restores the default cursor colour.
5939: If set, a sequence such as this may be used
5940: to change the cursor colour from inside
5941: .Nm :
5942: .Bd -literal -offset indent
5943: $ printf '\e033]12;red\e033\e\e'
5944: .Ed
1.753 nicm 5945: .It Em \&Cmg, \&Clmg, \&Dsmg , \&Enmg
5946: Set, clear, disable or enable DECSLRM margins.
1.756 nicm 5947: These are set automatically if the terminal reports it is
5948: .Em VT420
5949: compatible.
1.755 nicm 5950: .It Em \&Dsbp , \&Enbp
5951: Disable and enable bracketed paste.
1.756 nicm 5952: These are set automatically if the
5953: .Em XT
5954: capability is present.
1.772 nicm 5955: .It Em \&Dseks , \&Eneks
5956: Disable and enable extended keys.
1.756 nicm 5957: .It Em \&Dsfcs , \&Enfcs
5958: Disable and enable focus reporting.
5959: These are set automatically if the
5960: .Em XT
5961: capability is present.
1.649 nicm 5962: .It Em \&Smol
5963: Enable the overline attribute.
1.611 nicm 5964: .It Em \&Smulx
1.672 nicm 5965: Set a styled underscore.
5966: The single parameter is one of: 0 for no underscore, 1 for normal
5967: underscore, 2 for double underscore, 3 for curly underscore, 4 for dotted
5968: underscore and 5 for dashed underscore.
1.797 nicm 5969: .It Em \&Setulc , \&ol
5970: Set the underscore colour or reset to the default.
1.672 nicm 5971: The argument is (red * 65536) + (green * 256) + blue where each is between 0
5972: and 255.
1.361 jmc 5973: .It Em \&Ss , Se
1.403 nicm 5974: Set or reset the cursor style.
1.232 jmc 5975: If set, a sequence such as this may be used
5976: to change the cursor to an underline:
1.230 nicm 5977: .Bd -literal -offset indent
5978: $ printf '\e033[4 q'
5979: .Ed
5980: .Pp
5981: If
1.403 nicm 5982: .Em Se
5983: is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
1.741 nicm 5984: .It Em \&Sync
1.745 nicm 5985: Start (parameter is 1) or end (parameter is 2) a synchronized update.
1.478 nicm 5986: .It Em \&Tc
5987: Indicate that the terminal supports the
5988: .Ql direct colour
5989: RGB escape sequence (for example, \ee[38;2;255;255;255m).
1.518 nicm 5990: .Pp
1.612 nicm 5991: If supported, this is used for the initialize colour escape sequence (which
1.518 nicm 5992: may be enabled by adding the
5993: .Ql initc
5994: and
5995: .Ql ccc
5996: capabilities to the
5997: .Nm
5998: .Xr terminfo 5
5999: entry).
1.739 nicm 6000: .Pp
6001: This is equivalent to the
6002: .Em RGB
6003: .Xr terminfo 5
6004: capability.
1.232 jmc 6005: .It Em \&Ms
1.478 nicm 6006: Store the current buffer in the host terminal's selection (clipboard).
1.232 jmc 6007: See the
6008: .Em set-clipboard
6009: option above and the
6010: .Xr xterm 1
6011: man page.
1.756 nicm 6012: .It Em \&XT
6013: This is an existing extension capability that tmux uses to mean that the
6014: terminal supports the
6015: .Xr xterm 1
6016: title set sequences and to automatically set some of the capabilities above.
1.345 nicm 6017: .El
6018: .Sh CONTROL MODE
6019: .Nm
6020: offers a textual interface called
6021: .Em control mode .
6022: This allows applications to communicate with
6023: .Nm
6024: using a simple text-only protocol.
6025: .Pp
6026: In control mode, a client sends
6027: .Nm
6028: commands or command sequences terminated by newlines on standard input.
6029: Each command will produce one block of output on standard output.
6030: An output block consists of a
6031: .Em %begin
6032: line followed by the output (which may be empty).
6033: The output block ends with a
6034: .Em %end
6035: or
6036: .Em %error .
6037: .Em %begin
6038: and matching
6039: .Em %end
6040: or
6041: .Em %error
6042: have two arguments: an integer time (as seconds from epoch) and command number.
6043: For example:
6044: .Bd -literal -offset indent
6045: %begin 1363006971 2
6046: 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
6047: %end 1363006971 2
6048: .Ed
1.535 nicm 6049: .Pp
6050: The
6051: .Ic refresh-client
6052: .Fl C
6053: command may be used to set the size of a client in control mode.
1.345 nicm 6054: .Pp
6055: In control mode,
6056: .Nm
6057: outputs notifications.
6058: A notification will never occur inside an output block.
6059: .Pp
6060: The following notifications are defined:
6061: .Bl -tag -width Ds
1.750 jmc 6062: .It Ic %client-session-changed Ar client session-id name
1.547 nicm 6063: The client is now attached to the session with ID
6064: .Ar session-id ,
6065: which is named
6066: .Ar name .
1.778 nicm 6067: .It Ic %continue Ar pane-id
6068: The pane has been continued after being paused (if the
6069: .Ar pause-after
6070: flag is set, see
6071: .Ic refresh-client
6072: .Fl A ) .
1.345 nicm 6073: .It Ic %exit Op Ar reason
6074: The
6075: .Nm
6076: client is exiting immediately, either because it is not attached to any session
6077: or an error occurred.
6078: If present,
6079: .Ar reason
6080: describes why the client exited.
1.788 nicm 6081: .It Ic %extended-output Ar pane-id Ar age Ar ... \& : Ar value
1.779 nicm 6082: New form of
6083: .Ic %output
6084: sent when the
6085: .Ar pause-after
6086: flag is set.
6087: .Ar age
6088: is the time in milliseconds for which tmux had buffered the output before it was sent.
6089: Any subsequent arguments up until a single
6090: .Ql \&:
6091: are for future use and should be ignored.
1.460 nicm 6092: .It Ic %layout-change Ar window-id Ar window-layout Ar window-visible-layout Ar window-flags
1.345 nicm 6093: The layout of a window with ID
6094: .Ar window-id
6095: changed.
6096: The new layout is
6097: .Ar window-layout .
1.460 nicm 6098: The window's visible layout is
6099: .Ar window-visible-layout
6100: and the window flags are
6101: .Ar window-flags .
1.347 nicm 6102: .It Ic %output Ar pane-id Ar value
6103: A window pane produced output.
1.345 nicm 6104: .Ar value
1.350 nicm 6105: escapes non-printable characters and backslash as octal \\xxx.
1.547 nicm 6106: .It Ic %pane-mode-changed Ar pane-id
6107: The pane with ID
6108: .Ar pane-id
6109: has changed mode.
1.778 nicm 6110: .It Ic %pause Ar pane-id
6111: The pane has been paused (if the
6112: .Ar pause-after
6113: flag is set).
1.345 nicm 6114: .It Ic %session-changed Ar session-id Ar name
6115: The client is now attached to the session with ID
6116: .Ar session-id ,
6117: which is named
6118: .Ar name .
6119: .It Ic %session-renamed Ar name
6120: The current session was renamed to
6121: .Ar name .
1.547 nicm 6122: .It Ic %session-window-changed Ar session-id Ar window-id
6123: The session with ID
6124: .Ar session-id
6125: changed its active window to the window with ID
6126: .Ar window-id .
1.345 nicm 6127: .It Ic %sessions-changed
6128: A session was created or destroyed.
1.788 nicm 6129: .It Xo Ic %subscription-changed
6130: .Ar name
6131: .Ar session-id
6132: .Ar window-id
6133: .Ar window-index
6134: .Ar pane-id ... \& :
6135: .Ar value
6136: .Xc
6137: The value of the format associated with subscription
6138: .Ar name
6139: has changed to
6140: .Ar value .
6141: See
6142: .Ic refresh-client
6143: .Fl B .
6144: Any arguments after
6145: .Ar pane-id
6146: up until a single
6147: .Ql \&:
6148: are for future use and should be ignored.
1.345 nicm 6149: .It Ic %unlinked-window-add Ar window-id
6150: The window with ID
6151: .Ar window-id
6152: was created but is not linked to the current session.
6153: .It Ic %window-add Ar window-id
6154: The window with ID
6155: .Ar window-id
6156: was linked to the current session.
6157: .It Ic %window-close Ar window-id
6158: The window with ID
6159: .Ar window-id
6160: closed.
1.547 nicm 6161: .It Ic %window-pane-changed Ar window-id Ar pane-id
6162: The active pane in the window with ID
6163: .Ar window-id
6164: changed to the pane with ID
6165: .Ar pane-id .
1.345 nicm 6166: .It Ic %window-renamed Ar window-id Ar name
6167: The window with ID
6168: .Ar window-id
6169: was renamed to
6170: .Ar name .
1.644 schwarze 6171: .El
6172: .Sh ENVIRONMENT
6173: When
6174: .Nm
6175: is started, it inspects the following environment variables:
6176: .Bl -tag -width LC_CTYPE
6177: .It Ev EDITOR
6178: If the command specified in this variable contains the string
6179: .Ql vi
6180: and
6181: .Ev VISUAL
6182: is unset, use vi-style key bindings.
6183: Overridden by the
6184: .Ic mode-keys
6185: and
6186: .Ic status-keys
6187: options.
6188: .It Ev HOME
6189: The user's login directory.
6190: If unset, the
6191: .Xr passwd 5
6192: database is consulted.
6193: .It Ev LC_CTYPE
6194: The character encoding
6195: .Xr locale 1 .
6196: It is used for two separate purposes.
6197: For output to the terminal, UTF-8 is used if the
6198: .Fl u
6199: option is given or if
6200: .Ev LC_CTYPE
6201: contains
6202: .Qq UTF-8
6203: or
6204: .Qq UTF8 .
6205: Otherwise, only ASCII characters are written and non-ASCII characters
6206: are replaced with underscores
6207: .Pq Ql _ .
6208: For input,
6209: .Nm
6210: always runs with a UTF-8 locale.
6211: If en_US.UTF-8 is provided by the operating system it is used and
6212: .Ev LC_CTYPE
6213: is ignored for input.
6214: Otherwise,
6215: .Ev LC_CTYPE
6216: tells
6217: .Nm
6218: what the UTF-8 locale is called on the current system.
6219: If the locale specified by
6220: .Ev LC_CTYPE
6221: is not available or is not a UTF-8 locale,
6222: .Nm
6223: exits with an error message.
6224: .It Ev LC_TIME
6225: The date and time format
6226: .Xr locale 1 .
6227: It is used for locale-dependent
6228: .Xr strftime 3
6229: format specifiers.
6230: .It Ev PWD
6231: The current working directory to be set in the global environment.
6232: This may be useful if it contains symbolic links.
6233: If the value of the variable does not match the current working
6234: directory, the variable is ignored and the result of
6235: .Xr getcwd 3
6236: is used instead.
6237: .It Ev SHELL
6238: The absolute path to the default shell for new windows.
6239: See the
6240: .Ic default-shell
6241: option for details.
6242: .It Ev TMUX_TMPDIR
6243: The parent directory of the directory containing the server sockets.
6244: See the
6245: .Fl L
6246: option for details.
6247: .It Ev VISUAL
6248: If the command specified in this variable contains the string
6249: .Ql vi ,
6250: use vi-style key bindings.
6251: Overridden by the
6252: .Ic mode-keys
6253: and
6254: .Ic status-keys
6255: options.
1.1 nicm 6256: .El
6257: .Sh FILES
1.26 nicm 6258: .Bl -tag -width "/etc/tmux.confXXX" -compact
1.1 nicm 6259: .It Pa ~/.tmux.conf
1.6 jmc 6260: Default
1.1 nicm 6261: .Nm
1.6 jmc 6262: configuration file.
1.26 nicm 6263: .It Pa /etc/tmux.conf
6264: System-wide configuration file.
1.1 nicm 6265: .El
1.57 jmc 6266: .Sh EXAMPLES
6267: To create a new
6268: .Nm
6269: session running
6270: .Xr vi 1 :
6271: .Pp
6272: .Dl $ tmux new-session vi
6273: .Pp
6274: Most commands have a shorter form, known as an alias.
6275: For new-session, this is
6276: .Ic new :
6277: .Pp
6278: .Dl $ tmux new vi
6279: .Pp
6280: Alternatively, the shortest unambiguous form of a command is accepted.
6281: If there are several options, they are listed:
6282: .Bd -literal -offset indent
6283: $ tmux n
6284: ambiguous command: n, could be: new-session, new-window, next-window
6285: .Ed
6286: .Pp
6287: Within an active session, a new window may be created by typing
6288: .Ql C-b c
6289: (Ctrl
6290: followed by the
6291: .Ql b
6292: key
6293: followed by the
6294: .Ql c
6295: key).
6296: .Pp
6297: Windows may be navigated with:
6298: .Ql C-b 0
6299: (to select window 0),
6300: .Ql C-b 1
6301: (to select window 1), and so on;
6302: .Ql C-b n
6303: to select the next window; and
6304: .Ql C-b p
6305: to select the previous window.
6306: .Pp
6307: A session may be detached using
6308: .Ql C-b d
1.64 nicm 6309: (or by an external event such as
6310: .Xr ssh 1
6311: disconnection) and reattached with:
1.57 jmc 6312: .Pp
6313: .Dl $ tmux attach-session
6314: .Pp
6315: Typing
6316: .Ql C-b \&?
6317: lists the current key bindings in the current window; up and down may be used
6318: to navigate the list or
6319: .Ql q
6320: to exit from it.
6321: .Pp
6322: Commands to be run when the
6323: .Nm
6324: server is started may be placed in the
6325: .Pa ~/.tmux.conf
6326: configuration file.
6327: Common examples include:
6328: .Pp
6329: Changing the default prefix key:
6330: .Bd -literal -offset indent
6331: set-option -g prefix C-a
6332: unbind-key C-b
6333: bind-key C-a send-prefix
6334: .Ed
6335: .Pp
6336: Turning the status line off, or changing its colour:
6337: .Bd -literal -offset indent
6338: set-option -g status off
1.378 nicm 6339: set-option -g status-style bg=blue
1.57 jmc 6340: .Ed
6341: .Pp
6342: Setting other options, such as the default command,
6343: or locking after 30 minutes of inactivity:
6344: .Bd -literal -offset indent
6345: set-option -g default-command "exec /bin/ksh"
6346: set-option -g lock-after-time 1800
6347: .Ed
6348: .Pp
6349: Creating new key bindings:
6350: .Bd -literal -offset indent
6351: bind-key b set-option status
6352: bind-key / command-prompt "split-window 'exec man %%'"
1.73 nicm 6353: bind-key S command-prompt "new-window -n %1 'ssh %1'"
1.57 jmc 6354: .Ed
1.1 nicm 6355: .Sh SEE ALSO
6356: .Xr pty 4
6357: .Sh AUTHORS
1.477 nicm 6358: .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com