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