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