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