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