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