Annotation of src/usr.bin/tmux/tmux.1, Revision 1.561
1.561 ! nicm 1: .\" $OpenBSD: tmux.1,v 1.560 2017/06/09 09:21:24 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.561 ! nicm 17: .Dd $Mdocdate: June 9 2017 $
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.523 nicm 179: When starting,
1.1 nicm 180: .Nm
1.523 nicm 181: looks for the
1.14 nicm 182: .Ev LC_ALL ,
183: .Ev LC_CTYPE
184: and
1.2 nicm 185: .Ev LANG
1.523 nicm 186: environment variables: if the first found contains
187: .Ql UTF-8 ,
188: then the terminal is assumed to support UTF-8.
1.5 nicm 189: This is not always correct: the
1.2 nicm 190: .Fl u
191: flag explicitly informs
192: .Nm
1.6 jmc 193: that UTF-8 is supported.
1.33 nicm 194: .Pp
1.458 nicm 195: Note that
196: .Nm
1.459 jmc 197: itself always accepts UTF-8; this controls whether it will send UTF-8
198: characters to the terminal it is running (if not, they are replaced by
1.458 nicm 199: .Ql _ ) .
1.1 nicm 200: .It Fl v
201: Request verbose logging.
202: Log messages will be saved into
203: .Pa tmux-client-PID.log
204: and
205: .Pa tmux-server-PID.log
206: files in the current directory, where
207: .Em PID
1.6 jmc 208: is the PID of the server or client process.
1.558 nicm 209: .Pp
210: If
211: .Fl v
212: is specified twice, an additional
213: .Pa tmux-out-PID.log
214: file is generated with a copy of everything
215: .Nm
216: writes to the terminal.
217: .Pp
218: The
219: .Dv SIGUSR2
220: signal may be sent to the
221: .Nm
222: server process to toggle logging between on (as if
223: .Fl v
224: was given) and off.
1.1 nicm 225: .It Ar command Op Ar flags
226: This specifies one of a set of commands used to control
227: .Nm ,
1.6 jmc 228: as described in the following sections.
1.59 jmc 229: If no commands are specified, the
1.1 nicm 230: .Ic new-session
231: command is assumed.
1.57 jmc 232: .El
1.64 nicm 233: .Sh KEY BINDINGS
234: .Nm
235: may be controlled from an attached client by using a key combination of a
236: prefix key,
237: .Ql C-b
238: (Ctrl-b) by default, followed by a command key.
239: .Pp
1.172 nicm 240: The default command key bindings are:
1.64 nicm 241: .Pp
1.171 nicm 242: .Bl -tag -width "XXXXXXXXXX" -offset indent -compact
243: .It C-b
244: Send the prefix key (C-b) through to the application.
245: .It C-o
246: Rotate the panes in the current window forwards.
247: .It C-z
248: Suspend the
249: .Nm
250: client.
251: .It !
252: Break the current pane out of the window.
253: .It \&"
254: Split the current pane into two, top and bottom.
255: .It #
256: List all paste buffers.
1.236 nicm 257: .It $
258: Rename the current session.
1.171 nicm 259: .It %
260: Split the current pane into two, left and right.
261: .It &
262: Kill the current window.
263: .It '
264: Prompt for a window index to select.
1.412 nicm 265: .It \&(
266: Switch the attached client to the previous session.
267: .It \&)
268: Switch the attached client to the next session.
1.171 nicm 269: .It ,
270: Rename the current window.
271: .It -
272: Delete the most recently copied buffer of text.
273: .It .
274: Prompt for an index to move the current window.
275: .It 0 to 9
276: Select windows 0 to 9.
277: .It :
278: Enter the
279: .Nm
280: command prompt.
1.187 nicm 281: .It ;
282: Move to the previously active pane.
1.178 nicm 283: .It =
284: Choose which buffer to paste interactively from a list.
1.171 nicm 285: .It \&?
286: List all key bindings.
287: .It D
288: Choose a client to detach.
1.412 nicm 289: .It L
290: Switch the attached client back to the last session.
1.182 jmc 291: .It \&[
1.171 nicm 292: Enter copy mode to copy text or view the history.
1.182 jmc 293: .It \&]
1.171 nicm 294: Paste the most recently copied buffer of text.
1.64 nicm 295: .It c
1.65 nicm 296: Create a new window.
1.64 nicm 297: .It d
1.65 nicm 298: Detach the current client.
1.171 nicm 299: .It f
300: Prompt to search for text in open windows.
301: .It i
302: Display some information about the current window.
1.64 nicm 303: .It l
1.65 nicm 304: Move to the previously selected window.
1.64 nicm 305: .It n
1.65 nicm 306: Change to the next window.
1.171 nicm 307: .It o
308: Select the next pane in the current window.
1.64 nicm 309: .It p
1.65 nicm 310: Change to the previous window.
1.171 nicm 311: .It q
312: Briefly display pane indexes.
313: .It r
314: Force redraw of the attached client.
1.432 nicm 315: .It m
316: Mark the current pane (see
317: .Ic select-pane
318: .Fl m ) .
319: .It M
320: Clear the marked pane.
1.171 nicm 321: .It s
322: Select a new session for the attached client interactively.
323: .It t
324: Show the time.
325: .It w
326: Choose the current window interactively.
327: .It x
328: Kill the current pane.
1.412 nicm 329: .It z
330: Toggle zoom state of the current pane.
1.171 nicm 331: .It {
332: Swap the current pane with the previous pane.
333: .It }
334: Swap the current pane with the next pane.
335: .It ~
336: Show previous messages from
337: .Nm ,
338: if any.
339: .It Page Up
340: Enter copy mode and scroll one page up.
341: .It Up, Down
342: .It Left, Right
343: Change to the pane above, below, to the left, or to the right of the current
344: pane.
345: .It M-1 to M-5
346: Arrange panes in one of the five preset layouts: even-horizontal,
347: even-vertical, main-horizontal, main-vertical, or tiled.
1.412 nicm 348: .It Space
349: Arrange the current window in the next preset layout.
1.171 nicm 350: .It M-n
351: Move to the next window with a bell or activity marker.
352: .It M-o
353: Rotate the panes in the current window backwards.
354: .It M-p
355: Move to the previous window with a bell or activity marker.
356: .It C-Up, C-Down
357: .It C-Left, C-Right
358: Resize the current pane in steps of one cell.
359: .It M-Up, M-Down
360: .It M-Left, M-Right
361: Resize the current pane in steps of five cells.
1.64 nicm 362: .El
363: .Pp
364: Key bindings may be changed with the
365: .Ic bind-key
366: and
367: .Ic unbind-key
368: commands.
1.57 jmc 369: .Sh COMMANDS
370: This section contains a list of the commands supported by
371: .Nm .
372: Most commands accept the optional
373: .Fl t
1.432 nicm 374: (and sometimes
375: .Fl s )
1.57 jmc 376: argument with one of
377: .Ar target-client ,
378: .Ar target-session
379: .Ar target-window ,
380: or
381: .Ar target-pane .
382: These specify the client, session, window or pane which a command should affect.
1.423 nicm 383: .Pp
1.57 jmc 384: .Ar target-client
1.540 nicm 385: should be the name of the client,
386: typically the
1.57 jmc 387: .Xr pty 4
388: file to which the client is connected, for example either of
389: .Pa /dev/ttyp1
390: or
391: .Pa ttyp1
392: for the client attached to
393: .Pa /dev/ttyp1 .
1.423 nicm 394: If no client is specified,
395: .Nm
396: attempts to work out the client currently in use; if that fails, an error is
397: reported.
1.57 jmc 398: Clients may be listed with the
399: .Ic list-clients
400: command.
1.1 nicm 401: .Pp
1.57 jmc 402: .Ar target-session
1.423 nicm 403: is tried as, in order:
404: .Bl -enum -offset Ds
405: .It
406: A session ID prefixed with a $.
407: .It
408: An exact name of a session (as listed by the
1.57 jmc 409: .Ic list-sessions
1.423 nicm 410: command).
411: .It
412: The start of a session name, for example
413: .Ql mysess
414: would match a session named
415: .Ql mysession .
416: .It
417: An
1.57 jmc 418: .Xr fnmatch 3
1.423 nicm 419: pattern which is matched against the session name.
420: .El
421: .Pp
1.441 nicm 422: If the session name is prefixed with an
423: .Ql = ,
1.435 nicm 424: only an exact match is accepted (so
425: .Ql =mysess
426: will only match exactly
427: .Ql mysess ,
428: not
429: .Ql mysession ) .
1.441 nicm 430: .Pp
1.423 nicm 431: If a single session is found, it is used as the target session; multiple matches
1.57 jmc 432: produce an error.
433: If a session is omitted, the current session is used if available; if no
1.117 nicm 434: current session is available, the most recently used is chosen.
1.1 nicm 435: .Pp
1.57 jmc 436: .Ar target-window
1.472 nicm 437: (or
438: .Ar src-window
439: or
440: .Ar dst-window )
1.57 jmc 441: specifies a window in the form
442: .Em session Ns \&: Ns Em window .
443: .Em session
444: follows the same rules as for
445: .Ar target-session ,
446: and
447: .Em window
1.423 nicm 448: is looked for in order as:
449: .Bl -enum -offset Ds
450: .It
451: A special token, listed below.
452: .It
453: A window index, for example
454: .Ql mysession:1
455: is window 1 in session
456: .Ql mysession .
457: .It
458: A window ID, such as @1.
459: .It
460: An exact window name, such as
461: .Ql mysession:mywindow .
462: .It
463: The start of a window name, such as
464: .Ql mysession:mywin .
465: .It
466: As an
1.57 jmc 467: .Xr fnmatch 3
1.423 nicm 468: pattern matched against the window name.
469: .El
470: .Pp
1.435 nicm 471: Like sessions, a
472: .Ql =
473: prefix will do an exact match only.
1.57 jmc 474: An empty window name specifies the next unused index if appropriate (for
475: example the
476: .Ic new-window
477: and
478: .Ic link-window
479: commands)
480: otherwise the current window in
481: .Em session
482: is chosen.
1.423 nicm 483: .Pp
1.424 nicm 484: The following special tokens are available to indicate particular windows.
485: Each has a single-character alternative form.
1.423 nicm 486: .Bl -column "XXXXXXXXXX" "X"
487: .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
488: .It Li "{start}" Ta "^" Ta "The lowest-numbered window"
489: .It Li "{end}" Ta "$" Ta "The highest-numbered window"
490: .It Li "{last}" Ta "!" Ta "The last (previously current) window"
491: .It Li "{next}" Ta "+" Ta "The next window by number"
492: .It Li "{previous}" Ta "-" Ta "The previous window by number"
493: .El
1.1 nicm 494: .Pp
1.57 jmc 495: .Ar target-pane
1.472 nicm 496: (or
497: .Ar src-pane
498: or
499: .Ar dst-pane )
500: may be a pane ID or takes a similar form to
1.57 jmc 501: .Ar target-window
1.423 nicm 502: but with the optional addition of a period followed by a pane index or pane ID,
503: for example:
504: .Ql mysession:mywindow.1 .
1.57 jmc 505: If the pane index is omitted, the currently active pane in the specified
506: window is used.
1.423 nicm 507: The following special tokens are available for the pane index:
508: .Bl -column "XXXXXXXXXXXXXX" "X"
509: .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
510: .It Li "{last}" Ta "!" Ta "The last (previously active) pane"
511: .It Li "{next}" Ta "+" Ta "The next pane by number"
512: .It Li "{previous}" Ta "-" Ta "The previous pane by number"
513: .It Li "{top}" Ta "" Ta "The top pane"
514: .It Li "{bottom}" Ta "" Ta "The bottom pane"
515: .It Li "{left}" Ta "" Ta "The leftmost pane"
516: .It Li "{right}" Ta "" Ta "The rightmost pane"
517: .It Li "{top-left}" Ta "" Ta "The top-left pane"
518: .It Li "{top-right}" Ta "" Ta "The top-right pane"
519: .It Li "{bottom-left}" Ta "" Ta "The bottom-left pane"
520: .It Li "{bottom-right}" Ta "" Ta "The bottom-right pane"
1.447 nicm 521: .It Li "{up-of}" Ta "" Ta "The pane above the active pane"
522: .It Li "{down-of}" Ta "" Ta "The pane below the active pane"
523: .It Li "{left-of}" Ta "" Ta "The pane to the left of the active pane"
524: .It Li "{right-of}" Ta "" Ta "The pane to the right of the active pane"
1.423 nicm 525: .El
1.177 nicm 526: .Pp
1.423 nicm 527: The tokens
1.177 nicm 528: .Ql +
529: and
530: .Ql -
531: may be followed by an offset, for example:
532: .Bd -literal -offset indent
533: select-window -t:+2
534: .Ed
535: .Pp
1.432 nicm 536: In addition,
537: .Em target-session ,
538: .Em target-window
539: or
540: .Em target-pane
541: may consist entirely of the token
542: .Ql {mouse}
543: (alternative form
544: .Ql = )
545: to specify the most recent mouse event
546: (see the
547: .Sx MOUSE SUPPORT
548: section)
549: or
550: .Ql {marked}
551: (alternative form
552: .Ql ~ )
553: to specify the marked pane (see
554: .Ic select-pane
555: .Fl m ) .
556: .Pp
1.423 nicm 557: Sessions, window and panes are each numbered with a unique ID; session IDs are
558: prefixed with a
559: .Ql $ ,
560: windows with a
561: .Ql @ ,
562: and panes with a
563: .Ql % .
564: These are unique and are unchanged for the life of the session, window or pane
565: in the
1.212 nicm 566: .Nm
1.423 nicm 567: server.
568: The pane ID is passed to the child process of the pane in the
1.212 nicm 569: .Ev TMUX_PANE
570: environment variable.
1.423 nicm 571: IDs may be displayed using the
572: .Ql session_id ,
573: .Ql window_id ,
574: or
575: .Ql pane_id
576: formats (see the
577: .Sx FORMATS
578: section) and the
579: .Ic display-message ,
580: .Ic list-sessions ,
581: .Ic list-windows
582: or
583: .Ic list-panes
584: commands.
1.15 jmc 585: .Pp
1.153 nicm 586: .Ar shell-command
587: arguments are
588: .Xr sh 1
589: commands.
1.394 nicm 590: This may be a single argument passed to the shell, for example:
1.153 nicm 591: .Bd -literal -offset indent
592: new-window 'vi /etc/passwd'
593: .Ed
1.394 nicm 594: .Pp
595: Will run:
596: .Bd -literal -offset indent
597: /bin/sh -c 'vi /etc/passwd'
598: .Ed
599: .Pp
600: Additionally, the
601: .Ic new-window ,
602: .Ic new-session ,
603: .Ic split-window ,
604: .Ic respawn-window
605: and
606: .Ic respawn-pane
607: commands allow
608: .Ar shell-command
609: to be given as multiple arguments and executed directly (without
610: .Ql sh -c ) .
611: This can avoid issues with shell quoting.
612: For example:
613: .Bd -literal -offset indent
614: $ tmux new-window vi /etc/passwd
615: .Ed
616: .Pp
617: Will run
618: .Xr vi 1
619: directly without invoking the shell.
1.153 nicm 620: .Pp
621: .Ar command
622: .Op Ar arguments
623: refers to a
624: .Nm
625: command, passed with the command and arguments separately, for example:
626: .Bd -literal -offset indent
627: bind-key F1 set-window-option force-width 81
628: .Ed
629: .Pp
630: Or if using
631: .Xr sh 1 :
632: .Bd -literal -offset indent
633: $ tmux bind-key F1 set-window-option force-width 81
634: .Ed
635: .Pp
1.57 jmc 636: Multiple commands may be specified together as part of a
637: .Em command sequence .
638: Each command should be separated by spaces and a semicolon;
1.244 nicm 639: commands are executed sequentially from left to right and
1.293 nicm 640: lines ending with a backslash continue on to the next line,
641: except when escaped by another backslash.
1.57 jmc 642: A literal semicolon may be included by escaping it with a backslash (for
643: example, when specifying a command sequence to
644: .Ic bind-key ) .
1.13 nicm 645: .Pp
1.153 nicm 646: Example
647: .Nm
648: commands include:
1.13 nicm 649: .Bd -literal -offset indent
1.57 jmc 650: refresh-client -t/dev/ttyp2
651:
652: rename-session -tfirst newname
653:
654: set-window-option -t:0 monitor-activity on
655:
656: new-window ; split-window -d
1.244 nicm 657:
658: bind-key R source-file ~/.tmux.conf \e; \e
659: display-message "source-file done"
1.13 nicm 660: .Ed
1.153 nicm 661: .Pp
662: Or from
663: .Xr sh 1 :
664: .Bd -literal -offset indent
665: $ tmux kill-window -t :1
666:
1.159 jmc 667: $ tmux new-window \e; split-window -d
1.153 nicm 668:
1.159 jmc 669: $ tmux new-session -d 'vi /etc/passwd' \e; split-window -d \e; attach
1.153 nicm 670: .Ed
1.57 jmc 671: .Sh CLIENTS AND SESSIONS
1.153 nicm 672: The
673: .Nm
674: server manages clients, sessions, windows and panes.
675: Clients are attached to sessions to interact with them, either
676: when they are created with the
677: .Ic new-session
678: command, or later with the
679: .Ic attach-session
680: command.
1.188 nicm 681: Each session has one or more windows
1.153 nicm 682: .Em linked
683: into it.
684: Windows may be linked to multiple sessions and are made up of one or
685: more panes,
686: each of which contains a pseudo terminal.
687: Commands for creating, linking and otherwise manipulating windows
688: are covered
689: in the
690: .Sx WINDOWS AND PANES
691: section.
692: .Pp
693: The following commands are available to manage clients and sessions:
1.57 jmc 694: .Bl -tag -width Ds
695: .It Xo Ic attach-session
1.436 nicm 696: .Op Fl dEr
1.372 nicm 697: .Op Fl c Ar working-directory
1.57 jmc 698: .Op Fl t Ar target-session
699: .Xc
700: .D1 (alias: Ic attach )
701: If run from outside
702: .Nm ,
703: create a new client in the current terminal and attach it to
704: .Ar target-session .
705: If used from inside, switch the current client.
706: If
707: .Fl d
708: is specified, any other clients attached to the session are detached.
1.148 nicm 709: .Fl r
710: signifies the client is read-only (only keys bound to the
711: .Ic detach-client
1.242 nicm 712: or
713: .Ic switch-client
714: commands have any effect)
1.13 nicm 715: .Pp
1.57 jmc 716: If no server is started,
717: .Ic attach-session
718: will attempt to start it; this will fail unless sessions are created in the
719: configuration file.
1.217 nicm 720: .Pp
721: The
722: .Ar target-session
723: rules for
724: .Ic attach-session
725: are slightly adjusted: if
726: .Nm
727: needs to select the most recently used session, it will prefer the most
728: recently used
729: .Em unattached
730: session.
1.372 nicm 731: .Pp
732: .Fl c
733: will set the session working directory (used for new windows) to
734: .Ar working-directory .
1.436 nicm 735: .Pp
736: If
737: .Fl E
1.480 nicm 738: is used, the
1.436 nicm 739: .Ic update-environment
740: option will not be applied.
1.211 nicm 741: .It Xo Ic detach-client
1.463 nicm 742: .Op Fl aP
1.525 nicm 743: .Op Fl E Ar shell-command
1.219 nicm 744: .Op Fl s Ar target-session
1.211 nicm 745: .Op Fl t Ar target-client
746: .Xc
1.57 jmc 747: .D1 (alias: Ic detach )
1.218 nicm 748: Detach the current client if bound to a key, the client specified with
749: .Fl t ,
1.258 jmc 750: or all clients currently attached to the session specified by
1.218 nicm 751: .Fl s .
1.296 nicm 752: The
753: .Fl a
754: option kills all but the client given with
755: .Fl t .
1.211 nicm 756: If
757: .Fl P
758: is given, send SIGHUP to the parent process of the client, typically causing it
759: to exit.
1.525 nicm 760: With
761: .Fl E ,
762: run
763: .Ar shell-command
764: to replace the client.
1.57 jmc 765: .It Ic has-session Op Fl t Ar target-session
766: .D1 (alias: Ic has )
767: Report an error and exit with 1 if the specified session does not exist.
768: If it does exist, exit with 0.
769: .It Ic kill-server
770: Kill the
1.1 nicm 771: .Nm
1.57 jmc 772: server and clients and destroy all sessions.
1.369 nicm 773: .It Xo Ic kill-session
1.464 nicm 774: .Op Fl aC
1.297 nicm 775: .Op Fl t Ar target-session
1.369 nicm 776: .Xc
1.57 jmc 777: Destroy the given session, closing any windows linked to it and no other
778: sessions, and detaching all clients attached to it.
1.297 nicm 779: If
780: .Fl a
781: is given, all sessions but the specified one is killed.
1.464 nicm 782: The
783: .Fl C
1.467 nicm 784: flag clears alerts (bell, activity, or silence) in all windows linked to the
1.464 nicm 785: session.
1.250 nicm 786: .It Xo Ic list-clients
787: .Op Fl F Ar format
788: .Op Fl t Ar target-session
789: .Xc
1.57 jmc 790: .D1 (alias: Ic lsc )
1.221 jmc 791: List all clients attached to the server.
1.250 nicm 792: For the meaning of the
793: .Fl F
794: flag, see the
1.252 jmc 795: .Sx FORMATS
796: section.
1.221 jmc 797: If
1.220 nicm 798: .Ar target-session
799: is specified, list only clients connected to that session.
1.489 nicm 800: .It Xo Ic list-commands
801: .Op Fl F Ar format
802: .Xc
1.57 jmc 803: .D1 (alias: Ic lscm )
804: List the syntax of all commands supported by
805: .Nm .
1.247 nicm 806: .It Ic list-sessions Op Fl F Ar format
1.57 jmc 807: .D1 (alias: Ic ls )
808: List all sessions managed by the server.
1.247 nicm 809: For the meaning of the
810: .Fl F
811: flag, see the
812: .Sx FORMATS
813: section.
1.175 nicm 814: .It Ic lock-client Op Fl t Ar target-client
815: .D1 (alias: Ic lockc )
1.92 nicm 816: Lock
817: .Ar target-client ,
818: see the
819: .Ic lock-server
820: command.
1.175 nicm 821: .It Ic lock-session Op Fl t Ar target-session
822: .D1 (alias: Ic locks )
1.92 nicm 823: Lock all clients attached to
824: .Ar target-session .
1.57 jmc 825: .It Xo Ic new-session
1.436 nicm 826: .Op Fl AdDEP
1.371 nicm 827: .Op Fl c Ar start-directory
1.351 nicm 828: .Op Fl F Ar format
1.57 jmc 829: .Op Fl n Ar window-name
830: .Op Fl s Ar session-name
1.536 nicm 831: .Op Fl t Ar group-name
1.210 nicm 832: .Op Fl x Ar width
833: .Op Fl y Ar height
1.153 nicm 834: .Op Ar shell-command
1.57 jmc 835: .Xc
836: .D1 (alias: Ic new )
837: Create a new session with name
838: .Ar session-name .
1.153 nicm 839: .Pp
1.57 jmc 840: The new session is attached to the current terminal unless
841: .Fl d
842: is given.
843: .Ar window-name
1.1 nicm 844: and
1.153 nicm 845: .Ar shell-command
846: are the name of and shell command to execute in the initial window.
1.552 nicm 847: With
848: .Fl d ,
849: the initial size is 80 x 24;
1.210 nicm 850: .Fl x
851: and
852: .Fl y
1.552 nicm 853: can be used to specify a different size.
1.68 nicm 854: .Pp
855: If run from a terminal, any
856: .Xr termios 4
857: special characters are saved and used for new windows in the new session.
1.338 nicm 858: .Pp
859: The
860: .Fl A
861: flag makes
862: .Ic new-session
863: behave like
864: .Ic attach-session
865: if
866: .Ar session-name
1.416 nicm 867: already exists; in this case,
1.338 nicm 868: .Fl D
869: behaves like
870: .Fl d
871: to
872: .Ic attach-session .
1.101 nicm 873: .Pp
874: If
875: .Fl t
1.536 nicm 876: is given, it specifies a
877: .Ic session group .
878: Sessions in the same group share the same set of windows - new windows are
1.537 nicm 879: linked to all sessions in the group and any windows closed removed from all
1.536 nicm 880: sessions.
1.101 nicm 881: The current and previous window and any session options remain independent and
1.536 nicm 882: any session in a group may be killed without affecting the others.
883: The
884: .Ar group-name
885: argument may be:
886: .Bl -enum -width Ds
887: .It
888: the name of an existing group, in which case the new session is added to that
889: group;
890: .It
891: the name of an existing session - the new session is added to the same group
892: as that session, creating a new group if necessary;
893: .It
894: the name for a new group containing only the new session.
895: .El
896: .Pp
1.101 nicm 897: .Fl n
1.480 nicm 898: and
1.153 nicm 899: .Ar shell-command
1.101 nicm 900: are invalid if
901: .Fl t
902: is used.
1.351 nicm 903: .Pp
904: The
905: .Fl P
906: option prints information about the new session after it has been created.
907: By default, it uses the format
908: .Ql #{session_name}:
909: but a different format may be specified with
910: .Fl F .
1.436 nicm 911: .Pp
912: If
913: .Fl E
1.480 nicm 914: is used, the
1.436 nicm 915: .Ic update-environment
916: option will not be applied.
1.248 nicm 917: .It Xo Ic refresh-client
1.535 nicm 918: .Op Fl C Ar width,height
1.248 nicm 919: .Op Fl S
920: .Op Fl t Ar target-client
921: .Xc
1.57 jmc 922: .D1 (alias: Ic refresh )
923: Refresh the current client if bound to a key, or a single client if one is given
924: with
925: .Fl t .
1.248 nicm 926: If
927: .Fl S
1.538 nicm 928: is specified, only update the client's status line.
1.535 nicm 929: .Pp
930: .Fl C
931: sets the width and height of a control client.
1.57 jmc 932: .It Xo Ic rename-session
933: .Op Fl t Ar target-session
934: .Ar new-name
935: .Xc
936: .D1 (alias: Ic rename )
937: Rename the session to
938: .Ar new-name .
1.121 nicm 939: .It Xo Ic show-messages
1.465 nicm 940: .Op Fl JT
1.120 nicm 941: .Op Fl t Ar target-client
942: .Xc
943: .D1 (alias: Ic showmsgs )
1.377 nicm 944: Show client messages or server information.
1.120 nicm 945: Any messages displayed on the status line are saved in a per-client message
946: log, up to a maximum of the limit set by the
947: .Ar message-limit
1.384 nicm 948: server option.
1.377 nicm 949: With
950: .Fl t ,
951: display the log for
1.120 nicm 952: .Ar target-client .
1.377 nicm 953: .Fl J
954: and
955: .Fl T
1.465 nicm 956: show debugging information about jobs and terminals.
1.488 tim 957: .It Xo Ic source-file
958: .Op Fl q
959: .Ar path
960: .Xc
1.57 jmc 961: .D1 (alias: Ic source )
962: Execute commands from
1.519 nicm 963: .Ar path
964: (which may be a
965: .Xr glob 3
966: pattern).
1.488 tim 967: If
968: .Fl q
969: is given, no error will be returned if
970: .Ar path
971: does not exist.
1.521 nicm 972: .Pp
973: Within a configuration file, commands may be made conditional by surrounding
974: them with
975: .Em %if
976: and
977: .Em %endif
978: lines.
979: The argument to
980: .Em %if
981: is expanded as a format and if it evaluates to false
1.522 jmc 982: (zero or empty), subsequent lines are ignored until
1.521 nicm 983: .Em %endif .
984: For example:
985: .Bd -literal -offset indent
986: %if #{==:#{host},myhost}
987: set -g status-style bg=red
988: %endif
989: .Ed
990: .Pp
991: Will change the status line to red if running on
992: .Ql myhost .
993: .Em %if
994: may not be nested.
1.57 jmc 995: .It Ic start-server
996: .D1 (alias: Ic start )
997: Start the
1.1 nicm 998: .Nm
1.57 jmc 999: server, if not already running, without creating any sessions.
1000: .It Xo Ic suspend-client
1.202 nicm 1001: .Op Fl t Ar target-client
1.57 jmc 1002: .Xc
1003: .D1 (alias: Ic suspendc )
1004: Suspend a client by sending
1005: .Dv SIGTSTP
1006: (tty stop).
1007: .It Xo Ic switch-client
1.436 nicm 1008: .Op Fl Elnpr
1.57 jmc 1009: .Op Fl c Ar target-client
1010: .Op Fl t Ar target-session
1.421 nicm 1011: .Op Fl T Ar key-table
1.57 jmc 1012: .Xc
1013: .D1 (alias: Ic switchc )
1014: Switch the current session for client
1015: .Ar target-client
1016: to
1017: .Ar target-session .
1.183 nicm 1018: If
1.197 jmc 1019: .Fl l ,
1.183 nicm 1020: .Fl n
1021: or
1022: .Fl p
1.194 nicm 1023: is used, the client is moved to the last, next or previous session
1024: respectively.
1.242 nicm 1025: .Fl r
1026: toggles whether a client is read-only (see the
1027: .Ic attach-session
1028: command).
1.436 nicm 1029: .Pp
1030: If
1031: .Fl E
1032: is used,
1033: .Ic update-environment
1034: option will not be applied.
1.421 nicm 1035: .Pp
1036: .Fl T
1037: sets the client's key table; the next key from the client will be interpreted from
1038: .Ar key-table .
1039: This may be used to configure multiple prefix keys, or to bind commands to
1040: sequences of keys.
1041: For example, to make typing
1042: .Ql abc
1043: run the
1044: .Ic list-keys
1045: command:
1046: .Bd -literal -offset indent
1047: bind-key -Ttable2 c list-keys
1048: bind-key -Ttable1 b switch-client -Ttable2
1049: bind-key -Troot a switch-client -Ttable1
1050: .Ed
1.57 jmc 1051: .El
1052: .Sh WINDOWS AND PANES
1.1 nicm 1053: A
1054: .Nm
1.493 nicm 1055: window may be in one of two modes.
1.1 nicm 1056: The default permits direct access to the terminal attached to the window.
1.164 nicm 1057: The other is copy mode, which permits a section of a window or its
1058: history to be copied to a
1.1 nicm 1059: .Em paste buffer
1060: for later insertion into another window.
1061: This mode is entered with the
1062: .Ic copy-mode
1063: command, bound to
1.113 nicm 1064: .Ql \&[
1.1 nicm 1065: by default.
1.164 nicm 1066: It is also entered when a command that produces output, such as
1067: .Ic list-keys ,
1068: is executed from a key binding.
1.1 nicm 1069: .Pp
1.497 nicm 1070: Commands are sent to copy mode using the
1071: .Fl X
1072: flag to the
1073: .Ic send-keys
1074: command.
1075: When a key is pressed, copy mode automatically uses one of two key tables,
1076: depending on the
1.1 nicm 1077: .Ic mode-keys
1.497 nicm 1078: option:
1079: .Ic copy-mode
1080: for emacs, or
1081: .Ic copy-mode-vi
1082: for vi.
1083: Key tables may be viewed with the
1084: .Ic list-keys
1085: command.
1086: .Pp
1087: The following commands are supported in copy mode:
1.517 nicm 1088: .Bl -column "CommandXXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXXXXXXXX" "emacs" -offset indent
1.497 nicm 1089: .It Sy "Command" Ta Sy "vi" Ta Sy "emacs"
1090: .It Li "append-selection" Ta "" Ta ""
1091: .It Li "append-selection-and-cancel" Ta "A" Ta ""
1092: .It Li "back-to-indentation" Ta "^" Ta "M-m"
1093: .It Li "begin-selection" Ta "Space" Ta "C-Space"
1094: .It Li "bottom-line" Ta "L" Ta ""
1095: .It Li "cancel" Ta "q" Ta "Escape"
1096: .It Li "clear-selection" Ta "Escape" Ta "C-g"
1097: .It Li "copy-end-of-line" Ta "D" Ta "C-k"
1098: .It Li "copy-line" Ta "" Ta ""
1099: .It Li "copy-pipe <command>" Ta "" Ta ""
1.514 nicm 1100: .It Li "copy-pipe-and-cancel <command>" Ta "" Ta ""
1.497 nicm 1101: .It Li "copy-selection" Ta "" Ta ""
1102: .It Li "copy-selection-and-cancel" Ta "Enter" Ta "M-w"
1103: .It Li "cursor-down" Ta "j" Ta "Down"
1104: .It Li "cursor-left" Ta "h" Ta "Left"
1105: .It Li "cursor-right" Ta "l" Ta "Right"
1106: .It Li "cursor-up" Ta "k" Ta "Up"
1107: .It Li "end-of-line" Ta "$" Ta "C-e"
1108: .It Li "goto-line <line>" Ta ":" Ta "g"
1109: .It Li "halfpage-down" Ta "C-d" Ta "M-Down"
1110: .It Li "halfpage-up" Ta "C-u" Ta "M-Up"
1111: .It Li "history-bottom" Ta "G" Ta "M-<"
1112: .It Li "history-top" Ta "g" Ta "M->"
1113: .It Li "jump-again" Ta ";" Ta ";"
1114: .It Li "jump-backward <to>" Ta "F" Ta "F"
1115: .It Li "jump-forward <to>" Ta "f" Ta "f"
1116: .It Li "jump-reverse" Ta "," Ta ","
1117: .It Li "jump-to-backward <to>" Ta "T" Ta ""
1118: .It Li "jump-to-forward <to>" Ta "t" Ta ""
1119: .It Li "middle-line" Ta "M" Ta "M-r"
1120: .It Li "next-paragraph" Ta "}" Ta "M-}"
1121: .It Li "next-space" Ta "W" Ta ""
1122: .It Li "next-space-end" Ta "E" Ta ""
1123: .It Li "next-word" Ta "w" Ta ""
1124: .It Li "next-word-end" Ta "e" Ta "M-f"
1125: .It Li "other-end" Ta "o" Ta ""
1126: .It Li "page-down" Ta "C-f" Ta "PageDown"
1127: .It Li "page-up" Ta "C-b" Ta "PageUp"
1128: .It Li "previous-paragraph" Ta "{" Ta "M-{"
1129: .It Li "previous-space" Ta "B" Ta ""
1130: .It Li "previous-word" Ta "b" Ta "M-b"
1131: .It Li "rectangle-toggle" Ta "v" Ta "R"
1132: .It Li "scroll-down" Ta "C-e" Ta "C-Down"
1133: .It Li "scroll-up" Ta "C-y" Ta "C-Up"
1134: .It Li "search-again" Ta "n" Ta "n"
1.517 nicm 1135: .It Li "search-backward <for>" Ta "?" Ta ""
1136: .It Li "search-forward <for>" Ta "/" Ta ""
1137: .It Li "search-backward-incremental <for>" Ta "" Ta "C-r"
1138: .It Li "search-forward-incremental <for>" Ta "" Ta "C-s"
1.497 nicm 1139: .It Li "search-reverse" Ta "N" Ta "N"
1140: .It Li "select-line" Ta "V" Ta ""
1141: .It Li "start-of-line" Ta "0" Ta "C-a"
1.515 nicm 1142: .It Li "stop-selection" Ta "" Ta ""
1.497 nicm 1143: .It Li "top-line" Ta "H" Ta "M-R"
1.1 nicm 1144: .El
1.146 nicm 1145: .Pp
1146: The next and previous word keys use space and the
1147: .Ql - ,
1.154 nicm 1148: .Ql _
1.146 nicm 1149: and
1150: .Ql @
1.154 nicm 1151: characters as word delimiters by default, but this can be adjusted by
1152: setting the
1153: .Em word-separators
1.255 nicm 1154: session option.
1.146 nicm 1155: Next word moves to the start of the next word, next word end to the end of the
1156: next word and previous word to the start of the previous word.
1157: The three next and previous space keys work similarly but use a space alone as
1158: the word separator.
1.157 nicm 1159: .Pp
1160: The jump commands enable quick movement within a line.
1161: For instance, typing
1162: .Ql f
1163: followed by
1164: .Ql /
1165: will move the cursor to the next
1166: .Ql /
1167: character on the current line.
1168: A
1169: .Ql \&;
1170: will then jump to the next occurrence.
1.1 nicm 1171: .Pp
1.155 nicm 1172: Commands in copy mode may be prefaced by an optional repeat count.
1173: With vi key bindings, a prefix is entered using the number keys; with
1174: emacs, the Alt (meta) key and a number begins prefix entry.
1175: .Pp
1.164 nicm 1176: The synopsis for the
1177: .Ic copy-mode
1178: command is:
1.57 jmc 1179: .Bl -tag -width Ds
1180: .It Xo Ic copy-mode
1.450 nicm 1181: .Op Fl Meu
1.72 nicm 1182: .Op Fl t Ar target-pane
1.57 jmc 1183: .Xc
1184: Enter copy mode.
1185: The
1186: .Fl u
1187: option scrolls one page up.
1.419 nicm 1188: .Fl M
1189: begins a mouse drag (only valid if bound to a mouse key binding, see
1.420 jmc 1190: .Sx MOUSE SUPPORT ) .
1.450 nicm 1191: .Fl e
1192: specifies that scrolling to the bottom of the history (to the visible screen)
1193: should exit copy mode.
1194: While in copy mode, pressing a key other than those used for scrolling will
1195: disable this behaviour.
1196: This is intended to allow fast scrolling through a pane's history, for
1197: example with:
1198: .Bd -literal -offset indent
1199: bind PageUp copy-mode -eu
1200: .Ed
1.57 jmc 1201: .El
1.18 nicm 1202: .Pp
1.1 nicm 1203: Each window displayed by
1204: .Nm
1205: may be split into one or more
1206: .Em panes ;
1207: each pane takes up a certain area of the display and is a separate terminal.
1208: A window may be split into panes using the
1209: .Ic split-window
1210: command.
1.38 nicm 1211: Windows may be split horizontally (with the
1212: .Fl h
1213: flag) or vertically.
1214: Panes may be resized with the
1215: .Ic resize-pane
1.1 nicm 1216: command (bound to
1.523 nicm 1217: .Ql C-Up ,
1218: .Ql C-Down
1219: .Ql C-Left
1.38 nicm 1220: and
1.523 nicm 1221: .Ql C-Right
1.1 nicm 1222: by default), the current pane may be changed with the
1.156 nicm 1223: .Ic select-pane
1224: command and the
1.1 nicm 1225: .Ic rotate-window
1226: and
1227: .Ic swap-pane
1.38 nicm 1228: commands may be used to swap panes without changing their position.
1229: Panes are numbered beginning from zero in the order they are created.
1230: .Pp
1231: A number of preset
1232: .Em layouts
1233: are available.
1234: These may be selected with the
1235: .Ic select-layout
1236: command or cycled with
1237: .Ic next-layout
1238: (bound to
1.149 nicm 1239: .Ql Space
1.131 nicm 1240: by default); once a layout is chosen, panes within it may be moved and resized
1241: as normal.
1.1 nicm 1242: .Pp
1243: The following layouts are supported:
1244: .Bl -tag -width Ds
1245: .It Ic even-horizontal
1246: Panes are spread out evenly from left to right across the window.
1247: .It Ic even-vertical
1248: Panes are spread evenly from top to bottom.
1.2 nicm 1249: .It Ic main-horizontal
1.131 nicm 1250: A large (main) pane is shown at the top of the window and the remaining panes
1251: are spread from left to right in the leftover space at the bottom.
1.2 nicm 1252: Use the
1253: .Em main-pane-height
1254: window option to specify the height of the top pane.
1.1 nicm 1255: .It Ic main-vertical
1.2 nicm 1256: Similar to
1257: .Ic main-horizontal
1258: but the large pane is placed on the left and the others spread from top to
1259: bottom along the right.
1260: See the
1261: .Em main-pane-width
1262: window option.
1.165 nicm 1263: .It Ic tiled
1264: Panes are spread out as evenly as possible over the window in both rows and
1265: columns.
1.1 nicm 1266: .El
1.8 nicm 1267: .Pp
1.181 nicm 1268: In addition,
1269: .Ic select-layout
1270: may be used to apply a previously used layout - the
1271: .Ic list-windows
1272: command displays the layout of each window in a form suitable for use with
1273: .Ic select-layout .
1274: For example:
1275: .Bd -literal -offset indent
1276: $ tmux list-windows
1277: 0: ksh [159x48]
1278: layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1279: $ tmux select-layout bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1280: .Ed
1.196 nicm 1281: .Pp
1.181 nicm 1282: .Nm
1283: automatically adjusts the size of the layout for the current window size.
1284: Note that a layout cannot be applied to a window with more panes than that
1285: from which the layout was originally defined.
1286: .Pp
1.57 jmc 1287: Commands related to windows and panes are as follows:
1288: .Bl -tag -width Ds
1289: .It Xo Ic break-pane
1.280 nicm 1290: .Op Fl dP
1291: .Op Fl F Ar format
1.532 nicm 1292: .Op Fl n Ar window-name
1.440 nicm 1293: .Op Fl s Ar src-pane
1.480 nicm 1294: .Op Fl t Ar dst-window
1.57 jmc 1295: .Xc
1296: .D1 (alias: Ic breakp )
1297: Break
1.440 nicm 1298: .Ar src-pane
1299: off from its containing window to make it the only pane in
1300: .Ar dst-window .
1.57 jmc 1301: If
1302: .Fl d
1303: is given, the new window does not become the current window.
1.280 nicm 1304: The
1305: .Fl P
1306: option prints information about the new window after it has been created.
1307: By default, it uses the format
1308: .Ql #{session_name}:#{window_index}
1309: but a different format may be specified with
1310: .Fl F .
1.128 nicm 1311: .It Xo Ic capture-pane
1.506 nicm 1312: .Op Fl aepPqCJ
1.392 nicm 1313: .Op Fl b Ar buffer-name
1.213 nicm 1314: .Op Fl E Ar end-line
1315: .Op Fl S Ar start-line
1.128 nicm 1316: .Op Fl t Ar target-pane
1317: .Xc
1318: .D1 (alias: Ic capturep )
1.322 nicm 1319: Capture the contents of a pane.
1320: If
1321: .Fl p
1.325 nicm 1322: is given, the output goes to stdout, otherwise to the buffer specified with
1.322 nicm 1323: .Fl b
1324: or a new buffer if omitted.
1.339 nicm 1325: If
1326: .Fl a
1327: is given, the alternate screen is used, and the history is not accessible.
1.340 nicm 1328: If no alternate screen exists, an error will be returned unless
1329: .Fl q
1330: is given.
1.326 nicm 1331: If
1332: .Fl e
1.328 nicm 1333: is given, the output includes escape sequences for text and background
1334: attributes.
1335: .Fl C
1.330 nicm 1336: also escapes non-printable characters as octal \exxx.
1.328 nicm 1337: .Fl J
1.341 nicm 1338: joins wrapped lines and preserves trailing spaces at each line's end.
1.346 nicm 1339: .Fl P
1340: captures only any output that the pane has received that is the beginning of an
1341: as-yet incomplete escape sequence.
1.213 nicm 1342: .Pp
1343: .Fl S
1344: and
1345: .Fl E
1346: specify the starting and ending line numbers, zero is the first line of the
1347: visible pane and negative numbers are lines in the history.
1.397 nicm 1348: .Ql -
1349: to
1350: .Fl S
1351: is the start of the history and to
1352: .Fl E
1353: the end of the visible pane.
1.213 nicm 1354: The default is to capture only the visible contents of the pane.
1.76 nicm 1355: .It Xo
1356: .Ic choose-client
1.561 ! nicm 1357: .Op Fl O Ar sort-order
1.555 nicm 1358: .Op Fl t Ar target-pane
1.76 nicm 1359: .Op Ar template
1360: .Xc
1.555 nicm 1361: Put a pane into client mode, allowing a client to be selected interactively from
1362: a list.
1363: The following keys may be used in client mode:
1364: .Bl -column "Key" "Function" -offset indent
1365: .It Sy "Key" Ta Sy "Function"
1366: .It Li "Enter" Ta "Choose selected client"
1367: .It Li "Up" Ta "Select previous client"
1368: .It Li "Down" Ta "Select next client"
1.559 nicm 1369: .It Li "C-s" Ta "Search by name"
1370: .It Li "n" Ta "Repeat last search"
1.555 nicm 1371: .It Li "t" Ta "Toggle if client is tagged"
1372: .It Li "T" Ta "Tag no clients"
1373: .It Li "C-t" Ta "Tag all clients"
1374: .It Li "d" Ta "Detach selected client"
1375: .It Li "D" Ta "Detach tagged clients"
1376: .It Li "x" Ta "Detach and HUP selected client"
1377: .It Li "X" Ta "Detach and HUP tagged clients"
1378: .It Li "z" Ta "Suspend selected client"
1379: .It Li "Z" Ta "Suspend tagged clients"
1380: .It Li "O" Ta "Change sort order"
1381: .It Li "q" Ta "Exit mode"
1382: .El
1383: .Pp
1.76 nicm 1384: After a client is chosen,
1385: .Ql %%
1.555 nicm 1386: is replaced by the client name in
1.76 nicm 1387: .Ar template
1388: and the result executed as a command.
1389: If
1390: .Ar template
1391: is not given, "detach-client -t '%%'" is used.
1.555 nicm 1392: .Pp
1.561 ! nicm 1393: .Fl O
! 1394: specifies the initial sort order: one of
! 1395: .Ql name ,
! 1396: .Ql size ,
! 1397: .Ql creation ,
! 1398: or
! 1399: .Ql activity .
1.314 nicm 1400: This command works only if at least one client is attached.
1.76 nicm 1401: .It Xo
1.555 nicm 1402: .Ic choose-tree
1403: .Op Fl sw
1.561 ! nicm 1404: .Op Fl O Ar sort-order
1.555 nicm 1405: .Op Fl t Ar target-pane
1.76 nicm 1406: .Op Ar template
1407: .Xc
1.555 nicm 1408: Put a pane into tree mode, where a session, window or pane may be chosen
1.76 nicm 1409: interactively from a list.
1.298 nicm 1410: .Fl s
1.555 nicm 1411: starts with sessions collapsed and
1.298 nicm 1412: .Fl w
1.555 nicm 1413: with windows collapsed.
1414: The following keys may be used in tree mode:
1415: .Bl -column "Key" "Function" -offset indent
1416: .It Sy "Key" Ta Sy "Function"
1417: .It Li "Enter" Ta "Choose selected item"
1418: .It Li "Up" Ta "Select previous item"
1419: .It Li "Down" Ta "Select next item"
1.559 nicm 1420: .It Li "C-s" Ta "Search by name"
1421: .It Li "n" Ta "Repeat last search"
1.555 nicm 1422: .It Li "t" Ta "Toggle if item is tagged"
1423: .It Li "T" Ta "Tag no items"
1424: .It Li "C-t" Ta "Tag all items"
1.557 nicm 1425: .It Li "\&:" Ta "Run a command for each tagged item"
1.555 nicm 1426: .It Li "f" Ta "Enter a format to filter items"
1427: .It Li "O" Ta "Change sort order"
1428: .It Li "q" Ta "Exit mode"
1429: .El
1.320 nicm 1430: .Pp
1.555 nicm 1431: After a session, window or pane is chosen,
1.76 nicm 1432: .Ql %%
1.555 nicm 1433: is replaced by the target in
1.76 nicm 1434: .Ar template
1435: and the result executed as a command.
1436: If
1437: .Ar template
1.555 nicm 1438: is not given, "switch-client -t '%%'" is used.
1439: .Pp
1.561 ! nicm 1440: .Fl O
! 1441: specifies the initial sort order: one of
! 1442: .Ql index ,
! 1443: .Ql name ,
! 1444: or
! 1445: .Ql time .
1.314 nicm 1446: This command works only if at least one client is attached.
1.491 nicm 1447: .It Xo
1448: .Ic display-panes
1449: .Op Fl t Ar target-client
1450: .Op Ar template
1451: .Xc
1.398 nicm 1452: .D1 (alias: Ic displayp )
1.78 nicm 1453: Display a visible indicator of each pane shown by
1454: .Ar target-client .
1455: See the
1.145 nicm 1456: .Ic display-panes-time ,
1457: .Ic display-panes-colour ,
1.78 nicm 1458: and
1.145 nicm 1459: .Ic display-panes-active-colour
1.78 nicm 1460: session options.
1.491 nicm 1461: While the indicator is on screen, a pane may be chosen with the
1.84 nicm 1462: .Ql 0
1463: to
1464: .Ql 9
1.491 nicm 1465: keys, which will cause
1466: .Ar template
1467: to be executed as a command with
1468: .Ql %%
1469: substituted by the pane ID.
1470: The default
1471: .Ar template
1472: is "select-pane -t '%%'".
1.57 jmc 1473: .It Xo Ic find-window
1.285 nicm 1474: .Op Fl CNT
1.555 nicm 1475: .Op Fl t Ar target-pane
1.57 jmc 1476: .Ar match-string
1477: .Xc
1478: .D1 (alias: Ic findw )
1479: Search for the
1480: .Xr fnmatch 3
1481: pattern
1482: .Ar match-string
1483: in window names, titles, and visible content (but not history).
1.285 nicm 1484: The flags control matching behavior:
1485: .Fl C
1486: matches only visible window contents,
1487: .Fl N
1488: matches only the window name and
1489: .Fl T
1490: matches only the window title.
1491: The default is
1492: .Fl CNT .
1.555 nicm 1493: .Pp
1.314 nicm 1494: This command works only if at least one client is attached.
1.137 nicm 1495: .It Xo Ic join-pane
1.277 nicm 1496: .Op Fl bdhv
1.137 nicm 1497: .Oo Fl l
1498: .Ar size |
1499: .Fl p Ar percentage Oc
1500: .Op Fl s Ar src-pane
1501: .Op Fl t Ar dst-pane
1502: .Xc
1503: .D1 (alias: Ic joinp )
1504: Like
1505: .Ic split-window ,
1506: but instead of splitting
1507: .Ar dst-pane
1508: and creating a new pane, split it and move
1509: .Ar src-pane
1510: into the space.
1511: This can be used to reverse
1512: .Ic break-pane .
1.277 nicm 1513: The
1514: .Fl b
1515: option causes
1516: .Ar src-pane
1517: to be joined to left of or above
1518: .Ar dst-pane .
1.432 nicm 1519: .Pp
1520: If
1521: .Fl s
1522: is omitted and a marked pane is present (see
1523: .Ic select-pane
1524: .Fl m ) ,
1525: the marked pane is used rather than the current pane.
1.112 nicm 1526: .It Xo Ic kill-pane
1527: .Op Fl a
1528: .Op Fl t Ar target-pane
1529: .Xc
1.57 jmc 1530: .D1 (alias: Ic killp )
1531: Destroy the given pane.
1532: If no panes remain in the containing window, it is also destroyed.
1.112 nicm 1533: The
1534: .Fl a
1535: option kills all but the pane given with
1536: .Fl t .
1.289 nicm 1537: .It Xo Ic kill-window
1538: .Op Fl a
1539: .Op Fl t Ar target-window
1540: .Xc
1.57 jmc 1541: .D1 (alias: Ic killw )
1542: Kill the current window or the window at
1543: .Ar target-window ,
1.1 nicm 1544: removing it from any sessions to which it is linked.
1.289 nicm 1545: The
1546: .Fl a
1547: option kills all but the window given with
1548: .Fl t .
1.398 nicm 1549: .It Xo Ic last-pane
1550: .Op Fl de
1551: .Op Fl t Ar target-window
1552: .Xc
1.187 nicm 1553: .D1 (alias: Ic lastp )
1554: Select the last (previously selected) pane.
1.398 nicm 1555: .Fl e
1556: enables or
1557: .Fl d
1558: disables input to the pane.
1.56 jmc 1559: .It Ic last-window Op Fl t Ar target-session
1.1 nicm 1560: .D1 (alias: Ic last )
1561: Select the last (previously selected) window.
1562: If no
1563: .Ar target-session
1564: is specified, select the last window of the current session.
1565: .It Xo Ic link-window
1.439 nicm 1566: .Op Fl adk
1.1 nicm 1567: .Op Fl s Ar src-window
1568: .Op Fl t Ar dst-window
1569: .Xc
1570: .D1 (alias: Ic linkw )
1571: Link the window at
1572: .Ar src-window
1573: to the specified
1574: .Ar dst-window .
1575: If
1576: .Ar dst-window
1577: is specified and no such window exists, the
1578: .Ar src-window
1579: is linked there.
1.439 nicm 1580: With
1581: .Fl a ,
1582: the window is moved to the next index up (following windows
1583: are moved if necessary).
1.1 nicm 1584: If
1585: .Fl k
1586: is given and
1587: .Ar dst-window
1588: exists, it is killed, otherwise an error is generated.
1589: If
1590: .Fl d
1591: is given, the newly linked window is not selected.
1.214 nicm 1592: .It Xo Ic list-panes
1593: .Op Fl as
1.245 nicm 1594: .Op Fl F Ar format
1.214 nicm 1595: .Op Fl t Ar target
1596: .Xc
1.104 nicm 1597: .D1 (alias: Ic lsp )
1.214 nicm 1598: If
1599: .Fl a
1600: is given,
1601: .Ar target
1602: is ignored and all panes on the server are listed.
1603: If
1604: .Fl s
1605: is given,
1606: .Ar target
1607: is a session (or the current session).
1608: If neither is given,
1609: .Ar target
1610: is a window (or the current window).
1.247 nicm 1611: For the meaning of the
1612: .Fl F
1613: flag, see the
1614: .Sx FORMATS
1615: section.
1.214 nicm 1616: .It Xo Ic list-windows
1617: .Op Fl a
1.245 nicm 1618: .Op Fl F Ar format
1.214 nicm 1619: .Op Fl t Ar target-session
1620: .Xc
1.1 nicm 1621: .D1 (alias: Ic lsw )
1.214 nicm 1622: If
1623: .Fl a
1624: is given, list all windows on the server.
1625: Otherwise, list windows in the current session or in
1.1 nicm 1626: .Ar target-session .
1.245 nicm 1627: For the meaning of the
1628: .Fl F
1629: flag, see the
1630: .Sx FORMATS
1631: section.
1.277 nicm 1632: .It Xo Ic move-pane
1633: .Op Fl bdhv
1634: .Oo Fl l
1635: .Ar size |
1636: .Fl p Ar percentage Oc
1637: .Op Fl s Ar src-pane
1638: .Op Fl t Ar dst-pane
1639: .Xc
1640: .D1 (alias: Ic movep )
1641: Like
1642: .Ic join-pane ,
1643: but
1644: .Ar src-pane
1645: and
1646: .Ar dst-pane
1647: may belong to the same window.
1.1 nicm 1648: .It Xo Ic move-window
1.439 nicm 1649: .Op Fl ardk
1.1 nicm 1650: .Op Fl s Ar src-window
1651: .Op Fl t Ar dst-window
1652: .Xc
1653: .D1 (alias: Ic movew )
1654: This is similar to
1655: .Ic link-window ,
1656: except the window at
1657: .Ar src-window
1658: is moved to
1659: .Ar dst-window .
1.291 nicm 1660: With
1661: .Fl r ,
1662: all windows in the session are renumbered in sequential order, respecting
1663: the
1664: .Ic base-index
1665: option.
1.1 nicm 1666: .It Xo Ic new-window
1.201 nicm 1667: .Op Fl adkP
1.272 nicm 1668: .Op Fl c Ar start-directory
1.351 nicm 1669: .Op Fl F Ar format
1.1 nicm 1670: .Op Fl n Ar window-name
1671: .Op Fl t Ar target-window
1.153 nicm 1672: .Op Ar shell-command
1.1 nicm 1673: .Xc
1674: .D1 (alias: Ic neww )
1675: Create a new window.
1.160 nicm 1676: With
1677: .Fl a ,
1678: the new window is inserted at the next index up from the specified
1679: .Ar target-window ,
1680: moving windows up if necessary,
1681: otherwise
1682: .Ar target-window
1683: is the new window location.
1684: .Pp
1.1 nicm 1685: If
1686: .Fl d
1687: is given, the session does not make the new window the current window.
1688: .Ar target-window
1.28 nicm 1689: represents the window to be created; if the target already exists an error is
1690: shown, unless the
1691: .Fl k
1692: flag is used, in which case it is destroyed.
1.153 nicm 1693: .Ar shell-command
1.1 nicm 1694: is the command to execute.
1695: If
1.153 nicm 1696: .Ar shell-command
1697: is not specified, the value of the
1698: .Ic default-command
1699: option is used.
1.272 nicm 1700: .Fl c
1701: specifies the working directory in which the new window is created.
1.153 nicm 1702: .Pp
1703: When the shell command completes, the window closes.
1704: See the
1705: .Ic remain-on-exit
1706: option to change this behaviour.
1.1 nicm 1707: .Pp
1708: The
1709: .Ev TERM
1710: environment variable must be set to
1.523 nicm 1711: .Ql screen
1712: or
1713: .Ql tmux
1.1 nicm 1714: for all programs running
1715: .Em inside
1716: .Nm .
1717: New windows will automatically have
1.523 nicm 1718: .Ql TERM=screen
1.1 nicm 1719: added to their environment, but care must be taken not to reset this in shell
1720: start-up files.
1.201 nicm 1721: .Pp
1722: The
1723: .Fl P
1.279 nicm 1724: option prints information about the new window after it has been created.
1725: By default, it uses the format
1726: .Ql #{session_name}:#{window_index}
1727: but a different format may be specified with
1728: .Fl F .
1.56 jmc 1729: .It Ic next-layout Op Fl t Ar target-window
1.1 nicm 1730: .D1 (alias: Ic nextl )
1731: Move a window to the next layout and rearrange the panes to fit.
1732: .It Xo Ic next-window
1.9 nicm 1733: .Op Fl a
1.1 nicm 1734: .Op Fl t Ar target-session
1735: .Xc
1736: .D1 (alias: Ic next )
1737: Move to the next window in the session.
1.9 nicm 1738: If
1.12 jmc 1739: .Fl a
1.295 nicm 1740: is used, move to the next window with an alert.
1.107 nicm 1741: .It Xo Ic pipe-pane
1742: .Op Fl o
1743: .Op Fl t Ar target-pane
1.153 nicm 1744: .Op Ar shell-command
1.107 nicm 1745: .Xc
1746: .D1 (alias: Ic pipep )
1747: Pipe any output sent by the program in
1748: .Ar target-pane
1749: to a shell command.
1750: A pane may only be piped to one command at a time, any existing pipe is
1751: closed before
1.153 nicm 1752: .Ar shell-command
1.107 nicm 1753: is executed.
1.174 nicm 1754: The
1755: .Ar shell-command
1756: string may contain the special character sequences supported by the
1757: .Ic status-left
1.231 nicm 1758: option.
1.107 nicm 1759: If no
1.153 nicm 1760: .Ar shell-command
1.107 nicm 1761: is given, the current pipe (if any) is closed.
1762: .Pp
1763: The
1764: .Fl o
1765: option only opens a new pipe if no previous pipe exists, allowing a pipe to
1766: be toggled with a single key, for example:
1767: .Bd -literal -offset indent
1.174 nicm 1768: bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
1.107 nicm 1769: .Ed
1.176 nicm 1770: .It Xo Ic previous-layout
1771: .Op Fl t Ar target-window
1772: .Xc
1773: .D1 (alias: Ic prevl )
1774: Move to the previous layout in the session.
1.1 nicm 1775: .It Xo Ic previous-window
1.9 nicm 1776: .Op Fl a
1.1 nicm 1777: .Op Fl t Ar target-session
1778: .Xc
1779: .D1 (alias: Ic prev )
1780: Move to the previous window in the session.
1.9 nicm 1781: With
1782: .Fl a ,
1.295 nicm 1783: move to the previous window with an alert.
1.1 nicm 1784: .It Xo Ic rename-window
1785: .Op Fl t Ar target-window
1786: .Ar new-name
1787: .Xc
1788: .D1 (alias: Ic renamew )
1789: Rename the current window, or the window at
1790: .Ar target-window
1791: if specified, to
1792: .Ar new-name .
1793: .It Xo Ic resize-pane
1.419 nicm 1794: .Op Fl DLMRUZ
1.52 nicm 1795: .Op Fl t Ar target-pane
1.324 nicm 1796: .Op Fl x Ar width
1797: .Op Fl y Ar height
1.1 nicm 1798: .Op Ar adjustment
1799: .Xc
1800: .D1 (alias: Ic resizep )
1.324 nicm 1801: Resize a pane, up, down, left or right by
1802: .Ar adjustment
1803: with
1804: .Fl U ,
1.57 jmc 1805: .Fl D ,
1806: .Fl L
1.324 nicm 1807: or
1808: .Fl R ,
1809: or
1810: to an absolute size
1811: with
1812: .Fl x
1813: or
1814: .Fl y .
1.57 jmc 1815: The
1816: .Ar adjustment
1817: is given in lines or cells (the default is 1).
1.337 nicm 1818: .Pp
1819: With
1820: .Fl Z ,
1.349 nicm 1821: the active pane is toggled between zoomed (occupying the whole of the window)
1822: and unzoomed (its normal position in the layout).
1.419 nicm 1823: .Pp
1824: .Fl M
1825: begins mouse resizing (only valid if bound to a mouse key binding, see
1.420 jmc 1826: .Sx MOUSE SUPPORT ) .
1.234 nicm 1827: .It Xo Ic respawn-pane
1828: .Op Fl k
1829: .Op Fl t Ar target-pane
1830: .Op Ar shell-command
1831: .Xc
1832: .D1 (alias: Ic respawnp )
1833: Reactivate a pane in which the command has exited (see the
1834: .Ic remain-on-exit
1835: window option).
1836: If
1837: .Ar shell-command
1838: is not given, the command used when the pane was created is executed.
1839: The pane must be already inactive, unless
1840: .Fl k
1841: is given, in which case any existing command is killed.
1.57 jmc 1842: .It Xo Ic respawn-window
1843: .Op Fl k
1844: .Op Fl t Ar target-window
1.153 nicm 1845: .Op Ar shell-command
1.57 jmc 1846: .Xc
1847: .D1 (alias: Ic respawnw )
1.153 nicm 1848: Reactivate a window in which the command has exited (see the
1.57 jmc 1849: .Ic remain-on-exit
1850: window option).
1851: If
1.153 nicm 1852: .Ar shell-command
1.57 jmc 1853: is not given, the command used when the window was created is executed.
1854: The window must be already inactive, unless
1855: .Fl k
1856: is given, in which case any existing command is killed.
1857: .It Xo Ic rotate-window
1858: .Op Fl DU
1859: .Op Fl t Ar target-window
1860: .Xc
1861: .D1 (alias: Ic rotatew )
1862: Rotate the positions of the panes within a window, either upward (numerically
1863: lower) with
1864: .Fl U
1865: or downward (numerically higher).
1866: .It Xo Ic select-layout
1.424 nicm 1867: .Op Fl nop
1.57 jmc 1868: .Op Fl t Ar target-window
1869: .Op Ar layout-name
1870: .Xc
1.176 nicm 1871: .D1 (alias: Ic selectl )
1.57 jmc 1872: Choose a specific layout for a window.
1873: If
1874: .Ar layout-name
1.181 nicm 1875: is not given, the last preset layout used (if any) is reapplied.
1.204 nicm 1876: .Fl n
1877: and
1878: .Fl p
1879: are equivalent to the
1880: .Ic next-layout
1881: and
1882: .Ic previous-layout
1883: commands.
1.424 nicm 1884: .Fl o
1885: applies the last set layout if possible (undoes the most recent layout change).
1.156 nicm 1886: .It Xo Ic select-pane
1.432 nicm 1887: .Op Fl DdegLlMmRU
1.418 nicm 1888: .Op Fl P Ar style
1.156 nicm 1889: .Op Fl t Ar target-pane
1890: .Xc
1.57 jmc 1891: .D1 (alias: Ic selectp )
1892: Make pane
1893: .Ar target-pane
1894: the active pane in window
1.418 nicm 1895: .Ar target-window ,
1.420 jmc 1896: or set its style (with
1.418 nicm 1897: .Fl P ) .
1.156 nicm 1898: If one of
1899: .Fl D ,
1900: .Fl L ,
1901: .Fl R ,
1902: or
1903: .Fl U
1904: is used, respectively the pane below, to the left, to the right, or above the
1905: target pane is used.
1.204 nicm 1906: .Fl l
1907: is the same as using the
1908: .Ic last-pane
1909: command.
1.398 nicm 1910: .Fl e
1911: enables or
1912: .Fl d
1913: disables input to the pane.
1.418 nicm 1914: .Pp
1.432 nicm 1915: .Fl m
1916: and
1917: .Fl M
1918: are used to set and clear the
1919: .Em marked pane .
1920: There is one marked pane at a time, setting a new marked pane clears the last.
1921: The marked pane is the default target for
1922: .Fl s
1923: to
1924: .Ic join-pane ,
1925: .Ic swap-pane
1926: and
1927: .Ic swap-window .
1928: .Pp
1.418 nicm 1929: Each pane has a style: by default the
1930: .Ic window-style
1931: and
1932: .Ic window-active-style
1933: options are used,
1934: .Ic select-pane
1935: .Fl P
1936: sets the style for a single pane.
1937: For example, to set the pane 1 background to red:
1938: .Bd -literal -offset indent
1939: select-pane -t:.1 -P 'bg=red'
1940: .Ed
1941: .Pp
1942: .Fl g
1943: shows the current pane style.
1.204 nicm 1944: .It Xo Ic select-window
1.310 nicm 1945: .Op Fl lnpT
1.204 nicm 1946: .Op Fl t Ar target-window
1947: .Xc
1.57 jmc 1948: .D1 (alias: Ic selectw )
1949: Select the window at
1950: .Ar target-window .
1.204 nicm 1951: .Fl l ,
1952: .Fl n
1953: and
1954: .Fl p
1955: are equivalent to the
1956: .Ic last-window ,
1957: .Ic next-window
1958: and
1959: .Ic previous-window
1960: commands.
1.310 nicm 1961: If
1962: .Fl T
1963: is given and the selected window is already the current window,
1964: the command behaves like
1965: .Ic last-window .
1.57 jmc 1966: .It Xo Ic split-window
1.502 nicm 1967: .Op Fl bdfhvP
1.272 nicm 1968: .Op Fl c Ar start-directory
1.57 jmc 1969: .Oo Fl l
1970: .Ar size |
1971: .Fl p Ar percentage Oc
1.136 nicm 1972: .Op Fl t Ar target-pane
1.153 nicm 1973: .Op Ar shell-command
1.279 nicm 1974: .Op Fl F Ar format
1.57 jmc 1975: .Xc
1.176 nicm 1976: .D1 (alias: Ic splitw )
1.136 nicm 1977: Create a new pane by splitting
1978: .Ar target-pane :
1.57 jmc 1979: .Fl h
1980: does a horizontal split and
1981: .Fl v
1982: a vertical split; if neither is specified,
1983: .Fl v
1984: is assumed.
1985: The
1986: .Fl l
1987: and
1988: .Fl p
1.136 nicm 1989: options specify the size of the new pane in lines (for vertical split) or in
1.57 jmc 1990: cells (for horizontal split), or as a percentage, respectively.
1.408 nicm 1991: The
1992: .Fl b
1993: option causes the new pane to be created to the left of or above
1994: .Ar target-pane .
1.494 nicm 1995: The
1996: .Fl f
1997: option creates a new pane spanning the full window height (with
1998: .Fl h )
1999: or full window width (with
2000: .Fl v ) ,
2001: instead of splitting the active pane.
1.136 nicm 2002: All other options have the same meaning as for the
1.57 jmc 2003: .Ic new-window
2004: command.
2005: .It Xo Ic swap-pane
2006: .Op Fl dDU
2007: .Op Fl s Ar src-pane
2008: .Op Fl t Ar dst-pane
2009: .Xc
2010: .D1 (alias: Ic swapp )
2011: Swap two panes.
2012: If
2013: .Fl U
2014: is used and no source pane is specified with
2015: .Fl s ,
2016: .Ar dst-pane
2017: is swapped with the previous pane (before it numerically);
2018: .Fl D
2019: swaps with the next pane (after it numerically).
1.138 nicm 2020: .Fl d
2021: instructs
2022: .Nm
2023: not to change the active pane.
1.432 nicm 2024: .Pp
2025: If
2026: .Fl s
2027: is omitted and a marked pane is present (see
2028: .Ic select-pane
2029: .Fl m ) ,
2030: the marked pane is used rather than the current pane.
1.57 jmc 2031: .It Xo Ic swap-window
2032: .Op Fl d
2033: .Op Fl s Ar src-window
2034: .Op Fl t Ar dst-window
2035: .Xc
2036: .D1 (alias: Ic swapw )
2037: This is similar to
2038: .Ic link-window ,
2039: except the source and destination windows are swapped.
2040: It is an error if no window exists at
2041: .Ar src-window .
1.432 nicm 2042: .Pp
2043: Like
2044: .Ic swap-pane ,
2045: if
2046: .Fl s
2047: is omitted and a marked pane is present (see
2048: .Ic select-pane
2049: .Fl m ) ,
2050: the window containing the marked pane is used rather than the current window.
1.57 jmc 2051: .It Xo Ic unlink-window
1.1 nicm 2052: .Op Fl k
2053: .Op Fl t Ar target-window
2054: .Xc
1.57 jmc 2055: .D1 (alias: Ic unlinkw )
2056: Unlink
2057: .Ar target-window .
2058: Unless
2059: .Fl k
2060: is given, a window may be unlinked only if it is linked to multiple sessions -
2061: windows may not be linked to no sessions;
2062: if
1.1 nicm 2063: .Fl k
1.57 jmc 2064: is specified and the window is linked to only one session, it is unlinked and
2065: destroyed.
2066: .El
2067: .Sh KEY BINDINGS
1.93 nicm 2068: .Nm
2069: allows a command to be bound to most keys, with or without a prefix key.
2070: When specifying keys, most represent themselves (for example
2071: .Ql A
2072: to
1.95 jmc 2073: .Ql Z ) .
1.93 nicm 2074: Ctrl keys may be prefixed with
2075: .Ql C-
2076: or
1.95 jmc 2077: .Ql ^ ,
2078: and Alt (meta) with
1.93 nicm 2079: .Ql M- .
2080: In addition, the following special key names are accepted:
1.126 nicm 2081: .Em Up ,
2082: .Em Down ,
2083: .Em Left ,
2084: .Em Right ,
1.93 nicm 2085: .Em BSpace ,
2086: .Em BTab ,
2087: .Em DC
2088: (Delete),
2089: .Em End ,
2090: .Em Enter ,
2091: .Em Escape ,
2092: .Em F1
2093: to
1.402 nicm 2094: .Em F12 ,
1.93 nicm 2095: .Em Home ,
2096: .Em IC
2097: (Insert),
1.254 nicm 2098: .Em NPage/PageDown/PgDn ,
2099: .Em PPage/PageUp/PgUp ,
1.93 nicm 2100: .Em Space ,
2101: and
2102: .Em Tab .
2103: Note that to bind the
2104: .Ql \&"
2105: or
2106: .Ql '
2107: keys, quotation marks are necessary, for example:
2108: .Bd -literal -offset indent
2109: bind-key '"' split-window
1.167 nicm 2110: bind-key "'" new-window
1.93 nicm 2111: .Ed
2112: .Pp
1.57 jmc 2113: Commands related to key bindings are as follows:
2114: .Bl -tag -width Ds
2115: .It Xo Ic bind-key
1.501 nicm 2116: .Op Fl nr
1.421 nicm 2117: .Op Fl T Ar key-table
1.57 jmc 2118: .Ar key Ar command Op Ar arguments
1.1 nicm 2119: .Xc
1.57 jmc 2120: .D1 (alias: Ic bind )
2121: Bind key
2122: .Ar key
2123: to
2124: .Ar command .
1.421 nicm 2125: Keys are bound in a key table.
2126: By default (without -T), the key is bound in
2127: the
2128: .Em prefix
2129: key table.
2130: This table is used for keys pressed after the prefix key (for example,
2131: by default
2132: .Ql c
2133: is bound to
2134: .Ic new-window
2135: in the
2136: .Em prefix
2137: table, so
2138: .Ql C-b c
2139: creates a new window).
2140: The
2141: .Em root
2142: table is used for keys pressed without the prefix key: binding
2143: .Ql c
2144: to
2145: .Ic new-window
2146: in the
2147: .Em root
2148: table (not recommended) means a plain
2149: .Ql c
2150: will create a new window.
1.57 jmc 2151: .Fl n
1.421 nicm 2152: is an alias
2153: for
2154: .Fl T Ar root .
2155: Keys may also be bound in custom key tables and the
2156: .Ic switch-client
2157: .Fl T
2158: command used to switch to them from a key binding.
1.1 nicm 2159: The
1.57 jmc 2160: .Fl r
2161: flag indicates this key may repeat, see the
2162: .Ic repeat-time
2163: option.
2164: .Pp
2165: To view the default bindings and possible commands, see the
2166: .Ic list-keys
2167: command.
1.421 nicm 2168: .It Xo Ic list-keys
2169: .Op Fl T Ar key-table
2170: .Xc
1.57 jmc 2171: .D1 (alias: Ic lsk )
2172: List all key bindings.
2173: Without
1.421 nicm 2174: .Fl T
2175: all key tables are printed.
2176: With
2177: .Fl T
2178: only
2179: .Ar key-table .
1.57 jmc 2180: .It Xo Ic send-keys
1.497 nicm 2181: .Op Fl lMRX
2182: .Op Fl N Ar repeat-count
1.72 nicm 2183: .Op Fl t Ar target-pane
1.57 jmc 2184: .Ar key Ar ...
1.1 nicm 2185: .Xc
1.57 jmc 2186: .D1 (alias: Ic send )
2187: Send a key or keys to a window.
2188: Each argument
2189: .Ar key
2190: is the name of the key (such as
2191: .Ql C-a
2192: or
1.523 nicm 2193: .Ql NPage )
2194: to send; if the string is not recognised as a key, it is sent as a series of
1.57 jmc 2195: characters.
1.273 nicm 2196: The
2197: .Fl l
2198: flag disables key name lookup and sends the keys literally.
1.57 jmc 2199: All arguments are sent sequentially from first to last.
1.265 nicm 2200: The
2201: .Fl R
2202: flag causes the terminal state to be reset.
1.419 nicm 2203: .Pp
2204: .Fl M
2205: passes through a mouse event (only valid if bound to a mouse key binding, see
1.420 jmc 2206: .Sx MOUSE SUPPORT ) .
1.497 nicm 2207: .Pp
2208: .Fl X
2209: is used to send a command into copy mode - see
2210: the
2211: .Sx WINDOWS AND PANES
2212: section.
2213: .Fl N
1.516 nicm 2214: specifies a repeat count.
1.267 nicm 2215: .It Xo Ic send-prefix
2216: .Op Fl 2
2217: .Op Fl t Ar target-pane
2218: .Xc
2219: Send the prefix key, or with
2220: .Fl 2
2221: the secondary prefix key, to a window as if it was pressed.
1.57 jmc 2222: .It Xo Ic unbind-key
1.501 nicm 2223: .Op Fl an
1.421 nicm 2224: .Op Fl T Ar key-table
1.57 jmc 2225: .Ar key
1.2 nicm 2226: .Xc
1.57 jmc 2227: .D1 (alias: Ic unbind )
2228: Unbind the command bound to
2229: .Ar key .
1.530 nicm 2230: .Fl n
2231: and
1.421 nicm 2232: .Fl T
2233: are the same as for
2234: .Ic bind-key .
1.189 nicm 2235: If
2236: .Fl a
2237: is present, all key bindings are removed.
1.57 jmc 2238: .El
2239: .Sh OPTIONS
2240: The appearance and behaviour of
2241: .Nm
2242: may be modified by changing the value of various options.
1.133 nicm 2243: There are three types of option:
2244: .Em server options ,
1.57 jmc 2245: .Em session options
2246: and
2247: .Em window options .
2248: .Pp
1.133 nicm 2249: The
2250: .Nm
2251: server has a set of global options which do not apply to any particular
2252: window or session.
2253: These are altered with the
2254: .Ic set-option
2255: .Fl s
2256: command, or displayed with the
2257: .Ic show-options
2258: .Fl s
2259: command.
2260: .Pp
2261: In addition, each individual session may have a set of session options, and
2262: there is a separate set of global session options.
1.57 jmc 2263: Sessions which do not have a particular option configured inherit the value
2264: from the global session options.
2265: Session options are set or unset with the
2266: .Ic set-option
2267: command and may be listed with the
2268: .Ic show-options
2269: command.
1.133 nicm 2270: The available server and session options are listed under the
1.57 jmc 2271: .Ic set-option
2272: command.
2273: .Pp
2274: Similarly, a set of window options is attached to each window, and there is
2275: a set of global window options from which any unset options are inherited.
2276: Window options are altered with the
2277: .Ic set-window-option
2278: command and can be listed with the
2279: .Ic show-window-options
2280: command.
2281: All window options are documented with the
2282: .Ic set-window-option
2283: command.
1.318 nicm 2284: .Pp
2285: .Nm
2286: also supports user options which are prefixed with a
2287: .Ql \&@ .
1.321 jmc 2288: User options may have any name, so long as they are prefixed with
2289: .Ql \&@ ,
1.318 nicm 2290: and be set to any string.
1.418 nicm 2291: For example:
1.318 nicm 2292: .Bd -literal -offset indent
2293: $ tmux setw -q @foo "abc123"
2294: $ tmux showw -v @foo
2295: abc123
2296: .Ed
1.57 jmc 2297: .Pp
2298: Commands which set options are as follows:
2299: .Bl -tag -width Ds
1.1 nicm 2300: .It Xo Ic set-option
1.550 nicm 2301: .Op Fl aFgoqsuw
1.129 nicm 2302: .Op Fl t Ar target-session | Ar target-window
1.1 nicm 2303: .Ar option Ar value
2304: .Xc
2305: .D1 (alias: Ic set )
1.133 nicm 2306: Set a window option with
2307: .Fl w
2308: (equivalent to the
2309: .Ic set-window-option
2310: command),
2311: a server option with
2312: .Fl s ,
2313: otherwise a session option.
2314: If
2315: .Fl g
1.433 nicm 2316: is given, the global session or window option is set.
1.550 nicm 2317: .Fl F
2318: expands formats in the option value.
1.1 nicm 2319: The
2320: .Fl u
2321: flag unsets an option, so a session inherits the option from the global
1.433 nicm 2322: options (or with
2323: .Fl g ,
2324: restores a global option to the default).
1.336 nicm 2325: .Pp
2326: The
2327: .Fl o
1.446 nicm 2328: flag prevents setting an option that is already set and the
1.281 nicm 2329: .Fl q
1.446 nicm 2330: flag suppresses errors about unknown or ambiguous options.
1.281 nicm 2331: .Pp
1.378 nicm 2332: With
2333: .Fl a ,
2334: and if the option expects a string or a style,
2335: .Ar value
2336: is appended to the existing setting.
2337: For example:
2338: .Bd -literal -offset indent
2339: set -g status-left "foo"
2340: set -ag status-left "bar"
2341: .Ed
2342: .Pp
2343: Will result in
2344: .Ql foobar .
2345: And:
2346: .Bd -literal -offset indent
2347: set -g status-style "bg=red"
2348: set -ag status-style "fg=blue"
2349: .Ed
2350: .Pp
2351: Will result in a red background
2352: .Em and
2353: blue foreground.
2354: Without
2355: .Fl a ,
2356: the result would be the default background and a blue foreground.
2357: .Pp
1.133 nicm 2358: Available window options are listed under
2359: .Ic set-window-option .
1.274 nicm 2360: .Pp
2361: .Ar value
2362: depends on the option and may be a number, a string, or a flag (on, off, or
2363: omitted to toggle).
1.133 nicm 2364: .Pp
2365: Available server options are:
2366: .Bl -tag -width Ds
1.198 nicm 2367: .It Ic buffer-limit Ar number
2368: Set the number of buffers; as new buffers are added to the top of the stack,
2369: old ones are removed from the bottom if necessary to maintain this maximum
2370: length.
1.526 nicm 2371: .It Xo Ic command-alias[]
2372: .Ar name=value
2373: .Xc
2374: This is an array of custom aliases for commands.
2375: If an unknown command matches
2376: .Ar name ,
2377: it is replaced with
2378: .Ar value .
2379: For example, after:
2380: .Pp
2381: .Dl set -s command-alias[2] zoom='resize-pane -Z'
2382: .Pp
2383: Using:
2384: .Pp
2385: .Dl zoom -t:.1
2386: .Pp
2387: Is equivalent to:
2388: .Pp
2389: .Dl resize-pane -Z -t:.1
2390: .Pp
2391: Note that aliases are expanded when a command is parsed rather than when it is
2392: executed, so binding an alias with
2393: .Ic bind-key
2394: will bind the expanded form.
1.425 nicm 2395: .It Ic default-terminal Ar terminal
2396: Set the default terminal for new windows created in this session - the
2397: default value of the
2398: .Ev TERM
2399: environment variable.
2400: For
2401: .Nm
2402: to work correctly, this
2403: .Em must
2404: be set to
2405: .Ql screen ,
2406: .Ql tmux
2407: or a derivative of them.
1.239 nicm 2408: .It Ic escape-time Ar time
2409: Set the time in milliseconds for which
2410: .Nm
2411: waits after an escape is input to determine if it is part of a function or meta
2412: key sequences.
2413: The default is 500 milliseconds.
2414: .It Xo Ic exit-unattached
2415: .Op Ic on | off
2416: .Xc
2417: If enabled, the server will exit when there are no attached clients.
1.362 nicm 2418: .It Xo Ic focus-events
2419: .Op Ic on | off
2420: .Xc
2421: When enabled, focus events are requested from the terminal if supported and
2422: passed through to applications running in
2423: .Nm .
2424: Attached clients should be detached and attached again after changing this
2425: option.
1.445 nicm 2426: .It Ic history-file Ar path
2427: If not empty, a file to which
2428: .Nm
2429: will write command prompt history on exit and load it from on start.
1.384 nicm 2430: .It Ic message-limit Ar number
2431: Set the number of error or information messages to save in the message log for
2432: each client.
2433: The default is 100.
1.228 nicm 2434: .It Xo Ic set-clipboard
1.556 nicm 2435: .Op Ic on | external | off
1.228 nicm 2436: .Xc
2437: Attempt to set the terminal clipboard content using the
2438: .Xr xterm 1
1.560 nicm 2439: escape sequence, if there is an
1.228 nicm 2440: .Em \&Ms
2441: entry in the
2442: .Xr terminfo 5
1.560 nicm 2443: description (see the
2444: .Sx TERMINFO EXTENSIONS
2445: section).
2446: .Pp
1.556 nicm 2447: If set to
2448: .Ic on ,
2449: .Nm
2450: will both accept the escape sequence to create a buffer and attempt to set
2451: the terminal clipboard.
2452: If set to
2453: .Ic external ,
2454: .Nm
2455: will attempt to set the terminal clipboard but ignore attempts
2456: by applications to set
2457: .Nm
2458: buffers.
2459: If
2460: .Ic off ,
2461: .Nm
2462: will neither accept the clipboard escape sequence nor attempt to set the
2463: clipboard.
2464: .Pp
1.228 nicm 2465: Note that this feature needs to be enabled in
2466: .Xr xterm 1
2467: by setting the resource:
2468: .Bd -literal -offset indent
2469: disallowedWindowOps: 20,21,SetXprop
2470: .Ed
2471: .Pp
2472: Or changing this property from the
2473: .Xr xterm 1
2474: interactive menu when required.
1.528 nicm 2475: .It Ic terminal-overrides[] Ar string
2476: Allow terminal descriptions read using
2477: .Xr terminfo 5
1.531 nicm 2478: to be overridden.
1.528 nicm 2479: Each entry is a colon-separated string made up of a terminal type pattern
2480: (matched using
1.381 nicm 2481: .Xr fnmatch 3 )
2482: and a set of
2483: .Em name=value
2484: entries.
2485: .Pp
2486: For example, to set the
2487: .Ql clear
2488: .Xr terminfo 5
2489: entry to
2490: .Ql \ee[H\ee[2J
1.528 nicm 2491: for all terminal types matching
2492: .Ql rxvt* :
2493: .Pp
2494: .Dl "rxvt*:clear=\ee[H\ee[2J"
1.381 nicm 2495: .Pp
2496: The terminal entry value is passed through
2497: .Xr strunvis 3
2498: before interpretation.
1.133 nicm 2499: .El
1.129 nicm 2500: .Pp
1.18 nicm 2501: Available session options are:
1.1 nicm 2502: .Bl -tag -width Ds
1.312 nicm 2503: .It Ic assume-paste-time Ar milliseconds
2504: If keys are entered faster than one in
2505: .Ar milliseconds ,
2506: they are assumed to have been pasted rather than typed and
2507: .Nm
2508: key bindings are not processed.
2509: The default is one millisecond and zero disables.
1.69 nicm 2510: .It Ic base-index Ar index
2511: Set the base index from which an unused index should be searched when a new
2512: window is created.
2513: The default is zero.
1.1 nicm 2514: .It Xo Ic bell-action
1.429 nicm 2515: .Op Ic any | none | current | other
1.1 nicm 2516: .Xc
2517: Set action on window bell.
2518: .Ic any
2519: means a bell in any window linked to a session causes a bell in the current
2520: window of that session,
2521: .Ic none
1.429 nicm 2522: means all bells are ignored,
1.1 nicm 2523: .Ic current
1.429 nicm 2524: means only bells in windows other than the current window are ignored and
2525: .Ic other
2526: means bells in the current window are ignored but not those in other windows.
1.237 nicm 2527: .It Xo Ic bell-on-alert
2528: .Op Ic on | off
2529: .Xc
1.295 nicm 2530: If on, ring the terminal bell when an alert
1.237 nicm 2531: occurs.
1.153 nicm 2532: .It Ic default-command Ar shell-command
1.1 nicm 2533: Set the command used for new windows (if not specified when the window is
2534: created) to
1.153 nicm 2535: .Ar shell-command ,
1.79 nicm 2536: which may be any
2537: .Xr sh 1
2538: command.
1.19 nicm 2539: The default is an empty string, which instructs
2540: .Nm
1.79 nicm 2541: to create a login shell using the value of the
2542: .Ic default-shell
2543: option.
2544: .It Ic default-shell Ar path
2545: Specify the default shell.
2546: This is used as the login shell for new windows when the
2547: .Ic default-command
2548: option is set to empty, and must be the full path of the executable.
2549: When started
2550: .Nm
2551: tries to set a default value from the first suitable of the
1.19 nicm 2552: .Ev SHELL
1.79 nicm 2553: environment variable, the shell returned by
2554: .Xr getpwuid 3 ,
2555: or
2556: .Pa /bin/sh .
2557: This option should be configured when
2558: .Nm
2559: is used as a login shell.
1.206 nicm 2560: .It Xo Ic destroy-unattached
2561: .Op Ic on | off
2562: .Xc
1.185 nicm 2563: If enabled and the session is no longer attached to any clients, it is
2564: destroyed.
1.206 nicm 2565: .It Xo Ic detach-on-destroy
2566: .Op Ic on | off
2567: .Xc
1.184 nicm 2568: If on (the default), the client is detached when the session it is attached to
2569: is destroyed.
2570: If off, the client is switched to the most recently active of the remaining
2571: sessions.
1.145 nicm 2572: .It Ic display-panes-active-colour Ar colour
2573: Set the colour used by the
2574: .Ic display-panes
2575: command to show the indicator for the active pane.
1.78 nicm 2576: .It Ic display-panes-colour Ar colour
1.145 nicm 2577: Set the colour used by the
1.78 nicm 2578: .Ic display-panes
1.145 nicm 2579: command to show the indicators for inactive panes.
1.78 nicm 2580: .It Ic display-panes-time Ar time
2581: Set the time in milliseconds for which the indicators shown by the
2582: .Ic display-panes
2583: command appear.
1.21 nicm 2584: .It Ic display-time Ar time
1.78 nicm 2585: Set the amount of time for which status line messages and other on-screen
2586: indicators are displayed.
1.462 tim 2587: If set to 0, messages and indicators are displayed until a key is pressed.
1.21 nicm 2588: .Ar time
2589: is in milliseconds.
1.1 nicm 2590: .It Ic history-limit Ar lines
2591: Set the maximum number of lines held in window history.
2592: This setting applies only to new windows - existing window histories are not
2593: resized and retain the limit at the point they were created.
1.474 nicm 2594: .It Ic key-table Ar key-table
2595: Set the default key table to
2596: .Ar key-table
2597: instead of
2598: .Em root .
1.1 nicm 2599: .It Ic lock-after-time Ar number
1.100 nicm 2600: Lock the session (like the
2601: .Ic lock-session
1.90 nicm 2602: command) after
1.1 nicm 2603: .Ar number
1.448 nicm 2604: seconds of inactivity.
1.100 nicm 2605: The default is not to lock (set to 0).
1.153 nicm 2606: .It Ic lock-command Ar shell-command
1.90 nicm 2607: Command to run when locking each client.
2608: The default is to run
2609: .Xr lock 1
2610: with
2611: .Fl np .
1.378 nicm 2612: .It Ic message-command-style Ar style
2613: Set status line message command style, where
2614: .Ar style
2615: is a comma-separated list of characteristics to be specified.
2616: .Pp
2617: These may be
2618: .Ql bg=colour
2619: to set the background colour,
2620: .Ql fg=colour
2621: to set the foreground colour, and a list of attributes as specified below.
2622: .Pp
2623: The colour is one of:
1.1 nicm 2624: .Ic black ,
2625: .Ic red ,
2626: .Ic green ,
2627: .Ic yellow ,
2628: .Ic blue ,
2629: .Ic magenta ,
2630: .Ic cyan ,
1.85 nicm 2631: .Ic white ,
1.266 nicm 2632: aixterm bright variants (if supported:
2633: .Ic brightred ,
2634: .Ic brightgreen ,
2635: and so on),
1.85 nicm 2636: .Ic colour0
2637: to
2638: .Ic colour255
1.205 nicm 2639: from the 256-colour set,
2640: .Ic default ,
2641: or a hexadecimal RGB string such as
2642: .Ql #ffffff ,
2643: which chooses the closest match from the default 256-colour set.
1.378 nicm 2644: .Pp
2645: The attributes is either
2646: .Ic none
2647: or a comma-delimited list of one or more of:
2648: .Ic bright
2649: (or
2650: .Ic bold ) ,
2651: .Ic dim ,
2652: .Ic underscore ,
2653: .Ic blink ,
2654: .Ic reverse ,
2655: .Ic hidden ,
1.539 nicm 2656: .Ic italics ,
1.378 nicm 2657: or
1.539 nicm 2658: .Ic strikethrough
1.378 nicm 2659: to turn an attribute on, or an attribute prefixed with
2660: .Ql no
2661: to turn one off.
2662: .Pp
2663: Examples are:
2664: .Bd -literal -offset indent
2665: fg=yellow,bold,underscore,blink
2666: bg=black,fg=default,noreverse
2667: .Ed
2668: .Pp
2669: With the
2670: .Fl a
2671: flag to the
2672: .Ic set-option
2673: command the new style is added otherwise the existing style is replaced.
2674: .It Ic message-style Ar style
2675: Set status line message style.
2676: For how to specify
2677: .Ar style ,
2678: see the
2679: .Ic message-command-style
2680: option.
1.419 nicm 2681: .It Xo Ic mouse
1.226 nicm 2682: .Op Ic on | off
2683: .Xc
2684: If on,
2685: .Nm
1.419 nicm 2686: captures the mouse and allows mouse events to be bound as key bindings.
2687: See the
2688: .Sx MOUSE SUPPORT
2689: section for details.
1.267 nicm 2690: .It Ic prefix Ar key
2691: Set the key accepted as a prefix key.
1.473 nicm 2692: In addition to the standard keys described under
2693: .Sx KEY BINDINGS ,
2694: .Ic prefix
2695: can be set to the special key
2696: .Ql None
2697: to set no prefix.
1.267 nicm 2698: .It Ic prefix2 Ar key
2699: Set a secondary key accepted as a prefix key.
1.473 nicm 2700: Like
2701: .Ic prefix ,
2702: .Ic prefix2
2703: can be set to
2704: .Ql None .
1.291 nicm 2705: .It Xo Ic renumber-windows
2706: .Op Ic on | off
2707: .Xc
2708: If on, when a window is closed in a session, automatically renumber the other
2709: windows in numerical order.
2710: This respects the
2711: .Ic base-index
2712: option if it has been set.
2713: If off, do not renumber the windows.
1.21 nicm 2714: .It Ic repeat-time Ar time
1.1 nicm 2715: Allow multiple commands to be entered without pressing the prefix-key again
2716: in the specified
1.21 nicm 2717: .Ar time
1.1 nicm 2718: milliseconds (the default is 500).
2719: Whether a key repeats may be set when it is bound using the
2720: .Fl r
2721: flag to
2722: .Ic bind-key .
1.52 nicm 2723: Repeat is enabled for the default keys bound to the
2724: .Ic resize-pane
2725: command.
1.1 nicm 2726: .It Xo Ic set-titles
1.56 jmc 2727: .Op Ic on | off
1.1 nicm 2728: .Xc
1.261 nicm 2729: Attempt to set the client terminal title using the
2730: .Em tsl
2731: and
2732: .Em fsl
2733: .Xr terminfo 5
2734: entries if they exist.
2735: .Nm
1.444 nicm 2736: automatically sets these to the \ee]0;...\e007 sequence if
2737: the terminal appears to be
2738: .Xr xterm 1 .
1.11 nicm 2739: This option is off by default.
1.86 nicm 2740: .It Ic set-titles-string Ar string
2741: String used to set the window title if
2742: .Ic set-titles
2743: is on.
1.414 nicm 2744: Formats are expanded, see the
2745: .Sx FORMATS
2746: section.
1.1 nicm 2747: .It Xo Ic status
1.56 jmc 2748: .Op Ic on | off
1.1 nicm 2749: .Xc
2750: Show or hide the status line.
2751: .It Ic status-interval Ar interval
1.538 nicm 2752: Update the status line every
1.1 nicm 2753: .Ar interval
2754: seconds.
2755: By default, updates will occur every 15 seconds.
2756: A setting of zero disables redrawing at interval.
1.41 nicm 2757: .It Xo Ic status-justify
1.56 jmc 2758: .Op Ic left | centre | right
1.41 nicm 2759: .Xc
2760: Set the position of the window list component of the status line: left, centre
2761: or right justified.
1.1 nicm 2762: .It Xo Ic status-keys
1.56 jmc 2763: .Op Ic vi | emacs
1.1 nicm 2764: .Xc
1.6 jmc 2765: Use vi or emacs-style
1.1 nicm 2766: key bindings in the status line, for example at the command prompt.
1.191 nicm 2767: The default is emacs, unless the
2768: .Ev VISUAL
2769: or
2770: .Ev EDITOR
2771: environment variables are set and contain the string
2772: .Ql vi .
1.1 nicm 2773: .It Ic status-left Ar string
2774: Display
2775: .Ar string
1.538 nicm 2776: (by default the session name) to the left of the status line.
1.1 nicm 2777: .Ar string
2778: will be passed through
2779: .Xr strftime 3
1.359 nicm 2780: and formats (see
1.379 jmc 2781: .Sx FORMATS )
1.359 nicm 2782: will be expanded.
1.486 jmc 2783: It may also contain the special character sequence #[] to change the colour
1.485 nicm 2784: or attributes, for example
2785: .Ql #[fg=red,bright]
2786: to set a bright red foreground.
2787: See the
2788: .Ic message-command-style
2789: option for a description of colours and attributes.
1.83 nicm 2790: .Pp
1.263 nicm 2791: For details on how the names and titles can be set see the
1.261 nicm 2792: .Sx "NAMES AND TITLES"
2793: section.
1.109 nicm 2794: .Pp
1.83 nicm 2795: Examples are:
2796: .Bd -literal -offset indent
2797: #(sysctl vm.loadavg)
2798: #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
2799: .Ed
1.10 nicm 2800: .Pp
1.405 nicm 2801: The default is
2802: .Ql "[#S] " .
1.1 nicm 2803: .It Ic status-left-length Ar length
2804: Set the maximum
2805: .Ar length
1.538 nicm 2806: of the left component of the status line.
1.1 nicm 2807: The default is 10.
1.378 nicm 2808: .It Ic status-left-style Ar style
2809: Set the style of the left part of the status line.
2810: For how to specify
2811: .Ar style ,
2812: see the
2813: .Ic message-command-style
2814: option.
1.269 nicm 2815: .It Xo Ic status-position
2816: .Op Ic top | bottom
2817: .Xc
2818: Set the position of the status line.
1.1 nicm 2819: .It Ic status-right Ar string
2820: Display
2821: .Ar string
1.538 nicm 2822: to the right of the status line.
1.151 nicm 2823: By default, the current window title in double quotes, the date and the time
2824: are shown.
1.1 nicm 2825: As with
2826: .Ic status-left ,
2827: .Ar string
2828: will be passed to
1.459 jmc 2829: .Xr strftime 3
2830: and character pairs are replaced.
1.1 nicm 2831: .It Ic status-right-length Ar length
2832: Set the maximum
2833: .Ar length
1.538 nicm 2834: of the right component of the status line.
1.1 nicm 2835: The default is 40.
1.378 nicm 2836: .It Ic status-right-style Ar style
2837: Set the style of the right part of the status line.
2838: For how to specify
2839: .Ar style ,
2840: see the
2841: .Ic message-command-style
2842: option.
2843: .It Ic status-style Ar style
2844: Set status line style.
2845: For how to specify
2846: .Ar style ,
2847: see the
2848: .Ic message-command-style
2849: option.
1.529 nicm 2850: .It Ic update-environment[] Ar variable
2851: Set list of environment variables to be copied into the session environment
2852: when a new session is created or an existing session is attached.
1.63 nicm 2853: Any variables that do not exist in the source environment are set to be
2854: removed from the session environment (as if
2855: .Fl r
2856: was given to the
2857: .Ic set-environment
2858: command).
1.37 nicm 2859: .It Xo Ic visual-activity
1.56 jmc 2860: .Op Ic on | off
1.37 nicm 2861: .Xc
2862: If on, display a status line message when activity occurs in a window
1.39 jmc 2863: for which the
1.37 nicm 2864: .Ic monitor-activity
2865: window option is enabled.
2866: .It Xo Ic visual-bell
1.56 jmc 2867: .Op Ic on | off
1.37 nicm 2868: .Xc
2869: If this option is on, a message is shown on a bell instead of it being passed
2870: through to the terminal (which normally makes a sound).
2871: Also see the
2872: .Ic bell-action
2873: option.
1.192 nicm 2874: .It Xo Ic visual-silence
2875: .Op Ic on | off
2876: .Xc
2877: If
2878: .Ic monitor-silence
2879: is enabled, prints a message after the interval has expired on a given window.
1.255 nicm 2880: .It Ic word-separators Ar string
2881: Sets the session's conception of what characters are considered word
2882: separators, for the purposes of the next and previous word commands in
2883: copy mode.
2884: The default is
2885: .Ql \ -_@ .
1.1 nicm 2886: .El
2887: .It Xo Ic set-window-option
1.550 nicm 2888: .Op Fl aFgoqu
1.1 nicm 2889: .Op Fl t Ar target-window
2890: .Ar option Ar value
2891: .Xc
2892: .D1 (alias: Ic setw )
1.18 nicm 2893: Set a window option.
1.1 nicm 2894: The
1.58 nicm 2895: .Fl a ,
1.550 nicm 2896: .Fl F ,
1.281 nicm 2897: .Fl g ,
1.356 nicm 2898: .Fl o ,
1.281 nicm 2899: .Fl q
1.1 nicm 2900: and
2901: .Fl u
2902: flags work similarly to the
2903: .Ic set-option
2904: command.
2905: .Pp
1.18 nicm 2906: Supported window options are:
1.56 jmc 2907: .Pp
2908: .Bl -tag -width Ds -compact
1.1 nicm 2909: .It Xo Ic aggressive-resize
1.56 jmc 2910: .Op Ic on | off
1.1 nicm 2911: .Xc
2912: Aggressively resize the chosen window.
2913: This means that
2914: .Nm
2915: will resize the window to the size of the smallest session for which it is the
2916: current window, rather than the smallest session to which it is attached.
2917: The window may resize when the current window is changed on another sessions;
1.6 jmc 2918: this option is good for full-screen programs which support
2919: .Dv SIGWINCH
2920: and poor for interactive programs such as shells.
1.262 nicm 2921: .Pp
2922: .It Xo Ic allow-rename
2923: .Op Ic on | off
2924: .Xc
2925: Allow programs to change the window name using a terminal escape
1.478 nicm 2926: sequence (\eek...\ee\e\e).
1.262 nicm 2927: The default is on.
1.56 jmc 2928: .Pp
1.196 nicm 2929: .It Xo Ic alternate-screen
2930: .Op Ic on | off
2931: .Xc
2932: This option configures whether programs running inside
2933: .Nm
2934: may use the terminal alternate screen feature, which allows the
2935: .Em smcup
2936: and
2937: .Em rmcup
2938: .Xr terminfo 5
1.209 nicm 2939: capabilities.
2940: The alternate screen feature preserves the contents of the window when an
2941: interactive application starts and restores it on exit, so that any output
2942: visible before the application starts reappears unchanged after it exits.
2943: The default is on.
1.196 nicm 2944: .Pp
1.1 nicm 2945: .It Xo Ic automatic-rename
1.56 jmc 2946: .Op Ic on | off
1.1 nicm 2947: .Xc
2948: Control automatic window renaming.
2949: When this setting is enabled,
2950: .Nm
1.368 nicm 2951: will rename the window automatically using the format specified by
2952: .Ic automatic-rename-format .
1.1 nicm 2953: This flag is automatically disabled for an individual window when a name
2954: is specified at creation with
1.186 nicm 2955: .Ic new-window
2956: or
1.1 nicm 2957: .Ic new-session ,
2958: or later with
1.261 nicm 2959: .Ic rename-window ,
2960: or with a terminal escape sequence.
1.1 nicm 2961: It may be switched off globally with:
2962: .Bd -literal -offset indent
2963: set-window-option -g automatic-rename off
2964: .Ed
1.368 nicm 2965: .Pp
2966: .It Ic automatic-rename-format Ar format
2967: The format (see
2968: .Sx FORMATS )
2969: used when the
2970: .Ic automatic-rename
2971: option is enabled.
1.56 jmc 2972: .Pp
1.1 nicm 2973: .It Ic clock-mode-colour Ar colour
2974: Set clock colour.
1.56 jmc 2975: .Pp
1.1 nicm 2976: .It Xo Ic clock-mode-style
1.56 jmc 2977: .Op Ic 12 | 24
1.1 nicm 2978: .Xc
2979: Set clock hour format.
1.56 jmc 2980: .Pp
1.1 nicm 2981: .It Ic force-height Ar height
2982: .It Ic force-width Ar width
2983: Prevent
2984: .Nm
2985: from resizing a window to greater than
2986: .Ar width
2987: or
2988: .Ar height .
2989: A value of zero restores the default unlimited setting.
1.56 jmc 2990: .Pp
1.196 nicm 2991: .It Ic main-pane-height Ar height
1.2 nicm 2992: .It Ic main-pane-width Ar width
2993: Set the width or height of the main (left or top) pane in the
2994: .Ic main-horizontal
2995: or
2996: .Ic main-vertical
2997: layouts.
1.56 jmc 2998: .Pp
1.1 nicm 2999: .It Xo Ic mode-keys
1.56 jmc 3000: .Op Ic vi | emacs
1.1 nicm 3001: .Xc
1.500 nicm 3002: Use vi or emacs-style key bindings in copy mode.
3003: The default is emacs, unless
1.191 nicm 3004: .Ev VISUAL
3005: or
3006: .Ev EDITOR
3007: contains
3008: .Ql vi .
1.56 jmc 3009: .Pp
1.378 nicm 3010: .It Ic mode-style Ar style
3011: Set window modes style.
3012: For how to specify
3013: .Ar style ,
3014: see the
3015: .Ic message-command-style
3016: option.
3017: .Pp
1.1 nicm 3018: .It Xo Ic monitor-activity
1.56 jmc 3019: .Op Ic on | off
1.1 nicm 3020: .Xc
3021: Monitor for activity in the window.
3022: Windows with activity are highlighted in the status line.
1.56 jmc 3023: .Pp
1.192 nicm 3024: .It Xo Ic monitor-silence
3025: .Op Ic interval
3026: .Xc
3027: Monitor for silence (no activity) in the window within
3028: .Ic interval
3029: seconds.
3030: Windows that have been silent for the interval are highlighted in the
3031: status line.
3032: An interval of zero disables the monitoring.
1.195 nicm 3033: .Pp
3034: .It Ic other-pane-height Ar height
3035: Set the height of the other panes (not the main pane) in the
3036: .Ic main-horizontal
3037: layout.
3038: If this option is set to 0 (the default), it will have no effect.
3039: If both the
3040: .Ic main-pane-height
3041: and
3042: .Ic other-pane-height
3043: options are set, the main pane will grow taller to make the other panes the
3044: specified height, but will never shrink to do so.
3045: .Pp
3046: .It Ic other-pane-width Ar width
3047: Like
3048: .Ic other-pane-height ,
3049: but set the width of other panes in the
3050: .Ic main-vertical
3051: layout.
1.243 nicm 3052: .Pp
1.413 nicm 3053: .It Ic pane-active-border-style Ar style
3054: Set the pane border style for the currently active pane.
3055: For how to specify
3056: .Ar style ,
3057: see the
3058: .Ic message-command-style
3059: option.
3060: Attributes are ignored.
3061: .Pp
1.243 nicm 3062: .It Ic pane-base-index Ar index
3063: Like
3064: .Ic base-index ,
3065: but set the starting index for pane numbers.
1.484 nicm 3066: .Pp
3067: .It Ic pane-border-format Ar format
3068: Set the text shown in pane border status lines.
3069: .Pp
3070: .It Xo Ic pane-border-status
3071: .Op Ic off | top | bottom
3072: .Xc
3073: Turn pane border status lines off or set their position.
1.413 nicm 3074: .Pp
3075: .It Ic pane-border-style Ar style
3076: Set the pane border style for panes aside from the active pane.
3077: For how to specify
3078: .Ar style ,
3079: see the
3080: .Ic message-command-style
3081: option.
3082: Attributes are ignored.
1.192 nicm 3083: .Pp
1.1 nicm 3084: .It Xo Ic remain-on-exit
1.56 jmc 3085: .Op Ic on | off
1.1 nicm 3086: .Xc
3087: A window with this flag set is not destroyed when the program running in it
3088: exits.
3089: The window may be reactivated with the
3090: .Ic respawn-window
3091: command.
1.56 jmc 3092: .Pp
1.99 nicm 3093: .It Xo Ic synchronize-panes
3094: .Op Ic on | off
3095: .Xc
1.164 nicm 3096: Duplicate input to any pane to all other panes in the same window (only
3097: for panes that are not in any special mode).
1.56 jmc 3098: .Pp
1.418 nicm 3099: .It Ic window-active-style Ar style
3100: Set the style for the window's active pane.
3101: For how to specify
3102: .Ar style ,
3103: see the
3104: .Ic message-command-style
3105: option.
3106: .Pp
1.378 nicm 3107: .It Ic window-status-activity-style Ar style
3108: Set status line style for windows with an activity alert.
3109: For how to specify
3110: .Ar style ,
3111: see the
3112: .Ic message-command-style
3113: option.
1.169 nicm 3114: .Pp
1.378 nicm 3115: .It Ic window-status-bell-style Ar style
3116: Set status line style for windows with a bell alert.
3117: For how to specify
3118: .Ar style ,
3119: see the
3120: .Ic message-command-style
3121: option.
1.169 nicm 3122: .Pp
1.125 nicm 3123: .It Ic window-status-current-format Ar string
3124: Like
3125: .Ar window-status-format ,
3126: but is the format used when the window is the current window.
1.307 nicm 3127: .Pp
1.378 nicm 3128: .It Ic window-status-current-style Ar style
3129: Set status line style for the currently active window.
3130: For how to specify
3131: .Ar style ,
3132: see the
3133: .Ic message-command-style
3134: option.
1.239 nicm 3135: .Pp
3136: .It Ic window-status-format Ar string
3137: Set the format in which the window is displayed in the status line window list.
3138: See the
3139: .Ar status-left
3140: option for details of special character sequences available.
3141: The default is
3142: .Ql #I:#W#F .
1.290 nicm 3143: .Pp
1.378 nicm 3144: .It Ic window-status-last-style Ar style
3145: Set status line style for the last active window.
3146: For how to specify
3147: .Ar style ,
3148: see the
3149: .Ic message-command-style
3150: option.
3151: .Pp
1.290 nicm 3152: .It Ic window-status-separator Ar string
3153: Sets the separator drawn between windows in the status line.
3154: The default is a single space character.
1.125 nicm 3155: .Pp
1.378 nicm 3156: .It Ic window-status-style Ar style
3157: Set status line style for a single window.
1.418 nicm 3158: For how to specify
3159: .Ar style ,
3160: see the
3161: .Ic message-command-style
3162: option.
3163: .Pp
3164: .It Ic window-style Ar style
3165: Set the default window style.
1.378 nicm 3166: For how to specify
3167: .Ar style ,
3168: see the
3169: .Ic message-command-style
3170: option.
3171: .Pp
1.512 nicm 3172: .It Xo Ic wrap-search
3173: .Op Ic on | off
3174: .Xc
3175: If this option is set, searches will wrap around the end of the pane contents.
3176: The default is on.
1.513 nicm 3177: .Pp
1.1 nicm 3178: .It Xo Ic xterm-keys
1.56 jmc 3179: .Op Ic on | off
1.1 nicm 3180: .Xc
3181: If this option is set,
3182: .Nm
3183: will generate
1.57 jmc 3184: .Xr xterm 1 -style
3185: function key sequences; these have a number included to indicate modifiers such
3186: as Shift, Alt or Ctrl.
3187: .El
3188: .It Xo Ic show-options
1.340 nicm 3189: .Op Fl gqsvw
1.129 nicm 3190: .Op Fl t Ar target-session | Ar target-window
1.276 nicm 3191: .Op Ar option
1.57 jmc 3192: .Xc
3193: .D1 (alias: Ic show )
1.276 nicm 3194: Show the window options (or a single window option if given) with
1.129 nicm 3195: .Fl w
1.133 nicm 3196: (equivalent to
1.134 nicm 3197: .Ic show-window-options ) ,
1.133 nicm 3198: the server options with
3199: .Fl s ,
3200: otherwise the session options for
3201: .Ar target session .
3202: Global session or window options are listed if
3203: .Fl g
3204: is used.
1.317 nicm 3205: .Fl v
3206: shows only the option value, not the name.
1.340 nicm 3207: If
3208: .Fl q
3209: is set, no error will be returned if
3210: .Ar option
3211: is unset.
1.57 jmc 3212: .It Xo Ic show-window-options
1.317 nicm 3213: .Op Fl gv
1.57 jmc 3214: .Op Fl t Ar target-window
1.276 nicm 3215: .Op Ar option
1.57 jmc 3216: .Xc
3217: .D1 (alias: Ic showw )
1.276 nicm 3218: List the window options or a single option for
1.57 jmc 3219: .Ar target-window ,
3220: or the global window options if
3221: .Fl g
3222: is used.
1.317 nicm 3223: .Fl v
3224: shows only the option value, not the name.
1.63 nicm 3225: .El
1.469 nicm 3226: .Sh HOOKS
3227: .Nm
3228: allows commands to run on various triggers, called
3229: .Em hooks .
1.505 nicm 3230: Most
1.483 nicm 3231: .Nm
1.505 nicm 3232: commands have an
1.483 nicm 3233: .Em after
3234: hook and there are a number of hooks not associated with commands.
3235: .Pp
1.505 nicm 3236: A command's after
3237: hook is run after it completes, except when the command is run as part of a hook
1.483 nicm 3238: itself.
1.505 nicm 3239: They are named with an
1.483 nicm 3240: .Ql after-
3241: prefix.
3242: For example, the following command adds a hook to select the even-vertical
3243: layout after every
3244: .Ic split-window :
3245: .Bd -literal -offset indent
3246: set-hook after-split-window "selectl even-vertical"
3247: .Ed
3248: .Pp
3249: In addition, the following hooks are available:
1.560 nicm 3250: .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXX"
1.476 nicm 3251: .It alert-activity
3252: Run when a window has activity.
3253: See
3254: .Ic monitor-activity .
3255: .It alert-bell
3256: Run when a window has received a bell.
3257: .It alert-silence
3258: Run when a window has been silent.
3259: See
3260: .Ic monitor-silence .
1.469 nicm 3261: .It client-attached
3262: Run when a client is attached.
3263: .It client-detached
3264: Run when a client is detached
3265: .It client-resized
3266: Run when a client is resized.
1.511 nicm 3267: .It client-session-changed
3268: Run when a client's attached session is changed.
1.475 nicm 3269: .It pane-died
3270: Run when the program running in a pane exits, but
3271: .Ic remain-on-exit
3272: is on so the pane has not closed.
3273: .It pane-exited
3274: Run when the program running in a pane exits.
1.560 nicm 3275: .It pane-set-clipboard
3276: Run when the terminal clipboard is set using the
3277: .Xr xterm 1
3278: escape sequence.
1.510 nicm 3279: .It session-created
3280: Run when a new session created.
3281: .It session-closed
3282: Run when a session closed.
1.507 nicm 3283: .It session-renamed
3284: Run when a session is renamed.
1.511 nicm 3285: .It window-linked
3286: Run when a window is linked into a session.
1.507 nicm 3287: .It window-renamed
3288: Run when a window is renamed.
1.511 nicm 3289: .It window-unlinked
3290: Run when a window is unlinked from a session.
1.469 nicm 3291: .El
3292: .Pp
3293: Hooks are managed with these commands:
3294: .Bl -tag -width Ds
3295: .It Xo Ic set-hook
1.496 nicm 3296: .Op Fl gu
1.469 nicm 3297: .Op Fl t Ar target-session
3298: .Ar hook-name
3299: .Ar command
3300: .Xc
1.496 nicm 3301: Sets (or with
3302: .Fl u
3303: unsets) hook
1.469 nicm 3304: .Ar hook-name
3305: to
3306: .Ar command .
3307: If
3308: .Fl g
3309: is given,
3310: .Em hook-name
3311: is added to the global list of hooks, otherwise it is added to the session
3312: hooks (for
3313: .Ar target-session
3314: with
3315: .Fl t ) .
3316: Like options, session hooks inherit from the global ones.
3317: .It Xo Ic show-hooks
3318: .Op Fl g
3319: .Op Fl t Ar target-session
3320: .Xc
3321: Shows the global list of hooks with
3322: .Fl g ,
3323: otherwise the session hooks.
1.470 jmc 3324: .El
1.419 nicm 3325: .Sh MOUSE SUPPORT
3326: If the
3327: .Ic mouse
3328: option is on (the default is off),
3329: .Nm
3330: allows mouse events to be bound as keys.
3331: The name of each key is made up of a mouse event (such as
3332: .Ql MouseUp1 )
3333: and a location suffix (one of
3334: .Ql Pane
3335: for the contents of a pane,
3336: .Ql Border
3337: for a pane border or
3338: .Ql Status
3339: for the status line).
3340: The following mouse events are available:
3341: .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
1.498 nicm 3342: .It Li "WheelUp" Ta "WheelDown" Ta ""
1.481 nicm 3343: .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
3344: .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
3345: .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
1.498 nicm 3346: .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3" Ta "WheelUp"
3347: .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3" Ta "WheelDown"
1.419 nicm 3348: .El
3349: .Pp
3350: Each should be suffixed with a location, for example
3351: .Ql MouseDown1Status .
3352: .Pp
1.423 nicm 3353: The special token
3354: .Ql {mouse}
3355: or
1.419 nicm 3356: .Ql =
3357: may be used as
3358: .Ar target-window
3359: or
3360: .Ar target-pane
3361: in commands bound to mouse key bindings.
3362: It resolves to the window or pane over which the mouse event took place
3363: (for example, the window in the status line over which button 1 was released for a
3364: .Ql MouseUp1Status
3365: binding, or the pane over which the wheel was scrolled for a
3366: .Ql WheelDownPane
3367: binding).
3368: .Pp
3369: The
3370: .Ic send-keys
3371: .Fl M
3372: flag may be used to forward a mouse event to a pane.
3373: .Pp
3374: The default key bindings allow the mouse to be used to select and resize panes,
3375: to copy text and to change window using the status line.
3376: These take effect if the
3377: .Ic mouse
3378: option is turned on.
1.245 nicm 3379: .Sh FORMATS
1.294 nicm 3380: Certain commands accept the
1.245 nicm 3381: .Fl F
3382: flag with a
3383: .Ar format
3384: argument.
3385: This is a string which controls the output format of the command.
3386: Replacement variables are enclosed in
3387: .Ql #{
3388: and
3389: .Ql } ,
3390: for example
1.359 nicm 3391: .Ql #{session_name} .
1.409 nicm 3392: The possible variables are listed in the table below, or the name of a
3393: .Nm
3394: option may be used for an option's value.
3395: Some variables have a shorter alias such as
3396: .Ql #S ,
3397: and
1.376 nicm 3398: .Ql ##
3399: is replaced by a single
3400: .Ql # .
1.409 nicm 3401: .Pp
3402: Conditionals are available by prefixing with
1.246 jmc 3403: .Ql \&?
1.245 nicm 3404: and separating two alternatives with a comma;
3405: if the specified variable exists and is not zero, the first alternative
1.246 jmc 3406: is chosen, otherwise the second is used.
3407: For example
1.245 nicm 3408: .Ql #{?session_attached,attached,not attached}
3409: will include the string
3410: .Ql attached
3411: if the session is attached and the string
3412: .Ql not attached
1.409 nicm 3413: if it is unattached, or
3414: .Ql #{?automatic-rename,yes,no}
3415: will include
3416: .Ql yes
3417: if
3418: .Ic automatic-rename
3419: is enabled, or
3420: .Ql no
3421: if not.
1.520 nicm 3422: .Pp
1.554 nicm 3423: Comparisons may be expressed by prefixing two comma-separated
1.520 nicm 3424: alternatives by
3425: .Ql ==
3426: or
3427: .Ql !=
3428: and a colon.
3429: For example
1.544 nicm 3430: .Ql #{==:#{host},myhost}
1.520 nicm 3431: will be replaced by
3432: .Ql 1
3433: if running on
3434: .Ql myhost ,
3435: otherwise by
1.554 nicm 3436: .Ql 0 .
1.553 nicm 3437: An
3438: .Ql m
1.554 nicm 3439: specifies an
1.553 nicm 3440: .Xr fnmatch 3
1.554 nicm 3441: comparison where the first argument is the pattern and the second the string to
3442: compare, for example
1.553 nicm 3443: .Ql #{m:*foo*,#{host}} .
1.554 nicm 3444: .Ql ||
3445: and
3446: .Ql &&
3447: evaluate to true if either or both of two comma-separated alternatives are
3448: true, for example
3449: .Ql #{||,#{pane_in_mode},#{alternate_on}} .
3450: A
3451: .Ql C
3452: performs a search for an
3453: .Xr fnmatch 3
3454: pattern in the pane content and evaluates to zero if not found, or a line
3455: number if found.
1.453 nicm 3456: .Pp
1.367 nicm 3457: A limit may be placed on the length of the resultant string by prefixing it
3458: by an
3459: .Ql = ,
1.479 nicm 3460: a number and a colon.
3461: Positive numbers count from the start of the string and negative from the end,
3462: so
3463: .Ql #{=5:pane_title}
3464: will include at most the first 5 characters of the pane title, or
3465: .Ql #{=-5:pane_title}
3466: the last 5 characters.
1.453 nicm 3467: Prefixing a time variable with
3468: .Ql t:
3469: will convert it to a string, so if
3470: .Ql #{window_activity}
3471: gives
1.454 jmc 3472: .Ql 1445765102 ,
1.453 nicm 3473: .Ql #{t:window_activity}
3474: gives
3475: .Ql Sun Oct 25 09:25:02 2015 .
3476: The
3477: .Ql b:
3478: and
3479: .Ql d:
3480: prefixes are
3481: .Xr basename 3
3482: and
3483: .Xr dirname 3
3484: of the variable respectively.
1.461 nicm 3485: A prefix of the form
3486: .Ql s/foo/bar/:
3487: will substitute
3488: .Ql foo
3489: with
3490: .Ql bar
3491: throughout.
1.431 nicm 3492: .Pp
3493: In addition, the first line of a shell command's output may be inserted using
3494: .Ql #() .
3495: For example,
3496: .Ql #(uptime)
3497: will insert the system's uptime.
3498: When constructing formats,
3499: .Nm
3500: does not wait for
3501: .Ql #()
3502: commands to finish; instead, the previous result from running the same command is used,
3503: or a placeholder if the command has not been run before.
1.543 nicm 3504: If the command hasn't exited, the most recent line of output will be used, but the status
3505: line will not be updated more than once a second.
1.431 nicm 3506: Commands are executed with the
3507: .Nm
3508: global environment set (see the
3509: .Sx ENVIRONMENT
3510: section).
1.245 nicm 3511: .Pp
3512: The following variables are available, where appropriate:
1.359 nicm 3513: .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
3514: .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
3515: .It Li "alternate_on" Ta "" Ta "If pane is in alternate screen"
3516: .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
3517: .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
1.490 nicm 3518: .It Li "buffer_name" Ta "" Ta "Name of buffer"
1.386 nicm 3519: .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
1.359 nicm 3520: .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
3521: .It Li "client_activity" Ta "" Ta "Integer time client last had activity"
3522: .It Li "client_created" Ta "" Ta "Integer time client created"
1.443 nicm 3523: .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
1.542 nicm 3524: .It Li "client_discarded" Ta "" Ta "Bytes discarded when client behind"
1.359 nicm 3525: .It Li "client_height" Ta "" Ta "Height of client"
1.451 nicm 3526: .It Li "client_key_table" Ta "" Ta "Current key table"
1.359 nicm 3527: .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
1.540 nicm 3528: .It Li "client_name" Ta "" Ta "Name of client"
1.437 nicm 3529: .It Li "client_pid" Ta "" Ta "PID of client process"
1.359 nicm 3530: .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
3531: .It Li "client_readonly" Ta "" Ta "1 if client is readonly"
3532: .It Li "client_session" Ta "" Ta "Name of the client's session"
3533: .It Li "client_termname" Ta "" Ta "Terminal name of client"
1.524 nicm 3534: .It Li "client_termtype" Ta "" Ta "Terminal type of client"
1.359 nicm 3535: .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
3536: .It Li "client_utf8" Ta "" Ta "1 if client supports utf8"
3537: .It Li "client_width" Ta "" Ta "Width of client"
1.541 nicm 3538: .It Li "client_written" Ta "" Ta "Bytes written to client"
1.509 nicm 3539: .It Li "command" Ta "" Ta "Name of command in use, if any"
1.489 nicm 3540: .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
3541: .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
3542: .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
1.359 nicm 3543: .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
3544: .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
3545: .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
3546: .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
3547: .It Li "history_limit" Ta "" Ta "Maximum window history lines"
3548: .It Li "history_size" Ta "" Ta "Size of history in bytes"
1.509 nicm 3549: .It Li "hook" Ta "" Ta "Name of running hook, if any"
1.511 nicm 3550: .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
1.510 nicm 3551: .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
3552: .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
3553: .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
3554: .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
1.359 nicm 3555: .It Li "host" Ta "#H" Ta "Hostname of local host"
3556: .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
3557: .It Li "insert_flag" Ta "" Ta "Pane insert flag"
3558: .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
3559: .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
3560: .It Li "line" Ta "" Ta "Line number in the list"
3561: .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
3562: .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
3563: .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
1.533 nicm 3564: .It Li "mouse_all_flag" Ta "" Ta "Pane mouse all flag"
1.359 nicm 3565: .It Li "pane_active" Ta "" Ta "1 if active pane"
1.396 nicm 3566: .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
1.359 nicm 3567: .It Li "pane_current_command" Ta "" Ta "Current command if available"
3568: .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
1.411 nicm 3569: .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
1.359 nicm 3570: .It Li "pane_height" Ta "" Ta "Height of pane"
3571: .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
3572: .It Li "pane_in_mode" Ta "" Ta "If pane is in a mode"
1.404 nicm 3573: .It Li "pane_input_off" Ta "" Ta "If input to pane is disabled"
1.359 nicm 3574: .It Li "pane_index" Ta "#P" Ta "Index of pane"
1.396 nicm 3575: .It Li "pane_left" Ta "" Ta "Left of pane"
1.549 nicm 3576: .It Li "pane_mode" Ta "" Ta "Name of pane mode, if any."
1.359 nicm 3577: .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
1.396 nicm 3578: .It Li "pane_right" Ta "" Ta "Right of pane"
1.546 nicm 3579: .It Li "pane_search_string" Ta "" Ta "Last search string in copy mode"
1.359 nicm 3580: .It Li "pane_start_command" Ta "" Ta "Command pane started with"
1.396 nicm 3581: .It Li "pane_synchronized" Ta "" Ta "If pane is synchronized"
1.359 nicm 3582: .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
3583: .It Li "pane_title" Ta "#T" Ta "Title of pane"
1.396 nicm 3584: .It Li "pane_top" Ta "" Ta "Top of pane"
1.359 nicm 3585: .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
3586: .It Li "pane_width" Ta "" Ta "Width of pane"
1.437 nicm 3587: .It Li "pid" Ta "" Ta "Server PID"
1.359 nicm 3588: .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
3589: .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
1.452 nicm 3590: .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
1.430 nicm 3591: .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
1.382 nicm 3592: .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
1.415 nicm 3593: .It Li "session_activity" Ta "" Ta "Integer time of session last activity"
1.359 nicm 3594: .It Li "session_created" Ta "" Ta "Integer time session created"
1.449 nicm 3595: .It Li "session_last_attached" Ta "" Ta "Integer time session last attached"
1.536 nicm 3596: .It Li "session_group" Ta "" Ta "Name of session group"
1.359 nicm 3597: .It Li "session_grouped" Ta "" Ta "1 if session in a group"
3598: .It Li "session_height" Ta "" Ta "Height of session"
3599: .It Li "session_id" Ta "" Ta "Unique session ID"
1.382 nicm 3600: .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
1.359 nicm 3601: .It Li "session_name" Ta "#S" Ta "Name of session"
1.548 nicm 3602: .It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
1.359 nicm 3603: .It Li "session_width" Ta "" Ta "Width of session"
3604: .It Li "session_windows" Ta "" Ta "Number of windows in session"
1.487 nicm 3605: .It Li "socket_path" Ta "" Ta "Server socket path"
1.465 nicm 3606: .It Li "start_time" Ta "" Ta "Server start time"
1.438 nicm 3607: .It Li "window_activity" Ta "" Ta "Integer time of window last activity"
1.487 nicm 3608: .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
1.359 nicm 3609: .It Li "window_active" Ta "" Ta "1 if window active"
1.366 nicm 3610: .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
1.359 nicm 3611: .It Li "window_find_matches" Ta "" Ta "Matched data from the find-window"
3612: .It Li "window_flags" Ta "#F" Ta "Window flags"
3613: .It Li "window_height" Ta "" Ta "Height of window"
3614: .It Li "window_id" Ta "" Ta "Unique window ID"
3615: .It Li "window_index" Ta "#I" Ta "Index of window"
1.400 nicm 3616: .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
1.460 nicm 3617: .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
1.426 nicm 3618: .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
1.359 nicm 3619: .It Li "window_name" Ta "#W" Ta "Name of window"
3620: .It Li "window_panes" Ta "" Ta "Number of panes in window"
1.366 nicm 3621: .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
1.548 nicm 3622: .It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
1.460 nicm 3623: .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
1.359 nicm 3624: .It Li "window_width" Ta "" Ta "Width of window"
1.400 nicm 3625: .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
1.359 nicm 3626: .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
1.245 nicm 3627: .El
1.261 nicm 3628: .Sh NAMES AND TITLES
3629: .Nm
3630: distinguishes between names and titles.
3631: Windows and sessions have names, which may be used to specify them in targets
3632: and are displayed in the status line and various lists: the name is the
3633: .Nm
3634: identifier for a window or session.
3635: Only panes have titles.
3636: A pane's title is typically set by the program running inside the pane and
3637: is not modified by
3638: .Nm .
3639: It is the same mechanism used to set for example the
3640: .Xr xterm 1
3641: window title in an
3642: .Xr X 7
3643: window manager.
1.268 nicm 3644: Windows themselves do not have titles - a window's title is the title of its
1.261 nicm 3645: active pane.
3646: .Nm
3647: itself may set the title of the terminal in which the client is running, see
3648: the
3649: .Ic set-titles
3650: option.
3651: .Pp
3652: A session's name is set with the
3653: .Ic new-session
3654: and
3655: .Ic rename-session
3656: commands.
3657: A window's name is set with one of:
3658: .Bl -enum -width Ds
3659: .It
3660: A command argument (such as
3661: .Fl n
3662: for
3663: .Ic new-window
3664: or
3665: .Ic new-session ) .
3666: .It
3667: An escape sequence:
3668: .Bd -literal -offset indent
3669: $ printf '\e033kWINDOW_NAME\e033\e\e'
3670: .Ed
3671: .It
3672: Automatic renaming, which sets the name to the active command in the window's
3673: active pane.
3674: See the
3675: .Ic automatic-rename
3676: option.
3677: .El
3678: .Pp
3679: When a pane is first created, its title is the hostname.
3680: A pane's title can be set via the OSC title setting sequence, for example:
3681: .Bd -literal -offset indent
3682: $ printf '\e033]2;My Title\e033\e\e'
3683: .Ed
1.63 nicm 3684: .Sh ENVIRONMENT
3685: When the server is started,
3686: .Nm
3687: copies the environment into the
3688: .Em global environment ;
3689: in addition, each session has a
3690: .Em session environment .
1.193 nicm 3691: When a window is created, the session and global environments are merged.
3692: If a variable exists in both, the value from the session environment is used.
3693: The result is the initial environment passed to the new process.
1.63 nicm 3694: .Pp
3695: The
3696: .Ic update-environment
3697: session option may be used to update the session environment from the client
3698: when a new session is created or an old reattached.
3699: .Nm
3700: also initialises the
3701: .Ev TMUX
3702: variable with some internal information to allow commands to be executed
3703: from inside, and the
3704: .Ev TERM
3705: variable with the correct terminal setting of
3706: .Ql screen .
3707: .Pp
3708: Commands to alter and view the environment are:
3709: .Bl -tag -width Ds
3710: .It Xo Ic set-environment
3711: .Op Fl gru
3712: .Op Fl t Ar target-session
3713: .Ar name Op Ar value
3714: .Xc
1.115 nicm 3715: .D1 (alias: Ic setenv )
1.63 nicm 3716: Set or unset an environment variable.
3717: If
3718: .Fl g
3719: is used, the change is made in the global environment; otherwise, it is applied
3720: to the session environment for
3721: .Ar target-session .
3722: The
3723: .Fl u
3724: flag unsets a variable.
3725: .Fl r
3726: indicates the variable is to be removed from the environment before starting a
3727: new process.
3728: .It Xo Ic show-environment
1.442 nicm 3729: .Op Fl gs
1.63 nicm 3730: .Op Fl t Ar target-session
1.286 nicm 3731: .Op Ar variable
1.63 nicm 3732: .Xc
1.115 nicm 3733: .D1 (alias: Ic showenv )
1.63 nicm 3734: Display the environment for
3735: .Ar target-session
3736: or the global environment with
3737: .Fl g .
1.286 nicm 3738: If
3739: .Ar variable
3740: is omitted, all variables are shown.
1.63 nicm 3741: Variables removed from the environment are prefixed with
3742: .Ql - .
1.442 nicm 3743: If
3744: .Fl s
3745: is used, the output is formatted as a set of Bourne shell commands.
1.57 jmc 3746: .El
3747: .Sh STATUS LINE
3748: .Nm
3749: includes an optional status line which is displayed in the bottom line of each
3750: terminal.
3751: By default, the status line is enabled (it may be disabled with the
3752: .Ic status
3753: session option) and contains, from left-to-right: the name of the current
1.261 nicm 3754: session in square brackets; the window list; the title of the active pane
3755: in double quotes; and the time and date.
1.57 jmc 3756: .Pp
3757: The status line is made of three parts: configurable left and right sections
3758: (which may contain dynamic content such as the time or output from a shell
3759: command, see the
3760: .Ic status-left ,
3761: .Ic status-left-length ,
3762: .Ic status-right ,
3763: and
3764: .Ic status-right-length
3765: options below), and a central window list.
1.125 nicm 3766: By default, the window list shows the index, name and (if any) flag of the
3767: windows present in the current session in ascending numerical order.
3768: It may be customised with the
3769: .Ar window-status-format
3770: and
3771: .Ar window-status-current-format
3772: options.
1.57 jmc 3773: The flag is one of the following symbols appended to the window name:
3774: .Bl -column "Symbol" "Meaning" -offset indent
3775: .It Sy "Symbol" Ta Sy "Meaning"
3776: .It Li "*" Ta "Denotes the current window."
3777: .It Li "-" Ta "Marks the last window (previously selected)."
3778: .It Li "#" Ta "Window is monitored and activity has been detected."
1.557 nicm 3779: .It Li "\&!" Ta "A bell has occurred in the window."
1.192 nicm 3780: .It Li "~" Ta "The window has been silent for the monitor-silence interval."
1.432 nicm 3781: .It Li "M" Ta "The window contains the marked pane."
1.349 nicm 3782: .It Li "Z" Ta "The window's active pane is zoomed."
1.57 jmc 3783: .El
3784: .Pp
3785: The # symbol relates to the
3786: .Ic monitor-activity
1.388 nicm 3787: window option.
1.57 jmc 3788: The window name is printed in inverted colours if an alert (bell, activity or
1.388 nicm 3789: silence) is present.
1.57 jmc 3790: .Pp
1.131 nicm 3791: The colour and attributes of the status line may be configured, the entire
3792: status line using the
1.378 nicm 3793: .Ic status-style
3794: session option and individual windows using the
3795: .Ic window-status-style
3796: window option.
1.57 jmc 3797: .Pp
1.131 nicm 3798: The status line is automatically refreshed at interval if it has changed, the
3799: interval may be controlled with the
1.57 jmc 3800: .Ic status-interval
3801: session option.
3802: .Pp
3803: Commands related to the status line are as follows:
3804: .Bl -tag -width Ds
3805: .It Xo Ic command-prompt
1.517 nicm 3806: .Op Fl 1i
1.235 nicm 3807: .Op Fl I Ar inputs
1.73 nicm 3808: .Op Fl p Ar prompts
1.57 jmc 3809: .Op Fl t Ar target-client
3810: .Op Ar template
3811: .Xc
3812: Open the command prompt in a client.
3813: This may be used from inside
3814: .Nm
3815: to execute commands interactively.
1.231 nicm 3816: .Pp
1.57 jmc 3817: If
3818: .Ar template
1.73 nicm 3819: is specified, it is used as the command.
1.235 nicm 3820: If present,
3821: .Fl I
3822: is a comma-separated list of the initial text for each prompt.
1.73 nicm 3823: If
3824: .Fl p
3825: is given,
3826: .Ar prompts
3827: is a comma-separated list of prompts which are displayed in order; otherwise
3828: a single prompt is displayed, constructed from
3829: .Ar template
3830: if it is present, or
3831: .Ql \&:
3832: if not.
1.231 nicm 3833: .Pp
1.73 nicm 3834: Before the command is executed, the first occurrence of the string
3835: .Ql %%
1.74 jmc 3836: and all occurrences of
1.73 nicm 3837: .Ql %1
1.492 nicm 3838: are replaced by the response to the first prompt, all
1.73 nicm 3839: .Ql %2
3840: are replaced with the response to the second prompt, and so on for further
1.74 jmc 3841: prompts.
3842: Up to nine prompt responses may be replaced
3843: .Po
3844: .Ql %1
1.73 nicm 3845: to
1.74 jmc 3846: .Ql %9
3847: .Pc .
1.513 nicm 3848: .Ql %%%
3849: is like
3850: .Ql %%
3851: but any quotation marks are escaped.
1.497 nicm 3852: .Pp
3853: .Fl 1
3854: makes the prompt only accept one key press, in this case the resulting input
3855: is a single character.
1.517 nicm 3856: .Fl i
3857: executes the command every time the prompt input changes instead of when the
3858: user exits the command prompt.
1.500 nicm 3859: .Pp
3860: The following keys have a special meaning in the command prompt, depending
3861: on the value of the
3862: .Ic status-keys
3863: option:
3864: .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
3865: .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
3866: .It Li "Cancel command prompt" Ta "Escape" Ta "Escape"
3867: .It Li "Delete current word" Ta "" Ta "C-w"
3868: .It Li "Delete entire command" Ta "d" Ta "C-u"
3869: .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
3870: .It Li "Execute command" Ta "Enter" Ta "Enter"
3871: .It Li "Get next command from history" Ta "" Ta "Down"
3872: .It Li "Get previous command from history" Ta "" Ta "Up"
3873: .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
3874: .It Li "Look for completions" Ta "Tab" Ta "Tab"
3875: .It Li "Move cursor left" Ta "h" Ta "Left"
3876: .It Li "Move cursor right" Ta "l" Ta "Right"
3877: .It Li "Move cursor to end" Ta "$" Ta "C-e"
3878: .It Li "Move cursor to next word" Ta "w" Ta "M-f"
3879: .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
3880: .It Li "Move cursor to start" Ta "0" Ta "C-a"
3881: .It Li "Transpose characters" Ta "" Ta "C-t"
3882: .El
1.57 jmc 3883: .It Xo Ic confirm-before
1.238 nicm 3884: .Op Fl p Ar prompt
1.57 jmc 3885: .Op Fl t Ar target-client
3886: .Ar command
3887: .Xc
3888: .D1 (alias: Ic confirm )
3889: Ask for confirmation before executing
3890: .Ar command .
1.238 nicm 3891: If
3892: .Fl p
3893: is given,
3894: .Ar prompt
3895: is the prompt to display; otherwise a prompt is constructed from
3896: .Ar command .
3897: It may contain the special character sequences supported by the
3898: .Ic status-left
3899: option.
3900: .Pp
1.57 jmc 3901: This command works only from inside
3902: .Nm .
3903: .It Xo Ic display-message
1.127 nicm 3904: .Op Fl p
1.215 nicm 3905: .Op Fl c Ar target-client
3906: .Op Fl t Ar target-pane
1.57 jmc 3907: .Op Ar message
3908: .Xc
3909: .D1 (alias: Ic display )
1.127 nicm 3910: Display a message.
3911: If
3912: .Fl p
3913: is given, the output is printed to stdout, otherwise it is displayed in the
3914: .Ar target-client
3915: status line.
1.122 nicm 3916: The format of
1.124 jmc 3917: .Ar message
1.275 nicm 3918: is described in the
3919: .Sx FORMATS
3920: section; information is taken from
1.215 nicm 3921: .Ar target-pane
3922: if
3923: .Fl t
3924: is given, otherwise the active pane for the session attached to
3925: .Ar target-client .
1.57 jmc 3926: .El
3927: .Sh BUFFERS
3928: .Nm
1.392 nicm 3929: maintains a set of named
1.199 nicm 3930: .Em paste buffers .
1.392 nicm 3931: Each buffer may be either explicitly or automatically named.
3932: Explicitly named buffers are named when created with the
3933: .Ic set-buffer
3934: or
3935: .Ic load-buffer
3936: commands, or by renaming an automatically named buffer with
3937: .Ic set-buffer
3938: .Fl n .
3939: Automatically named buffers are given a name such as
3940: .Ql buffer0001 ,
3941: .Ql buffer0002
3942: and so on.
3943: When the
3944: .Ic buffer-limit
3945: option is reached, the oldest automatically named buffer is deleted.
1.493 nicm 3946: Explicitly named buffers are not subject to
1.57 jmc 3947: .Ic buffer-limit
1.392 nicm 3948: and may be deleted with
3949: .Ic delete-buffer
3950: command.
3951: .Pp
1.57 jmc 3952: Buffers may be added using
3953: .Ic copy-mode
3954: or the
3955: .Ic set-buffer
1.392 nicm 3956: and
3957: .Ic load-buffer
3958: commands, and pasted into a window using the
1.57 jmc 3959: .Ic paste-buffer
3960: command.
1.392 nicm 3961: If a buffer command is used and no buffer is specified, the most
3962: recently added automatically named buffer is assumed.
1.57 jmc 3963: .Pp
3964: A configurable history buffer is also maintained for each window.
3965: By default, up to 2000 lines are kept; this can be altered with the
3966: .Ic history-limit
3967: option (see the
3968: .Ic set-option
3969: command above).
3970: .Pp
3971: The buffer commands are as follows:
3972: .Bl -tag -width Ds
1.178 nicm 3973: .It Xo
3974: .Ic choose-buffer
1.561 ! nicm 3975: .Op Fl O Ar sort-order
1.555 nicm 3976: .Op Fl t Ar target-pane
1.178 nicm 3977: .Op Ar template
3978: .Xc
1.555 nicm 3979: Put a pane into buffer mode, where a buffer may be chosen interactively from
3980: a list.
3981: The following keys may be used in buffer mode:
3982: .Bl -column "Key" "Function" -offset indent
3983: .It Sy "Key" Ta Sy "Function"
3984: .It Li "Enter" Ta "Choose selected buffer"
3985: .It Li "Up" Ta "Select previous buffer"
3986: .It Li "Down" Ta "Select next buffer"
1.559 nicm 3987: .It Li "C-s" Ta "Search by name or content"
3988: .It Li "n" Ta "Repeat last search"
1.555 nicm 3989: .It Li "t" Ta "Toggle if buffer is tagged"
3990: .It Li "T" Ta "Tag no buffers"
3991: .It Li "C-t" Ta "Tag all buffers"
3992: .It Li "d" Ta "Delete selected buffer"
3993: .It Li "D" Ta "Delete tagged buffers"
3994: .It Li "O" Ta "Change sort order"
3995: .It Li "q" Ta "Exit mode"
3996: .El
3997: .Pp
3998: After a buffer is chosen,
1.178 nicm 3999: .Ql %%
1.392 nicm 4000: is replaced by the buffer name in
1.178 nicm 4001: .Ar template
4002: and the result executed as a command.
4003: If
4004: .Ar template
4005: is not given, "paste-buffer -b '%%'" is used.
1.555 nicm 4006: .Pp
1.561 ! nicm 4007: .Fl O
! 4008: specifies the initial sort order: one of
! 4009: .Ql time ,
! 4010: .Ql name
! 4011: or
! 4012: .Ql size .
1.314 nicm 4013: This command works only if at least one client is attached.
1.57 jmc 4014: .It Ic clear-history Op Fl t Ar target-pane
4015: .D1 (alias: Ic clearhist )
4016: Remove and free the history for the specified pane.
1.392 nicm 4017: .It Ic delete-buffer Op Fl b Ar buffer-name
1.57 jmc 4018: .D1 (alias: Ic deleteb )
1.392 nicm 4019: Delete the buffer named
4020: .Ar buffer-name ,
4021: or the most recently added automatically named buffer if not specified.
1.294 nicm 4022: .It Xo Ic list-buffers
4023: .Op Fl F Ar format
4024: .Xc
1.57 jmc 4025: .D1 (alias: Ic lsb )
1.198 nicm 4026: List the global buffers.
1.294 nicm 4027: For the meaning of the
4028: .Fl F
4029: flag, see the
4030: .Sx FORMATS
4031: section.
1.200 jmc 4032: .It Xo Ic load-buffer
1.392 nicm 4033: .Op Fl b Ar buffer-name
1.57 jmc 4034: .Ar path
4035: .Xc
4036: .D1 (alias: Ic loadb )
4037: Load the contents of the specified paste buffer from
4038: .Ar path .
4039: .It Xo Ic paste-buffer
1.278 nicm 4040: .Op Fl dpr
1.392 nicm 4041: .Op Fl b Ar buffer-name
1.170 nicm 4042: .Op Fl s Ar separator
1.158 nicm 4043: .Op Fl t Ar target-pane
1.57 jmc 4044: .Xc
4045: .D1 (alias: Ic pasteb )
1.158 nicm 4046: Insert the contents of a paste buffer into the specified pane.
4047: If not specified, paste into the current one.
1.57 jmc 4048: With
4049: .Fl d ,
1.392 nicm 4050: also delete the paste buffer.
1.57 jmc 4051: When output, any linefeed (LF) characters in the paste buffer are replaced with
1.170 nicm 4052: a separator, by default carriage return (CR).
4053: A custom separator may be specified using the
4054: .Fl s
4055: flag.
4056: The
1.57 jmc 4057: .Fl r
1.170 nicm 4058: flag means to do no replacement (equivalent to a separator of LF).
1.278 nicm 4059: If
4060: .Fl p
4061: is specified, paste bracket control codes are inserted around the
4062: buffer if the application has requested bracketed paste mode.
1.57 jmc 4063: .It Xo Ic save-buffer
4064: .Op Fl a
1.392 nicm 4065: .Op Fl b Ar buffer-name
1.57 jmc 4066: .Ar path
4067: .Xc
4068: .D1 (alias: Ic saveb )
4069: Save the contents of the specified paste buffer to
4070: .Ar path .
4071: The
4072: .Fl a
4073: option appends to rather than overwriting the file.
4074: .It Xo Ic set-buffer
1.383 nicm 4075: .Op Fl a
1.392 nicm 4076: .Op Fl b Ar buffer-name
4077: .Op Fl n Ar new-buffer-name
1.57 jmc 4078: .Ar data
4079: .Xc
4080: .D1 (alias: Ic setb )
4081: Set the contents of the specified buffer to
4082: .Ar data .
1.383 nicm 4083: The
4084: .Fl a
4085: option appends to rather than overwriting the buffer.
1.392 nicm 4086: The
4087: .Fl n
4088: option renames the buffer to
4089: .Ar new-buffer-name .
1.1 nicm 4090: .It Xo Ic show-buffer
1.392 nicm 4091: .Op Fl b Ar buffer-name
1.1 nicm 4092: .Xc
4093: .D1 (alias: Ic showb )
4094: Display the contents of the specified buffer.
1.57 jmc 4095: .El
4096: .Sh MISCELLANEOUS
4097: Miscellaneous commands are as follows:
4098: .Bl -tag -width Ds
1.72 nicm 4099: .It Ic clock-mode Op Fl t Ar target-pane
1.57 jmc 4100: Display a large clock.
1.334 nicm 4101: .It Xo Ic if-shell
1.410 nicm 4102: .Op Fl bF
1.334 nicm 4103: .Op Fl t Ar target-pane
4104: .Ar shell-command command
4105: .Op Ar command
4106: .Xc
1.57 jmc 4107: .D1 (alias: Ic if )
1.251 nicm 4108: Execute the first
1.57 jmc 4109: .Ar command
4110: if
4111: .Ar shell-command
1.251 nicm 4112: returns success or the second
4113: .Ar command
4114: otherwise.
1.410 nicm 4115: Before being executed,
4116: .Ar shell-command
4117: is expanded using the rules specified in the
1.334 nicm 4118: .Sx FORMATS
4119: section, including those relevant to
4120: .Ar target-pane .
1.335 nicm 4121: With
4122: .Fl b ,
4123: .Ar shell-command
4124: is run in the background.
1.410 nicm 4125: .Pp
4126: If
4127: .Fl F
4128: is given,
4129: .Ar shell-command
4130: is not executed but considered success if neither empty nor zero (after formats
4131: are expanded).
1.57 jmc 4132: .It Ic lock-server
4133: .D1 (alias: Ic lock )
1.90 nicm 4134: Lock each client individually by running the command specified by the
4135: .Ic lock-command
4136: option.
1.308 nicm 4137: .It Xo Ic run-shell
1.357 nicm 4138: .Op Fl b
1.308 nicm 4139: .Op Fl t Ar target-pane
4140: .Ar shell-command
4141: .Xc
1.87 nicm 4142: .D1 (alias: Ic run )
4143: Execute
1.153 nicm 4144: .Ar shell-command
1.106 nicm 4145: in the background without creating a window.
1.334 nicm 4146: Before being executed, shell-command is expanded using the rules specified in
4147: the
4148: .Sx FORMATS
4149: section.
1.335 nicm 4150: With
4151: .Fl b ,
4152: the command is run in the background.
1.308 nicm 4153: After it finishes, any output to stdout is displayed in copy mode (in the pane
4154: specified by
4155: .Fl t
4156: or the current pane if omitted).
1.153 nicm 4157: If the command doesn't return success, the exit status is also displayed.
1.342 nicm 4158: .It Xo Ic wait-for
1.370 nicm 4159: .Op Fl L | S | U
1.342 nicm 4160: .Ar channel
4161: .Xc
4162: .D1 (alias: Ic wait )
1.343 nicm 4163: When used without options, prevents the client from exiting until woken using
1.342 nicm 4164: .Ic wait-for
4165: .Fl S
4166: with the same channel.
1.343 nicm 4167: When
4168: .Fl L
4169: is used, the channel is locked and any clients that try to lock the same
4170: channel are made to wait until the channel is unlocked with
4171: .Ic wait-for
4172: .Fl U .
1.342 nicm 4173: This command only works from outside
4174: .Nm .
1.228 nicm 4175: .El
4176: .Sh TERMINFO EXTENSIONS
4177: .Nm
1.478 nicm 4178: understands some unofficial extensions to
1.228 nicm 4179: .Xr terminfo 5 :
4180: .Bl -tag -width Ds
1.360 nicm 4181: .It Em Cs , Cr
1.233 nicm 4182: Set the cursor colour.
1.232 jmc 4183: The first takes a single string argument and is used to set the colour;
4184: the second takes no arguments and restores the default cursor colour.
4185: If set, a sequence such as this may be used
4186: to change the cursor colour from inside
4187: .Nm :
4188: .Bd -literal -offset indent
4189: $ printf '\e033]12;red\e033\e\e'
4190: .Ed
1.361 jmc 4191: .It Em \&Ss , Se
1.403 nicm 4192: Set or reset the cursor style.
1.232 jmc 4193: If set, a sequence such as this may be used
4194: to change the cursor to an underline:
1.230 nicm 4195: .Bd -literal -offset indent
4196: $ printf '\e033[4 q'
4197: .Ed
4198: .Pp
4199: If
1.403 nicm 4200: .Em Se
4201: is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
1.478 nicm 4202: .It Em \&Tc
4203: Indicate that the terminal supports the
4204: .Ql direct colour
4205: RGB escape sequence (for example, \ee[38;2;255;255;255m).
1.518 nicm 4206: .Pp
4207: If supported, this is used for the OSC initialize colour escape sequence (which
4208: may be enabled by adding the
4209: .Ql initc
4210: and
4211: .Ql ccc
4212: capabilities to the
4213: .Nm
4214: .Xr terminfo 5
4215: entry).
1.232 jmc 4216: .It Em \&Ms
1.478 nicm 4217: Store the current buffer in the host terminal's selection (clipboard).
1.232 jmc 4218: See the
4219: .Em set-clipboard
4220: option above and the
4221: .Xr xterm 1
4222: man page.
1.345 nicm 4223: .El
4224: .Sh CONTROL MODE
4225: .Nm
4226: offers a textual interface called
4227: .Em control mode .
4228: This allows applications to communicate with
4229: .Nm
4230: using a simple text-only protocol.
4231: .Pp
4232: In control mode, a client sends
4233: .Nm
4234: commands or command sequences terminated by newlines on standard input.
4235: Each command will produce one block of output on standard output.
4236: An output block consists of a
4237: .Em %begin
4238: line followed by the output (which may be empty).
4239: The output block ends with a
4240: .Em %end
4241: or
4242: .Em %error .
4243: .Em %begin
4244: and matching
4245: .Em %end
4246: or
4247: .Em %error
4248: have two arguments: an integer time (as seconds from epoch) and command number.
4249: For example:
4250: .Bd -literal -offset indent
4251: %begin 1363006971 2
4252: 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
4253: %end 1363006971 2
4254: .Ed
1.535 nicm 4255: .Pp
4256: The
4257: .Ic refresh-client
4258: .Fl C
4259: command may be used to set the size of a client in control mode.
1.345 nicm 4260: .Pp
4261: In control mode,
4262: .Nm
4263: outputs notifications.
4264: A notification will never occur inside an output block.
4265: .Pp
4266: The following notifications are defined:
4267: .Bl -tag -width Ds
1.547 nicm 4268: .It Ic %client-session-changed Ar client Ar session-id Ar name
4269: The client is now attached to the session with ID
4270: .Ar session-id ,
4271: which is named
4272: .Ar name .
1.345 nicm 4273: .It Ic %exit Op Ar reason
4274: The
4275: .Nm
4276: client is exiting immediately, either because it is not attached to any session
4277: or an error occurred.
4278: If present,
4279: .Ar reason
4280: describes why the client exited.
1.460 nicm 4281: .It Ic %layout-change Ar window-id Ar window-layout Ar window-visible-layout Ar window-flags
1.345 nicm 4282: The layout of a window with ID
4283: .Ar window-id
4284: changed.
4285: The new layout is
4286: .Ar window-layout .
1.460 nicm 4287: The window's visible layout is
4288: .Ar window-visible-layout
4289: and the window flags are
4290: .Ar window-flags .
1.347 nicm 4291: .It Ic %output Ar pane-id Ar value
4292: A window pane produced output.
1.345 nicm 4293: .Ar value
1.350 nicm 4294: escapes non-printable characters and backslash as octal \\xxx.
1.547 nicm 4295: .It Ic %pane-mode-changed Ar pane-id
4296: The pane with ID
4297: .Ar pane-id
4298: has changed mode.
1.345 nicm 4299: .It Ic %session-changed Ar session-id Ar name
4300: The client is now attached to the session with ID
4301: .Ar session-id ,
4302: which is named
4303: .Ar name .
4304: .It Ic %session-renamed Ar name
4305: The current session was renamed to
4306: .Ar name .
1.547 nicm 4307: .It Ic %session-window-changed Ar session-id Ar window-id
4308: The session with ID
4309: .Ar session-id
4310: changed its active window to the window with ID
4311: .Ar window-id .
1.345 nicm 4312: .It Ic %sessions-changed
4313: A session was created or destroyed.
4314: .It Ic %unlinked-window-add Ar window-id
4315: The window with ID
4316: .Ar window-id
4317: was created but is not linked to the current session.
4318: .It Ic %window-add Ar window-id
4319: The window with ID
4320: .Ar window-id
4321: was linked to the current session.
4322: .It Ic %window-close Ar window-id
4323: The window with ID
4324: .Ar window-id
4325: closed.
1.547 nicm 4326: .It Ic %window-pane-changed Ar window-id Ar pane-id
4327: The active pane in the window with ID
4328: .Ar window-id
4329: changed to the pane with ID
4330: .Ar pane-id .
1.345 nicm 4331: .It Ic %window-renamed Ar window-id Ar name
4332: The window with ID
4333: .Ar window-id
4334: was renamed to
4335: .Ar name .
1.1 nicm 4336: .El
4337: .Sh FILES
1.26 nicm 4338: .Bl -tag -width "/etc/tmux.confXXX" -compact
1.1 nicm 4339: .It Pa ~/.tmux.conf
1.6 jmc 4340: Default
1.1 nicm 4341: .Nm
1.6 jmc 4342: configuration file.
1.26 nicm 4343: .It Pa /etc/tmux.conf
4344: System-wide configuration file.
1.1 nicm 4345: .El
1.57 jmc 4346: .Sh EXAMPLES
4347: To create a new
4348: .Nm
4349: session running
4350: .Xr vi 1 :
4351: .Pp
4352: .Dl $ tmux new-session vi
4353: .Pp
4354: Most commands have a shorter form, known as an alias.
4355: For new-session, this is
4356: .Ic new :
4357: .Pp
4358: .Dl $ tmux new vi
4359: .Pp
4360: Alternatively, the shortest unambiguous form of a command is accepted.
4361: If there are several options, they are listed:
4362: .Bd -literal -offset indent
4363: $ tmux n
4364: ambiguous command: n, could be: new-session, new-window, next-window
4365: .Ed
4366: .Pp
4367: Within an active session, a new window may be created by typing
4368: .Ql C-b c
4369: (Ctrl
4370: followed by the
4371: .Ql b
4372: key
4373: followed by the
4374: .Ql c
4375: key).
4376: .Pp
4377: Windows may be navigated with:
4378: .Ql C-b 0
4379: (to select window 0),
4380: .Ql C-b 1
4381: (to select window 1), and so on;
4382: .Ql C-b n
4383: to select the next window; and
4384: .Ql C-b p
4385: to select the previous window.
4386: .Pp
4387: A session may be detached using
4388: .Ql C-b d
1.64 nicm 4389: (or by an external event such as
4390: .Xr ssh 1
4391: disconnection) and reattached with:
1.57 jmc 4392: .Pp
4393: .Dl $ tmux attach-session
4394: .Pp
4395: Typing
4396: .Ql C-b \&?
4397: lists the current key bindings in the current window; up and down may be used
4398: to navigate the list or
4399: .Ql q
4400: to exit from it.
4401: .Pp
4402: Commands to be run when the
4403: .Nm
4404: server is started may be placed in the
4405: .Pa ~/.tmux.conf
4406: configuration file.
4407: Common examples include:
4408: .Pp
4409: Changing the default prefix key:
4410: .Bd -literal -offset indent
4411: set-option -g prefix C-a
4412: unbind-key C-b
4413: bind-key C-a send-prefix
4414: .Ed
4415: .Pp
4416: Turning the status line off, or changing its colour:
4417: .Bd -literal -offset indent
4418: set-option -g status off
1.378 nicm 4419: set-option -g status-style bg=blue
1.57 jmc 4420: .Ed
4421: .Pp
4422: Setting other options, such as the default command,
4423: or locking after 30 minutes of inactivity:
4424: .Bd -literal -offset indent
4425: set-option -g default-command "exec /bin/ksh"
4426: set-option -g lock-after-time 1800
4427: .Ed
4428: .Pp
4429: Creating new key bindings:
4430: .Bd -literal -offset indent
4431: bind-key b set-option status
4432: bind-key / command-prompt "split-window 'exec man %%'"
1.73 nicm 4433: bind-key S command-prompt "new-window -n %1 'ssh %1'"
1.57 jmc 4434: .Ed
1.1 nicm 4435: .Sh SEE ALSO
4436: .Xr pty 4
4437: .Sh AUTHORS
1.477 nicm 4438: .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com