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