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