Annotation of src/usr.bin/tmux/tmux.1, Revision 1.566
1.566 ! nicm 1: .\" $OpenBSD: tmux.1,v 1.565 2017/06/29 22:02:19 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.566 ! nicm 17: .Dd $Mdocdate: June 29 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.562 nicm 1357: .Op Fl f Ar filter
1.561 nicm 1358: .Op Fl O Ar sort-order
1.555 nicm 1359: .Op Fl t Ar target-pane
1.76 nicm 1360: .Op Ar template
1361: .Xc
1.555 nicm 1362: Put a pane into client mode, allowing a client to be selected interactively from
1363: a list.
1364: The following keys may be used in client mode:
1365: .Bl -column "Key" "Function" -offset indent
1366: .It Sy "Key" Ta Sy "Function"
1367: .It Li "Enter" Ta "Choose selected client"
1368: .It Li "Up" Ta "Select previous client"
1369: .It Li "Down" Ta "Select next client"
1.559 nicm 1370: .It Li "C-s" Ta "Search by name"
1371: .It Li "n" Ta "Repeat last search"
1.555 nicm 1372: .It Li "t" Ta "Toggle if client is tagged"
1373: .It Li "T" Ta "Tag no clients"
1374: .It Li "C-t" Ta "Tag all clients"
1375: .It Li "d" Ta "Detach selected client"
1376: .It Li "D" Ta "Detach tagged clients"
1377: .It Li "x" Ta "Detach and HUP selected client"
1378: .It Li "X" Ta "Detach and HUP tagged clients"
1379: .It Li "z" Ta "Suspend selected client"
1380: .It Li "Z" Ta "Suspend tagged clients"
1.562 nicm 1381: .It Li "f" Ta "Enter a format to filter items"
1.555 nicm 1382: .It Li "O" Ta "Change sort order"
1383: .It Li "q" Ta "Exit mode"
1384: .El
1385: .Pp
1.76 nicm 1386: After a client is chosen,
1387: .Ql %%
1.555 nicm 1388: is replaced by the client name in
1.76 nicm 1389: .Ar template
1390: and the result executed as a command.
1391: If
1392: .Ar template
1393: is not given, "detach-client -t '%%'" is used.
1.555 nicm 1394: .Pp
1.561 nicm 1395: .Fl O
1396: specifies the initial sort order: one of
1397: .Ql name ,
1398: .Ql size ,
1399: .Ql creation ,
1400: or
1401: .Ql activity .
1.562 nicm 1402: .Fl f
1403: specifies an initial filter.
1.314 nicm 1404: This command works only if at least one client is attached.
1.76 nicm 1405: .It Xo
1.555 nicm 1406: .Ic choose-tree
1407: .Op Fl sw
1.562 nicm 1408: .Op Fl f Ar filter
1.561 nicm 1409: .Op Fl O Ar sort-order
1.555 nicm 1410: .Op Fl t Ar target-pane
1.76 nicm 1411: .Op Ar template
1412: .Xc
1.555 nicm 1413: Put a pane into tree mode, where a session, window or pane may be chosen
1.76 nicm 1414: interactively from a list.
1.298 nicm 1415: .Fl s
1.555 nicm 1416: starts with sessions collapsed and
1.298 nicm 1417: .Fl w
1.555 nicm 1418: with windows collapsed.
1419: The following keys may be used in tree mode:
1420: .Bl -column "Key" "Function" -offset indent
1421: .It Sy "Key" Ta Sy "Function"
1422: .It Li "Enter" Ta "Choose selected item"
1423: .It Li "Up" Ta "Select previous item"
1424: .It Li "Down" Ta "Select next item"
1.566 ! nicm 1425: .It Li "<" Ta "Scroll list of previews left"
! 1426: .It Li ">" Ta "Scroll list of previews right"
1.559 nicm 1427: .It Li "C-s" Ta "Search by name"
1428: .It Li "n" Ta "Repeat last search"
1.555 nicm 1429: .It Li "t" Ta "Toggle if item is tagged"
1430: .It Li "T" Ta "Tag no items"
1431: .It Li "C-t" Ta "Tag all items"
1.557 nicm 1432: .It Li "\&:" Ta "Run a command for each tagged item"
1.555 nicm 1433: .It Li "f" Ta "Enter a format to filter items"
1434: .It Li "O" Ta "Change sort order"
1435: .It Li "q" Ta "Exit mode"
1436: .El
1.320 nicm 1437: .Pp
1.555 nicm 1438: After a session, window or pane is chosen,
1.76 nicm 1439: .Ql %%
1.555 nicm 1440: is replaced by the target in
1.76 nicm 1441: .Ar template
1442: and the result executed as a command.
1443: If
1444: .Ar template
1.555 nicm 1445: is not given, "switch-client -t '%%'" is used.
1446: .Pp
1.561 nicm 1447: .Fl O
1448: specifies the initial sort order: one of
1449: .Ql index ,
1450: .Ql name ,
1451: or
1452: .Ql time .
1.562 nicm 1453: .Fl f
1454: specifies an initial filter.
1.314 nicm 1455: This command works only if at least one client is attached.
1.491 nicm 1456: .It Xo
1457: .Ic display-panes
1458: .Op Fl t Ar target-client
1459: .Op Ar template
1460: .Xc
1.398 nicm 1461: .D1 (alias: Ic displayp )
1.78 nicm 1462: Display a visible indicator of each pane shown by
1463: .Ar target-client .
1464: See the
1.145 nicm 1465: .Ic display-panes-time ,
1466: .Ic display-panes-colour ,
1.78 nicm 1467: and
1.145 nicm 1468: .Ic display-panes-active-colour
1.78 nicm 1469: session options.
1.491 nicm 1470: While the indicator is on screen, a pane may be chosen with the
1.84 nicm 1471: .Ql 0
1472: to
1473: .Ql 9
1.491 nicm 1474: keys, which will cause
1475: .Ar template
1476: to be executed as a command with
1477: .Ql %%
1478: substituted by the pane ID.
1479: The default
1480: .Ar template
1481: is "select-pane -t '%%'".
1.57 jmc 1482: .It Xo Ic find-window
1.285 nicm 1483: .Op Fl CNT
1.555 nicm 1484: .Op Fl t Ar target-pane
1.57 jmc 1485: .Ar match-string
1486: .Xc
1487: .D1 (alias: Ic findw )
1488: Search for the
1489: .Xr fnmatch 3
1490: pattern
1491: .Ar match-string
1492: in window names, titles, and visible content (but not history).
1.285 nicm 1493: The flags control matching behavior:
1494: .Fl C
1495: matches only visible window contents,
1496: .Fl N
1497: matches only the window name and
1498: .Fl T
1499: matches only the window title.
1500: The default is
1501: .Fl CNT .
1.555 nicm 1502: .Pp
1.314 nicm 1503: This command works only if at least one client is attached.
1.137 nicm 1504: .It Xo Ic join-pane
1.277 nicm 1505: .Op Fl bdhv
1.137 nicm 1506: .Oo Fl l
1507: .Ar size |
1508: .Fl p Ar percentage Oc
1509: .Op Fl s Ar src-pane
1510: .Op Fl t Ar dst-pane
1511: .Xc
1512: .D1 (alias: Ic joinp )
1513: Like
1514: .Ic split-window ,
1515: but instead of splitting
1516: .Ar dst-pane
1517: and creating a new pane, split it and move
1518: .Ar src-pane
1519: into the space.
1520: This can be used to reverse
1521: .Ic break-pane .
1.277 nicm 1522: The
1523: .Fl b
1524: option causes
1525: .Ar src-pane
1526: to be joined to left of or above
1527: .Ar dst-pane .
1.432 nicm 1528: .Pp
1529: If
1530: .Fl s
1531: is omitted and a marked pane is present (see
1532: .Ic select-pane
1533: .Fl m ) ,
1534: the marked pane is used rather than the current pane.
1.112 nicm 1535: .It Xo Ic kill-pane
1536: .Op Fl a
1537: .Op Fl t Ar target-pane
1538: .Xc
1.57 jmc 1539: .D1 (alias: Ic killp )
1540: Destroy the given pane.
1541: If no panes remain in the containing window, it is also destroyed.
1.112 nicm 1542: The
1543: .Fl a
1544: option kills all but the pane given with
1545: .Fl t .
1.289 nicm 1546: .It Xo Ic kill-window
1547: .Op Fl a
1548: .Op Fl t Ar target-window
1549: .Xc
1.57 jmc 1550: .D1 (alias: Ic killw )
1551: Kill the current window or the window at
1552: .Ar target-window ,
1.1 nicm 1553: removing it from any sessions to which it is linked.
1.289 nicm 1554: The
1555: .Fl a
1556: option kills all but the window given with
1557: .Fl t .
1.398 nicm 1558: .It Xo Ic last-pane
1559: .Op Fl de
1560: .Op Fl t Ar target-window
1561: .Xc
1.187 nicm 1562: .D1 (alias: Ic lastp )
1563: Select the last (previously selected) pane.
1.398 nicm 1564: .Fl e
1565: enables or
1566: .Fl d
1567: disables input to the pane.
1.56 jmc 1568: .It Ic last-window Op Fl t Ar target-session
1.1 nicm 1569: .D1 (alias: Ic last )
1570: Select the last (previously selected) window.
1571: If no
1572: .Ar target-session
1573: is specified, select the last window of the current session.
1574: .It Xo Ic link-window
1.439 nicm 1575: .Op Fl adk
1.1 nicm 1576: .Op Fl s Ar src-window
1577: .Op Fl t Ar dst-window
1578: .Xc
1579: .D1 (alias: Ic linkw )
1580: Link the window at
1581: .Ar src-window
1582: to the specified
1583: .Ar dst-window .
1584: If
1585: .Ar dst-window
1586: is specified and no such window exists, the
1587: .Ar src-window
1588: is linked there.
1.439 nicm 1589: With
1590: .Fl a ,
1591: the window is moved to the next index up (following windows
1592: are moved if necessary).
1.1 nicm 1593: If
1594: .Fl k
1595: is given and
1596: .Ar dst-window
1597: exists, it is killed, otherwise an error is generated.
1598: If
1599: .Fl d
1600: is given, the newly linked window is not selected.
1.214 nicm 1601: .It Xo Ic list-panes
1602: .Op Fl as
1.245 nicm 1603: .Op Fl F Ar format
1.214 nicm 1604: .Op Fl t Ar target
1605: .Xc
1.104 nicm 1606: .D1 (alias: Ic lsp )
1.214 nicm 1607: If
1608: .Fl a
1609: is given,
1610: .Ar target
1611: is ignored and all panes on the server are listed.
1612: If
1613: .Fl s
1614: is given,
1615: .Ar target
1616: is a session (or the current session).
1617: If neither is given,
1618: .Ar target
1619: is a window (or the current window).
1.247 nicm 1620: For the meaning of the
1621: .Fl F
1622: flag, see the
1623: .Sx FORMATS
1624: section.
1.214 nicm 1625: .It Xo Ic list-windows
1626: .Op Fl a
1.245 nicm 1627: .Op Fl F Ar format
1.214 nicm 1628: .Op Fl t Ar target-session
1629: .Xc
1.1 nicm 1630: .D1 (alias: Ic lsw )
1.214 nicm 1631: If
1632: .Fl a
1633: is given, list all windows on the server.
1634: Otherwise, list windows in the current session or in
1.1 nicm 1635: .Ar target-session .
1.245 nicm 1636: For the meaning of the
1637: .Fl F
1638: flag, see the
1639: .Sx FORMATS
1640: section.
1.277 nicm 1641: .It Xo Ic move-pane
1642: .Op Fl bdhv
1643: .Oo Fl l
1644: .Ar size |
1645: .Fl p Ar percentage Oc
1646: .Op Fl s Ar src-pane
1647: .Op Fl t Ar dst-pane
1648: .Xc
1649: .D1 (alias: Ic movep )
1650: Like
1651: .Ic join-pane ,
1652: but
1653: .Ar src-pane
1654: and
1655: .Ar dst-pane
1656: may belong to the same window.
1.1 nicm 1657: .It Xo Ic move-window
1.439 nicm 1658: .Op Fl ardk
1.1 nicm 1659: .Op Fl s Ar src-window
1660: .Op Fl t Ar dst-window
1661: .Xc
1662: .D1 (alias: Ic movew )
1663: This is similar to
1664: .Ic link-window ,
1665: except the window at
1666: .Ar src-window
1667: is moved to
1668: .Ar dst-window .
1.291 nicm 1669: With
1670: .Fl r ,
1671: all windows in the session are renumbered in sequential order, respecting
1672: the
1673: .Ic base-index
1674: option.
1.1 nicm 1675: .It Xo Ic new-window
1.201 nicm 1676: .Op Fl adkP
1.272 nicm 1677: .Op Fl c Ar start-directory
1.351 nicm 1678: .Op Fl F Ar format
1.1 nicm 1679: .Op Fl n Ar window-name
1680: .Op Fl t Ar target-window
1.153 nicm 1681: .Op Ar shell-command
1.1 nicm 1682: .Xc
1683: .D1 (alias: Ic neww )
1684: Create a new window.
1.160 nicm 1685: With
1686: .Fl a ,
1687: the new window is inserted at the next index up from the specified
1688: .Ar target-window ,
1689: moving windows up if necessary,
1690: otherwise
1691: .Ar target-window
1692: is the new window location.
1693: .Pp
1.1 nicm 1694: If
1695: .Fl d
1696: is given, the session does not make the new window the current window.
1697: .Ar target-window
1.28 nicm 1698: represents the window to be created; if the target already exists an error is
1699: shown, unless the
1700: .Fl k
1701: flag is used, in which case it is destroyed.
1.153 nicm 1702: .Ar shell-command
1.1 nicm 1703: is the command to execute.
1704: If
1.153 nicm 1705: .Ar shell-command
1706: is not specified, the value of the
1707: .Ic default-command
1708: option is used.
1.272 nicm 1709: .Fl c
1710: specifies the working directory in which the new window is created.
1.153 nicm 1711: .Pp
1712: When the shell command completes, the window closes.
1713: See the
1714: .Ic remain-on-exit
1715: option to change this behaviour.
1.1 nicm 1716: .Pp
1717: The
1718: .Ev TERM
1719: environment variable must be set to
1.523 nicm 1720: .Ql screen
1721: or
1722: .Ql tmux
1.1 nicm 1723: for all programs running
1724: .Em inside
1725: .Nm .
1726: New windows will automatically have
1.523 nicm 1727: .Ql TERM=screen
1.1 nicm 1728: added to their environment, but care must be taken not to reset this in shell
1729: start-up files.
1.201 nicm 1730: .Pp
1731: The
1732: .Fl P
1.279 nicm 1733: option prints information about the new window after it has been created.
1734: By default, it uses the format
1735: .Ql #{session_name}:#{window_index}
1736: but a different format may be specified with
1737: .Fl F .
1.56 jmc 1738: .It Ic next-layout Op Fl t Ar target-window
1.1 nicm 1739: .D1 (alias: Ic nextl )
1740: Move a window to the next layout and rearrange the panes to fit.
1741: .It Xo Ic next-window
1.9 nicm 1742: .Op Fl a
1.1 nicm 1743: .Op Fl t Ar target-session
1744: .Xc
1745: .D1 (alias: Ic next )
1746: Move to the next window in the session.
1.9 nicm 1747: If
1.12 jmc 1748: .Fl a
1.295 nicm 1749: is used, move to the next window with an alert.
1.107 nicm 1750: .It Xo Ic pipe-pane
1751: .Op Fl o
1752: .Op Fl t Ar target-pane
1.153 nicm 1753: .Op Ar shell-command
1.107 nicm 1754: .Xc
1755: .D1 (alias: Ic pipep )
1756: Pipe any output sent by the program in
1757: .Ar target-pane
1758: to a shell command.
1759: A pane may only be piped to one command at a time, any existing pipe is
1760: closed before
1.153 nicm 1761: .Ar shell-command
1.107 nicm 1762: is executed.
1.174 nicm 1763: The
1764: .Ar shell-command
1765: string may contain the special character sequences supported by the
1766: .Ic status-left
1.231 nicm 1767: option.
1.107 nicm 1768: If no
1.153 nicm 1769: .Ar shell-command
1.107 nicm 1770: is given, the current pipe (if any) is closed.
1771: .Pp
1772: The
1773: .Fl o
1774: option only opens a new pipe if no previous pipe exists, allowing a pipe to
1775: be toggled with a single key, for example:
1776: .Bd -literal -offset indent
1.174 nicm 1777: bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
1.107 nicm 1778: .Ed
1.176 nicm 1779: .It Xo Ic previous-layout
1780: .Op Fl t Ar target-window
1781: .Xc
1782: .D1 (alias: Ic prevl )
1783: Move to the previous layout in the session.
1.1 nicm 1784: .It Xo Ic previous-window
1.9 nicm 1785: .Op Fl a
1.1 nicm 1786: .Op Fl t Ar target-session
1787: .Xc
1788: .D1 (alias: Ic prev )
1789: Move to the previous window in the session.
1.9 nicm 1790: With
1791: .Fl a ,
1.295 nicm 1792: move to the previous window with an alert.
1.1 nicm 1793: .It Xo Ic rename-window
1794: .Op Fl t Ar target-window
1795: .Ar new-name
1796: .Xc
1797: .D1 (alias: Ic renamew )
1798: Rename the current window, or the window at
1799: .Ar target-window
1800: if specified, to
1801: .Ar new-name .
1802: .It Xo Ic resize-pane
1.419 nicm 1803: .Op Fl DLMRUZ
1.52 nicm 1804: .Op Fl t Ar target-pane
1.324 nicm 1805: .Op Fl x Ar width
1806: .Op Fl y Ar height
1.1 nicm 1807: .Op Ar adjustment
1808: .Xc
1809: .D1 (alias: Ic resizep )
1.324 nicm 1810: Resize a pane, up, down, left or right by
1811: .Ar adjustment
1812: with
1813: .Fl U ,
1.57 jmc 1814: .Fl D ,
1815: .Fl L
1.324 nicm 1816: or
1817: .Fl R ,
1818: or
1819: to an absolute size
1820: with
1821: .Fl x
1822: or
1823: .Fl y .
1.57 jmc 1824: The
1825: .Ar adjustment
1826: is given in lines or cells (the default is 1).
1.337 nicm 1827: .Pp
1828: With
1829: .Fl Z ,
1.349 nicm 1830: the active pane is toggled between zoomed (occupying the whole of the window)
1831: and unzoomed (its normal position in the layout).
1.419 nicm 1832: .Pp
1833: .Fl M
1834: begins mouse resizing (only valid if bound to a mouse key binding, see
1.420 jmc 1835: .Sx MOUSE SUPPORT ) .
1.234 nicm 1836: .It Xo Ic respawn-pane
1837: .Op Fl k
1838: .Op Fl t Ar target-pane
1839: .Op Ar shell-command
1840: .Xc
1841: .D1 (alias: Ic respawnp )
1842: Reactivate a pane in which the command has exited (see the
1843: .Ic remain-on-exit
1844: window option).
1845: If
1846: .Ar shell-command
1847: is not given, the command used when the pane was created is executed.
1848: The pane must be already inactive, unless
1849: .Fl k
1850: is given, in which case any existing command is killed.
1.57 jmc 1851: .It Xo Ic respawn-window
1852: .Op Fl k
1853: .Op Fl t Ar target-window
1.153 nicm 1854: .Op Ar shell-command
1.57 jmc 1855: .Xc
1856: .D1 (alias: Ic respawnw )
1.153 nicm 1857: Reactivate a window in which the command has exited (see the
1.57 jmc 1858: .Ic remain-on-exit
1859: window option).
1860: If
1.153 nicm 1861: .Ar shell-command
1.57 jmc 1862: is not given, the command used when the window was created is executed.
1863: The window must be already inactive, unless
1864: .Fl k
1865: is given, in which case any existing command is killed.
1866: .It Xo Ic rotate-window
1867: .Op Fl DU
1868: .Op Fl t Ar target-window
1869: .Xc
1870: .D1 (alias: Ic rotatew )
1871: Rotate the positions of the panes within a window, either upward (numerically
1872: lower) with
1873: .Fl U
1874: or downward (numerically higher).
1875: .It Xo Ic select-layout
1.424 nicm 1876: .Op Fl nop
1.57 jmc 1877: .Op Fl t Ar target-window
1878: .Op Ar layout-name
1879: .Xc
1.176 nicm 1880: .D1 (alias: Ic selectl )
1.57 jmc 1881: Choose a specific layout for a window.
1882: If
1883: .Ar layout-name
1.181 nicm 1884: is not given, the last preset layout used (if any) is reapplied.
1.204 nicm 1885: .Fl n
1886: and
1887: .Fl p
1888: are equivalent to the
1889: .Ic next-layout
1890: and
1891: .Ic previous-layout
1892: commands.
1.424 nicm 1893: .Fl o
1894: applies the last set layout if possible (undoes the most recent layout change).
1.156 nicm 1895: .It Xo Ic select-pane
1.432 nicm 1896: .Op Fl DdegLlMmRU
1.418 nicm 1897: .Op Fl P Ar style
1.156 nicm 1898: .Op Fl t Ar target-pane
1899: .Xc
1.57 jmc 1900: .D1 (alias: Ic selectp )
1901: Make pane
1902: .Ar target-pane
1903: the active pane in window
1.418 nicm 1904: .Ar target-window ,
1.420 jmc 1905: or set its style (with
1.418 nicm 1906: .Fl P ) .
1.156 nicm 1907: If one of
1908: .Fl D ,
1909: .Fl L ,
1910: .Fl R ,
1911: or
1912: .Fl U
1913: is used, respectively the pane below, to the left, to the right, or above the
1914: target pane is used.
1.204 nicm 1915: .Fl l
1916: is the same as using the
1917: .Ic last-pane
1918: command.
1.398 nicm 1919: .Fl e
1920: enables or
1921: .Fl d
1922: disables input to the pane.
1.418 nicm 1923: .Pp
1.432 nicm 1924: .Fl m
1925: and
1926: .Fl M
1927: are used to set and clear the
1928: .Em marked pane .
1929: There is one marked pane at a time, setting a new marked pane clears the last.
1930: The marked pane is the default target for
1931: .Fl s
1932: to
1933: .Ic join-pane ,
1934: .Ic swap-pane
1935: and
1936: .Ic swap-window .
1937: .Pp
1.418 nicm 1938: Each pane has a style: by default the
1939: .Ic window-style
1940: and
1941: .Ic window-active-style
1942: options are used,
1943: .Ic select-pane
1944: .Fl P
1945: sets the style for a single pane.
1946: For example, to set the pane 1 background to red:
1947: .Bd -literal -offset indent
1948: select-pane -t:.1 -P 'bg=red'
1949: .Ed
1950: .Pp
1951: .Fl g
1952: shows the current pane style.
1.204 nicm 1953: .It Xo Ic select-window
1.310 nicm 1954: .Op Fl lnpT
1.204 nicm 1955: .Op Fl t Ar target-window
1956: .Xc
1.57 jmc 1957: .D1 (alias: Ic selectw )
1958: Select the window at
1959: .Ar target-window .
1.204 nicm 1960: .Fl l ,
1961: .Fl n
1962: and
1963: .Fl p
1964: are equivalent to the
1965: .Ic last-window ,
1966: .Ic next-window
1967: and
1968: .Ic previous-window
1969: commands.
1.310 nicm 1970: If
1971: .Fl T
1972: is given and the selected window is already the current window,
1973: the command behaves like
1974: .Ic last-window .
1.57 jmc 1975: .It Xo Ic split-window
1.502 nicm 1976: .Op Fl bdfhvP
1.272 nicm 1977: .Op Fl c Ar start-directory
1.57 jmc 1978: .Oo Fl l
1979: .Ar size |
1980: .Fl p Ar percentage Oc
1.136 nicm 1981: .Op Fl t Ar target-pane
1.153 nicm 1982: .Op Ar shell-command
1.279 nicm 1983: .Op Fl F Ar format
1.57 jmc 1984: .Xc
1.176 nicm 1985: .D1 (alias: Ic splitw )
1.136 nicm 1986: Create a new pane by splitting
1987: .Ar target-pane :
1.57 jmc 1988: .Fl h
1989: does a horizontal split and
1990: .Fl v
1991: a vertical split; if neither is specified,
1992: .Fl v
1993: is assumed.
1994: The
1995: .Fl l
1996: and
1997: .Fl p
1.136 nicm 1998: options specify the size of the new pane in lines (for vertical split) or in
1.57 jmc 1999: cells (for horizontal split), or as a percentage, respectively.
1.408 nicm 2000: The
2001: .Fl b
2002: option causes the new pane to be created to the left of or above
2003: .Ar target-pane .
1.494 nicm 2004: The
2005: .Fl f
2006: option creates a new pane spanning the full window height (with
2007: .Fl h )
2008: or full window width (with
2009: .Fl v ) ,
2010: instead of splitting the active pane.
1.136 nicm 2011: All other options have the same meaning as for the
1.57 jmc 2012: .Ic new-window
2013: command.
2014: .It Xo Ic swap-pane
2015: .Op Fl dDU
2016: .Op Fl s Ar src-pane
2017: .Op Fl t Ar dst-pane
2018: .Xc
2019: .D1 (alias: Ic swapp )
2020: Swap two panes.
2021: If
2022: .Fl U
2023: is used and no source pane is specified with
2024: .Fl s ,
2025: .Ar dst-pane
2026: is swapped with the previous pane (before it numerically);
2027: .Fl D
2028: swaps with the next pane (after it numerically).
1.138 nicm 2029: .Fl d
2030: instructs
2031: .Nm
2032: not to change the active pane.
1.432 nicm 2033: .Pp
2034: If
2035: .Fl s
2036: is omitted and a marked pane is present (see
2037: .Ic select-pane
2038: .Fl m ) ,
2039: the marked pane is used rather than the current pane.
1.57 jmc 2040: .It Xo Ic swap-window
2041: .Op Fl d
2042: .Op Fl s Ar src-window
2043: .Op Fl t Ar dst-window
2044: .Xc
2045: .D1 (alias: Ic swapw )
2046: This is similar to
2047: .Ic link-window ,
2048: except the source and destination windows are swapped.
2049: It is an error if no window exists at
2050: .Ar src-window .
1.432 nicm 2051: .Pp
2052: Like
2053: .Ic swap-pane ,
2054: if
2055: .Fl s
2056: is omitted and a marked pane is present (see
2057: .Ic select-pane
2058: .Fl m ) ,
2059: the window containing the marked pane is used rather than the current window.
1.57 jmc 2060: .It Xo Ic unlink-window
1.1 nicm 2061: .Op Fl k
2062: .Op Fl t Ar target-window
2063: .Xc
1.57 jmc 2064: .D1 (alias: Ic unlinkw )
2065: Unlink
2066: .Ar target-window .
2067: Unless
2068: .Fl k
2069: is given, a window may be unlinked only if it is linked to multiple sessions -
2070: windows may not be linked to no sessions;
2071: if
1.1 nicm 2072: .Fl k
1.57 jmc 2073: is specified and the window is linked to only one session, it is unlinked and
2074: destroyed.
2075: .El
2076: .Sh KEY BINDINGS
1.93 nicm 2077: .Nm
2078: allows a command to be bound to most keys, with or without a prefix key.
2079: When specifying keys, most represent themselves (for example
2080: .Ql A
2081: to
1.95 jmc 2082: .Ql Z ) .
1.93 nicm 2083: Ctrl keys may be prefixed with
2084: .Ql C-
2085: or
1.95 jmc 2086: .Ql ^ ,
2087: and Alt (meta) with
1.93 nicm 2088: .Ql M- .
2089: In addition, the following special key names are accepted:
1.126 nicm 2090: .Em Up ,
2091: .Em Down ,
2092: .Em Left ,
2093: .Em Right ,
1.93 nicm 2094: .Em BSpace ,
2095: .Em BTab ,
2096: .Em DC
2097: (Delete),
2098: .Em End ,
2099: .Em Enter ,
2100: .Em Escape ,
2101: .Em F1
2102: to
1.402 nicm 2103: .Em F12 ,
1.93 nicm 2104: .Em Home ,
2105: .Em IC
2106: (Insert),
1.254 nicm 2107: .Em NPage/PageDown/PgDn ,
2108: .Em PPage/PageUp/PgUp ,
1.93 nicm 2109: .Em Space ,
2110: and
2111: .Em Tab .
2112: Note that to bind the
2113: .Ql \&"
2114: or
2115: .Ql '
2116: keys, quotation marks are necessary, for example:
2117: .Bd -literal -offset indent
2118: bind-key '"' split-window
1.167 nicm 2119: bind-key "'" new-window
1.93 nicm 2120: .Ed
2121: .Pp
1.57 jmc 2122: Commands related to key bindings are as follows:
2123: .Bl -tag -width Ds
2124: .It Xo Ic bind-key
1.501 nicm 2125: .Op Fl nr
1.421 nicm 2126: .Op Fl T Ar key-table
1.57 jmc 2127: .Ar key Ar command Op Ar arguments
1.1 nicm 2128: .Xc
1.57 jmc 2129: .D1 (alias: Ic bind )
2130: Bind key
2131: .Ar key
2132: to
2133: .Ar command .
1.421 nicm 2134: Keys are bound in a key table.
2135: By default (without -T), the key is bound in
2136: the
2137: .Em prefix
2138: key table.
2139: This table is used for keys pressed after the prefix key (for example,
2140: by default
2141: .Ql c
2142: is bound to
2143: .Ic new-window
2144: in the
2145: .Em prefix
2146: table, so
2147: .Ql C-b c
2148: creates a new window).
2149: The
2150: .Em root
2151: table is used for keys pressed without the prefix key: binding
2152: .Ql c
2153: to
2154: .Ic new-window
2155: in the
2156: .Em root
2157: table (not recommended) means a plain
2158: .Ql c
2159: will create a new window.
1.57 jmc 2160: .Fl n
1.421 nicm 2161: is an alias
2162: for
2163: .Fl T Ar root .
2164: Keys may also be bound in custom key tables and the
2165: .Ic switch-client
2166: .Fl T
2167: command used to switch to them from a key binding.
1.1 nicm 2168: The
1.57 jmc 2169: .Fl r
2170: flag indicates this key may repeat, see the
2171: .Ic repeat-time
2172: option.
2173: .Pp
2174: To view the default bindings and possible commands, see the
2175: .Ic list-keys
2176: command.
1.421 nicm 2177: .It Xo Ic list-keys
2178: .Op Fl T Ar key-table
2179: .Xc
1.57 jmc 2180: .D1 (alias: Ic lsk )
2181: List all key bindings.
2182: Without
1.421 nicm 2183: .Fl T
2184: all key tables are printed.
2185: With
2186: .Fl T
2187: only
2188: .Ar key-table .
1.57 jmc 2189: .It Xo Ic send-keys
1.497 nicm 2190: .Op Fl lMRX
2191: .Op Fl N Ar repeat-count
1.72 nicm 2192: .Op Fl t Ar target-pane
1.57 jmc 2193: .Ar key Ar ...
1.1 nicm 2194: .Xc
1.57 jmc 2195: .D1 (alias: Ic send )
2196: Send a key or keys to a window.
2197: Each argument
2198: .Ar key
2199: is the name of the key (such as
2200: .Ql C-a
2201: or
1.523 nicm 2202: .Ql NPage )
2203: to send; if the string is not recognised as a key, it is sent as a series of
1.57 jmc 2204: characters.
1.273 nicm 2205: The
2206: .Fl l
2207: flag disables key name lookup and sends the keys literally.
1.57 jmc 2208: All arguments are sent sequentially from first to last.
1.265 nicm 2209: The
2210: .Fl R
2211: flag causes the terminal state to be reset.
1.419 nicm 2212: .Pp
2213: .Fl M
2214: passes through a mouse event (only valid if bound to a mouse key binding, see
1.420 jmc 2215: .Sx MOUSE SUPPORT ) .
1.497 nicm 2216: .Pp
2217: .Fl X
2218: is used to send a command into copy mode - see
2219: the
2220: .Sx WINDOWS AND PANES
2221: section.
2222: .Fl N
1.516 nicm 2223: specifies a repeat count.
1.267 nicm 2224: .It Xo Ic send-prefix
2225: .Op Fl 2
2226: .Op Fl t Ar target-pane
2227: .Xc
2228: Send the prefix key, or with
2229: .Fl 2
2230: the secondary prefix key, to a window as if it was pressed.
1.57 jmc 2231: .It Xo Ic unbind-key
1.501 nicm 2232: .Op Fl an
1.421 nicm 2233: .Op Fl T Ar key-table
1.57 jmc 2234: .Ar key
1.2 nicm 2235: .Xc
1.57 jmc 2236: .D1 (alias: Ic unbind )
2237: Unbind the command bound to
2238: .Ar key .
1.530 nicm 2239: .Fl n
2240: and
1.421 nicm 2241: .Fl T
2242: are the same as for
2243: .Ic bind-key .
1.189 nicm 2244: If
2245: .Fl a
2246: is present, all key bindings are removed.
1.57 jmc 2247: .El
2248: .Sh OPTIONS
2249: The appearance and behaviour of
2250: .Nm
2251: may be modified by changing the value of various options.
1.133 nicm 2252: There are three types of option:
2253: .Em server options ,
1.57 jmc 2254: .Em session options
2255: and
2256: .Em window options .
2257: .Pp
1.133 nicm 2258: The
2259: .Nm
2260: server has a set of global options which do not apply to any particular
2261: window or session.
2262: These are altered with the
2263: .Ic set-option
2264: .Fl s
2265: command, or displayed with the
2266: .Ic show-options
2267: .Fl s
2268: command.
2269: .Pp
2270: In addition, each individual session may have a set of session options, and
2271: there is a separate set of global session options.
1.57 jmc 2272: Sessions which do not have a particular option configured inherit the value
2273: from the global session options.
2274: Session options are set or unset with the
2275: .Ic set-option
2276: command and may be listed with the
2277: .Ic show-options
2278: command.
1.133 nicm 2279: The available server and session options are listed under the
1.57 jmc 2280: .Ic set-option
2281: command.
2282: .Pp
2283: Similarly, a set of window options is attached to each window, and there is
2284: a set of global window options from which any unset options are inherited.
2285: Window options are altered with the
2286: .Ic set-window-option
2287: command and can be listed with the
2288: .Ic show-window-options
2289: command.
2290: All window options are documented with the
2291: .Ic set-window-option
2292: command.
1.318 nicm 2293: .Pp
2294: .Nm
2295: also supports user options which are prefixed with a
2296: .Ql \&@ .
1.321 jmc 2297: User options may have any name, so long as they are prefixed with
2298: .Ql \&@ ,
1.318 nicm 2299: and be set to any string.
1.418 nicm 2300: For example:
1.318 nicm 2301: .Bd -literal -offset indent
2302: $ tmux setw -q @foo "abc123"
2303: $ tmux showw -v @foo
2304: abc123
2305: .Ed
1.57 jmc 2306: .Pp
2307: Commands which set options are as follows:
2308: .Bl -tag -width Ds
1.1 nicm 2309: .It Xo Ic set-option
1.550 nicm 2310: .Op Fl aFgoqsuw
1.129 nicm 2311: .Op Fl t Ar target-session | Ar target-window
1.1 nicm 2312: .Ar option Ar value
2313: .Xc
2314: .D1 (alias: Ic set )
1.133 nicm 2315: Set a window option with
2316: .Fl w
2317: (equivalent to the
2318: .Ic set-window-option
2319: command),
2320: a server option with
2321: .Fl s ,
2322: otherwise a session option.
2323: If
2324: .Fl g
1.433 nicm 2325: is given, the global session or window option is set.
1.550 nicm 2326: .Fl F
2327: expands formats in the option value.
1.1 nicm 2328: The
2329: .Fl u
2330: flag unsets an option, so a session inherits the option from the global
1.433 nicm 2331: options (or with
2332: .Fl g ,
2333: restores a global option to the default).
1.336 nicm 2334: .Pp
2335: The
2336: .Fl o
1.446 nicm 2337: flag prevents setting an option that is already set and the
1.281 nicm 2338: .Fl q
1.446 nicm 2339: flag suppresses errors about unknown or ambiguous options.
1.281 nicm 2340: .Pp
1.378 nicm 2341: With
2342: .Fl a ,
2343: and if the option expects a string or a style,
2344: .Ar value
2345: is appended to the existing setting.
2346: For example:
2347: .Bd -literal -offset indent
2348: set -g status-left "foo"
2349: set -ag status-left "bar"
2350: .Ed
2351: .Pp
2352: Will result in
2353: .Ql foobar .
2354: And:
2355: .Bd -literal -offset indent
2356: set -g status-style "bg=red"
2357: set -ag status-style "fg=blue"
2358: .Ed
2359: .Pp
2360: Will result in a red background
2361: .Em and
2362: blue foreground.
2363: Without
2364: .Fl a ,
2365: the result would be the default background and a blue foreground.
2366: .Pp
1.133 nicm 2367: Available window options are listed under
2368: .Ic set-window-option .
1.274 nicm 2369: .Pp
2370: .Ar value
2371: depends on the option and may be a number, a string, or a flag (on, off, or
2372: omitted to toggle).
1.133 nicm 2373: .Pp
2374: Available server options are:
2375: .Bl -tag -width Ds
1.198 nicm 2376: .It Ic buffer-limit Ar number
2377: Set the number of buffers; as new buffers are added to the top of the stack,
2378: old ones are removed from the bottom if necessary to maintain this maximum
2379: length.
1.526 nicm 2380: .It Xo Ic command-alias[]
2381: .Ar name=value
2382: .Xc
2383: This is an array of custom aliases for commands.
2384: If an unknown command matches
2385: .Ar name ,
2386: it is replaced with
2387: .Ar value .
2388: For example, after:
2389: .Pp
1.565 nicm 2390: .Dl set -s command-alias[100] zoom='resize-pane -Z'
1.526 nicm 2391: .Pp
2392: Using:
2393: .Pp
2394: .Dl zoom -t:.1
2395: .Pp
2396: Is equivalent to:
2397: .Pp
2398: .Dl resize-pane -Z -t:.1
2399: .Pp
2400: Note that aliases are expanded when a command is parsed rather than when it is
2401: executed, so binding an alias with
2402: .Ic bind-key
2403: will bind the expanded form.
1.425 nicm 2404: .It Ic default-terminal Ar terminal
2405: Set the default terminal for new windows created in this session - the
2406: default value of the
2407: .Ev TERM
2408: environment variable.
2409: For
2410: .Nm
2411: to work correctly, this
2412: .Em must
2413: be set to
2414: .Ql screen ,
2415: .Ql tmux
2416: or a derivative of them.
1.239 nicm 2417: .It Ic escape-time Ar time
2418: Set the time in milliseconds for which
2419: .Nm
2420: waits after an escape is input to determine if it is part of a function or meta
2421: key sequences.
2422: The default is 500 milliseconds.
2423: .It Xo Ic exit-unattached
2424: .Op Ic on | off
2425: .Xc
2426: If enabled, the server will exit when there are no attached clients.
1.362 nicm 2427: .It Xo Ic focus-events
2428: .Op Ic on | off
2429: .Xc
2430: When enabled, focus events are requested from the terminal if supported and
2431: passed through to applications running in
2432: .Nm .
2433: Attached clients should be detached and attached again after changing this
2434: option.
1.445 nicm 2435: .It Ic history-file Ar path
2436: If not empty, a file to which
2437: .Nm
2438: will write command prompt history on exit and load it from on start.
1.384 nicm 2439: .It Ic message-limit Ar number
2440: Set the number of error or information messages to save in the message log for
2441: each client.
2442: The default is 100.
1.228 nicm 2443: .It Xo Ic set-clipboard
1.556 nicm 2444: .Op Ic on | external | off
1.228 nicm 2445: .Xc
2446: Attempt to set the terminal clipboard content using the
2447: .Xr xterm 1
1.560 nicm 2448: escape sequence, if there is an
1.228 nicm 2449: .Em \&Ms
2450: entry in the
2451: .Xr terminfo 5
1.560 nicm 2452: description (see the
2453: .Sx TERMINFO EXTENSIONS
2454: section).
2455: .Pp
1.556 nicm 2456: If set to
2457: .Ic on ,
2458: .Nm
2459: will both accept the escape sequence to create a buffer and attempt to set
2460: the terminal clipboard.
2461: If set to
2462: .Ic external ,
2463: .Nm
2464: will attempt to set the terminal clipboard but ignore attempts
2465: by applications to set
2466: .Nm
2467: buffers.
2468: If
2469: .Ic off ,
2470: .Nm
2471: will neither accept the clipboard escape sequence nor attempt to set the
2472: clipboard.
2473: .Pp
1.228 nicm 2474: Note that this feature needs to be enabled in
2475: .Xr xterm 1
2476: by setting the resource:
2477: .Bd -literal -offset indent
2478: disallowedWindowOps: 20,21,SetXprop
2479: .Ed
2480: .Pp
2481: Or changing this property from the
2482: .Xr xterm 1
2483: interactive menu when required.
1.528 nicm 2484: .It Ic terminal-overrides[] Ar string
2485: Allow terminal descriptions read using
2486: .Xr terminfo 5
1.531 nicm 2487: to be overridden.
1.528 nicm 2488: Each entry is a colon-separated string made up of a terminal type pattern
2489: (matched using
1.381 nicm 2490: .Xr fnmatch 3 )
2491: and a set of
2492: .Em name=value
2493: entries.
2494: .Pp
2495: For example, to set the
2496: .Ql clear
2497: .Xr terminfo 5
2498: entry to
2499: .Ql \ee[H\ee[2J
1.528 nicm 2500: for all terminal types matching
2501: .Ql rxvt* :
2502: .Pp
2503: .Dl "rxvt*:clear=\ee[H\ee[2J"
1.381 nicm 2504: .Pp
2505: The terminal entry value is passed through
2506: .Xr strunvis 3
2507: before interpretation.
1.133 nicm 2508: .El
1.129 nicm 2509: .Pp
1.18 nicm 2510: Available session options are:
1.1 nicm 2511: .Bl -tag -width Ds
1.312 nicm 2512: .It Ic assume-paste-time Ar milliseconds
2513: If keys are entered faster than one in
2514: .Ar milliseconds ,
2515: they are assumed to have been pasted rather than typed and
2516: .Nm
2517: key bindings are not processed.
2518: The default is one millisecond and zero disables.
1.69 nicm 2519: .It Ic base-index Ar index
2520: Set the base index from which an unused index should be searched when a new
2521: window is created.
2522: The default is zero.
1.1 nicm 2523: .It Xo Ic bell-action
1.429 nicm 2524: .Op Ic any | none | current | other
1.1 nicm 2525: .Xc
2526: Set action on window bell.
2527: .Ic any
2528: means a bell in any window linked to a session causes a bell in the current
2529: window of that session,
2530: .Ic none
1.429 nicm 2531: means all bells are ignored,
1.1 nicm 2532: .Ic current
1.429 nicm 2533: means only bells in windows other than the current window are ignored and
2534: .Ic other
2535: means bells in the current window are ignored but not those in other windows.
1.237 nicm 2536: .It Xo Ic bell-on-alert
2537: .Op Ic on | off
2538: .Xc
1.295 nicm 2539: If on, ring the terminal bell when an alert
1.237 nicm 2540: occurs.
1.153 nicm 2541: .It Ic default-command Ar shell-command
1.1 nicm 2542: Set the command used for new windows (if not specified when the window is
2543: created) to
1.153 nicm 2544: .Ar shell-command ,
1.79 nicm 2545: which may be any
2546: .Xr sh 1
2547: command.
1.19 nicm 2548: The default is an empty string, which instructs
2549: .Nm
1.79 nicm 2550: to create a login shell using the value of the
2551: .Ic default-shell
2552: option.
2553: .It Ic default-shell Ar path
2554: Specify the default shell.
2555: This is used as the login shell for new windows when the
2556: .Ic default-command
2557: option is set to empty, and must be the full path of the executable.
2558: When started
2559: .Nm
2560: tries to set a default value from the first suitable of the
1.19 nicm 2561: .Ev SHELL
1.79 nicm 2562: environment variable, the shell returned by
2563: .Xr getpwuid 3 ,
2564: or
2565: .Pa /bin/sh .
2566: This option should be configured when
2567: .Nm
2568: is used as a login shell.
1.206 nicm 2569: .It Xo Ic destroy-unattached
2570: .Op Ic on | off
2571: .Xc
1.185 nicm 2572: If enabled and the session is no longer attached to any clients, it is
2573: destroyed.
1.206 nicm 2574: .It Xo Ic detach-on-destroy
2575: .Op Ic on | off
2576: .Xc
1.184 nicm 2577: If on (the default), the client is detached when the session it is attached to
2578: is destroyed.
2579: If off, the client is switched to the most recently active of the remaining
2580: sessions.
1.145 nicm 2581: .It Ic display-panes-active-colour Ar colour
2582: Set the colour used by the
2583: .Ic display-panes
2584: command to show the indicator for the active pane.
1.78 nicm 2585: .It Ic display-panes-colour Ar colour
1.145 nicm 2586: Set the colour used by the
1.78 nicm 2587: .Ic display-panes
1.145 nicm 2588: command to show the indicators for inactive panes.
1.78 nicm 2589: .It Ic display-panes-time Ar time
2590: Set the time in milliseconds for which the indicators shown by the
2591: .Ic display-panes
2592: command appear.
1.21 nicm 2593: .It Ic display-time Ar time
1.78 nicm 2594: Set the amount of time for which status line messages and other on-screen
2595: indicators are displayed.
1.462 tim 2596: If set to 0, messages and indicators are displayed until a key is pressed.
1.21 nicm 2597: .Ar time
2598: is in milliseconds.
1.1 nicm 2599: .It Ic history-limit Ar lines
2600: Set the maximum number of lines held in window history.
2601: This setting applies only to new windows - existing window histories are not
2602: resized and retain the limit at the point they were created.
1.474 nicm 2603: .It Ic key-table Ar key-table
2604: Set the default key table to
2605: .Ar key-table
2606: instead of
2607: .Em root .
1.1 nicm 2608: .It Ic lock-after-time Ar number
1.100 nicm 2609: Lock the session (like the
2610: .Ic lock-session
1.90 nicm 2611: command) after
1.1 nicm 2612: .Ar number
1.448 nicm 2613: seconds of inactivity.
1.100 nicm 2614: The default is not to lock (set to 0).
1.153 nicm 2615: .It Ic lock-command Ar shell-command
1.90 nicm 2616: Command to run when locking each client.
2617: The default is to run
2618: .Xr lock 1
2619: with
2620: .Fl np .
1.378 nicm 2621: .It Ic message-command-style Ar style
2622: Set status line message command style, where
2623: .Ar style
2624: is a comma-separated list of characteristics to be specified.
2625: .Pp
2626: These may be
2627: .Ql bg=colour
2628: to set the background colour,
2629: .Ql fg=colour
2630: to set the foreground colour, and a list of attributes as specified below.
2631: .Pp
2632: The colour is one of:
1.1 nicm 2633: .Ic black ,
2634: .Ic red ,
2635: .Ic green ,
2636: .Ic yellow ,
2637: .Ic blue ,
2638: .Ic magenta ,
2639: .Ic cyan ,
1.85 nicm 2640: .Ic white ,
1.266 nicm 2641: aixterm bright variants (if supported:
2642: .Ic brightred ,
2643: .Ic brightgreen ,
2644: and so on),
1.85 nicm 2645: .Ic colour0
2646: to
2647: .Ic colour255
1.205 nicm 2648: from the 256-colour set,
2649: .Ic default ,
2650: or a hexadecimal RGB string such as
2651: .Ql #ffffff ,
2652: which chooses the closest match from the default 256-colour set.
1.378 nicm 2653: .Pp
2654: The attributes is either
2655: .Ic none
2656: or a comma-delimited list of one or more of:
2657: .Ic bright
2658: (or
2659: .Ic bold ) ,
2660: .Ic dim ,
2661: .Ic underscore ,
2662: .Ic blink ,
2663: .Ic reverse ,
2664: .Ic hidden ,
1.539 nicm 2665: .Ic italics ,
1.378 nicm 2666: or
1.539 nicm 2667: .Ic strikethrough
1.378 nicm 2668: to turn an attribute on, or an attribute prefixed with
2669: .Ql no
2670: to turn one off.
2671: .Pp
2672: Examples are:
2673: .Bd -literal -offset indent
2674: fg=yellow,bold,underscore,blink
2675: bg=black,fg=default,noreverse
2676: .Ed
2677: .Pp
2678: With the
2679: .Fl a
2680: flag to the
2681: .Ic set-option
2682: command the new style is added otherwise the existing style is replaced.
2683: .It Ic message-style Ar style
2684: Set status line message style.
2685: For how to specify
2686: .Ar style ,
2687: see the
2688: .Ic message-command-style
2689: option.
1.419 nicm 2690: .It Xo Ic mouse
1.226 nicm 2691: .Op Ic on | off
2692: .Xc
2693: If on,
2694: .Nm
1.419 nicm 2695: captures the mouse and allows mouse events to be bound as key bindings.
2696: See the
2697: .Sx MOUSE SUPPORT
2698: section for details.
1.267 nicm 2699: .It Ic prefix Ar key
2700: Set the key accepted as a prefix key.
1.473 nicm 2701: In addition to the standard keys described under
2702: .Sx KEY BINDINGS ,
2703: .Ic prefix
2704: can be set to the special key
2705: .Ql None
2706: to set no prefix.
1.267 nicm 2707: .It Ic prefix2 Ar key
2708: Set a secondary key accepted as a prefix key.
1.473 nicm 2709: Like
2710: .Ic prefix ,
2711: .Ic prefix2
2712: can be set to
2713: .Ql None .
1.291 nicm 2714: .It Xo Ic renumber-windows
2715: .Op Ic on | off
2716: .Xc
2717: If on, when a window is closed in a session, automatically renumber the other
2718: windows in numerical order.
2719: This respects the
2720: .Ic base-index
2721: option if it has been set.
2722: If off, do not renumber the windows.
1.21 nicm 2723: .It Ic repeat-time Ar time
1.1 nicm 2724: Allow multiple commands to be entered without pressing the prefix-key again
2725: in the specified
1.21 nicm 2726: .Ar time
1.1 nicm 2727: milliseconds (the default is 500).
2728: Whether a key repeats may be set when it is bound using the
2729: .Fl r
2730: flag to
2731: .Ic bind-key .
1.52 nicm 2732: Repeat is enabled for the default keys bound to the
2733: .Ic resize-pane
2734: command.
1.1 nicm 2735: .It Xo Ic set-titles
1.56 jmc 2736: .Op Ic on | off
1.1 nicm 2737: .Xc
1.261 nicm 2738: Attempt to set the client terminal title using the
2739: .Em tsl
2740: and
2741: .Em fsl
2742: .Xr terminfo 5
2743: entries if they exist.
2744: .Nm
1.444 nicm 2745: automatically sets these to the \ee]0;...\e007 sequence if
2746: the terminal appears to be
2747: .Xr xterm 1 .
1.11 nicm 2748: This option is off by default.
1.86 nicm 2749: .It Ic set-titles-string Ar string
2750: String used to set the window title if
2751: .Ic set-titles
2752: is on.
1.414 nicm 2753: Formats are expanded, see the
2754: .Sx FORMATS
2755: section.
1.1 nicm 2756: .It Xo Ic status
1.56 jmc 2757: .Op Ic on | off
1.1 nicm 2758: .Xc
2759: Show or hide the status line.
2760: .It Ic status-interval Ar interval
1.538 nicm 2761: Update the status line every
1.1 nicm 2762: .Ar interval
2763: seconds.
2764: By default, updates will occur every 15 seconds.
2765: A setting of zero disables redrawing at interval.
1.41 nicm 2766: .It Xo Ic status-justify
1.56 jmc 2767: .Op Ic left | centre | right
1.41 nicm 2768: .Xc
2769: Set the position of the window list component of the status line: left, centre
2770: or right justified.
1.1 nicm 2771: .It Xo Ic status-keys
1.56 jmc 2772: .Op Ic vi | emacs
1.1 nicm 2773: .Xc
1.6 jmc 2774: Use vi or emacs-style
1.1 nicm 2775: key bindings in the status line, for example at the command prompt.
1.191 nicm 2776: The default is emacs, unless the
2777: .Ev VISUAL
2778: or
2779: .Ev EDITOR
2780: environment variables are set and contain the string
2781: .Ql vi .
1.1 nicm 2782: .It Ic status-left Ar string
2783: Display
2784: .Ar string
1.538 nicm 2785: (by default the session name) to the left of the status line.
1.1 nicm 2786: .Ar string
2787: will be passed through
2788: .Xr strftime 3
1.359 nicm 2789: and formats (see
1.379 jmc 2790: .Sx FORMATS )
1.359 nicm 2791: will be expanded.
1.486 jmc 2792: It may also contain the special character sequence #[] to change the colour
1.485 nicm 2793: or attributes, for example
2794: .Ql #[fg=red,bright]
2795: to set a bright red foreground.
2796: See the
2797: .Ic message-command-style
2798: option for a description of colours and attributes.
1.83 nicm 2799: .Pp
1.263 nicm 2800: For details on how the names and titles can be set see the
1.261 nicm 2801: .Sx "NAMES AND TITLES"
2802: section.
1.109 nicm 2803: .Pp
1.83 nicm 2804: Examples are:
2805: .Bd -literal -offset indent
2806: #(sysctl vm.loadavg)
2807: #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
2808: .Ed
1.10 nicm 2809: .Pp
1.405 nicm 2810: The default is
2811: .Ql "[#S] " .
1.1 nicm 2812: .It Ic status-left-length Ar length
2813: Set the maximum
2814: .Ar length
1.538 nicm 2815: of the left component of the status line.
1.1 nicm 2816: The default is 10.
1.378 nicm 2817: .It Ic status-left-style Ar style
2818: Set the style of the left part of the status line.
2819: For how to specify
2820: .Ar style ,
2821: see the
2822: .Ic message-command-style
2823: option.
1.269 nicm 2824: .It Xo Ic status-position
2825: .Op Ic top | bottom
2826: .Xc
2827: Set the position of the status line.
1.1 nicm 2828: .It Ic status-right Ar string
2829: Display
2830: .Ar string
1.538 nicm 2831: to the right of the status line.
1.151 nicm 2832: By default, the current window title in double quotes, the date and the time
2833: are shown.
1.1 nicm 2834: As with
2835: .Ic status-left ,
2836: .Ar string
2837: will be passed to
1.459 jmc 2838: .Xr strftime 3
2839: and character pairs are replaced.
1.1 nicm 2840: .It Ic status-right-length Ar length
2841: Set the maximum
2842: .Ar length
1.538 nicm 2843: of the right component of the status line.
1.1 nicm 2844: The default is 40.
1.378 nicm 2845: .It Ic status-right-style Ar style
2846: Set the style of the right part of the status line.
2847: For how to specify
2848: .Ar style ,
2849: see the
2850: .Ic message-command-style
2851: option.
2852: .It Ic status-style Ar style
2853: Set status line style.
2854: For how to specify
2855: .Ar style ,
2856: see the
2857: .Ic message-command-style
2858: option.
1.529 nicm 2859: .It Ic update-environment[] Ar variable
2860: Set list of environment variables to be copied into the session environment
2861: when a new session is created or an existing session is attached.
1.63 nicm 2862: Any variables that do not exist in the source environment are set to be
2863: removed from the session environment (as if
2864: .Fl r
2865: was given to the
2866: .Ic set-environment
2867: command).
1.563 nicm 2868: .It Ic user-keys[] Ar key
2869: Set list of user-defined key escape sequences.
2870: Each item is associated with a key named
1.564 nicm 2871: .Ql User0 ,
2872: .Ql User1 ,
1.563 nicm 2873: and so on.
2874: .Pp
2875: For example:
2876: .Bd -literal -offset indent
2877: set -s user-keys[0] '\e[5;30012~'
2878: bind User0 resize-pane -L 3
2879: .Ed
1.37 nicm 2880: .It Xo Ic visual-activity
1.56 jmc 2881: .Op Ic on | off
1.37 nicm 2882: .Xc
2883: If on, display a status line message when activity occurs in a window
1.39 jmc 2884: for which the
1.37 nicm 2885: .Ic monitor-activity
2886: window option is enabled.
2887: .It Xo Ic visual-bell
1.56 jmc 2888: .Op Ic on | off
1.37 nicm 2889: .Xc
2890: If this option is on, a message is shown on a bell instead of it being passed
2891: through to the terminal (which normally makes a sound).
2892: Also see the
2893: .Ic bell-action
2894: option.
1.192 nicm 2895: .It Xo Ic visual-silence
2896: .Op Ic on | off
2897: .Xc
2898: If
2899: .Ic monitor-silence
2900: is enabled, prints a message after the interval has expired on a given window.
1.255 nicm 2901: .It Ic word-separators Ar string
2902: Sets the session's conception of what characters are considered word
2903: separators, for the purposes of the next and previous word commands in
2904: copy mode.
2905: The default is
2906: .Ql \ -_@ .
1.1 nicm 2907: .El
2908: .It Xo Ic set-window-option
1.550 nicm 2909: .Op Fl aFgoqu
1.1 nicm 2910: .Op Fl t Ar target-window
2911: .Ar option Ar value
2912: .Xc
2913: .D1 (alias: Ic setw )
1.18 nicm 2914: Set a window option.
1.1 nicm 2915: The
1.58 nicm 2916: .Fl a ,
1.550 nicm 2917: .Fl F ,
1.281 nicm 2918: .Fl g ,
1.356 nicm 2919: .Fl o ,
1.281 nicm 2920: .Fl q
1.1 nicm 2921: and
2922: .Fl u
2923: flags work similarly to the
2924: .Ic set-option
2925: command.
2926: .Pp
1.18 nicm 2927: Supported window options are:
1.56 jmc 2928: .Pp
2929: .Bl -tag -width Ds -compact
1.1 nicm 2930: .It Xo Ic aggressive-resize
1.56 jmc 2931: .Op Ic on | off
1.1 nicm 2932: .Xc
2933: Aggressively resize the chosen window.
2934: This means that
2935: .Nm
2936: will resize the window to the size of the smallest session for which it is the
2937: current window, rather than the smallest session to which it is attached.
2938: The window may resize when the current window is changed on another sessions;
1.6 jmc 2939: this option is good for full-screen programs which support
2940: .Dv SIGWINCH
2941: and poor for interactive programs such as shells.
1.262 nicm 2942: .Pp
2943: .It Xo Ic allow-rename
2944: .Op Ic on | off
2945: .Xc
2946: Allow programs to change the window name using a terminal escape
1.478 nicm 2947: sequence (\eek...\ee\e\e).
1.262 nicm 2948: The default is on.
1.56 jmc 2949: .Pp
1.196 nicm 2950: .It Xo Ic alternate-screen
2951: .Op Ic on | off
2952: .Xc
2953: This option configures whether programs running inside
2954: .Nm
2955: may use the terminal alternate screen feature, which allows the
2956: .Em smcup
2957: and
2958: .Em rmcup
2959: .Xr terminfo 5
1.209 nicm 2960: capabilities.
2961: The alternate screen feature preserves the contents of the window when an
2962: interactive application starts and restores it on exit, so that any output
2963: visible before the application starts reappears unchanged after it exits.
2964: The default is on.
1.196 nicm 2965: .Pp
1.1 nicm 2966: .It Xo Ic automatic-rename
1.56 jmc 2967: .Op Ic on | off
1.1 nicm 2968: .Xc
2969: Control automatic window renaming.
2970: When this setting is enabled,
2971: .Nm
1.368 nicm 2972: will rename the window automatically using the format specified by
2973: .Ic automatic-rename-format .
1.1 nicm 2974: This flag is automatically disabled for an individual window when a name
2975: is specified at creation with
1.186 nicm 2976: .Ic new-window
2977: or
1.1 nicm 2978: .Ic new-session ,
2979: or later with
1.261 nicm 2980: .Ic rename-window ,
2981: or with a terminal escape sequence.
1.1 nicm 2982: It may be switched off globally with:
2983: .Bd -literal -offset indent
2984: set-window-option -g automatic-rename off
2985: .Ed
1.368 nicm 2986: .Pp
2987: .It Ic automatic-rename-format Ar format
2988: The format (see
2989: .Sx FORMATS )
2990: used when the
2991: .Ic automatic-rename
2992: option is enabled.
1.56 jmc 2993: .Pp
1.1 nicm 2994: .It Ic clock-mode-colour Ar colour
2995: Set clock colour.
1.56 jmc 2996: .Pp
1.1 nicm 2997: .It Xo Ic clock-mode-style
1.56 jmc 2998: .Op Ic 12 | 24
1.1 nicm 2999: .Xc
3000: Set clock hour format.
1.56 jmc 3001: .Pp
1.1 nicm 3002: .It Ic force-height Ar height
3003: .It Ic force-width Ar width
3004: Prevent
3005: .Nm
3006: from resizing a window to greater than
3007: .Ar width
3008: or
3009: .Ar height .
3010: A value of zero restores the default unlimited setting.
1.56 jmc 3011: .Pp
1.196 nicm 3012: .It Ic main-pane-height Ar height
1.2 nicm 3013: .It Ic main-pane-width Ar width
3014: Set the width or height of the main (left or top) pane in the
3015: .Ic main-horizontal
3016: or
3017: .Ic main-vertical
3018: layouts.
1.56 jmc 3019: .Pp
1.1 nicm 3020: .It Xo Ic mode-keys
1.56 jmc 3021: .Op Ic vi | emacs
1.1 nicm 3022: .Xc
1.500 nicm 3023: Use vi or emacs-style key bindings in copy mode.
3024: The default is emacs, unless
1.191 nicm 3025: .Ev VISUAL
3026: or
3027: .Ev EDITOR
3028: contains
3029: .Ql vi .
1.56 jmc 3030: .Pp
1.378 nicm 3031: .It Ic mode-style Ar style
3032: Set window modes style.
3033: For how to specify
3034: .Ar style ,
3035: see the
3036: .Ic message-command-style
3037: option.
3038: .Pp
1.1 nicm 3039: .It Xo Ic monitor-activity
1.56 jmc 3040: .Op Ic on | off
1.1 nicm 3041: .Xc
3042: Monitor for activity in the window.
3043: Windows with activity are highlighted in the status line.
1.56 jmc 3044: .Pp
1.192 nicm 3045: .It Xo Ic monitor-silence
3046: .Op Ic interval
3047: .Xc
3048: Monitor for silence (no activity) in the window within
3049: .Ic interval
3050: seconds.
3051: Windows that have been silent for the interval are highlighted in the
3052: status line.
3053: An interval of zero disables the monitoring.
1.195 nicm 3054: .Pp
3055: .It Ic other-pane-height Ar height
3056: Set the height of the other panes (not the main pane) in the
3057: .Ic main-horizontal
3058: layout.
3059: If this option is set to 0 (the default), it will have no effect.
3060: If both the
3061: .Ic main-pane-height
3062: and
3063: .Ic other-pane-height
3064: options are set, the main pane will grow taller to make the other panes the
3065: specified height, but will never shrink to do so.
3066: .Pp
3067: .It Ic other-pane-width Ar width
3068: Like
3069: .Ic other-pane-height ,
3070: but set the width of other panes in the
3071: .Ic main-vertical
3072: layout.
1.243 nicm 3073: .Pp
1.413 nicm 3074: .It Ic pane-active-border-style Ar style
3075: Set the pane border style for the currently active pane.
3076: For how to specify
3077: .Ar style ,
3078: see the
3079: .Ic message-command-style
3080: option.
3081: Attributes are ignored.
3082: .Pp
1.243 nicm 3083: .It Ic pane-base-index Ar index
3084: Like
3085: .Ic base-index ,
3086: but set the starting index for pane numbers.
1.484 nicm 3087: .Pp
3088: .It Ic pane-border-format Ar format
3089: Set the text shown in pane border status lines.
3090: .Pp
3091: .It Xo Ic pane-border-status
3092: .Op Ic off | top | bottom
3093: .Xc
3094: Turn pane border status lines off or set their position.
1.413 nicm 3095: .Pp
3096: .It Ic pane-border-style Ar style
3097: Set the pane border style for panes aside from the active pane.
3098: For how to specify
3099: .Ar style ,
3100: see the
3101: .Ic message-command-style
3102: option.
3103: Attributes are ignored.
1.192 nicm 3104: .Pp
1.1 nicm 3105: .It Xo Ic remain-on-exit
1.56 jmc 3106: .Op Ic on | off
1.1 nicm 3107: .Xc
3108: A window with this flag set is not destroyed when the program running in it
3109: exits.
3110: The window may be reactivated with the
3111: .Ic respawn-window
3112: command.
1.56 jmc 3113: .Pp
1.99 nicm 3114: .It Xo Ic synchronize-panes
3115: .Op Ic on | off
3116: .Xc
1.164 nicm 3117: Duplicate input to any pane to all other panes in the same window (only
3118: for panes that are not in any special mode).
1.56 jmc 3119: .Pp
1.418 nicm 3120: .It Ic window-active-style Ar style
3121: Set the style for the window's active pane.
3122: For how to specify
3123: .Ar style ,
3124: see the
3125: .Ic message-command-style
3126: option.
3127: .Pp
1.378 nicm 3128: .It Ic window-status-activity-style Ar style
3129: Set status line style for windows with an activity alert.
3130: For how to specify
3131: .Ar style ,
3132: see the
3133: .Ic message-command-style
3134: option.
1.169 nicm 3135: .Pp
1.378 nicm 3136: .It Ic window-status-bell-style Ar style
3137: Set status line style for windows with a bell alert.
3138: For how to specify
3139: .Ar style ,
3140: see the
3141: .Ic message-command-style
3142: option.
1.169 nicm 3143: .Pp
1.125 nicm 3144: .It Ic window-status-current-format Ar string
3145: Like
3146: .Ar window-status-format ,
3147: but is the format used when the window is the current window.
1.307 nicm 3148: .Pp
1.378 nicm 3149: .It Ic window-status-current-style Ar style
3150: Set status line style for the currently active window.
3151: For how to specify
3152: .Ar style ,
3153: see the
3154: .Ic message-command-style
3155: option.
1.239 nicm 3156: .Pp
3157: .It Ic window-status-format Ar string
3158: Set the format in which the window is displayed in the status line window list.
3159: See the
3160: .Ar status-left
3161: option for details of special character sequences available.
3162: The default is
3163: .Ql #I:#W#F .
1.290 nicm 3164: .Pp
1.378 nicm 3165: .It Ic window-status-last-style Ar style
3166: Set status line style for the last active window.
3167: For how to specify
3168: .Ar style ,
3169: see the
3170: .Ic message-command-style
3171: option.
3172: .Pp
1.290 nicm 3173: .It Ic window-status-separator Ar string
3174: Sets the separator drawn between windows in the status line.
3175: The default is a single space character.
1.125 nicm 3176: .Pp
1.378 nicm 3177: .It Ic window-status-style Ar style
3178: Set status line style for a single window.
1.418 nicm 3179: For how to specify
3180: .Ar style ,
3181: see the
3182: .Ic message-command-style
3183: option.
3184: .Pp
3185: .It Ic window-style Ar style
3186: Set the default window style.
1.378 nicm 3187: For how to specify
3188: .Ar style ,
3189: see the
3190: .Ic message-command-style
3191: option.
3192: .Pp
1.512 nicm 3193: .It Xo Ic wrap-search
3194: .Op Ic on | off
3195: .Xc
3196: If this option is set, searches will wrap around the end of the pane contents.
3197: The default is on.
1.513 nicm 3198: .Pp
1.1 nicm 3199: .It Xo Ic xterm-keys
1.56 jmc 3200: .Op Ic on | off
1.1 nicm 3201: .Xc
3202: If this option is set,
3203: .Nm
3204: will generate
1.57 jmc 3205: .Xr xterm 1 -style
3206: function key sequences; these have a number included to indicate modifiers such
3207: as Shift, Alt or Ctrl.
3208: .El
3209: .It Xo Ic show-options
1.340 nicm 3210: .Op Fl gqsvw
1.129 nicm 3211: .Op Fl t Ar target-session | Ar target-window
1.276 nicm 3212: .Op Ar option
1.57 jmc 3213: .Xc
3214: .D1 (alias: Ic show )
1.276 nicm 3215: Show the window options (or a single window option if given) with
1.129 nicm 3216: .Fl w
1.133 nicm 3217: (equivalent to
1.134 nicm 3218: .Ic show-window-options ) ,
1.133 nicm 3219: the server options with
3220: .Fl s ,
3221: otherwise the session options for
3222: .Ar target session .
3223: Global session or window options are listed if
3224: .Fl g
3225: is used.
1.317 nicm 3226: .Fl v
3227: shows only the option value, not the name.
1.340 nicm 3228: If
3229: .Fl q
3230: is set, no error will be returned if
3231: .Ar option
3232: is unset.
1.57 jmc 3233: .It Xo Ic show-window-options
1.317 nicm 3234: .Op Fl gv
1.57 jmc 3235: .Op Fl t Ar target-window
1.276 nicm 3236: .Op Ar option
1.57 jmc 3237: .Xc
3238: .D1 (alias: Ic showw )
1.276 nicm 3239: List the window options or a single option for
1.57 jmc 3240: .Ar target-window ,
3241: or the global window options if
3242: .Fl g
3243: is used.
1.317 nicm 3244: .Fl v
3245: shows only the option value, not the name.
1.63 nicm 3246: .El
1.469 nicm 3247: .Sh HOOKS
3248: .Nm
3249: allows commands to run on various triggers, called
3250: .Em hooks .
1.505 nicm 3251: Most
1.483 nicm 3252: .Nm
1.505 nicm 3253: commands have an
1.483 nicm 3254: .Em after
3255: hook and there are a number of hooks not associated with commands.
3256: .Pp
1.505 nicm 3257: A command's after
3258: hook is run after it completes, except when the command is run as part of a hook
1.483 nicm 3259: itself.
1.505 nicm 3260: They are named with an
1.483 nicm 3261: .Ql after-
3262: prefix.
3263: For example, the following command adds a hook to select the even-vertical
3264: layout after every
3265: .Ic split-window :
3266: .Bd -literal -offset indent
3267: set-hook after-split-window "selectl even-vertical"
3268: .Ed
3269: .Pp
3270: In addition, the following hooks are available:
1.560 nicm 3271: .Bl -tag -width "XXXXXXXXXXXXXXXXXXXXXX"
1.476 nicm 3272: .It alert-activity
3273: Run when a window has activity.
3274: See
3275: .Ic monitor-activity .
3276: .It alert-bell
3277: Run when a window has received a bell.
3278: .It alert-silence
3279: Run when a window has been silent.
3280: See
3281: .Ic monitor-silence .
1.469 nicm 3282: .It client-attached
3283: Run when a client is attached.
3284: .It client-detached
3285: Run when a client is detached
3286: .It client-resized
3287: Run when a client is resized.
1.511 nicm 3288: .It client-session-changed
3289: Run when a client's attached session is changed.
1.475 nicm 3290: .It pane-died
3291: Run when the program running in a pane exits, but
3292: .Ic remain-on-exit
3293: is on so the pane has not closed.
3294: .It pane-exited
3295: Run when the program running in a pane exits.
1.560 nicm 3296: .It pane-set-clipboard
3297: Run when the terminal clipboard is set using the
3298: .Xr xterm 1
3299: escape sequence.
1.510 nicm 3300: .It session-created
3301: Run when a new session created.
3302: .It session-closed
3303: Run when a session closed.
1.507 nicm 3304: .It session-renamed
3305: Run when a session is renamed.
1.511 nicm 3306: .It window-linked
3307: Run when a window is linked into a session.
1.507 nicm 3308: .It window-renamed
3309: Run when a window is renamed.
1.511 nicm 3310: .It window-unlinked
3311: Run when a window is unlinked from a session.
1.469 nicm 3312: .El
3313: .Pp
3314: Hooks are managed with these commands:
3315: .Bl -tag -width Ds
3316: .It Xo Ic set-hook
1.496 nicm 3317: .Op Fl gu
1.469 nicm 3318: .Op Fl t Ar target-session
3319: .Ar hook-name
3320: .Ar command
3321: .Xc
1.496 nicm 3322: Sets (or with
3323: .Fl u
3324: unsets) hook
1.469 nicm 3325: .Ar hook-name
3326: to
3327: .Ar command .
3328: If
3329: .Fl g
3330: is given,
3331: .Em hook-name
3332: is added to the global list of hooks, otherwise it is added to the session
3333: hooks (for
3334: .Ar target-session
3335: with
3336: .Fl t ) .
3337: Like options, session hooks inherit from the global ones.
3338: .It Xo Ic show-hooks
3339: .Op Fl g
3340: .Op Fl t Ar target-session
3341: .Xc
3342: Shows the global list of hooks with
3343: .Fl g ,
3344: otherwise the session hooks.
1.470 jmc 3345: .El
1.419 nicm 3346: .Sh MOUSE SUPPORT
3347: If the
3348: .Ic mouse
3349: option is on (the default is off),
3350: .Nm
3351: allows mouse events to be bound as keys.
3352: The name of each key is made up of a mouse event (such as
3353: .Ql MouseUp1 )
3354: and a location suffix (one of
3355: .Ql Pane
3356: for the contents of a pane,
3357: .Ql Border
3358: for a pane border or
3359: .Ql Status
3360: for the status line).
3361: The following mouse events are available:
3362: .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
1.498 nicm 3363: .It Li "WheelUp" Ta "WheelDown" Ta ""
1.481 nicm 3364: .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
3365: .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
3366: .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
1.498 nicm 3367: .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3" Ta "WheelUp"
3368: .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3" Ta "WheelDown"
1.419 nicm 3369: .El
3370: .Pp
3371: Each should be suffixed with a location, for example
3372: .Ql MouseDown1Status .
3373: .Pp
1.423 nicm 3374: The special token
3375: .Ql {mouse}
3376: or
1.419 nicm 3377: .Ql =
3378: may be used as
3379: .Ar target-window
3380: or
3381: .Ar target-pane
3382: in commands bound to mouse key bindings.
3383: It resolves to the window or pane over which the mouse event took place
3384: (for example, the window in the status line over which button 1 was released for a
3385: .Ql MouseUp1Status
3386: binding, or the pane over which the wheel was scrolled for a
3387: .Ql WheelDownPane
3388: binding).
3389: .Pp
3390: The
3391: .Ic send-keys
3392: .Fl M
3393: flag may be used to forward a mouse event to a pane.
3394: .Pp
3395: The default key bindings allow the mouse to be used to select and resize panes,
3396: to copy text and to change window using the status line.
3397: These take effect if the
3398: .Ic mouse
3399: option is turned on.
1.245 nicm 3400: .Sh FORMATS
1.294 nicm 3401: Certain commands accept the
1.245 nicm 3402: .Fl F
3403: flag with a
3404: .Ar format
3405: argument.
3406: This is a string which controls the output format of the command.
3407: Replacement variables are enclosed in
3408: .Ql #{
3409: and
3410: .Ql } ,
3411: for example
1.359 nicm 3412: .Ql #{session_name} .
1.409 nicm 3413: The possible variables are listed in the table below, or the name of a
3414: .Nm
3415: option may be used for an option's value.
3416: Some variables have a shorter alias such as
3417: .Ql #S ,
3418: and
1.376 nicm 3419: .Ql ##
3420: is replaced by a single
3421: .Ql # .
1.409 nicm 3422: .Pp
3423: Conditionals are available by prefixing with
1.246 jmc 3424: .Ql \&?
1.245 nicm 3425: and separating two alternatives with a comma;
3426: if the specified variable exists and is not zero, the first alternative
1.246 jmc 3427: is chosen, otherwise the second is used.
3428: For example
1.245 nicm 3429: .Ql #{?session_attached,attached,not attached}
3430: will include the string
3431: .Ql attached
3432: if the session is attached and the string
3433: .Ql not attached
1.409 nicm 3434: if it is unattached, or
3435: .Ql #{?automatic-rename,yes,no}
3436: will include
3437: .Ql yes
3438: if
3439: .Ic automatic-rename
3440: is enabled, or
3441: .Ql no
3442: if not.
1.520 nicm 3443: .Pp
1.554 nicm 3444: Comparisons may be expressed by prefixing two comma-separated
1.520 nicm 3445: alternatives by
3446: .Ql ==
3447: or
3448: .Ql !=
3449: and a colon.
3450: For example
1.544 nicm 3451: .Ql #{==:#{host},myhost}
1.520 nicm 3452: will be replaced by
3453: .Ql 1
3454: if running on
3455: .Ql myhost ,
3456: otherwise by
1.554 nicm 3457: .Ql 0 .
1.553 nicm 3458: An
3459: .Ql m
1.554 nicm 3460: specifies an
1.553 nicm 3461: .Xr fnmatch 3
1.554 nicm 3462: comparison where the first argument is the pattern and the second the string to
3463: compare, for example
1.553 nicm 3464: .Ql #{m:*foo*,#{host}} .
1.554 nicm 3465: .Ql ||
3466: and
3467: .Ql &&
3468: evaluate to true if either or both of two comma-separated alternatives are
3469: true, for example
3470: .Ql #{||,#{pane_in_mode},#{alternate_on}} .
3471: A
3472: .Ql C
3473: performs a search for an
3474: .Xr fnmatch 3
3475: pattern in the pane content and evaluates to zero if not found, or a line
3476: number if found.
1.453 nicm 3477: .Pp
1.367 nicm 3478: A limit may be placed on the length of the resultant string by prefixing it
3479: by an
3480: .Ql = ,
1.479 nicm 3481: a number and a colon.
3482: Positive numbers count from the start of the string and negative from the end,
3483: so
3484: .Ql #{=5:pane_title}
3485: will include at most the first 5 characters of the pane title, or
3486: .Ql #{=-5:pane_title}
3487: the last 5 characters.
1.453 nicm 3488: Prefixing a time variable with
3489: .Ql t:
3490: will convert it to a string, so if
3491: .Ql #{window_activity}
3492: gives
1.454 jmc 3493: .Ql 1445765102 ,
1.453 nicm 3494: .Ql #{t:window_activity}
3495: gives
3496: .Ql Sun Oct 25 09:25:02 2015 .
3497: The
3498: .Ql b:
3499: and
3500: .Ql d:
3501: prefixes are
3502: .Xr basename 3
3503: and
3504: .Xr dirname 3
3505: of the variable respectively.
1.461 nicm 3506: A prefix of the form
3507: .Ql s/foo/bar/:
3508: will substitute
3509: .Ql foo
3510: with
3511: .Ql bar
3512: throughout.
1.431 nicm 3513: .Pp
3514: In addition, the first line of a shell command's output may be inserted using
3515: .Ql #() .
3516: For example,
3517: .Ql #(uptime)
3518: will insert the system's uptime.
3519: When constructing formats,
3520: .Nm
3521: does not wait for
3522: .Ql #()
3523: commands to finish; instead, the previous result from running the same command is used,
3524: or a placeholder if the command has not been run before.
1.543 nicm 3525: If the command hasn't exited, the most recent line of output will be used, but the status
3526: line will not be updated more than once a second.
1.431 nicm 3527: Commands are executed with the
3528: .Nm
3529: global environment set (see the
3530: .Sx ENVIRONMENT
3531: section).
1.245 nicm 3532: .Pp
3533: The following variables are available, where appropriate:
1.359 nicm 3534: .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
3535: .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
3536: .It Li "alternate_on" Ta "" Ta "If pane is in alternate screen"
3537: .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
3538: .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
1.490 nicm 3539: .It Li "buffer_name" Ta "" Ta "Name of buffer"
1.386 nicm 3540: .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
1.359 nicm 3541: .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
3542: .It Li "client_activity" Ta "" Ta "Integer time client last had activity"
3543: .It Li "client_created" Ta "" Ta "Integer time client created"
1.443 nicm 3544: .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
1.542 nicm 3545: .It Li "client_discarded" Ta "" Ta "Bytes discarded when client behind"
1.359 nicm 3546: .It Li "client_height" Ta "" Ta "Height of client"
1.451 nicm 3547: .It Li "client_key_table" Ta "" Ta "Current key table"
1.359 nicm 3548: .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
1.540 nicm 3549: .It Li "client_name" Ta "" Ta "Name of client"
1.437 nicm 3550: .It Li "client_pid" Ta "" Ta "PID of client process"
1.359 nicm 3551: .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
3552: .It Li "client_readonly" Ta "" Ta "1 if client is readonly"
3553: .It Li "client_session" Ta "" Ta "Name of the client's session"
3554: .It Li "client_termname" Ta "" Ta "Terminal name of client"
1.524 nicm 3555: .It Li "client_termtype" Ta "" Ta "Terminal type of client"
1.359 nicm 3556: .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
3557: .It Li "client_utf8" Ta "" Ta "1 if client supports utf8"
3558: .It Li "client_width" Ta "" Ta "Width of client"
1.541 nicm 3559: .It Li "client_written" Ta "" Ta "Bytes written to client"
1.509 nicm 3560: .It Li "command" Ta "" Ta "Name of command in use, if any"
1.489 nicm 3561: .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
3562: .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
3563: .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
1.359 nicm 3564: .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
3565: .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
3566: .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
3567: .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
3568: .It Li "history_limit" Ta "" Ta "Maximum window history lines"
3569: .It Li "history_size" Ta "" Ta "Size of history in bytes"
1.509 nicm 3570: .It Li "hook" Ta "" Ta "Name of running hook, if any"
1.511 nicm 3571: .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
1.510 nicm 3572: .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
3573: .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
3574: .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
3575: .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
1.359 nicm 3576: .It Li "host" Ta "#H" Ta "Hostname of local host"
3577: .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
3578: .It Li "insert_flag" Ta "" Ta "Pane insert flag"
3579: .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
3580: .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
3581: .It Li "line" Ta "" Ta "Line number in the list"
3582: .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
3583: .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
3584: .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
1.533 nicm 3585: .It Li "mouse_all_flag" Ta "" Ta "Pane mouse all flag"
1.359 nicm 3586: .It Li "pane_active" Ta "" Ta "1 if active pane"
1.396 nicm 3587: .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
1.359 nicm 3588: .It Li "pane_current_command" Ta "" Ta "Current command if available"
3589: .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
1.411 nicm 3590: .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
1.359 nicm 3591: .It Li "pane_height" Ta "" Ta "Height of pane"
3592: .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
3593: .It Li "pane_in_mode" Ta "" Ta "If pane is in a mode"
1.404 nicm 3594: .It Li "pane_input_off" Ta "" Ta "If input to pane is disabled"
1.359 nicm 3595: .It Li "pane_index" Ta "#P" Ta "Index of pane"
1.396 nicm 3596: .It Li "pane_left" Ta "" Ta "Left of pane"
1.549 nicm 3597: .It Li "pane_mode" Ta "" Ta "Name of pane mode, if any."
1.359 nicm 3598: .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
1.396 nicm 3599: .It Li "pane_right" Ta "" Ta "Right of pane"
1.546 nicm 3600: .It Li "pane_search_string" Ta "" Ta "Last search string in copy mode"
1.359 nicm 3601: .It Li "pane_start_command" Ta "" Ta "Command pane started with"
1.396 nicm 3602: .It Li "pane_synchronized" Ta "" Ta "If pane is synchronized"
1.359 nicm 3603: .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
3604: .It Li "pane_title" Ta "#T" Ta "Title of pane"
1.396 nicm 3605: .It Li "pane_top" Ta "" Ta "Top of pane"
1.359 nicm 3606: .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
3607: .It Li "pane_width" Ta "" Ta "Width of pane"
1.437 nicm 3608: .It Li "pid" Ta "" Ta "Server PID"
1.359 nicm 3609: .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
3610: .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
1.452 nicm 3611: .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
1.430 nicm 3612: .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
1.382 nicm 3613: .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
1.415 nicm 3614: .It Li "session_activity" Ta "" Ta "Integer time of session last activity"
1.359 nicm 3615: .It Li "session_created" Ta "" Ta "Integer time session created"
1.449 nicm 3616: .It Li "session_last_attached" Ta "" Ta "Integer time session last attached"
1.536 nicm 3617: .It Li "session_group" Ta "" Ta "Name of session group"
1.359 nicm 3618: .It Li "session_grouped" Ta "" Ta "1 if session in a group"
3619: .It Li "session_height" Ta "" Ta "Height of session"
3620: .It Li "session_id" Ta "" Ta "Unique session ID"
1.382 nicm 3621: .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
1.359 nicm 3622: .It Li "session_name" Ta "#S" Ta "Name of session"
1.548 nicm 3623: .It Li "session_stack" Ta "" Ta "Window indexes in most recent order"
1.359 nicm 3624: .It Li "session_width" Ta "" Ta "Width of session"
3625: .It Li "session_windows" Ta "" Ta "Number of windows in session"
1.487 nicm 3626: .It Li "socket_path" Ta "" Ta "Server socket path"
1.465 nicm 3627: .It Li "start_time" Ta "" Ta "Server start time"
1.438 nicm 3628: .It Li "window_activity" Ta "" Ta "Integer time of window last activity"
1.487 nicm 3629: .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
1.359 nicm 3630: .It Li "window_active" Ta "" Ta "1 if window active"
1.366 nicm 3631: .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
1.359 nicm 3632: .It Li "window_find_matches" Ta "" Ta "Matched data from the find-window"
3633: .It Li "window_flags" Ta "#F" Ta "Window flags"
3634: .It Li "window_height" Ta "" Ta "Height of window"
3635: .It Li "window_id" Ta "" Ta "Unique window ID"
3636: .It Li "window_index" Ta "#I" Ta "Index of window"
1.400 nicm 3637: .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
1.460 nicm 3638: .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
1.426 nicm 3639: .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
1.359 nicm 3640: .It Li "window_name" Ta "#W" Ta "Name of window"
3641: .It Li "window_panes" Ta "" Ta "Number of panes in window"
1.366 nicm 3642: .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
1.548 nicm 3643: .It Li "window_stack_index" Ta "" Ta "Index in session most recent stack"
1.460 nicm 3644: .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
1.359 nicm 3645: .It Li "window_width" Ta "" Ta "Width of window"
1.400 nicm 3646: .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
1.359 nicm 3647: .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
1.245 nicm 3648: .El
1.261 nicm 3649: .Sh NAMES AND TITLES
3650: .Nm
3651: distinguishes between names and titles.
3652: Windows and sessions have names, which may be used to specify them in targets
3653: and are displayed in the status line and various lists: the name is the
3654: .Nm
3655: identifier for a window or session.
3656: Only panes have titles.
3657: A pane's title is typically set by the program running inside the pane and
3658: is not modified by
3659: .Nm .
3660: It is the same mechanism used to set for example the
3661: .Xr xterm 1
3662: window title in an
3663: .Xr X 7
3664: window manager.
1.268 nicm 3665: Windows themselves do not have titles - a window's title is the title of its
1.261 nicm 3666: active pane.
3667: .Nm
3668: itself may set the title of the terminal in which the client is running, see
3669: the
3670: .Ic set-titles
3671: option.
3672: .Pp
3673: A session's name is set with the
3674: .Ic new-session
3675: and
3676: .Ic rename-session
3677: commands.
3678: A window's name is set with one of:
3679: .Bl -enum -width Ds
3680: .It
3681: A command argument (such as
3682: .Fl n
3683: for
3684: .Ic new-window
3685: or
3686: .Ic new-session ) .
3687: .It
3688: An escape sequence:
3689: .Bd -literal -offset indent
3690: $ printf '\e033kWINDOW_NAME\e033\e\e'
3691: .Ed
3692: .It
3693: Automatic renaming, which sets the name to the active command in the window's
3694: active pane.
3695: See the
3696: .Ic automatic-rename
3697: option.
3698: .El
3699: .Pp
3700: When a pane is first created, its title is the hostname.
3701: A pane's title can be set via the OSC title setting sequence, for example:
3702: .Bd -literal -offset indent
3703: $ printf '\e033]2;My Title\e033\e\e'
3704: .Ed
1.63 nicm 3705: .Sh ENVIRONMENT
3706: When the server is started,
3707: .Nm
3708: copies the environment into the
3709: .Em global environment ;
3710: in addition, each session has a
3711: .Em session environment .
1.193 nicm 3712: When a window is created, the session and global environments are merged.
3713: If a variable exists in both, the value from the session environment is used.
3714: The result is the initial environment passed to the new process.
1.63 nicm 3715: .Pp
3716: The
3717: .Ic update-environment
3718: session option may be used to update the session environment from the client
3719: when a new session is created or an old reattached.
3720: .Nm
3721: also initialises the
3722: .Ev TMUX
3723: variable with some internal information to allow commands to be executed
3724: from inside, and the
3725: .Ev TERM
3726: variable with the correct terminal setting of
3727: .Ql screen .
3728: .Pp
3729: Commands to alter and view the environment are:
3730: .Bl -tag -width Ds
3731: .It Xo Ic set-environment
3732: .Op Fl gru
3733: .Op Fl t Ar target-session
3734: .Ar name Op Ar value
3735: .Xc
1.115 nicm 3736: .D1 (alias: Ic setenv )
1.63 nicm 3737: Set or unset an environment variable.
3738: If
3739: .Fl g
3740: is used, the change is made in the global environment; otherwise, it is applied
3741: to the session environment for
3742: .Ar target-session .
3743: The
3744: .Fl u
3745: flag unsets a variable.
3746: .Fl r
3747: indicates the variable is to be removed from the environment before starting a
3748: new process.
3749: .It Xo Ic show-environment
1.442 nicm 3750: .Op Fl gs
1.63 nicm 3751: .Op Fl t Ar target-session
1.286 nicm 3752: .Op Ar variable
1.63 nicm 3753: .Xc
1.115 nicm 3754: .D1 (alias: Ic showenv )
1.63 nicm 3755: Display the environment for
3756: .Ar target-session
3757: or the global environment with
3758: .Fl g .
1.286 nicm 3759: If
3760: .Ar variable
3761: is omitted, all variables are shown.
1.63 nicm 3762: Variables removed from the environment are prefixed with
3763: .Ql - .
1.442 nicm 3764: If
3765: .Fl s
3766: is used, the output is formatted as a set of Bourne shell commands.
1.57 jmc 3767: .El
3768: .Sh STATUS LINE
3769: .Nm
3770: includes an optional status line which is displayed in the bottom line of each
3771: terminal.
3772: By default, the status line is enabled (it may be disabled with the
3773: .Ic status
3774: session option) and contains, from left-to-right: the name of the current
1.261 nicm 3775: session in square brackets; the window list; the title of the active pane
3776: in double quotes; and the time and date.
1.57 jmc 3777: .Pp
3778: The status line is made of three parts: configurable left and right sections
3779: (which may contain dynamic content such as the time or output from a shell
3780: command, see the
3781: .Ic status-left ,
3782: .Ic status-left-length ,
3783: .Ic status-right ,
3784: and
3785: .Ic status-right-length
3786: options below), and a central window list.
1.125 nicm 3787: By default, the window list shows the index, name and (if any) flag of the
3788: windows present in the current session in ascending numerical order.
3789: It may be customised with the
3790: .Ar window-status-format
3791: and
3792: .Ar window-status-current-format
3793: options.
1.57 jmc 3794: The flag is one of the following symbols appended to the window name:
3795: .Bl -column "Symbol" "Meaning" -offset indent
3796: .It Sy "Symbol" Ta Sy "Meaning"
3797: .It Li "*" Ta "Denotes the current window."
3798: .It Li "-" Ta "Marks the last window (previously selected)."
3799: .It Li "#" Ta "Window is monitored and activity has been detected."
1.557 nicm 3800: .It Li "\&!" Ta "A bell has occurred in the window."
1.192 nicm 3801: .It Li "~" Ta "The window has been silent for the monitor-silence interval."
1.432 nicm 3802: .It Li "M" Ta "The window contains the marked pane."
1.349 nicm 3803: .It Li "Z" Ta "The window's active pane is zoomed."
1.57 jmc 3804: .El
3805: .Pp
3806: The # symbol relates to the
3807: .Ic monitor-activity
1.388 nicm 3808: window option.
1.57 jmc 3809: The window name is printed in inverted colours if an alert (bell, activity or
1.388 nicm 3810: silence) is present.
1.57 jmc 3811: .Pp
1.131 nicm 3812: The colour and attributes of the status line may be configured, the entire
3813: status line using the
1.378 nicm 3814: .Ic status-style
3815: session option and individual windows using the
3816: .Ic window-status-style
3817: window option.
1.57 jmc 3818: .Pp
1.131 nicm 3819: The status line is automatically refreshed at interval if it has changed, the
3820: interval may be controlled with the
1.57 jmc 3821: .Ic status-interval
3822: session option.
3823: .Pp
3824: Commands related to the status line are as follows:
3825: .Bl -tag -width Ds
3826: .It Xo Ic command-prompt
1.517 nicm 3827: .Op Fl 1i
1.235 nicm 3828: .Op Fl I Ar inputs
1.73 nicm 3829: .Op Fl p Ar prompts
1.57 jmc 3830: .Op Fl t Ar target-client
3831: .Op Ar template
3832: .Xc
3833: Open the command prompt in a client.
3834: This may be used from inside
3835: .Nm
3836: to execute commands interactively.
1.231 nicm 3837: .Pp
1.57 jmc 3838: If
3839: .Ar template
1.73 nicm 3840: is specified, it is used as the command.
1.235 nicm 3841: If present,
3842: .Fl I
3843: is a comma-separated list of the initial text for each prompt.
1.73 nicm 3844: If
3845: .Fl p
3846: is given,
3847: .Ar prompts
3848: is a comma-separated list of prompts which are displayed in order; otherwise
3849: a single prompt is displayed, constructed from
3850: .Ar template
3851: if it is present, or
3852: .Ql \&:
3853: if not.
1.231 nicm 3854: .Pp
1.73 nicm 3855: Before the command is executed, the first occurrence of the string
3856: .Ql %%
1.74 jmc 3857: and all occurrences of
1.73 nicm 3858: .Ql %1
1.492 nicm 3859: are replaced by the response to the first prompt, all
1.73 nicm 3860: .Ql %2
3861: are replaced with the response to the second prompt, and so on for further
1.74 jmc 3862: prompts.
3863: Up to nine prompt responses may be replaced
3864: .Po
3865: .Ql %1
1.73 nicm 3866: to
1.74 jmc 3867: .Ql %9
3868: .Pc .
1.513 nicm 3869: .Ql %%%
3870: is like
3871: .Ql %%
3872: but any quotation marks are escaped.
1.497 nicm 3873: .Pp
3874: .Fl 1
3875: makes the prompt only accept one key press, in this case the resulting input
3876: is a single character.
1.517 nicm 3877: .Fl i
3878: executes the command every time the prompt input changes instead of when the
3879: user exits the command prompt.
1.500 nicm 3880: .Pp
3881: The following keys have a special meaning in the command prompt, depending
3882: on the value of the
3883: .Ic status-keys
3884: option:
3885: .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
3886: .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
3887: .It Li "Cancel command prompt" Ta "Escape" Ta "Escape"
3888: .It Li "Delete current word" Ta "" Ta "C-w"
3889: .It Li "Delete entire command" Ta "d" Ta "C-u"
3890: .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
3891: .It Li "Execute command" Ta "Enter" Ta "Enter"
3892: .It Li "Get next command from history" Ta "" Ta "Down"
3893: .It Li "Get previous command from history" Ta "" Ta "Up"
3894: .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
3895: .It Li "Look for completions" Ta "Tab" Ta "Tab"
3896: .It Li "Move cursor left" Ta "h" Ta "Left"
3897: .It Li "Move cursor right" Ta "l" Ta "Right"
3898: .It Li "Move cursor to end" Ta "$" Ta "C-e"
3899: .It Li "Move cursor to next word" Ta "w" Ta "M-f"
3900: .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
3901: .It Li "Move cursor to start" Ta "0" Ta "C-a"
3902: .It Li "Transpose characters" Ta "" Ta "C-t"
3903: .El
1.57 jmc 3904: .It Xo Ic confirm-before
1.238 nicm 3905: .Op Fl p Ar prompt
1.57 jmc 3906: .Op Fl t Ar target-client
3907: .Ar command
3908: .Xc
3909: .D1 (alias: Ic confirm )
3910: Ask for confirmation before executing
3911: .Ar command .
1.238 nicm 3912: If
3913: .Fl p
3914: is given,
3915: .Ar prompt
3916: is the prompt to display; otherwise a prompt is constructed from
3917: .Ar command .
3918: It may contain the special character sequences supported by the
3919: .Ic status-left
3920: option.
3921: .Pp
1.57 jmc 3922: This command works only from inside
3923: .Nm .
3924: .It Xo Ic display-message
1.127 nicm 3925: .Op Fl p
1.215 nicm 3926: .Op Fl c Ar target-client
3927: .Op Fl t Ar target-pane
1.57 jmc 3928: .Op Ar message
3929: .Xc
3930: .D1 (alias: Ic display )
1.127 nicm 3931: Display a message.
3932: If
3933: .Fl p
3934: is given, the output is printed to stdout, otherwise it is displayed in the
3935: .Ar target-client
3936: status line.
1.122 nicm 3937: The format of
1.124 jmc 3938: .Ar message
1.275 nicm 3939: is described in the
3940: .Sx FORMATS
3941: section; information is taken from
1.215 nicm 3942: .Ar target-pane
3943: if
3944: .Fl t
3945: is given, otherwise the active pane for the session attached to
3946: .Ar target-client .
1.57 jmc 3947: .El
3948: .Sh BUFFERS
3949: .Nm
1.392 nicm 3950: maintains a set of named
1.199 nicm 3951: .Em paste buffers .
1.392 nicm 3952: Each buffer may be either explicitly or automatically named.
3953: Explicitly named buffers are named when created with the
3954: .Ic set-buffer
3955: or
3956: .Ic load-buffer
3957: commands, or by renaming an automatically named buffer with
3958: .Ic set-buffer
3959: .Fl n .
3960: Automatically named buffers are given a name such as
3961: .Ql buffer0001 ,
3962: .Ql buffer0002
3963: and so on.
3964: When the
3965: .Ic buffer-limit
3966: option is reached, the oldest automatically named buffer is deleted.
1.493 nicm 3967: Explicitly named buffers are not subject to
1.57 jmc 3968: .Ic buffer-limit
1.392 nicm 3969: and may be deleted with
3970: .Ic delete-buffer
3971: command.
3972: .Pp
1.57 jmc 3973: Buffers may be added using
3974: .Ic copy-mode
3975: or the
3976: .Ic set-buffer
1.392 nicm 3977: and
3978: .Ic load-buffer
3979: commands, and pasted into a window using the
1.57 jmc 3980: .Ic paste-buffer
3981: command.
1.392 nicm 3982: If a buffer command is used and no buffer is specified, the most
3983: recently added automatically named buffer is assumed.
1.57 jmc 3984: .Pp
3985: A configurable history buffer is also maintained for each window.
3986: By default, up to 2000 lines are kept; this can be altered with the
3987: .Ic history-limit
3988: option (see the
3989: .Ic set-option
3990: command above).
3991: .Pp
3992: The buffer commands are as follows:
3993: .Bl -tag -width Ds
1.178 nicm 3994: .It Xo
3995: .Ic choose-buffer
1.562 nicm 3996: .Op Fl f Ar filter
1.561 nicm 3997: .Op Fl O Ar sort-order
1.555 nicm 3998: .Op Fl t Ar target-pane
1.178 nicm 3999: .Op Ar template
4000: .Xc
1.555 nicm 4001: Put a pane into buffer mode, where a buffer may be chosen interactively from
4002: a list.
4003: The following keys may be used in buffer mode:
4004: .Bl -column "Key" "Function" -offset indent
4005: .It Sy "Key" Ta Sy "Function"
4006: .It Li "Enter" Ta "Choose selected buffer"
4007: .It Li "Up" Ta "Select previous buffer"
4008: .It Li "Down" Ta "Select next buffer"
1.559 nicm 4009: .It Li "C-s" Ta "Search by name or content"
4010: .It Li "n" Ta "Repeat last search"
1.555 nicm 4011: .It Li "t" Ta "Toggle if buffer is tagged"
4012: .It Li "T" Ta "Tag no buffers"
4013: .It Li "C-t" Ta "Tag all buffers"
4014: .It Li "d" Ta "Delete selected buffer"
4015: .It Li "D" Ta "Delete tagged buffers"
1.562 nicm 4016: .It Li "f" Ta "Enter a format to filter items"
1.555 nicm 4017: .It Li "O" Ta "Change sort order"
4018: .It Li "q" Ta "Exit mode"
4019: .El
4020: .Pp
4021: After a buffer is chosen,
1.178 nicm 4022: .Ql %%
1.392 nicm 4023: is replaced by the buffer name in
1.178 nicm 4024: .Ar template
4025: and the result executed as a command.
4026: If
4027: .Ar template
4028: is not given, "paste-buffer -b '%%'" is used.
1.555 nicm 4029: .Pp
1.561 nicm 4030: .Fl O
4031: specifies the initial sort order: one of
4032: .Ql time ,
4033: .Ql name
4034: or
4035: .Ql size .
1.562 nicm 4036: .Fl f
4037: specifies an initial filter.
1.314 nicm 4038: This command works only if at least one client is attached.
1.57 jmc 4039: .It Ic clear-history Op Fl t Ar target-pane
4040: .D1 (alias: Ic clearhist )
4041: Remove and free the history for the specified pane.
1.392 nicm 4042: .It Ic delete-buffer Op Fl b Ar buffer-name
1.57 jmc 4043: .D1 (alias: Ic deleteb )
1.392 nicm 4044: Delete the buffer named
4045: .Ar buffer-name ,
4046: or the most recently added automatically named buffer if not specified.
1.294 nicm 4047: .It Xo Ic list-buffers
4048: .Op Fl F Ar format
4049: .Xc
1.57 jmc 4050: .D1 (alias: Ic lsb )
1.198 nicm 4051: List the global buffers.
1.294 nicm 4052: For the meaning of the
4053: .Fl F
4054: flag, see the
4055: .Sx FORMATS
4056: section.
1.200 jmc 4057: .It Xo Ic load-buffer
1.392 nicm 4058: .Op Fl b Ar buffer-name
1.57 jmc 4059: .Ar path
4060: .Xc
4061: .D1 (alias: Ic loadb )
4062: Load the contents of the specified paste buffer from
4063: .Ar path .
4064: .It Xo Ic paste-buffer
1.278 nicm 4065: .Op Fl dpr
1.392 nicm 4066: .Op Fl b Ar buffer-name
1.170 nicm 4067: .Op Fl s Ar separator
1.158 nicm 4068: .Op Fl t Ar target-pane
1.57 jmc 4069: .Xc
4070: .D1 (alias: Ic pasteb )
1.158 nicm 4071: Insert the contents of a paste buffer into the specified pane.
4072: If not specified, paste into the current one.
1.57 jmc 4073: With
4074: .Fl d ,
1.392 nicm 4075: also delete the paste buffer.
1.57 jmc 4076: When output, any linefeed (LF) characters in the paste buffer are replaced with
1.170 nicm 4077: a separator, by default carriage return (CR).
4078: A custom separator may be specified using the
4079: .Fl s
4080: flag.
4081: The
1.57 jmc 4082: .Fl r
1.170 nicm 4083: flag means to do no replacement (equivalent to a separator of LF).
1.278 nicm 4084: If
4085: .Fl p
4086: is specified, paste bracket control codes are inserted around the
4087: buffer if the application has requested bracketed paste mode.
1.57 jmc 4088: .It Xo Ic save-buffer
4089: .Op Fl a
1.392 nicm 4090: .Op Fl b Ar buffer-name
1.57 jmc 4091: .Ar path
4092: .Xc
4093: .D1 (alias: Ic saveb )
4094: Save the contents of the specified paste buffer to
4095: .Ar path .
4096: The
4097: .Fl a
4098: option appends to rather than overwriting the file.
4099: .It Xo Ic set-buffer
1.383 nicm 4100: .Op Fl a
1.392 nicm 4101: .Op Fl b Ar buffer-name
4102: .Op Fl n Ar new-buffer-name
1.57 jmc 4103: .Ar data
4104: .Xc
4105: .D1 (alias: Ic setb )
4106: Set the contents of the specified buffer to
4107: .Ar data .
1.383 nicm 4108: The
4109: .Fl a
4110: option appends to rather than overwriting the buffer.
1.392 nicm 4111: The
4112: .Fl n
4113: option renames the buffer to
4114: .Ar new-buffer-name .
1.1 nicm 4115: .It Xo Ic show-buffer
1.392 nicm 4116: .Op Fl b Ar buffer-name
1.1 nicm 4117: .Xc
4118: .D1 (alias: Ic showb )
4119: Display the contents of the specified buffer.
1.57 jmc 4120: .El
4121: .Sh MISCELLANEOUS
4122: Miscellaneous commands are as follows:
4123: .Bl -tag -width Ds
1.72 nicm 4124: .It Ic clock-mode Op Fl t Ar target-pane
1.57 jmc 4125: Display a large clock.
1.334 nicm 4126: .It Xo Ic if-shell
1.410 nicm 4127: .Op Fl bF
1.334 nicm 4128: .Op Fl t Ar target-pane
4129: .Ar shell-command command
4130: .Op Ar command
4131: .Xc
1.57 jmc 4132: .D1 (alias: Ic if )
1.251 nicm 4133: Execute the first
1.57 jmc 4134: .Ar command
4135: if
4136: .Ar shell-command
1.251 nicm 4137: returns success or the second
4138: .Ar command
4139: otherwise.
1.410 nicm 4140: Before being executed,
4141: .Ar shell-command
4142: is expanded using the rules specified in the
1.334 nicm 4143: .Sx FORMATS
4144: section, including those relevant to
4145: .Ar target-pane .
1.335 nicm 4146: With
4147: .Fl b ,
4148: .Ar shell-command
4149: is run in the background.
1.410 nicm 4150: .Pp
4151: If
4152: .Fl F
4153: is given,
4154: .Ar shell-command
4155: is not executed but considered success if neither empty nor zero (after formats
4156: are expanded).
1.57 jmc 4157: .It Ic lock-server
4158: .D1 (alias: Ic lock )
1.90 nicm 4159: Lock each client individually by running the command specified by the
4160: .Ic lock-command
4161: option.
1.308 nicm 4162: .It Xo Ic run-shell
1.357 nicm 4163: .Op Fl b
1.308 nicm 4164: .Op Fl t Ar target-pane
4165: .Ar shell-command
4166: .Xc
1.87 nicm 4167: .D1 (alias: Ic run )
4168: Execute
1.153 nicm 4169: .Ar shell-command
1.106 nicm 4170: in the background without creating a window.
1.334 nicm 4171: Before being executed, shell-command is expanded using the rules specified in
4172: the
4173: .Sx FORMATS
4174: section.
1.335 nicm 4175: With
4176: .Fl b ,
4177: the command is run in the background.
1.308 nicm 4178: After it finishes, any output to stdout is displayed in copy mode (in the pane
4179: specified by
4180: .Fl t
4181: or the current pane if omitted).
1.153 nicm 4182: If the command doesn't return success, the exit status is also displayed.
1.342 nicm 4183: .It Xo Ic wait-for
1.370 nicm 4184: .Op Fl L | S | U
1.342 nicm 4185: .Ar channel
4186: .Xc
4187: .D1 (alias: Ic wait )
1.343 nicm 4188: When used without options, prevents the client from exiting until woken using
1.342 nicm 4189: .Ic wait-for
4190: .Fl S
4191: with the same channel.
1.343 nicm 4192: When
4193: .Fl L
4194: is used, the channel is locked and any clients that try to lock the same
4195: channel are made to wait until the channel is unlocked with
4196: .Ic wait-for
4197: .Fl U .
1.342 nicm 4198: This command only works from outside
4199: .Nm .
1.228 nicm 4200: .El
4201: .Sh TERMINFO EXTENSIONS
4202: .Nm
1.478 nicm 4203: understands some unofficial extensions to
1.228 nicm 4204: .Xr terminfo 5 :
4205: .Bl -tag -width Ds
1.360 nicm 4206: .It Em Cs , Cr
1.233 nicm 4207: Set the cursor colour.
1.232 jmc 4208: The first takes a single string argument and is used to set the colour;
4209: the second takes no arguments and restores the default cursor colour.
4210: If set, a sequence such as this may be used
4211: to change the cursor colour from inside
4212: .Nm :
4213: .Bd -literal -offset indent
4214: $ printf '\e033]12;red\e033\e\e'
4215: .Ed
1.361 jmc 4216: .It Em \&Ss , Se
1.403 nicm 4217: Set or reset the cursor style.
1.232 jmc 4218: If set, a sequence such as this may be used
4219: to change the cursor to an underline:
1.230 nicm 4220: .Bd -literal -offset indent
4221: $ printf '\e033[4 q'
4222: .Ed
4223: .Pp
4224: If
1.403 nicm 4225: .Em Se
4226: is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
1.478 nicm 4227: .It Em \&Tc
4228: Indicate that the terminal supports the
4229: .Ql direct colour
4230: RGB escape sequence (for example, \ee[38;2;255;255;255m).
1.518 nicm 4231: .Pp
4232: If supported, this is used for the OSC initialize colour escape sequence (which
4233: may be enabled by adding the
4234: .Ql initc
4235: and
4236: .Ql ccc
4237: capabilities to the
4238: .Nm
4239: .Xr terminfo 5
4240: entry).
1.232 jmc 4241: .It Em \&Ms
1.478 nicm 4242: Store the current buffer in the host terminal's selection (clipboard).
1.232 jmc 4243: See the
4244: .Em set-clipboard
4245: option above and the
4246: .Xr xterm 1
4247: man page.
1.345 nicm 4248: .El
4249: .Sh CONTROL MODE
4250: .Nm
4251: offers a textual interface called
4252: .Em control mode .
4253: This allows applications to communicate with
4254: .Nm
4255: using a simple text-only protocol.
4256: .Pp
4257: In control mode, a client sends
4258: .Nm
4259: commands or command sequences terminated by newlines on standard input.
4260: Each command will produce one block of output on standard output.
4261: An output block consists of a
4262: .Em %begin
4263: line followed by the output (which may be empty).
4264: The output block ends with a
4265: .Em %end
4266: or
4267: .Em %error .
4268: .Em %begin
4269: and matching
4270: .Em %end
4271: or
4272: .Em %error
4273: have two arguments: an integer time (as seconds from epoch) and command number.
4274: For example:
4275: .Bd -literal -offset indent
4276: %begin 1363006971 2
4277: 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
4278: %end 1363006971 2
4279: .Ed
1.535 nicm 4280: .Pp
4281: The
4282: .Ic refresh-client
4283: .Fl C
4284: command may be used to set the size of a client in control mode.
1.345 nicm 4285: .Pp
4286: In control mode,
4287: .Nm
4288: outputs notifications.
4289: A notification will never occur inside an output block.
4290: .Pp
4291: The following notifications are defined:
4292: .Bl -tag -width Ds
1.547 nicm 4293: .It Ic %client-session-changed Ar client Ar session-id Ar name
4294: The client is now attached to the session with ID
4295: .Ar session-id ,
4296: which is named
4297: .Ar name .
1.345 nicm 4298: .It Ic %exit Op Ar reason
4299: The
4300: .Nm
4301: client is exiting immediately, either because it is not attached to any session
4302: or an error occurred.
4303: If present,
4304: .Ar reason
4305: describes why the client exited.
1.460 nicm 4306: .It Ic %layout-change Ar window-id Ar window-layout Ar window-visible-layout Ar window-flags
1.345 nicm 4307: The layout of a window with ID
4308: .Ar window-id
4309: changed.
4310: The new layout is
4311: .Ar window-layout .
1.460 nicm 4312: The window's visible layout is
4313: .Ar window-visible-layout
4314: and the window flags are
4315: .Ar window-flags .
1.347 nicm 4316: .It Ic %output Ar pane-id Ar value
4317: A window pane produced output.
1.345 nicm 4318: .Ar value
1.350 nicm 4319: escapes non-printable characters and backslash as octal \\xxx.
1.547 nicm 4320: .It Ic %pane-mode-changed Ar pane-id
4321: The pane with ID
4322: .Ar pane-id
4323: has changed mode.
1.345 nicm 4324: .It Ic %session-changed Ar session-id Ar name
4325: The client is now attached to the session with ID
4326: .Ar session-id ,
4327: which is named
4328: .Ar name .
4329: .It Ic %session-renamed Ar name
4330: The current session was renamed to
4331: .Ar name .
1.547 nicm 4332: .It Ic %session-window-changed Ar session-id Ar window-id
4333: The session with ID
4334: .Ar session-id
4335: changed its active window to the window with ID
4336: .Ar window-id .
1.345 nicm 4337: .It Ic %sessions-changed
4338: A session was created or destroyed.
4339: .It Ic %unlinked-window-add Ar window-id
4340: The window with ID
4341: .Ar window-id
4342: was created but is not linked to the current session.
4343: .It Ic %window-add Ar window-id
4344: The window with ID
4345: .Ar window-id
4346: was linked to the current session.
4347: .It Ic %window-close Ar window-id
4348: The window with ID
4349: .Ar window-id
4350: closed.
1.547 nicm 4351: .It Ic %window-pane-changed Ar window-id Ar pane-id
4352: The active pane in the window with ID
4353: .Ar window-id
4354: changed to the pane with ID
4355: .Ar pane-id .
1.345 nicm 4356: .It Ic %window-renamed Ar window-id Ar name
4357: The window with ID
4358: .Ar window-id
4359: was renamed to
4360: .Ar name .
1.1 nicm 4361: .El
4362: .Sh FILES
1.26 nicm 4363: .Bl -tag -width "/etc/tmux.confXXX" -compact
1.1 nicm 4364: .It Pa ~/.tmux.conf
1.6 jmc 4365: Default
1.1 nicm 4366: .Nm
1.6 jmc 4367: configuration file.
1.26 nicm 4368: .It Pa /etc/tmux.conf
4369: System-wide configuration file.
1.1 nicm 4370: .El
1.57 jmc 4371: .Sh EXAMPLES
4372: To create a new
4373: .Nm
4374: session running
4375: .Xr vi 1 :
4376: .Pp
4377: .Dl $ tmux new-session vi
4378: .Pp
4379: Most commands have a shorter form, known as an alias.
4380: For new-session, this is
4381: .Ic new :
4382: .Pp
4383: .Dl $ tmux new vi
4384: .Pp
4385: Alternatively, the shortest unambiguous form of a command is accepted.
4386: If there are several options, they are listed:
4387: .Bd -literal -offset indent
4388: $ tmux n
4389: ambiguous command: n, could be: new-session, new-window, next-window
4390: .Ed
4391: .Pp
4392: Within an active session, a new window may be created by typing
4393: .Ql C-b c
4394: (Ctrl
4395: followed by the
4396: .Ql b
4397: key
4398: followed by the
4399: .Ql c
4400: key).
4401: .Pp
4402: Windows may be navigated with:
4403: .Ql C-b 0
4404: (to select window 0),
4405: .Ql C-b 1
4406: (to select window 1), and so on;
4407: .Ql C-b n
4408: to select the next window; and
4409: .Ql C-b p
4410: to select the previous window.
4411: .Pp
4412: A session may be detached using
4413: .Ql C-b d
1.64 nicm 4414: (or by an external event such as
4415: .Xr ssh 1
4416: disconnection) and reattached with:
1.57 jmc 4417: .Pp
4418: .Dl $ tmux attach-session
4419: .Pp
4420: Typing
4421: .Ql C-b \&?
4422: lists the current key bindings in the current window; up and down may be used
4423: to navigate the list or
4424: .Ql q
4425: to exit from it.
4426: .Pp
4427: Commands to be run when the
4428: .Nm
4429: server is started may be placed in the
4430: .Pa ~/.tmux.conf
4431: configuration file.
4432: Common examples include:
4433: .Pp
4434: Changing the default prefix key:
4435: .Bd -literal -offset indent
4436: set-option -g prefix C-a
4437: unbind-key C-b
4438: bind-key C-a send-prefix
4439: .Ed
4440: .Pp
4441: Turning the status line off, or changing its colour:
4442: .Bd -literal -offset indent
4443: set-option -g status off
1.378 nicm 4444: set-option -g status-style bg=blue
1.57 jmc 4445: .Ed
4446: .Pp
4447: Setting other options, such as the default command,
4448: or locking after 30 minutes of inactivity:
4449: .Bd -literal -offset indent
4450: set-option -g default-command "exec /bin/ksh"
4451: set-option -g lock-after-time 1800
4452: .Ed
4453: .Pp
4454: Creating new key bindings:
4455: .Bd -literal -offset indent
4456: bind-key b set-option status
4457: bind-key / command-prompt "split-window 'exec man %%'"
1.73 nicm 4458: bind-key S command-prompt "new-window -n %1 'ssh %1'"
1.57 jmc 4459: .Ed
1.1 nicm 4460: .Sh SEE ALSO
4461: .Xr pty 4
4462: .Sh AUTHORS
1.477 nicm 4463: .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com