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