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