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