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