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