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