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