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