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