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