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