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