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