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