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