Annotation of src/usr.bin/tmux/tmux.1, Revision 1.397
1.397 ! nicm 1: .\" $OpenBSD: tmux.1,v 1.396 2014/05/27 12:49:36 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.397 ! nicm 17: .Dd $Mdocdate: May 27 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
1295: .D1 (alias: Ic displayp)
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.187 nicm 1385: .It Ic last-pane Op Fl t Ar target-window
1386: .D1 (alias: Ic lastp )
1387: Select the last (previously selected) pane.
1.56 jmc 1388: .It Ic last-window Op Fl t Ar target-session
1.1 nicm 1389: .D1 (alias: Ic last )
1390: Select the last (previously selected) window.
1391: If no
1392: .Ar target-session
1393: is specified, select the last window of the current session.
1394: .It Xo Ic link-window
1395: .Op Fl dk
1396: .Op Fl s Ar src-window
1397: .Op Fl t Ar dst-window
1398: .Xc
1399: .D1 (alias: Ic linkw )
1400: Link the window at
1401: .Ar src-window
1402: to the specified
1403: .Ar dst-window .
1404: If
1405: .Ar dst-window
1406: is specified and no such window exists, the
1407: .Ar src-window
1408: is linked there.
1409: If
1410: .Fl k
1411: is given and
1412: .Ar dst-window
1413: exists, it is killed, otherwise an error is generated.
1414: If
1415: .Fl d
1416: is given, the newly linked window is not selected.
1.214 nicm 1417: .It Xo Ic list-panes
1418: .Op Fl as
1.245 nicm 1419: .Op Fl F Ar format
1.214 nicm 1420: .Op Fl t Ar target
1421: .Xc
1.104 nicm 1422: .D1 (alias: Ic lsp )
1.214 nicm 1423: If
1424: .Fl a
1425: is given,
1426: .Ar target
1427: is ignored and all panes on the server are listed.
1428: If
1429: .Fl s
1430: is given,
1431: .Ar target
1432: is a session (or the current session).
1433: If neither is given,
1434: .Ar target
1435: is a window (or the current window).
1.247 nicm 1436: For the meaning of the
1437: .Fl F
1438: flag, see the
1439: .Sx FORMATS
1440: section.
1.214 nicm 1441: .It Xo Ic list-windows
1442: .Op Fl a
1.245 nicm 1443: .Op Fl F Ar format
1.214 nicm 1444: .Op Fl t Ar target-session
1445: .Xc
1.1 nicm 1446: .D1 (alias: Ic lsw )
1.214 nicm 1447: If
1448: .Fl a
1449: is given, list all windows on the server.
1450: Otherwise, list windows in the current session or in
1.1 nicm 1451: .Ar target-session .
1.245 nicm 1452: For the meaning of the
1453: .Fl F
1454: flag, see the
1455: .Sx FORMATS
1456: section.
1.277 nicm 1457: .It Xo Ic move-pane
1458: .Op Fl bdhv
1459: .Oo Fl l
1460: .Ar size |
1461: .Fl p Ar percentage Oc
1462: .Op Fl s Ar src-pane
1463: .Op Fl t Ar dst-pane
1464: .Xc
1465: .D1 (alias: Ic movep )
1466: Like
1467: .Ic join-pane ,
1468: but
1469: .Ar src-pane
1470: and
1471: .Ar dst-pane
1472: may belong to the same window.
1.1 nicm 1473: .It Xo Ic move-window
1.291 nicm 1474: .Op Fl rdk
1.1 nicm 1475: .Op Fl s Ar src-window
1476: .Op Fl t Ar dst-window
1477: .Xc
1478: .D1 (alias: Ic movew )
1479: This is similar to
1480: .Ic link-window ,
1481: except the window at
1482: .Ar src-window
1483: is moved to
1484: .Ar dst-window .
1.291 nicm 1485: With
1486: .Fl r ,
1487: all windows in the session are renumbered in sequential order, respecting
1488: the
1489: .Ic base-index
1490: option.
1.1 nicm 1491: .It Xo Ic new-window
1.201 nicm 1492: .Op Fl adkP
1.272 nicm 1493: .Op Fl c Ar start-directory
1.351 nicm 1494: .Op Fl F Ar format
1.1 nicm 1495: .Op Fl n Ar window-name
1496: .Op Fl t Ar target-window
1.153 nicm 1497: .Op Ar shell-command
1.1 nicm 1498: .Xc
1499: .D1 (alias: Ic neww )
1500: Create a new window.
1.160 nicm 1501: With
1502: .Fl a ,
1503: the new window is inserted at the next index up from the specified
1504: .Ar target-window ,
1505: moving windows up if necessary,
1506: otherwise
1507: .Ar target-window
1508: is the new window location.
1509: .Pp
1.1 nicm 1510: If
1511: .Fl d
1512: is given, the session does not make the new window the current window.
1513: .Ar target-window
1.28 nicm 1514: represents the window to be created; if the target already exists an error is
1515: shown, unless the
1516: .Fl k
1517: flag is used, in which case it is destroyed.
1.153 nicm 1518: .Ar shell-command
1.1 nicm 1519: is the command to execute.
1520: If
1.153 nicm 1521: .Ar shell-command
1522: is not specified, the value of the
1523: .Ic default-command
1524: option is used.
1.272 nicm 1525: .Fl c
1526: specifies the working directory in which the new window is created.
1.153 nicm 1527: .Pp
1528: When the shell command completes, the window closes.
1529: See the
1530: .Ic remain-on-exit
1531: option to change this behaviour.
1.1 nicm 1532: .Pp
1533: The
1534: .Ev TERM
1535: environment variable must be set to
1536: .Dq screen
1537: for all programs running
1538: .Em inside
1539: .Nm .
1540: New windows will automatically have
1541: .Dq TERM=screen
1542: added to their environment, but care must be taken not to reset this in shell
1543: start-up files.
1.201 nicm 1544: .Pp
1545: The
1546: .Fl P
1.279 nicm 1547: option prints information about the new window after it has been created.
1548: By default, it uses the format
1549: .Ql #{session_name}:#{window_index}
1550: but a different format may be specified with
1551: .Fl F .
1.56 jmc 1552: .It Ic next-layout Op Fl t Ar target-window
1.1 nicm 1553: .D1 (alias: Ic nextl )
1554: Move a window to the next layout and rearrange the panes to fit.
1555: .It Xo Ic next-window
1.9 nicm 1556: .Op Fl a
1.1 nicm 1557: .Op Fl t Ar target-session
1558: .Xc
1559: .D1 (alias: Ic next )
1560: Move to the next window in the session.
1.9 nicm 1561: If
1.12 jmc 1562: .Fl a
1.295 nicm 1563: is used, move to the next window with an alert.
1.107 nicm 1564: .It Xo Ic pipe-pane
1565: .Op Fl o
1566: .Op Fl t Ar target-pane
1.153 nicm 1567: .Op Ar shell-command
1.107 nicm 1568: .Xc
1569: .D1 (alias: Ic pipep )
1570: Pipe any output sent by the program in
1571: .Ar target-pane
1572: to a shell command.
1573: A pane may only be piped to one command at a time, any existing pipe is
1574: closed before
1.153 nicm 1575: .Ar shell-command
1.107 nicm 1576: is executed.
1.174 nicm 1577: The
1578: .Ar shell-command
1579: string may contain the special character sequences supported by the
1580: .Ic status-left
1.231 nicm 1581: option.
1.107 nicm 1582: If no
1.153 nicm 1583: .Ar shell-command
1.107 nicm 1584: is given, the current pipe (if any) is closed.
1585: .Pp
1586: The
1587: .Fl o
1588: option only opens a new pipe if no previous pipe exists, allowing a pipe to
1589: be toggled with a single key, for example:
1590: .Bd -literal -offset indent
1.174 nicm 1591: bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
1.107 nicm 1592: .Ed
1.176 nicm 1593: .It Xo Ic previous-layout
1594: .Op Fl t Ar target-window
1595: .Xc
1596: .D1 (alias: Ic prevl )
1597: Move to the previous layout in the session.
1.1 nicm 1598: .It Xo Ic previous-window
1.9 nicm 1599: .Op Fl a
1.1 nicm 1600: .Op Fl t Ar target-session
1601: .Xc
1602: .D1 (alias: Ic prev )
1603: Move to the previous window in the session.
1.9 nicm 1604: With
1605: .Fl a ,
1.295 nicm 1606: move to the previous window with an alert.
1.1 nicm 1607: .It Xo Ic rename-window
1608: .Op Fl t Ar target-window
1609: .Ar new-name
1610: .Xc
1611: .D1 (alias: Ic renamew )
1612: Rename the current window, or the window at
1613: .Ar target-window
1614: if specified, to
1615: .Ar new-name .
1616: .It Xo Ic resize-pane
1.337 nicm 1617: .Op Fl DLRUZ
1.52 nicm 1618: .Op Fl t Ar target-pane
1.324 nicm 1619: .Op Fl x Ar width
1620: .Op Fl y Ar height
1.1 nicm 1621: .Op Ar adjustment
1622: .Xc
1623: .D1 (alias: Ic resizep )
1.324 nicm 1624: Resize a pane, up, down, left or right by
1625: .Ar adjustment
1626: with
1627: .Fl U ,
1.57 jmc 1628: .Fl D ,
1629: .Fl L
1.324 nicm 1630: or
1631: .Fl R ,
1632: or
1633: to an absolute size
1634: with
1635: .Fl x
1636: or
1637: .Fl y .
1.57 jmc 1638: The
1639: .Ar adjustment
1640: is given in lines or cells (the default is 1).
1.337 nicm 1641: .Pp
1642: With
1643: .Fl Z ,
1.349 nicm 1644: the active pane is toggled between zoomed (occupying the whole of the window)
1645: and unzoomed (its normal position in the layout).
1.234 nicm 1646: .It Xo Ic respawn-pane
1647: .Op Fl k
1648: .Op Fl t Ar target-pane
1649: .Op Ar shell-command
1650: .Xc
1651: .D1 (alias: Ic respawnp )
1652: Reactivate a pane in which the command has exited (see the
1653: .Ic remain-on-exit
1654: window option).
1655: If
1656: .Ar shell-command
1657: is not given, the command used when the pane was created is executed.
1658: The pane must be already inactive, unless
1659: .Fl k
1660: is given, in which case any existing command is killed.
1.57 jmc 1661: .It Xo Ic respawn-window
1662: .Op Fl k
1663: .Op Fl t Ar target-window
1.153 nicm 1664: .Op Ar shell-command
1.57 jmc 1665: .Xc
1666: .D1 (alias: Ic respawnw )
1.153 nicm 1667: Reactivate a window in which the command has exited (see the
1.57 jmc 1668: .Ic remain-on-exit
1669: window option).
1670: If
1.153 nicm 1671: .Ar shell-command
1.57 jmc 1672: is not given, the command used when the window was created is executed.
1673: The window must be already inactive, unless
1674: .Fl k
1675: is given, in which case any existing command is killed.
1676: .It Xo Ic rotate-window
1677: .Op Fl DU
1678: .Op Fl t Ar target-window
1679: .Xc
1680: .D1 (alias: Ic rotatew )
1681: Rotate the positions of the panes within a window, either upward (numerically
1682: lower) with
1683: .Fl U
1684: or downward (numerically higher).
1685: .It Xo Ic select-layout
1.313 nicm 1686: .Op Fl np
1.57 jmc 1687: .Op Fl t Ar target-window
1688: .Op Ar layout-name
1689: .Xc
1.176 nicm 1690: .D1 (alias: Ic selectl )
1.57 jmc 1691: Choose a specific layout for a window.
1692: If
1693: .Ar layout-name
1.181 nicm 1694: is not given, the last preset layout used (if any) is reapplied.
1.204 nicm 1695: .Fl n
1696: and
1697: .Fl p
1698: are equivalent to the
1699: .Ic next-layout
1700: and
1701: .Ic previous-layout
1702: commands.
1.156 nicm 1703: .It Xo Ic select-pane
1.204 nicm 1704: .Op Fl lDLRU
1.156 nicm 1705: .Op Fl t Ar target-pane
1706: .Xc
1.57 jmc 1707: .D1 (alias: Ic selectp )
1708: Make pane
1709: .Ar target-pane
1710: the active pane in window
1711: .Ar target-window .
1.156 nicm 1712: If one of
1713: .Fl D ,
1714: .Fl L ,
1715: .Fl R ,
1716: or
1717: .Fl U
1718: is used, respectively the pane below, to the left, to the right, or above the
1719: target pane is used.
1.204 nicm 1720: .Fl l
1721: is the same as using the
1722: .Ic last-pane
1723: command.
1724: .It Xo Ic select-window
1.310 nicm 1725: .Op Fl lnpT
1.204 nicm 1726: .Op Fl t Ar target-window
1727: .Xc
1.57 jmc 1728: .D1 (alias: Ic selectw )
1729: Select the window at
1730: .Ar target-window .
1.204 nicm 1731: .Fl l ,
1732: .Fl n
1733: and
1734: .Fl p
1735: are equivalent to the
1736: .Ic last-window ,
1737: .Ic next-window
1738: and
1739: .Ic previous-window
1740: commands.
1.310 nicm 1741: If
1742: .Fl T
1743: is given and the selected window is already the current window,
1744: the command behaves like
1745: .Ic last-window .
1.57 jmc 1746: .It Xo Ic split-window
1.201 nicm 1747: .Op Fl dhvP
1.272 nicm 1748: .Op Fl c Ar start-directory
1.57 jmc 1749: .Oo Fl l
1750: .Ar size |
1751: .Fl p Ar percentage Oc
1.136 nicm 1752: .Op Fl t Ar target-pane
1.153 nicm 1753: .Op Ar shell-command
1.279 nicm 1754: .Op Fl F Ar format
1.57 jmc 1755: .Xc
1.176 nicm 1756: .D1 (alias: Ic splitw )
1.136 nicm 1757: Create a new pane by splitting
1758: .Ar target-pane :
1.57 jmc 1759: .Fl h
1760: does a horizontal split and
1761: .Fl v
1762: a vertical split; if neither is specified,
1763: .Fl v
1764: is assumed.
1765: The
1766: .Fl l
1767: and
1768: .Fl p
1.136 nicm 1769: options specify the size of the new pane in lines (for vertical split) or in
1.57 jmc 1770: cells (for horizontal split), or as a percentage, respectively.
1.136 nicm 1771: All other options have the same meaning as for the
1.57 jmc 1772: .Ic new-window
1773: command.
1774: .It Xo Ic swap-pane
1775: .Op Fl dDU
1776: .Op Fl s Ar src-pane
1777: .Op Fl t Ar dst-pane
1778: .Xc
1779: .D1 (alias: Ic swapp )
1780: Swap two panes.
1781: If
1782: .Fl U
1783: is used and no source pane is specified with
1784: .Fl s ,
1785: .Ar dst-pane
1786: is swapped with the previous pane (before it numerically);
1787: .Fl D
1788: swaps with the next pane (after it numerically).
1.138 nicm 1789: .Fl d
1790: instructs
1791: .Nm
1792: not to change the active pane.
1.57 jmc 1793: .It Xo Ic swap-window
1794: .Op Fl d
1795: .Op Fl s Ar src-window
1796: .Op Fl t Ar dst-window
1797: .Xc
1798: .D1 (alias: Ic swapw )
1799: This is similar to
1800: .Ic link-window ,
1801: except the source and destination windows are swapped.
1802: It is an error if no window exists at
1803: .Ar src-window .
1804: .It Xo Ic unlink-window
1.1 nicm 1805: .Op Fl k
1806: .Op Fl t Ar target-window
1807: .Xc
1.57 jmc 1808: .D1 (alias: Ic unlinkw )
1809: Unlink
1810: .Ar target-window .
1811: Unless
1812: .Fl k
1813: is given, a window may be unlinked only if it is linked to multiple sessions -
1814: windows may not be linked to no sessions;
1815: if
1.1 nicm 1816: .Fl k
1.57 jmc 1817: is specified and the window is linked to only one session, it is unlinked and
1818: destroyed.
1819: .El
1820: .Sh KEY BINDINGS
1.93 nicm 1821: .Nm
1822: allows a command to be bound to most keys, with or without a prefix key.
1823: When specifying keys, most represent themselves (for example
1824: .Ql A
1825: to
1.95 jmc 1826: .Ql Z ) .
1.93 nicm 1827: Ctrl keys may be prefixed with
1828: .Ql C-
1829: or
1.95 jmc 1830: .Ql ^ ,
1831: and Alt (meta) with
1.93 nicm 1832: .Ql M- .
1833: In addition, the following special key names are accepted:
1.126 nicm 1834: .Em Up ,
1835: .Em Down ,
1836: .Em Left ,
1837: .Em Right ,
1.93 nicm 1838: .Em BSpace ,
1839: .Em BTab ,
1840: .Em DC
1841: (Delete),
1842: .Em End ,
1843: .Em Enter ,
1844: .Em Escape ,
1845: .Em F1
1846: to
1847: .Em F20 ,
1848: .Em Home ,
1849: .Em IC
1850: (Insert),
1.254 nicm 1851: .Em NPage/PageDown/PgDn ,
1852: .Em PPage/PageUp/PgUp ,
1.93 nicm 1853: .Em Space ,
1854: and
1855: .Em Tab .
1856: Note that to bind the
1857: .Ql \&"
1858: or
1859: .Ql '
1860: keys, quotation marks are necessary, for example:
1861: .Bd -literal -offset indent
1862: bind-key '"' split-window
1.167 nicm 1863: bind-key "'" new-window
1.93 nicm 1864: .Ed
1865: .Pp
1.57 jmc 1866: Commands related to key bindings are as follows:
1867: .Bl -tag -width Ds
1868: .It Xo Ic bind-key
1869: .Op Fl cnr
1.395 nicm 1870: .Op Fl t Ar mode-table
1.57 jmc 1871: .Ar key Ar command Op Ar arguments
1.1 nicm 1872: .Xc
1.57 jmc 1873: .D1 (alias: Ic bind )
1874: Bind key
1875: .Ar key
1876: to
1877: .Ar command .
1878: By default (without
1879: .Fl t )
1880: the primary key bindings are modified (those normally activated with the prefix
1881: key); in this case, if
1882: .Fl n
1883: is specified, it is not necessary to use the prefix key,
1884: .Ar command
1885: is bound to
1886: .Ar key
1887: alone.
1.1 nicm 1888: The
1.57 jmc 1889: .Fl r
1890: flag indicates this key may repeat, see the
1891: .Ic repeat-time
1892: option.
1893: .Pp
1894: If
1895: .Fl t
1896: is present,
1897: .Ar key
1898: is bound in
1.395 nicm 1899: .Ar mode-table :
1.57 jmc 1900: the binding for command mode with
1901: .Fl c
1902: or for normal mode without.
1903: To view the default bindings and possible commands, see the
1904: .Ic list-keys
1905: command.
1906: .It Ic list-keys Op Fl t Ar key-table
1907: .D1 (alias: Ic lsk )
1908: List all key bindings.
1909: Without
1910: .Fl t
1911: the primary key bindings - those executed when preceded by the prefix key -
1912: are printed.
1913: .Pp
1914: With
1915: .Fl t ,
1916: the key bindings in
1917: .Ar key-table
1918: are listed; this may be one of:
1919: .Em vi-edit ,
1920: .Em emacs-edit ,
1921: .Em vi-choice ,
1922: .Em emacs-choice ,
1923: .Em vi-copy
1924: or
1925: .Em emacs-copy .
1926: .It Xo Ic send-keys
1.273 nicm 1927: .Op Fl lR
1.72 nicm 1928: .Op Fl t Ar target-pane
1.57 jmc 1929: .Ar key Ar ...
1.1 nicm 1930: .Xc
1.57 jmc 1931: .D1 (alias: Ic send )
1932: Send a key or keys to a window.
1933: Each argument
1934: .Ar key
1935: is the name of the key (such as
1936: .Ql C-a
1937: or
1938: .Ql npage
1939: ) to send; if the string is not recognised as a key, it is sent as a series of
1940: characters.
1.273 nicm 1941: The
1942: .Fl l
1943: flag disables key name lookup and sends the keys literally.
1.57 jmc 1944: All arguments are sent sequentially from first to last.
1.265 nicm 1945: The
1946: .Fl R
1947: flag causes the terminal state to be reset.
1.267 nicm 1948: .It Xo Ic send-prefix
1949: .Op Fl 2
1950: .Op Fl t Ar target-pane
1951: .Xc
1952: Send the prefix key, or with
1953: .Fl 2
1954: the secondary prefix key, to a window as if it was pressed.
1.57 jmc 1955: .It Xo Ic unbind-key
1.189 nicm 1956: .Op Fl acn
1.395 nicm 1957: .Op Fl t Ar mode-table
1.57 jmc 1958: .Ar key
1.2 nicm 1959: .Xc
1.57 jmc 1960: .D1 (alias: Ic unbind )
1961: Unbind the command bound to
1962: .Ar key .
1963: Without
1964: .Fl t
1965: the primary key bindings are modified; in this case, if
1966: .Fl n
1967: is specified, the command bound to
1968: .Ar key
1969: without a prefix (if any) is removed.
1.189 nicm 1970: If
1971: .Fl a
1972: is present, all key bindings are removed.
1.57 jmc 1973: .Pp
1.47 nicm 1974: If
1.57 jmc 1975: .Fl t
1976: is present,
1977: .Ar key
1978: in
1.395 nicm 1979: .Ar mode-table
1.57 jmc 1980: is unbound: the binding for command mode with
1981: .Fl c
1982: or for normal mode without.
1983: .El
1984: .Sh OPTIONS
1985: The appearance and behaviour of
1986: .Nm
1987: may be modified by changing the value of various options.
1.133 nicm 1988: There are three types of option:
1989: .Em server options ,
1.57 jmc 1990: .Em session options
1991: and
1992: .Em window options .
1993: .Pp
1.133 nicm 1994: The
1995: .Nm
1996: server has a set of global options which do not apply to any particular
1997: window or session.
1998: These are altered with the
1999: .Ic set-option
2000: .Fl s
2001: command, or displayed with the
2002: .Ic show-options
2003: .Fl s
2004: command.
2005: .Pp
2006: In addition, each individual session may have a set of session options, and
2007: there is a separate set of global session options.
1.57 jmc 2008: Sessions which do not have a particular option configured inherit the value
2009: from the global session options.
2010: Session options are set or unset with the
2011: .Ic set-option
2012: command and may be listed with the
2013: .Ic show-options
2014: command.
1.133 nicm 2015: The available server and session options are listed under the
1.57 jmc 2016: .Ic set-option
2017: command.
2018: .Pp
2019: Similarly, a set of window options is attached to each window, and there is
2020: a set of global window options from which any unset options are inherited.
2021: Window options are altered with the
2022: .Ic set-window-option
2023: command and can be listed with the
2024: .Ic show-window-options
2025: command.
2026: All window options are documented with the
2027: .Ic set-window-option
2028: command.
1.318 nicm 2029: .Pp
2030: .Nm
2031: also supports user options which are prefixed with a
2032: .Ql \&@ .
1.321 jmc 2033: User options may have any name, so long as they are prefixed with
2034: .Ql \&@ ,
1.318 nicm 2035: and be set to any string.
2036: For example
2037: .Bd -literal -offset indent
2038: $ tmux setw -q @foo "abc123"
2039: $ tmux showw -v @foo
2040: abc123
2041: .Ed
1.57 jmc 2042: .Pp
2043: Commands which set options are as follows:
2044: .Bl -tag -width Ds
1.1 nicm 2045: .It Xo Ic set-option
1.336 nicm 2046: .Op Fl agoqsuw
1.129 nicm 2047: .Op Fl t Ar target-session | Ar target-window
1.1 nicm 2048: .Ar option Ar value
2049: .Xc
2050: .D1 (alias: Ic set )
1.133 nicm 2051: Set a window option with
2052: .Fl w
2053: (equivalent to the
2054: .Ic set-window-option
2055: command),
2056: a server option with
2057: .Fl s ,
2058: otherwise a session option.
2059: .Pp
2060: If
2061: .Fl g
2062: is specified, the global session or window option is set.
1.1 nicm 2063: The
2064: .Fl u
2065: flag unsets an option, so a session inherits the option from the global
1.133 nicm 2066: options.
2067: It is not possible to unset a global option.
1.336 nicm 2068: .Pp
2069: The
2070: .Fl o
2071: flag prevents setting an option that is already set.
1.1 nicm 2072: .Pp
1.281 nicm 2073: The
2074: .Fl q
1.389 nicm 2075: flag suppresses errors about unknown options.
1.281 nicm 2076: .Pp
1.378 nicm 2077: With
2078: .Fl a ,
2079: and if the option expects a string or a style,
2080: .Ar value
2081: is appended to the existing setting.
2082: For example:
2083: .Bd -literal -offset indent
2084: set -g status-left "foo"
2085: set -ag status-left "bar"
2086: .Ed
2087: .Pp
2088: Will result in
2089: .Ql foobar .
2090: And:
2091: .Bd -literal -offset indent
2092: set -g status-style "bg=red"
2093: set -ag status-style "fg=blue"
2094: .Ed
2095: .Pp
2096: Will result in a red background
2097: .Em and
2098: blue foreground.
2099: Without
2100: .Fl a ,
2101: the result would be the default background and a blue foreground.
2102: .Pp
1.133 nicm 2103: Available window options are listed under
2104: .Ic set-window-option .
1.274 nicm 2105: .Pp
2106: .Ar value
2107: depends on the option and may be a number, a string, or a flag (on, off, or
2108: omitted to toggle).
1.133 nicm 2109: .Pp
2110: Available server options are:
2111: .Bl -tag -width Ds
1.198 nicm 2112: .It Ic buffer-limit Ar number
2113: Set the number of buffers; as new buffers are added to the top of the stack,
2114: old ones are removed from the bottom if necessary to maintain this maximum
2115: length.
1.239 nicm 2116: .It Ic escape-time Ar time
2117: Set the time in milliseconds for which
2118: .Nm
2119: waits after an escape is input to determine if it is part of a function or meta
2120: key sequences.
2121: The default is 500 milliseconds.
2122: .It Xo Ic exit-unattached
2123: .Op Ic on | off
2124: .Xc
2125: If enabled, the server will exit when there are no attached clients.
1.362 nicm 2126: .It Xo Ic focus-events
2127: .Op Ic on | off
2128: .Xc
2129: When enabled, focus events are requested from the terminal if supported and
2130: passed through to applications running in
2131: .Nm .
2132: Attached clients should be detached and attached again after changing this
2133: option.
1.384 nicm 2134: .It Ic message-limit Ar number
2135: Set the number of error or information messages to save in the message log for
2136: each client.
2137: The default is 100.
1.228 nicm 2138: .It Xo Ic set-clipboard
2139: .Op Ic on | off
2140: .Xc
2141: Attempt to set the terminal clipboard content using the
2142: \ee]52;...\e007
2143: .Xr xterm 1
2144: escape sequences.
2145: This option is on by default if there is an
2146: .Em \&Ms
2147: entry in the
2148: .Xr terminfo 5
2149: description for the client terminal.
2150: Note that this feature needs to be enabled in
2151: .Xr xterm 1
2152: by setting the resource:
2153: .Bd -literal -offset indent
2154: disallowedWindowOps: 20,21,SetXprop
2155: .Ed
2156: .Pp
2157: Or changing this property from the
2158: .Xr xterm 1
2159: interactive menu when required.
1.381 nicm 2160: .It Ic terminal-overrides Ar string
2161: Contains a list of entries which override terminal descriptions read using
2162: .Xr terminfo 5 .
2163: .Ar string
2164: is a comma-separated list of items each a colon-separated string made up of a
2165: terminal type pattern (matched using
2166: .Xr fnmatch 3 )
2167: and a set of
2168: .Em name=value
2169: entries.
2170: .Pp
2171: For example, to set the
2172: .Ql clear
2173: .Xr terminfo 5
2174: entry to
2175: .Ql \ee[H\ee[2J
2176: for all terminal types and the
2177: .Ql dch1
2178: entry to
2179: .Ql \ee[P
2180: for the
2181: .Ql rxvt
2182: terminal type, the option could be set to the string:
2183: .Bd -literal -offset indent
2184: "*:clear=\ee[H\ee[2J,rxvt:dch1=\ee[P"
2185: .Ed
2186: .Pp
2187: The terminal entry value is passed through
2188: .Xr strunvis 3
2189: before interpretation.
2190: The default value forcibly corrects the
2191: .Ql colors
2192: entry for terminals which support 256 colours:
2193: .Bd -literal -offset indent
2194: "*256col*:colors=256,xterm*:XT"
2195: .Ed
1.133 nicm 2196: .El
1.129 nicm 2197: .Pp
1.18 nicm 2198: Available session options are:
1.1 nicm 2199: .Bl -tag -width Ds
1.312 nicm 2200: .It Ic assume-paste-time Ar milliseconds
2201: If keys are entered faster than one in
2202: .Ar milliseconds ,
2203: they are assumed to have been pasted rather than typed and
2204: .Nm
2205: key bindings are not processed.
2206: The default is one millisecond and zero disables.
1.69 nicm 2207: .It Ic base-index Ar index
2208: Set the base index from which an unused index should be searched when a new
2209: window is created.
2210: The default is zero.
1.1 nicm 2211: .It Xo Ic bell-action
1.56 jmc 2212: .Op Ic any | none | current
1.1 nicm 2213: .Xc
2214: Set action on window bell.
2215: .Ic any
2216: means a bell in any window linked to a session causes a bell in the current
2217: window of that session,
2218: .Ic none
2219: means all bells are ignored and
2220: .Ic current
1.305 nicm 2221: means only bells in windows other than the current window are ignored.
1.237 nicm 2222: .It Xo Ic bell-on-alert
2223: .Op Ic on | off
2224: .Xc
1.295 nicm 2225: If on, ring the terminal bell when an alert
1.237 nicm 2226: occurs.
1.153 nicm 2227: .It Ic default-command Ar shell-command
1.1 nicm 2228: Set the command used for new windows (if not specified when the window is
2229: created) to
1.153 nicm 2230: .Ar shell-command ,
1.79 nicm 2231: which may be any
2232: .Xr sh 1
2233: command.
1.19 nicm 2234: The default is an empty string, which instructs
2235: .Nm
1.79 nicm 2236: to create a login shell using the value of the
2237: .Ic default-shell
2238: option.
2239: .It Ic default-shell Ar path
2240: Specify the default shell.
2241: This is used as the login shell for new windows when the
2242: .Ic default-command
2243: option is set to empty, and must be the full path of the executable.
2244: When started
2245: .Nm
2246: tries to set a default value from the first suitable of the
1.19 nicm 2247: .Ev SHELL
1.79 nicm 2248: environment variable, the shell returned by
2249: .Xr getpwuid 3 ,
2250: or
2251: .Pa /bin/sh .
2252: This option should be configured when
2253: .Nm
2254: is used as a login shell.
1.22 nicm 2255: .It Ic default-terminal Ar terminal
2256: Set the default terminal for new windows created in this session - the
2257: default value of the
2258: .Ev TERM
2259: environment variable.
2260: For
2261: .Nm
2262: to work correctly, this
2263: .Em must
2264: be set to
2265: .Ql screen
2266: or a derivative of it.
1.206 nicm 2267: .It Xo Ic destroy-unattached
2268: .Op Ic on | off
2269: .Xc
1.185 nicm 2270: If enabled and the session is no longer attached to any clients, it is
2271: destroyed.
1.206 nicm 2272: .It Xo Ic detach-on-destroy
2273: .Op Ic on | off
2274: .Xc
1.184 nicm 2275: If on (the default), the client is detached when the session it is attached to
2276: is destroyed.
2277: If off, the client is switched to the most recently active of the remaining
2278: sessions.
1.145 nicm 2279: .It Ic display-panes-active-colour Ar colour
2280: Set the colour used by the
2281: .Ic display-panes
2282: command to show the indicator for the active pane.
1.78 nicm 2283: .It Ic display-panes-colour Ar colour
1.145 nicm 2284: Set the colour used by the
1.78 nicm 2285: .Ic display-panes
1.145 nicm 2286: command to show the indicators for inactive panes.
1.78 nicm 2287: .It Ic display-panes-time Ar time
2288: Set the time in milliseconds for which the indicators shown by the
2289: .Ic display-panes
2290: command appear.
1.21 nicm 2291: .It Ic display-time Ar time
1.78 nicm 2292: Set the amount of time for which status line messages and other on-screen
2293: indicators are displayed.
1.21 nicm 2294: .Ar time
2295: is in milliseconds.
1.1 nicm 2296: .It Ic history-limit Ar lines
2297: Set the maximum number of lines held in window history.
2298: This setting applies only to new windows - existing window histories are not
2299: resized and retain the limit at the point they were created.
2300: .It Ic lock-after-time Ar number
1.100 nicm 2301: Lock the session (like the
2302: .Ic lock-session
1.90 nicm 2303: command) after
1.1 nicm 2304: .Ar number
1.100 nicm 2305: seconds of inactivity, or the entire server (all sessions) if the
2306: .Ic lock-server
2307: option is set.
2308: The default is not to lock (set to 0).
1.153 nicm 2309: .It Ic lock-command Ar shell-command
1.90 nicm 2310: Command to run when locking each client.
2311: The default is to run
2312: .Xr lock 1
2313: with
2314: .Fl np .
1.100 nicm 2315: .It Xo Ic lock-server
2316: .Op Ic on | off
2317: .Xc
2318: If this option is
1.102 nicm 2319: .Ic on
1.100 nicm 2320: (the default),
2321: instead of each session locking individually as each has been
2322: idle for
1.108 jmc 2323: .Ic lock-after-time ,
2324: the entire server will lock after
1.100 nicm 2325: .Em all
2326: sessions would have locked.
2327: This has no effect as a session option; it must be set as a global option.
1.378 nicm 2328: .It Ic message-command-style Ar style
2329: Set status line message command style, where
2330: .Ar style
2331: is a comma-separated list of characteristics to be specified.
2332: .Pp
2333: These may be
2334: .Ql bg=colour
2335: to set the background colour,
2336: .Ql fg=colour
2337: to set the foreground colour, and a list of attributes as specified below.
2338: .Pp
2339: The colour is one of:
1.1 nicm 2340: .Ic black ,
2341: .Ic red ,
2342: .Ic green ,
2343: .Ic yellow ,
2344: .Ic blue ,
2345: .Ic magenta ,
2346: .Ic cyan ,
1.85 nicm 2347: .Ic white ,
1.266 nicm 2348: aixterm bright variants (if supported:
2349: .Ic brightred ,
2350: .Ic brightgreen ,
2351: and so on),
1.85 nicm 2352: .Ic colour0
2353: to
2354: .Ic colour255
1.205 nicm 2355: from the 256-colour set,
2356: .Ic default ,
2357: or a hexadecimal RGB string such as
2358: .Ql #ffffff ,
2359: which chooses the closest match from the default 256-colour set.
1.378 nicm 2360: .Pp
2361: The attributes is either
2362: .Ic none
2363: or a comma-delimited list of one or more of:
2364: .Ic bright
2365: (or
2366: .Ic bold ) ,
2367: .Ic dim ,
2368: .Ic underscore ,
2369: .Ic blink ,
2370: .Ic reverse ,
2371: .Ic hidden ,
2372: or
2373: .Ic italics ,
2374: to turn an attribute on, or an attribute prefixed with
2375: .Ql no
2376: to turn one off.
2377: .Pp
2378: Examples are:
2379: .Bd -literal -offset indent
2380: fg=yellow,bold,underscore,blink
2381: bg=black,fg=default,noreverse
2382: .Ed
2383: .Pp
2384: With the
2385: .Fl a
2386: flag to the
2387: .Ic set-option
2388: command the new style is added otherwise the existing style is replaced.
2389: .It Ic message-style Ar style
2390: Set status line message style.
2391: For how to specify
2392: .Ar style ,
2393: see the
2394: .Ic message-command-style
2395: option.
1.226 nicm 2396: .It Xo Ic mouse-resize-pane
2397: .Op Ic on | off
2398: .Xc
2399: If on,
2400: .Nm
2401: captures the mouse and allows panes to be resized by dragging on their borders.
1.102 nicm 2402: .It Xo Ic mouse-select-pane
2403: .Op Ic on | off
2404: .Xc
2405: If on,
2406: .Nm
2407: captures the mouse and when a window is split into multiple panes the mouse may
2408: be used to select the current pane.
2409: The mouse click is also passed through to the application as normal.
1.222 nicm 2410: .It Xo Ic mouse-select-window
2411: .Op Ic on | off
2412: .Xc
2413: If on, clicking the mouse on a window name in the status line will select that
2414: window.
1.239 nicm 2415: .It Xo Ic mouse-utf8
2416: .Op Ic on | off
2417: .Xc
2418: If enabled, request mouse input as UTF-8 on UTF-8 terminals.
1.378 nicm 2419: .It Ic pane-active-border-style Ar style
2420: Set the pane border style for the currently active pane.
2421: For how to specify
2422: .Ar style ,
2423: see the
2424: .Ic message-command-style
2425: option.
2426: Attributes are ignored.
2427: .It Ic pane-border-style Ar style
2428: Set the pane border style for paneas aside from the active pane.
2429: For how to specify
2430: .Ar style ,
2431: see the
2432: .Ic message-command-style
2433: option.
2434: Attributes are ignored.
1.267 nicm 2435: .It Ic prefix Ar key
2436: Set the key accepted as a prefix key.
2437: .It Ic prefix2 Ar key
2438: Set a secondary key accepted as a prefix key.
1.291 nicm 2439: .It Xo Ic renumber-windows
2440: .Op Ic on | off
2441: .Xc
2442: If on, when a window is closed in a session, automatically renumber the other
2443: windows in numerical order.
2444: This respects the
2445: .Ic base-index
2446: option if it has been set.
2447: If off, do not renumber the windows.
1.21 nicm 2448: .It Ic repeat-time Ar time
1.1 nicm 2449: Allow multiple commands to be entered without pressing the prefix-key again
2450: in the specified
1.21 nicm 2451: .Ar time
1.1 nicm 2452: milliseconds (the default is 500).
2453: Whether a key repeats may be set when it is bound using the
2454: .Fl r
2455: flag to
2456: .Ic bind-key .
1.52 nicm 2457: Repeat is enabled for the default keys bound to the
2458: .Ic resize-pane
2459: command.
1.1 nicm 2460: .It Xo Ic set-remain-on-exit
1.56 jmc 2461: .Op Ic on | off
1.1 nicm 2462: .Xc
2463: Set the
2464: .Ic remain-on-exit
2465: window option for any windows first created in this session.
1.153 nicm 2466: When this option is true, windows in which the running program has
2467: exited do not close, instead remaining open but inactivate.
2468: Use the
2469: .Ic respawn-window
2470: command to reactivate such a window, or the
2471: .Ic kill-window
2472: command to destroy it.
1.1 nicm 2473: .It Xo Ic set-titles
1.56 jmc 2474: .Op Ic on | off
1.1 nicm 2475: .Xc
1.261 nicm 2476: Attempt to set the client terminal title using the
2477: .Em tsl
2478: and
2479: .Em fsl
2480: .Xr terminfo 5
2481: entries if they exist.
2482: .Nm
2483: automatically sets these to the \ee]2;...\e007 sequence if
1.1 nicm 2484: the terminal appears to be an xterm.
1.11 nicm 2485: This option is off by default.
1.6 jmc 2486: Note that elinks
1.1 nicm 2487: will only attempt to set the window title if the STY environment
2488: variable is set.
1.86 nicm 2489: .It Ic set-titles-string Ar string
2490: String used to set the window title if
2491: .Ic set-titles
2492: is on.
2493: Character sequences are replaced as for the
2494: .Ic status-left
2495: option.
1.1 nicm 2496: .It Xo Ic status
1.56 jmc 2497: .Op Ic on | off
1.1 nicm 2498: .Xc
2499: Show or hide the status line.
2500: .It Ic status-interval Ar interval
2501: Update the status bar every
2502: .Ar interval
2503: seconds.
2504: By default, updates will occur every 15 seconds.
2505: A setting of zero disables redrawing at interval.
1.41 nicm 2506: .It Xo Ic status-justify
1.56 jmc 2507: .Op Ic left | centre | right
1.41 nicm 2508: .Xc
2509: Set the position of the window list component of the status line: left, centre
2510: or right justified.
1.1 nicm 2511: .It Xo Ic status-keys
1.56 jmc 2512: .Op Ic vi | emacs
1.1 nicm 2513: .Xc
1.6 jmc 2514: Use vi or emacs-style
1.1 nicm 2515: key bindings in the status line, for example at the command prompt.
1.191 nicm 2516: The default is emacs, unless the
2517: .Ev VISUAL
2518: or
2519: .Ev EDITOR
2520: environment variables are set and contain the string
2521: .Ql vi .
1.1 nicm 2522: .It Ic status-left Ar string
2523: Display
2524: .Ar string
1.359 nicm 2525: (by default the session name) to the left of the status bar.
1.1 nicm 2526: .Ar string
2527: will be passed through
2528: .Xr strftime 3
1.359 nicm 2529: and formats (see
1.379 jmc 2530: .Sx FORMATS )
1.359 nicm 2531: will be expanded.
2532: It may also contain any of the following special character sequences:
1.1 nicm 2533: .Bl -column "Character pair" "Replaced with" -offset indent
2534: .It Sy "Character pair" Ta Sy "Replaced with"
1.153 nicm 2535: .It Li "#(shell-command)" Ta "First line of the command's output"
1.83 nicm 2536: .It Li "#[attributes]" Ta "Colour or attribute change"
1.1 nicm 2537: .It Li "##" Ta "A literal" Ql #
2538: .El
1.83 nicm 2539: .Pp
1.153 nicm 2540: The #(shell-command) form executes
2541: .Ql shell-command
2542: and inserts the first line of its output.
1.103 nicm 2543: Note that shell commands are only executed once at the interval specified by
2544: the
2545: .Ic status-interval
2546: option: if the status line is redrawn in the meantime, the previous result is
2547: used.
1.161 nicm 2548: Shell commands are executed with the
2549: .Nm
2550: global environment set (see the
1.162 jmc 2551: .Sx ENVIRONMENT
2552: section).
1.163 nicm 2553: .Pp
1.263 nicm 2554: For details on how the names and titles can be set see the
1.261 nicm 2555: .Sx "NAMES AND TITLES"
2556: section.
1.378 nicm 2557: For a list of allowed attributes see the
2558: .Ic message-command-style
2559: option.
1.109 nicm 2560: .Pp
1.83 nicm 2561: Examples are:
2562: .Bd -literal -offset indent
2563: #(sysctl vm.loadavg)
2564: #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
2565: .Ed
1.10 nicm 2566: .Pp
1.12 jmc 2567: By default, UTF-8 in
1.10 nicm 2568: .Ar string
2569: is not interpreted, to enable UTF-8, use the
2570: .Ic status-utf8
2571: option.
1.1 nicm 2572: .It Ic status-left-length Ar length
2573: Set the maximum
2574: .Ar length
2575: of the left component of the status bar.
2576: The default is 10.
1.378 nicm 2577: .It Ic status-left-style Ar style
2578: Set the style of the left part of the status line.
2579: For how to specify
2580: .Ar style ,
2581: see the
2582: .Ic message-command-style
2583: option.
1.269 nicm 2584: .It Xo Ic status-position
2585: .Op Ic top | bottom
2586: .Xc
2587: Set the position of the status line.
1.1 nicm 2588: .It Ic status-right Ar string
2589: Display
2590: .Ar string
2591: to the right of the status bar.
1.151 nicm 2592: By default, the current window title in double quotes, the date and the time
2593: are shown.
1.1 nicm 2594: As with
2595: .Ic status-left ,
2596: .Ar string
2597: will be passed to
1.10 nicm 2598: .Xr strftime 3 ,
2599: character pairs are replaced, and UTF-8 is dependent on the
2600: .Ic status-utf8
2601: option.
1.1 nicm 2602: .It Ic status-right-length Ar length
2603: Set the maximum
2604: .Ar length
2605: of the right component of the status bar.
2606: The default is 40.
1.378 nicm 2607: .It Ic status-right-style Ar style
2608: Set the style of the right part of the status line.
2609: For how to specify
2610: .Ar style ,
2611: see the
2612: .Ic message-command-style
2613: option.
2614: .It Ic status-style Ar style
2615: Set status line style.
2616: For how to specify
2617: .Ar style ,
2618: see the
2619: .Ic message-command-style
2620: option.
1.10 nicm 2621: .It Xo Ic status-utf8
1.56 jmc 2622: .Op Ic on | off
1.10 nicm 2623: .Xc
2624: Instruct
2625: .Nm
2626: to treat top-bit-set characters in the
2627: .Ic status-left
2628: and
2629: .Ic status-right
2630: strings as UTF-8; notably, this is important for wide characters.
2631: This option defaults to off.
1.63 nicm 2632: .It Ic update-environment Ar variables
2633: Set a space-separated string containing a list of environment variables to be
2634: copied into the session environment when a new session is created or an
2635: existing session is attached.
2636: Any variables that do not exist in the source environment are set to be
2637: removed from the session environment (as if
2638: .Fl r
2639: was given to the
2640: .Ic set-environment
2641: command).
2642: The default is
1.190 nicm 2643: "DISPLAY SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION WINDOWID
2644: XAUTHORITY".
1.37 nicm 2645: .It Xo Ic visual-activity
1.56 jmc 2646: .Op Ic on | off
1.37 nicm 2647: .Xc
2648: If on, display a status line message when activity occurs in a window
1.39 jmc 2649: for which the
1.37 nicm 2650: .Ic monitor-activity
2651: window option is enabled.
2652: .It Xo Ic visual-bell
1.56 jmc 2653: .Op Ic on | off
1.37 nicm 2654: .Xc
2655: If this option is on, a message is shown on a bell instead of it being passed
2656: through to the terminal (which normally makes a sound).
2657: Also see the
2658: .Ic bell-action
2659: option.
1.192 nicm 2660: .It Xo Ic visual-silence
2661: .Op Ic on | off
2662: .Xc
2663: If
2664: .Ic monitor-silence
2665: is enabled, prints a message after the interval has expired on a given window.
1.255 nicm 2666: .It Ic word-separators Ar string
2667: Sets the session's conception of what characters are considered word
2668: separators, for the purposes of the next and previous word commands in
2669: copy mode.
2670: The default is
2671: .Ql \ -_@ .
1.1 nicm 2672: .El
2673: .It Xo Ic set-window-option
1.356 nicm 2674: .Op Fl agoqu
1.1 nicm 2675: .Op Fl t Ar target-window
2676: .Ar option Ar value
2677: .Xc
2678: .D1 (alias: Ic setw )
1.18 nicm 2679: Set a window option.
1.1 nicm 2680: The
1.58 nicm 2681: .Fl a ,
1.281 nicm 2682: .Fl g ,
1.356 nicm 2683: .Fl o ,
1.281 nicm 2684: .Fl q
1.1 nicm 2685: and
2686: .Fl u
2687: flags work similarly to the
2688: .Ic set-option
2689: command.
2690: .Pp
1.18 nicm 2691: Supported window options are:
1.56 jmc 2692: .Pp
2693: .Bl -tag -width Ds -compact
1.1 nicm 2694: .It Xo Ic aggressive-resize
1.56 jmc 2695: .Op Ic on | off
1.1 nicm 2696: .Xc
2697: Aggressively resize the chosen window.
2698: This means that
2699: .Nm
2700: will resize the window to the size of the smallest session for which it is the
2701: current window, rather than the smallest session to which it is attached.
2702: The window may resize when the current window is changed on another sessions;
1.6 jmc 2703: this option is good for full-screen programs which support
2704: .Dv SIGWINCH
2705: and poor for interactive programs such as shells.
1.262 nicm 2706: .Pp
2707: .It Xo Ic allow-rename
2708: .Op Ic on | off
2709: .Xc
2710: Allow programs to change the window name using a terminal escape
2711: sequence (\\033k...\\033\\\\).
2712: The default is on.
1.56 jmc 2713: .Pp
1.196 nicm 2714: .It Xo Ic alternate-screen
2715: .Op Ic on | off
2716: .Xc
2717: This option configures whether programs running inside
2718: .Nm
2719: may use the terminal alternate screen feature, which allows the
2720: .Em smcup
2721: and
2722: .Em rmcup
2723: .Xr terminfo 5
1.209 nicm 2724: capabilities.
2725: The alternate screen feature preserves the contents of the window when an
2726: interactive application starts and restores it on exit, so that any output
2727: visible before the application starts reappears unchanged after it exits.
2728: The default is on.
1.196 nicm 2729: .Pp
1.1 nicm 2730: .It Xo Ic automatic-rename
1.56 jmc 2731: .Op Ic on | off
1.1 nicm 2732: .Xc
2733: Control automatic window renaming.
2734: When this setting is enabled,
2735: .Nm
1.368 nicm 2736: will rename the window automatically using the format specified by
2737: .Ic automatic-rename-format .
1.1 nicm 2738: This flag is automatically disabled for an individual window when a name
2739: is specified at creation with
1.186 nicm 2740: .Ic new-window
2741: or
1.1 nicm 2742: .Ic new-session ,
2743: or later with
1.261 nicm 2744: .Ic rename-window ,
2745: or with a terminal escape sequence.
1.1 nicm 2746: It may be switched off globally with:
2747: .Bd -literal -offset indent
2748: set-window-option -g automatic-rename off
2749: .Ed
1.368 nicm 2750: .Pp
2751: .It Ic automatic-rename-format Ar format
2752: The format (see
2753: .Sx FORMATS )
2754: used when the
2755: .Ic automatic-rename
2756: option is enabled.
1.283 nicm 2757: .Pp
2758: .It Ic c0-change-interval Ar interval
2759: .It Ic c0-change-trigger Ar trigger
2760: These two options configure a simple form of rate limiting for a pane.
2761: If
2762: .Nm
2763: sees more than
2764: .Ar trigger
2765: C0 sequences that modify the screen (for example, carriage returns, linefeeds
2766: or backspaces) in one millisecond, it will stop updating the pane immediately and
2767: instead redraw it entirely every
2768: .Ar interval
2769: milliseconds.
2770: This helps to prevent fast output (such as
1.374 nicm 2771: .Xr yes 1 )
2772: overwhelming the terminal.
1.284 nicm 2773: The default is a trigger of 250 and an interval of 100.
1.283 nicm 2774: A trigger of zero disables the rate limiting.
1.56 jmc 2775: .Pp
1.1 nicm 2776: .It Ic clock-mode-colour Ar colour
2777: Set clock colour.
1.56 jmc 2778: .Pp
1.1 nicm 2779: .It Xo Ic clock-mode-style
1.56 jmc 2780: .Op Ic 12 | 24
1.1 nicm 2781: .Xc
2782: Set clock hour format.
1.56 jmc 2783: .Pp
1.1 nicm 2784: .It Ic force-height Ar height
2785: .It Ic force-width Ar width
2786: Prevent
2787: .Nm
2788: from resizing a window to greater than
2789: .Ar width
2790: or
2791: .Ar height .
2792: A value of zero restores the default unlimited setting.
1.56 jmc 2793: .Pp
1.196 nicm 2794: .It Ic main-pane-height Ar height
1.2 nicm 2795: .It Ic main-pane-width Ar width
2796: Set the width or height of the main (left or top) pane in the
2797: .Ic main-horizontal
2798: or
2799: .Ic main-vertical
2800: layouts.
1.56 jmc 2801: .Pp
1.1 nicm 2802: .It Xo Ic mode-keys
1.56 jmc 2803: .Op Ic vi | emacs
1.1 nicm 2804: .Xc
1.105 nicm 2805: Use vi or emacs-style key bindings in copy and choice modes.
1.191 nicm 2806: As with the
2807: .Ic status-keys
2808: option, the default is emacs, unless
2809: .Ev VISUAL
2810: or
2811: .Ev EDITOR
2812: contains
2813: .Ql vi .
1.56 jmc 2814: .Pp
1.50 nicm 2815: .It Xo Ic mode-mouse
1.240 nicm 2816: .Op Ic on | off | copy-mode
1.50 nicm 2817: .Xc
1.51 jmc 2818: Mouse state in modes.
1.223 nicm 2819: If on, the mouse may be used to enter copy mode and copy a selection by
2820: dragging, to enter copy mode and scroll with the mouse wheel, or to select an
2821: option in choice mode.
1.240 nicm 2822: If set to
1.241 jmc 2823: .Em copy-mode ,
1.240 nicm 2824: the mouse behaves as set to on, but cannot be used to enter copy
2825: mode.
1.56 jmc 2826: .Pp
1.378 nicm 2827: .It Ic mode-style Ar style
2828: Set window modes style.
2829: For how to specify
2830: .Ar style ,
2831: see the
2832: .Ic message-command-style
2833: option.
2834: .Pp
1.1 nicm 2835: .It Xo Ic monitor-activity
1.56 jmc 2836: .Op Ic on | off
1.1 nicm 2837: .Xc
2838: Monitor for activity in the window.
2839: Windows with activity are highlighted in the status line.
1.56 jmc 2840: .Pp
1.192 nicm 2841: .It Xo Ic monitor-silence
2842: .Op Ic interval
2843: .Xc
2844: Monitor for silence (no activity) in the window within
2845: .Ic interval
2846: seconds.
2847: Windows that have been silent for the interval are highlighted in the
2848: status line.
2849: An interval of zero disables the monitoring.
1.195 nicm 2850: .Pp
2851: .It Ic other-pane-height Ar height
2852: Set the height of the other panes (not the main pane) in the
2853: .Ic main-horizontal
2854: layout.
2855: If this option is set to 0 (the default), it will have no effect.
2856: If both the
2857: .Ic main-pane-height
2858: and
2859: .Ic other-pane-height
2860: options are set, the main pane will grow taller to make the other panes the
2861: specified height, but will never shrink to do so.
2862: .Pp
2863: .It Ic other-pane-width Ar width
2864: Like
2865: .Ic other-pane-height ,
2866: but set the width of other panes in the
2867: .Ic main-vertical
2868: layout.
1.243 nicm 2869: .Pp
2870: .It Ic pane-base-index Ar index
2871: Like
2872: .Ic base-index ,
2873: but set the starting index for pane numbers.
1.192 nicm 2874: .Pp
1.1 nicm 2875: .It Xo Ic remain-on-exit
1.56 jmc 2876: .Op Ic on | off
1.1 nicm 2877: .Xc
2878: A window with this flag set is not destroyed when the program running in it
2879: exits.
2880: The window may be reactivated with the
2881: .Ic respawn-window
2882: command.
1.56 jmc 2883: .Pp
1.99 nicm 2884: .It Xo Ic synchronize-panes
2885: .Op Ic on | off
2886: .Xc
1.164 nicm 2887: Duplicate input to any pane to all other panes in the same window (only
2888: for panes that are not in any special mode).
1.139 nicm 2889: .Pp
1.1 nicm 2890: .It Xo Ic utf8
1.56 jmc 2891: .Op Ic on | off
1.1 nicm 2892: .Xc
2893: Instructs
2894: .Nm
2895: to expect UTF-8 sequences to appear in this window.
1.56 jmc 2896: .Pp
1.378 nicm 2897: .It Ic window-status-activity-style Ar style
2898: Set status line style for windows with an activity alert.
2899: For how to specify
2900: .Ar style ,
2901: see the
2902: .Ic message-command-style
2903: option.
1.169 nicm 2904: .Pp
1.378 nicm 2905: .It Ic window-status-bell-style Ar style
2906: Set status line style for windows with a bell alert.
2907: For how to specify
2908: .Ar style ,
2909: see the
2910: .Ic message-command-style
2911: option.
1.169 nicm 2912: .Pp
1.125 nicm 2913: .It Ic window-status-current-format Ar string
2914: Like
2915: .Ar window-status-format ,
2916: but is the format used when the window is the current window.
1.307 nicm 2917: .Pp
1.378 nicm 2918: .It Ic window-status-current-style Ar style
2919: Set status line style for the currently active window.
2920: For how to specify
2921: .Ar style ,
2922: see the
2923: .Ic message-command-style
2924: option.
1.239 nicm 2925: .Pp
2926: .It Ic window-status-format Ar string
2927: Set the format in which the window is displayed in the status line window list.
2928: See the
2929: .Ar status-left
2930: option for details of special character sequences available.
2931: The default is
2932: .Ql #I:#W#F .
1.290 nicm 2933: .Pp
1.378 nicm 2934: .It Ic window-status-last-style Ar style
2935: Set status line style for the last active window.
2936: For how to specify
2937: .Ar style ,
2938: see the
2939: .Ic message-command-style
2940: option.
2941: .Pp
1.290 nicm 2942: .It Ic window-status-separator Ar string
2943: Sets the separator drawn between windows in the status line.
2944: The default is a single space character.
1.125 nicm 2945: .Pp
1.378 nicm 2946: .It Ic window-status-style Ar style
2947: Set status line style for a single window.
2948: For how to specify
2949: .Ar style ,
2950: see the
2951: .Ic message-command-style
2952: option.
2953: .Pp
1.1 nicm 2954: .It Xo Ic xterm-keys
1.56 jmc 2955: .Op Ic on | off
1.1 nicm 2956: .Xc
2957: If this option is set,
2958: .Nm
2959: will generate
1.57 jmc 2960: .Xr xterm 1 -style
2961: function key sequences; these have a number included to indicate modifiers such
2962: as Shift, Alt or Ctrl.
1.123 nicm 2963: The default is off.
1.282 nicm 2964: .Pp
2965: .It Xo Ic wrap-search
2966: .Op Ic on | off
2967: .Xc
2968: If this option is set, searches will wrap around the end of the pane contents.
2969: The default is on.
1.57 jmc 2970: .El
2971: .It Xo Ic show-options
1.340 nicm 2972: .Op Fl gqsvw
1.129 nicm 2973: .Op Fl t Ar target-session | Ar target-window
1.276 nicm 2974: .Op Ar option
1.57 jmc 2975: .Xc
2976: .D1 (alias: Ic show )
1.276 nicm 2977: Show the window options (or a single window option if given) with
1.129 nicm 2978: .Fl w
1.133 nicm 2979: (equivalent to
1.134 nicm 2980: .Ic show-window-options ) ,
1.133 nicm 2981: the server options with
2982: .Fl s ,
2983: otherwise the session options for
2984: .Ar target session .
2985: Global session or window options are listed if
2986: .Fl g
2987: is used.
1.317 nicm 2988: .Fl v
2989: shows only the option value, not the name.
1.340 nicm 2990: If
2991: .Fl q
2992: is set, no error will be returned if
2993: .Ar option
2994: is unset.
1.57 jmc 2995: .It Xo Ic show-window-options
1.317 nicm 2996: .Op Fl gv
1.57 jmc 2997: .Op Fl t Ar target-window
1.276 nicm 2998: .Op Ar option
1.57 jmc 2999: .Xc
3000: .D1 (alias: Ic showw )
1.276 nicm 3001: List the window options or a single option for
1.57 jmc 3002: .Ar target-window ,
3003: or the global window options if
3004: .Fl g
3005: is used.
1.317 nicm 3006: .Fl v
3007: shows only the option value, not the name.
1.63 nicm 3008: .El
1.245 nicm 3009: .Sh FORMATS
1.294 nicm 3010: Certain commands accept the
1.245 nicm 3011: .Fl F
3012: flag with a
3013: .Ar format
3014: argument.
3015: This is a string which controls the output format of the command.
3016: Replacement variables are enclosed in
3017: .Ql #{
3018: and
3019: .Ql } ,
3020: for example
1.359 nicm 3021: .Ql #{session_name} .
3022: Some variables also have an shorter alias such as
1.245 nicm 3023: .Ql #S .
1.376 nicm 3024: .Ql ##
3025: is replaced by a single
3026: .Ql # .
1.245 nicm 3027: Conditionals are also accepted by prefixing with
1.246 jmc 3028: .Ql \&?
1.245 nicm 3029: and separating two alternatives with a comma;
3030: if the specified variable exists and is not zero, the first alternative
1.246 jmc 3031: is chosen, otherwise the second is used.
3032: For example
1.245 nicm 3033: .Ql #{?session_attached,attached,not attached}
3034: will include the string
3035: .Ql attached
3036: if the session is attached and the string
3037: .Ql not attached
3038: if it is unattached.
1.367 nicm 3039: A limit may be placed on the length of the resultant string by prefixing it
3040: by an
3041: .Ql = ,
3042: a number and a colon, so
3043: .Ql #{=10:pane_title}
3044: will include at most the first 10 characters of the pane title.
1.245 nicm 3045: .Pp
3046: The following variables are available, where appropriate:
1.359 nicm 3047: .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
3048: .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
3049: .It Li "alternate_on" Ta "" Ta "If pane is in alternate screen"
3050: .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
3051: .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
1.386 nicm 3052: .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
1.359 nicm 3053: .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
3054: .It Li "client_activity" Ta "" Ta "Integer time client last had activity"
3055: .It Li "client_activity_string" Ta "" Ta "String time client last had activity"
3056: .It Li "client_created" Ta "" Ta "Integer time client created"
3057: .It Li "client_created_string" Ta "" Ta "String time client created"
3058: .It Li "client_height" Ta "" Ta "Height of client"
3059: .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
3060: .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
3061: .It Li "client_readonly" Ta "" Ta "1 if client is readonly"
3062: .It Li "client_session" Ta "" Ta "Name of the client's session"
3063: .It Li "client_termname" Ta "" Ta "Terminal name of client"
3064: .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
3065: .It Li "client_utf8" Ta "" Ta "1 if client supports utf8"
3066: .It Li "client_width" Ta "" Ta "Width of client"
3067: .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
3068: .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
3069: .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
3070: .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
3071: .It Li "history_limit" Ta "" Ta "Maximum window history lines"
3072: .It Li "history_size" Ta "" Ta "Size of history in bytes"
3073: .It Li "host" Ta "#H" Ta "Hostname of local host"
3074: .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
3075: .It Li "insert_flag" Ta "" Ta "Pane insert flag"
3076: .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
3077: .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
3078: .It Li "line" Ta "" Ta "Line number in the list"
3079: .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
3080: .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
3081: .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
3082: .It Li "mouse_utf8_flag" Ta "" Ta "Pane mouse UTF-8 flag"
3083: .It Li "pane_active" Ta "" Ta "1 if active pane"
1.396 nicm 3084: .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
1.359 nicm 3085: .It Li "pane_current_command" Ta "" Ta "Current command if available"
3086: .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
3087: .It Li "pane_height" Ta "" Ta "Height of pane"
3088: .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
3089: .It Li "pane_in_mode" Ta "" Ta "If pane is in a mode"
3090: .It Li "pane_index" Ta "#P" Ta "Index of pane"
1.396 nicm 3091: .It Li "pane_left" Ta "" Ta "Left of pane"
1.359 nicm 3092: .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
1.396 nicm 3093: .It Li "pane_right" Ta "" Ta "Right of pane"
1.359 nicm 3094: .It Li "pane_start_command" Ta "" Ta "Command pane started with"
1.396 nicm 3095: .It Li "pane_synchronized" Ta "" Ta "If pane is synchronized"
1.359 nicm 3096: .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
3097: .It Li "pane_title" Ta "#T" Ta "Title of pane"
1.396 nicm 3098: .It Li "pane_top" Ta "" Ta "Top of pane"
1.359 nicm 3099: .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
3100: .It Li "pane_width" Ta "" Ta "Width of pane"
3101: .It Li "saved_cursor_x" Ta "" Ta "Saved cursor X in pane"
3102: .It Li "saved_cursor_y" Ta "" Ta "Saved cursor Y in pane"
3103: .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
3104: .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
1.382 nicm 3105: .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
1.359 nicm 3106: .It Li "session_created" Ta "" Ta "Integer time session created"
3107: .It Li "session_created_string" Ta "" Ta "String time session created"
3108: .It Li "session_group" Ta "" Ta "Number of session group"
3109: .It Li "session_grouped" Ta "" Ta "1 if session in a group"
3110: .It Li "session_height" Ta "" Ta "Height of session"
3111: .It Li "session_id" Ta "" Ta "Unique session ID"
1.382 nicm 3112: .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
1.359 nicm 3113: .It Li "session_name" Ta "#S" Ta "Name of session"
3114: .It Li "session_width" Ta "" Ta "Width of session"
3115: .It Li "session_windows" Ta "" Ta "Number of windows in session"
3116: .It Li "window_active" Ta "" Ta "1 if window active"
1.366 nicm 3117: .It Li "window_activity_flag" Ta "" Ta "1 if window has activity alert"
3118: .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
1.359 nicm 3119: .It Li "window_find_matches" Ta "" Ta "Matched data from the find-window"
3120: .It Li "window_flags" Ta "#F" Ta "Window flags"
3121: .It Li "window_height" Ta "" Ta "Height of window"
3122: .It Li "window_id" Ta "" Ta "Unique window ID"
3123: .It Li "window_index" Ta "#I" Ta "Index of window"
3124: .It Li "window_layout" Ta "" Ta "Window layout description"
3125: .It Li "window_name" Ta "#W" Ta "Name of window"
3126: .It Li "window_panes" Ta "" Ta "Number of panes in window"
1.366 nicm 3127: .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
1.359 nicm 3128: .It Li "window_width" Ta "" Ta "Width of window"
3129: .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
1.245 nicm 3130: .El
1.261 nicm 3131: .Sh NAMES AND TITLES
3132: .Nm
3133: distinguishes between names and titles.
3134: Windows and sessions have names, which may be used to specify them in targets
3135: and are displayed in the status line and various lists: the name is the
3136: .Nm
3137: identifier for a window or session.
3138: Only panes have titles.
3139: A pane's title is typically set by the program running inside the pane and
3140: is not modified by
3141: .Nm .
3142: It is the same mechanism used to set for example the
3143: .Xr xterm 1
3144: window title in an
3145: .Xr X 7
3146: window manager.
1.268 nicm 3147: Windows themselves do not have titles - a window's title is the title of its
1.261 nicm 3148: active pane.
3149: .Nm
3150: itself may set the title of the terminal in which the client is running, see
3151: the
3152: .Ic set-titles
3153: option.
3154: .Pp
3155: A session's name is set with the
3156: .Ic new-session
3157: and
3158: .Ic rename-session
3159: commands.
3160: A window's name is set with one of:
3161: .Bl -enum -width Ds
3162: .It
3163: A command argument (such as
3164: .Fl n
3165: for
3166: .Ic new-window
3167: or
3168: .Ic new-session ) .
3169: .It
3170: An escape sequence:
3171: .Bd -literal -offset indent
3172: $ printf '\e033kWINDOW_NAME\e033\e\e'
3173: .Ed
3174: .It
3175: Automatic renaming, which sets the name to the active command in the window's
3176: active pane.
3177: See the
3178: .Ic automatic-rename
3179: option.
3180: .El
3181: .Pp
3182: When a pane is first created, its title is the hostname.
3183: A pane's title can be set via the OSC title setting sequence, for example:
3184: .Bd -literal -offset indent
3185: $ printf '\e033]2;My Title\e033\e\e'
3186: .Ed
1.63 nicm 3187: .Sh ENVIRONMENT
3188: When the server is started,
3189: .Nm
3190: copies the environment into the
3191: .Em global environment ;
3192: in addition, each session has a
3193: .Em session environment .
1.193 nicm 3194: When a window is created, the session and global environments are merged.
3195: If a variable exists in both, the value from the session environment is used.
3196: The result is the initial environment passed to the new process.
1.63 nicm 3197: .Pp
3198: The
3199: .Ic update-environment
3200: session option may be used to update the session environment from the client
3201: when a new session is created or an old reattached.
3202: .Nm
3203: also initialises the
3204: .Ev TMUX
3205: variable with some internal information to allow commands to be executed
3206: from inside, and the
3207: .Ev TERM
3208: variable with the correct terminal setting of
3209: .Ql screen .
3210: .Pp
3211: Commands to alter and view the environment are:
3212: .Bl -tag -width Ds
3213: .It Xo Ic set-environment
3214: .Op Fl gru
3215: .Op Fl t Ar target-session
3216: .Ar name Op Ar value
3217: .Xc
1.115 nicm 3218: .D1 (alias: Ic setenv )
1.63 nicm 3219: Set or unset an environment variable.
3220: If
3221: .Fl g
3222: is used, the change is made in the global environment; otherwise, it is applied
3223: to the session environment for
3224: .Ar target-session .
3225: The
3226: .Fl u
3227: flag unsets a variable.
3228: .Fl r
3229: indicates the variable is to be removed from the environment before starting a
3230: new process.
3231: .It Xo Ic show-environment
3232: .Op Fl g
3233: .Op Fl t Ar target-session
1.286 nicm 3234: .Op Ar variable
1.63 nicm 3235: .Xc
1.115 nicm 3236: .D1 (alias: Ic showenv )
1.63 nicm 3237: Display the environment for
3238: .Ar target-session
3239: or the global environment with
3240: .Fl g .
1.286 nicm 3241: If
3242: .Ar variable
3243: is omitted, all variables are shown.
1.63 nicm 3244: Variables removed from the environment are prefixed with
3245: .Ql - .
1.57 jmc 3246: .El
3247: .Sh STATUS LINE
3248: .Nm
3249: includes an optional status line which is displayed in the bottom line of each
3250: terminal.
3251: By default, the status line is enabled (it may be disabled with the
3252: .Ic status
3253: session option) and contains, from left-to-right: the name of the current
1.261 nicm 3254: session in square brackets; the window list; the title of the active pane
3255: in double quotes; and the time and date.
1.57 jmc 3256: .Pp
3257: The status line is made of three parts: configurable left and right sections
3258: (which may contain dynamic content such as the time or output from a shell
3259: command, see the
3260: .Ic status-left ,
3261: .Ic status-left-length ,
3262: .Ic status-right ,
3263: and
3264: .Ic status-right-length
3265: options below), and a central window list.
1.125 nicm 3266: By default, the window list shows the index, name and (if any) flag of the
3267: windows present in the current session in ascending numerical order.
3268: It may be customised with the
3269: .Ar window-status-format
3270: and
3271: .Ar window-status-current-format
3272: options.
1.57 jmc 3273: The flag is one of the following symbols appended to the window name:
3274: .Bl -column "Symbol" "Meaning" -offset indent
3275: .It Sy "Symbol" Ta Sy "Meaning"
3276: .It Li "*" Ta "Denotes the current window."
3277: .It Li "-" Ta "Marks the last window (previously selected)."
3278: .It Li "#" Ta "Window is monitored and activity has been detected."
3279: .It Li "!" Ta "A bell has occurred in the window."
1.192 nicm 3280: .It Li "~" Ta "The window has been silent for the monitor-silence interval."
1.349 nicm 3281: .It Li "Z" Ta "The window's active pane is zoomed."
1.57 jmc 3282: .El
3283: .Pp
3284: The # symbol relates to the
3285: .Ic monitor-activity
1.388 nicm 3286: window option.
1.57 jmc 3287: The window name is printed in inverted colours if an alert (bell, activity or
1.388 nicm 3288: silence) is present.
1.57 jmc 3289: .Pp
1.131 nicm 3290: The colour and attributes of the status line may be configured, the entire
3291: status line using the
1.378 nicm 3292: .Ic status-style
3293: session option and individual windows using the
3294: .Ic window-status-style
3295: window option.
1.57 jmc 3296: .Pp
1.131 nicm 3297: The status line is automatically refreshed at interval if it has changed, the
3298: interval may be controlled with the
1.57 jmc 3299: .Ic status-interval
3300: session option.
3301: .Pp
3302: Commands related to the status line are as follows:
3303: .Bl -tag -width Ds
3304: .It Xo Ic command-prompt
1.235 nicm 3305: .Op Fl I Ar inputs
1.73 nicm 3306: .Op Fl p Ar prompts
1.57 jmc 3307: .Op Fl t Ar target-client
3308: .Op Ar template
3309: .Xc
3310: Open the command prompt in a client.
3311: This may be used from inside
3312: .Nm
3313: to execute commands interactively.
1.231 nicm 3314: .Pp
1.57 jmc 3315: If
3316: .Ar template
1.73 nicm 3317: is specified, it is used as the command.
1.235 nicm 3318: If present,
3319: .Fl I
3320: is a comma-separated list of the initial text for each prompt.
1.73 nicm 3321: If
3322: .Fl p
3323: is given,
3324: .Ar prompts
3325: is a comma-separated list of prompts which are displayed in order; otherwise
3326: a single prompt is displayed, constructed from
3327: .Ar template
3328: if it is present, or
3329: .Ql \&:
3330: if not.
1.235 nicm 3331: .Pp
3332: Both
3333: .Ar inputs
3334: and
1.231 nicm 3335: .Ar prompts
3336: may contain the special character sequences supported by the
3337: .Ic status-left
3338: option.
3339: .Pp
1.73 nicm 3340: Before the command is executed, the first occurrence of the string
3341: .Ql %%
1.74 jmc 3342: and all occurrences of
1.73 nicm 3343: .Ql %1
3344: are replaced by the response to the first prompt, the second
3345: .Ql %%
3346: and all
3347: .Ql %2
3348: are replaced with the response to the second prompt, and so on for further
1.74 jmc 3349: prompts.
3350: Up to nine prompt responses may be replaced
3351: .Po
3352: .Ql %1
1.73 nicm 3353: to
1.74 jmc 3354: .Ql %9
3355: .Pc .
1.57 jmc 3356: .It Xo Ic confirm-before
1.238 nicm 3357: .Op Fl p Ar prompt
1.57 jmc 3358: .Op Fl t Ar target-client
3359: .Ar command
3360: .Xc
3361: .D1 (alias: Ic confirm )
3362: Ask for confirmation before executing
3363: .Ar command .
1.238 nicm 3364: If
3365: .Fl p
3366: is given,
3367: .Ar prompt
3368: is the prompt to display; otherwise a prompt is constructed from
3369: .Ar command .
3370: It may contain the special character sequences supported by the
3371: .Ic status-left
3372: option.
3373: .Pp
1.57 jmc 3374: This command works only from inside
3375: .Nm .
3376: .It Xo Ic display-message
1.127 nicm 3377: .Op Fl p
1.215 nicm 3378: .Op Fl c Ar target-client
3379: .Op Fl t Ar target-pane
1.57 jmc 3380: .Op Ar message
3381: .Xc
3382: .D1 (alias: Ic display )
1.127 nicm 3383: Display a message.
3384: If
3385: .Fl p
3386: is given, the output is printed to stdout, otherwise it is displayed in the
3387: .Ar target-client
3388: status line.
1.122 nicm 3389: The format of
1.124 jmc 3390: .Ar message
1.275 nicm 3391: is described in the
3392: .Sx FORMATS
3393: section; information is taken from
1.215 nicm 3394: .Ar target-pane
3395: if
3396: .Fl t
3397: is given, otherwise the active pane for the session attached to
3398: .Ar target-client .
1.57 jmc 3399: .El
3400: .Sh BUFFERS
3401: .Nm
1.392 nicm 3402: maintains a set of named
1.199 nicm 3403: .Em paste buffers .
1.392 nicm 3404: Each buffer may be either explicitly or automatically named.
3405: Explicitly named buffers are named when created with the
3406: .Ic set-buffer
3407: or
3408: .Ic load-buffer
3409: commands, or by renaming an automatically named buffer with
3410: .Ic set-buffer
3411: .Fl n .
3412: Automatically named buffers are given a name such as
3413: .Ql buffer0001 ,
3414: .Ql buffer0002
3415: and so on.
3416: When the
3417: .Ic buffer-limit
3418: option is reached, the oldest automatically named buffer is deleted.
3419: Explicitly named are not subject to
1.57 jmc 3420: .Ic buffer-limit
1.392 nicm 3421: and may be deleted with
3422: .Ic delete-buffer
3423: command.
3424: .Pp
1.57 jmc 3425: Buffers may be added using
3426: .Ic copy-mode
3427: or the
3428: .Ic set-buffer
1.392 nicm 3429: and
3430: .Ic load-buffer
3431: commands, and pasted into a window using the
1.57 jmc 3432: .Ic paste-buffer
3433: command.
1.392 nicm 3434: If a buffer command is used and no buffer is specified, the most
3435: recently added automatically named buffer is assumed.
1.57 jmc 3436: .Pp
3437: A configurable history buffer is also maintained for each window.
3438: By default, up to 2000 lines are kept; this can be altered with the
3439: .Ic history-limit
3440: option (see the
3441: .Ic set-option
3442: command above).
3443: .Pp
3444: The buffer commands are as follows:
3445: .Bl -tag -width Ds
1.178 nicm 3446: .It Xo
3447: .Ic choose-buffer
1.294 nicm 3448: .Op Fl F Ar format
1.178 nicm 3449: .Op Fl t Ar target-window
3450: .Op Ar template
3451: .Xc
3452: Put a window into buffer choice mode, where a buffer may be chosen
3453: interactively from a list.
3454: After a buffer is selected,
3455: .Ql %%
1.392 nicm 3456: is replaced by the buffer name in
1.178 nicm 3457: .Ar template
3458: and the result executed as a command.
3459: If
3460: .Ar template
3461: is not given, "paste-buffer -b '%%'" is used.
1.294 nicm 3462: For the meaning of the
3463: .Fl F
3464: flag, see the
3465: .Sx FORMATS
3466: section.
1.314 nicm 3467: This command works only if at least one client is attached.
1.57 jmc 3468: .It Ic clear-history Op Fl t Ar target-pane
3469: .D1 (alias: Ic clearhist )
3470: Remove and free the history for the specified pane.
1.392 nicm 3471: .It Ic delete-buffer Op Fl b Ar buffer-name
1.57 jmc 3472: .D1 (alias: Ic deleteb )
1.392 nicm 3473: Delete the buffer named
3474: .Ar buffer-name ,
3475: or the most recently added automatically named buffer if not specified.
1.294 nicm 3476: .It Xo Ic list-buffers
3477: .Op Fl F Ar format
3478: .Xc
1.57 jmc 3479: .D1 (alias: Ic lsb )
1.198 nicm 3480: List the global buffers.
1.294 nicm 3481: For the meaning of the
3482: .Fl F
3483: flag, see the
3484: .Sx FORMATS
3485: section.
1.200 jmc 3486: .It Xo Ic load-buffer
1.392 nicm 3487: .Op Fl b Ar buffer-name
1.57 jmc 3488: .Ar path
3489: .Xc
3490: .D1 (alias: Ic loadb )
3491: Load the contents of the specified paste buffer from
3492: .Ar path .
3493: .It Xo Ic paste-buffer
1.278 nicm 3494: .Op Fl dpr
1.392 nicm 3495: .Op Fl b Ar buffer-name
1.170 nicm 3496: .Op Fl s Ar separator
1.158 nicm 3497: .Op Fl t Ar target-pane
1.57 jmc 3498: .Xc
3499: .D1 (alias: Ic pasteb )
1.158 nicm 3500: Insert the contents of a paste buffer into the specified pane.
3501: If not specified, paste into the current one.
1.57 jmc 3502: With
3503: .Fl d ,
1.392 nicm 3504: also delete the paste buffer.
1.57 jmc 3505: When output, any linefeed (LF) characters in the paste buffer are replaced with
1.170 nicm 3506: a separator, by default carriage return (CR).
3507: A custom separator may be specified using the
3508: .Fl s
3509: flag.
3510: The
1.57 jmc 3511: .Fl r
1.170 nicm 3512: flag means to do no replacement (equivalent to a separator of LF).
1.278 nicm 3513: If
3514: .Fl p
3515: is specified, paste bracket control codes are inserted around the
3516: buffer if the application has requested bracketed paste mode.
1.57 jmc 3517: .It Xo Ic save-buffer
3518: .Op Fl a
1.392 nicm 3519: .Op Fl b Ar buffer-name
1.57 jmc 3520: .Ar path
3521: .Xc
3522: .D1 (alias: Ic saveb )
3523: Save the contents of the specified paste buffer to
3524: .Ar path .
3525: The
3526: .Fl a
3527: option appends to rather than overwriting the file.
3528: .It Xo Ic set-buffer
1.383 nicm 3529: .Op Fl a
1.392 nicm 3530: .Op Fl b Ar buffer-name
3531: .Op Fl n Ar new-buffer-name
1.57 jmc 3532: .Ar data
3533: .Xc
3534: .D1 (alias: Ic setb )
3535: Set the contents of the specified buffer to
3536: .Ar data .
1.383 nicm 3537: The
3538: .Fl a
3539: option appends to rather than overwriting the buffer.
1.392 nicm 3540: The
3541: .Fl n
3542: option renames the buffer to
3543: .Ar new-buffer-name .
1.1 nicm 3544: .It Xo Ic show-buffer
1.392 nicm 3545: .Op Fl b Ar buffer-name
1.1 nicm 3546: .Xc
3547: .D1 (alias: Ic showb )
3548: Display the contents of the specified buffer.
1.57 jmc 3549: .El
3550: .Sh MISCELLANEOUS
3551: Miscellaneous commands are as follows:
3552: .Bl -tag -width Ds
1.72 nicm 3553: .It Ic clock-mode Op Fl t Ar target-pane
1.57 jmc 3554: Display a large clock.
1.334 nicm 3555: .It Xo Ic if-shell
1.352 nicm 3556: .Op Fl b
1.334 nicm 3557: .Op Fl t Ar target-pane
3558: .Ar shell-command command
3559: .Op Ar command
3560: .Xc
1.57 jmc 3561: .D1 (alias: Ic if )
1.251 nicm 3562: Execute the first
1.57 jmc 3563: .Ar command
3564: if
3565: .Ar shell-command
1.251 nicm 3566: returns success or the second
3567: .Ar command
3568: otherwise.
1.334 nicm 3569: Before being executed, shell-command is expanded using the rules specified in the
3570: .Sx FORMATS
3571: section, including those relevant to
3572: .Ar target-pane .
1.335 nicm 3573: With
3574: .Fl b ,
3575: .Ar shell-command
3576: is run in the background.
1.57 jmc 3577: .It Ic lock-server
3578: .D1 (alias: Ic lock )
1.90 nicm 3579: Lock each client individually by running the command specified by the
3580: .Ic lock-command
3581: option.
1.308 nicm 3582: .It Xo Ic run-shell
1.357 nicm 3583: .Op Fl b
1.308 nicm 3584: .Op Fl t Ar target-pane
3585: .Ar shell-command
3586: .Xc
1.87 nicm 3587: .D1 (alias: Ic run )
3588: Execute
1.153 nicm 3589: .Ar shell-command
1.106 nicm 3590: in the background without creating a window.
1.334 nicm 3591: Before being executed, shell-command is expanded using the rules specified in
3592: the
3593: .Sx FORMATS
3594: section.
1.335 nicm 3595: With
3596: .Fl b ,
3597: the command is run in the background.
1.308 nicm 3598: After it finishes, any output to stdout is displayed in copy mode (in the pane
3599: specified by
3600: .Fl t
3601: or the current pane if omitted).
1.153 nicm 3602: If the command doesn't return success, the exit status is also displayed.
1.342 nicm 3603: .It Xo Ic wait-for
1.370 nicm 3604: .Op Fl L | S | U
1.342 nicm 3605: .Ar channel
3606: .Xc
3607: .D1 (alias: Ic wait )
1.343 nicm 3608: When used without options, prevents the client from exiting until woken using
1.342 nicm 3609: .Ic wait-for
3610: .Fl S
3611: with the same channel.
1.343 nicm 3612: When
3613: .Fl L
3614: is used, the channel is locked and any clients that try to lock the same
3615: channel are made to wait until the channel is unlocked with
3616: .Ic wait-for
3617: .Fl U .
1.342 nicm 3618: This command only works from outside
3619: .Nm .
1.228 nicm 3620: .El
3621: .Sh TERMINFO EXTENSIONS
3622: .Nm
3623: understands some extensions to
3624: .Xr terminfo 5 :
3625: .Bl -tag -width Ds
1.360 nicm 3626: .It Em Cs , Cr
1.233 nicm 3627: Set the cursor colour.
1.232 jmc 3628: The first takes a single string argument and is used to set the colour;
3629: the second takes no arguments and restores the default cursor colour.
3630: If set, a sequence such as this may be used
3631: to change the cursor colour from inside
3632: .Nm :
3633: .Bd -literal -offset indent
3634: $ printf '\e033]12;red\e033\e\e'
3635: .Ed
1.361 jmc 3636: .It Em \&Ss , Se
1.230 nicm 3637: Change the cursor style.
1.232 jmc 3638: If set, a sequence such as this may be used
3639: to change the cursor to an underline:
1.230 nicm 3640: .Bd -literal -offset indent
3641: $ printf '\e033[4 q'
3642: .Ed
3643: .Pp
3644: If
3645: .Em Csr
3646: is set, it will be used to reset the cursor style instead
3647: of
3648: .Em Cs .
1.232 jmc 3649: .It Em \&Ms
3650: This sequence can be used by
3651: .Nm
3652: to store the current buffer in the host terminal's selection (clipboard).
3653: See the
3654: .Em set-clipboard
3655: option above and the
3656: .Xr xterm 1
3657: man page.
1.345 nicm 3658: .El
3659: .Sh CONTROL MODE
3660: .Nm
3661: offers a textual interface called
3662: .Em control mode .
3663: This allows applications to communicate with
3664: .Nm
3665: using a simple text-only protocol.
3666: .Pp
3667: In control mode, a client sends
3668: .Nm
3669: commands or command sequences terminated by newlines on standard input.
3670: Each command will produce one block of output on standard output.
3671: An output block consists of a
3672: .Em %begin
3673: line followed by the output (which may be empty).
3674: The output block ends with a
3675: .Em %end
3676: or
3677: .Em %error .
3678: .Em %begin
3679: and matching
3680: .Em %end
3681: or
3682: .Em %error
3683: have two arguments: an integer time (as seconds from epoch) and command number.
3684: For example:
3685: .Bd -literal -offset indent
3686: %begin 1363006971 2
3687: 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
3688: %end 1363006971 2
3689: .Ed
3690: .Pp
3691: In control mode,
3692: .Nm
3693: outputs notifications.
3694: A notification will never occur inside an output block.
3695: .Pp
3696: The following notifications are defined:
3697: .Bl -tag -width Ds
3698: .It Ic %exit Op Ar reason
3699: The
3700: .Nm
3701: client is exiting immediately, either because it is not attached to any session
3702: or an error occurred.
3703: If present,
3704: .Ar reason
3705: describes why the client exited.
3706: .It Ic %layout-change Ar window-id Ar window-layout
3707: The layout of a window with ID
3708: .Ar window-id
3709: changed.
3710: The new layout is
3711: .Ar window-layout .
1.347 nicm 3712: .It Ic %output Ar pane-id Ar value
3713: A window pane produced output.
1.345 nicm 3714: .Ar value
1.350 nicm 3715: escapes non-printable characters and backslash as octal \\xxx.
1.345 nicm 3716: .It Ic %session-changed Ar session-id Ar name
3717: The client is now attached to the session with ID
3718: .Ar session-id ,
3719: which is named
3720: .Ar name .
3721: .It Ic %session-renamed Ar name
3722: The current session was renamed to
3723: .Ar name .
3724: .It Ic %sessions-changed
3725: A session was created or destroyed.
3726: .It Ic %unlinked-window-add Ar window-id
3727: The window with ID
3728: .Ar window-id
3729: was created but is not linked to the current session.
3730: .It Ic %window-add Ar window-id
3731: The window with ID
3732: .Ar window-id
3733: was linked to the current session.
3734: .It Ic %window-close Ar window-id
3735: The window with ID
3736: .Ar window-id
3737: closed.
3738: .It Ic %window-renamed Ar window-id Ar name
3739: The window with ID
3740: .Ar window-id
3741: was renamed to
3742: .Ar name .
1.1 nicm 3743: .El
3744: .Sh FILES
1.26 nicm 3745: .Bl -tag -width "/etc/tmux.confXXX" -compact
1.1 nicm 3746: .It Pa ~/.tmux.conf
1.6 jmc 3747: Default
1.1 nicm 3748: .Nm
1.6 jmc 3749: configuration file.
1.26 nicm 3750: .It Pa /etc/tmux.conf
3751: System-wide configuration file.
1.1 nicm 3752: .El
1.57 jmc 3753: .Sh EXAMPLES
3754: To create a new
3755: .Nm
3756: session running
3757: .Xr vi 1 :
3758: .Pp
3759: .Dl $ tmux new-session vi
3760: .Pp
3761: Most commands have a shorter form, known as an alias.
3762: For new-session, this is
3763: .Ic new :
3764: .Pp
3765: .Dl $ tmux new vi
3766: .Pp
3767: Alternatively, the shortest unambiguous form of a command is accepted.
3768: If there are several options, they are listed:
3769: .Bd -literal -offset indent
3770: $ tmux n
3771: ambiguous command: n, could be: new-session, new-window, next-window
3772: .Ed
3773: .Pp
3774: Within an active session, a new window may be created by typing
3775: .Ql C-b c
3776: (Ctrl
3777: followed by the
3778: .Ql b
3779: key
3780: followed by the
3781: .Ql c
3782: key).
3783: .Pp
3784: Windows may be navigated with:
3785: .Ql C-b 0
3786: (to select window 0),
3787: .Ql C-b 1
3788: (to select window 1), and so on;
3789: .Ql C-b n
3790: to select the next window; and
3791: .Ql C-b p
3792: to select the previous window.
3793: .Pp
3794: A session may be detached using
3795: .Ql C-b d
1.64 nicm 3796: (or by an external event such as
3797: .Xr ssh 1
3798: disconnection) and reattached with:
1.57 jmc 3799: .Pp
3800: .Dl $ tmux attach-session
3801: .Pp
3802: Typing
3803: .Ql C-b \&?
3804: lists the current key bindings in the current window; up and down may be used
3805: to navigate the list or
3806: .Ql q
3807: to exit from it.
3808: .Pp
3809: Commands to be run when the
3810: .Nm
3811: server is started may be placed in the
3812: .Pa ~/.tmux.conf
3813: configuration file.
3814: Common examples include:
3815: .Pp
3816: Changing the default prefix key:
3817: .Bd -literal -offset indent
3818: set-option -g prefix C-a
3819: unbind-key C-b
3820: bind-key C-a send-prefix
3821: .Ed
3822: .Pp
3823: Turning the status line off, or changing its colour:
3824: .Bd -literal -offset indent
3825: set-option -g status off
1.378 nicm 3826: set-option -g status-style bg=blue
1.57 jmc 3827: .Ed
3828: .Pp
3829: Setting other options, such as the default command,
3830: or locking after 30 minutes of inactivity:
3831: .Bd -literal -offset indent
3832: set-option -g default-command "exec /bin/ksh"
3833: set-option -g lock-after-time 1800
3834: .Ed
3835: .Pp
3836: Creating new key bindings:
3837: .Bd -literal -offset indent
3838: bind-key b set-option status
3839: bind-key / command-prompt "split-window 'exec man %%'"
1.73 nicm 3840: bind-key S command-prompt "new-window -n %1 'ssh %1'"
1.57 jmc 3841: .Ed
1.1 nicm 3842: .Sh SEE ALSO
3843: .Xr pty 4
3844: .Sh AUTHORS
1.364 schwarze 3845: .An Nicholas Marriott Aq Mt nicm@users.sourceforge.net