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