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