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