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