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