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