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