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