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