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