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