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