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