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