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