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