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