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