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