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