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