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