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