Annotation of src/usr.bin/tmux/tmux.1, Revision 1.203
1.203 ! nicm 1: .\" $OpenBSD: tmux.1,v 1.202 2011/01/01 11:24:45 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.202 nicm 17: .Dd $Mdocdate: January 1 2011 $
1.1 nicm 18: .Dt TMUX 1
19: .Os
20: .Sh NAME
21: .Nm tmux
1.6 jmc 22: .Nd terminal multiplexer
1.1 nicm 23: .Sh SYNOPSIS
24: .Nm tmux
25: .Bk -words
1.114 nicm 26: .Op Fl 28lquv
1.91 nicm 27: .Op Fl c Ar shell-command
1.1 nicm 28: .Op Fl f Ar file
29: .Op Fl L Ar socket-name
30: .Op Fl S Ar socket-path
31: .Op Ar command Op Ar flags
32: .Ek
33: .Sh DESCRIPTION
34: .Nm
1.59 jmc 35: is a terminal multiplexer:
36: it enables a number of terminals to be created, accessed, and
37: controlled from a single screen.
1.67 jmc 38: .Nm
39: may be detached from a screen
40: and continue running in the background,
41: then later reattached.
1.1 nicm 42: .Pp
1.60 nicm 43: When
44: .Nm
45: is started it creates a new
46: .Em session
47: with a single
48: .Em window
49: and displays it on screen.
50: A status line at the bottom of the screen
51: shows information on the current session
52: and is used to enter interactive commands.
53: .Pp
54: A session is a single collection of
55: .Em pseudo terminals
56: under the management of
57: .Nm .
58: Each session has one or more
59: windows linked to it.
60: A window occupies the entire screen
61: and may be split into rectangular panes,
62: each of which is a separate pseudo terminal
63: (the
64: .Xr pty 4
65: manual page documents the technical details of pseudo terminals).
66: Any number of
67: .Nm
68: instances may connect to the same session,
69: and any number of windows may be present in the same session.
70: Once all sessions are killed,
71: .Nm
72: exits.
73: .Pp
1.64 nicm 74: Each session is persistent and will survive accidental disconnection
1.66 jmc 75: (such as
1.64 nicm 76: .Xr ssh 1
1.67 jmc 77: connection timeout) or intentional detaching (with the
1.64 nicm 78: .Ql C-b d
79: key strokes).
80: .Nm
81: may be reattached using:
82: .Pp
83: .Dl $ tmux attach
1.60 nicm 84: .Pp
1.64 nicm 85: In
86: .Nm ,
87: a session is displayed on screen by a
88: .Em client
89: and all sessions are managed by a single
90: .Em server .
91: The server and each client are separate processes which communicate through a
92: socket in
93: .Pa /tmp .
1.65 nicm 94: .Pp
1.1 nicm 95: The options are as follows:
96: .Bl -tag -width "XXXXXXXXXXXX"
97: .It Fl 2
98: Force
99: .Nm
100: to assume the terminal supports 256 colours.
101: .It Fl 8
102: Like
103: .Fl 2 ,
1.6 jmc 104: but indicates that the terminal supports 88 colours.
1.91 nicm 105: .It Fl c Ar shell-command
106: Execute
107: .Ar shell-command
108: using the default shell.
109: If necessary, the
110: .Nm
111: server will be started to retrieve the
112: .Ic default-shell
113: option.
1.153 nicm 114: This option is for compatibility with
115: .Xr sh 1
116: when
117: .Nm
118: is used as a login shell.
1.1 nicm 119: .It Fl f Ar file
120: Specify an alternative configuration file.
121: By default,
122: .Nm
1.26 nicm 123: loads the system configuration file from
124: .Pa /etc/tmux.conf ,
125: if present, then looks for a user configuration file at
1.1 nicm 126: .Pa ~/.tmux.conf .
127: The configuration file is a set of
128: .Nm
129: commands which are executed in sequence when the server is first started.
1.61 nicm 130: .Pp
131: If a command in the configuration file fails,
132: .Nm
133: will report an error and exit without executing further commands.
1.1 nicm 134: .It Fl L Ar socket-name
135: .Nm
136: stores the server socket in a directory under
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
1.202 nicm 660: .Op Fl t Ar target-client
1.57 jmc 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.197 jmc 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.201 nicm 1100: .Op Fl adkP
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.201 nicm 1148: .Pp
1149: The
1150: .Fl P
1151: option prints the location of the new window after it has been created.
1.56 jmc 1152: .It Ic next-layout Op Fl t Ar target-window
1.1 nicm 1153: .D1 (alias: Ic nextl )
1154: Move a window to the next layout and rearrange the panes to fit.
1155: .It Xo Ic next-window
1.9 nicm 1156: .Op Fl a
1.1 nicm 1157: .Op Fl t Ar target-session
1158: .Xc
1159: .D1 (alias: Ic next )
1160: Move to the next window in the session.
1.9 nicm 1161: If
1.12 jmc 1162: .Fl a
1.9 nicm 1163: is used, move to the next window with a bell, activity or content alert.
1.107 nicm 1164: .It Xo Ic pipe-pane
1165: .Op Fl o
1166: .Op Fl t Ar target-pane
1.153 nicm 1167: .Op Ar shell-command
1.107 nicm 1168: .Xc
1169: .D1 (alias: Ic pipep )
1170: Pipe any output sent by the program in
1171: .Ar target-pane
1172: to a shell command.
1173: A pane may only be piped to one command at a time, any existing pipe is
1174: closed before
1.153 nicm 1175: .Ar shell-command
1.107 nicm 1176: is executed.
1.174 nicm 1177: The
1178: .Ar shell-command
1179: string may contain the special character sequences supported by the
1180: .Ic status-left
1181: command.
1.107 nicm 1182: If no
1.153 nicm 1183: .Ar shell-command
1.107 nicm 1184: is given, the current pipe (if any) is closed.
1185: .Pp
1186: The
1187: .Fl o
1188: option only opens a new pipe if no previous pipe exists, allowing a pipe to
1189: be toggled with a single key, for example:
1190: .Bd -literal -offset indent
1.174 nicm 1191: bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
1.107 nicm 1192: .Ed
1.176 nicm 1193: .It Xo Ic previous-layout
1194: .Op Fl t Ar target-window
1195: .Xc
1196: .D1 (alias: Ic prevl )
1197: Move to the previous layout in the session.
1.1 nicm 1198: .It Xo Ic previous-window
1.9 nicm 1199: .Op Fl a
1.1 nicm 1200: .Op Fl t Ar target-session
1201: .Xc
1202: .D1 (alias: Ic prev )
1203: Move to the previous window in the session.
1.9 nicm 1204: With
1205: .Fl a ,
1206: move to the previous window with a bell, activity or content alert.
1.1 nicm 1207: .It Xo Ic rename-window
1208: .Op Fl t Ar target-window
1209: .Ar new-name
1210: .Xc
1211: .D1 (alias: Ic renamew )
1212: Rename the current window, or the window at
1213: .Ar target-window
1214: if specified, to
1215: .Ar new-name .
1216: .It Xo Ic resize-pane
1.39 jmc 1217: .Op Fl DLRU
1.52 nicm 1218: .Op Fl t Ar target-pane
1.1 nicm 1219: .Op Ar adjustment
1220: .Xc
1221: .D1 (alias: Ic resizep )
1.57 jmc 1222: Resize a pane, upward with
1223: .Fl U
1224: (the default), downward with
1225: .Fl D ,
1226: to the left with
1227: .Fl L
1228: and to the right with
1229: .Fl R .
1230: The
1231: .Ar adjustment
1232: is given in lines or cells (the default is 1).
1233: .It Xo Ic respawn-window
1234: .Op Fl k
1235: .Op Fl t Ar target-window
1.153 nicm 1236: .Op Ar shell-command
1.57 jmc 1237: .Xc
1238: .D1 (alias: Ic respawnw )
1.153 nicm 1239: Reactivate a window in which the command has exited (see the
1.57 jmc 1240: .Ic remain-on-exit
1241: window option).
1242: If
1.153 nicm 1243: .Ar shell-command
1.57 jmc 1244: is not given, the command used when the window was created is executed.
1245: The window must be already inactive, unless
1246: .Fl k
1247: is given, in which case any existing command is killed.
1248: .It Xo Ic rotate-window
1249: .Op Fl DU
1250: .Op Fl t Ar target-window
1251: .Xc
1252: .D1 (alias: Ic rotatew )
1253: Rotate the positions of the panes within a window, either upward (numerically
1254: lower) with
1255: .Fl U
1256: or downward (numerically higher).
1257: .It Xo Ic select-layout
1258: .Op Fl t Ar target-window
1259: .Op Ar layout-name
1260: .Xc
1.176 nicm 1261: .D1 (alias: Ic selectl )
1.57 jmc 1262: Choose a specific layout for a window.
1263: If
1264: .Ar layout-name
1.181 nicm 1265: is not given, the last preset layout used (if any) is reapplied.
1.156 nicm 1266: .It Xo Ic select-pane
1267: .Op Fl DLRU
1268: .Op Fl t Ar target-pane
1269: .Xc
1.57 jmc 1270: .D1 (alias: Ic selectp )
1271: Make pane
1272: .Ar target-pane
1273: the active pane in window
1274: .Ar target-window .
1.156 nicm 1275: If one of
1276: .Fl D ,
1277: .Fl L ,
1278: .Fl R ,
1279: or
1280: .Fl U
1281: is used, respectively the pane below, to the left, to the right, or above the
1282: target pane is used.
1.57 jmc 1283: .It Ic select-window Op Fl t Ar target-window
1284: .D1 (alias: Ic selectw )
1285: Select the window at
1286: .Ar target-window .
1287: .It Xo Ic split-window
1.201 nicm 1288: .Op Fl dhvP
1.57 jmc 1289: .Oo Fl l
1290: .Ar size |
1291: .Fl p Ar percentage Oc
1.136 nicm 1292: .Op Fl t Ar target-pane
1.153 nicm 1293: .Op Ar shell-command
1.57 jmc 1294: .Xc
1.176 nicm 1295: .D1 (alias: Ic splitw )
1.136 nicm 1296: Create a new pane by splitting
1297: .Ar target-pane :
1.57 jmc 1298: .Fl h
1299: does a horizontal split and
1300: .Fl v
1301: a vertical split; if neither is specified,
1302: .Fl v
1303: is assumed.
1304: The
1305: .Fl l
1306: and
1307: .Fl p
1.136 nicm 1308: options specify the size of the new pane in lines (for vertical split) or in
1.57 jmc 1309: cells (for horizontal split), or as a percentage, respectively.
1.136 nicm 1310: All other options have the same meaning as for the
1.57 jmc 1311: .Ic new-window
1312: command.
1313: .It Xo Ic swap-pane
1314: .Op Fl dDU
1315: .Op Fl s Ar src-pane
1316: .Op Fl t Ar dst-pane
1317: .Xc
1318: .D1 (alias: Ic swapp )
1319: Swap two panes.
1320: If
1321: .Fl U
1322: is used and no source pane is specified with
1323: .Fl s ,
1324: .Ar dst-pane
1325: is swapped with the previous pane (before it numerically);
1326: .Fl D
1327: swaps with the next pane (after it numerically).
1.138 nicm 1328: .Fl d
1329: instructs
1330: .Nm
1331: not to change the active pane.
1.57 jmc 1332: .It Xo Ic swap-window
1333: .Op Fl d
1334: .Op Fl s Ar src-window
1335: .Op Fl t Ar dst-window
1336: .Xc
1337: .D1 (alias: Ic swapw )
1338: This is similar to
1339: .Ic link-window ,
1340: except the source and destination windows are swapped.
1341: It is an error if no window exists at
1342: .Ar src-window .
1343: .It Xo Ic unlink-window
1.1 nicm 1344: .Op Fl k
1345: .Op Fl t Ar target-window
1346: .Xc
1.57 jmc 1347: .D1 (alias: Ic unlinkw )
1348: Unlink
1349: .Ar target-window .
1350: Unless
1351: .Fl k
1352: is given, a window may be unlinked only if it is linked to multiple sessions -
1353: windows may not be linked to no sessions;
1354: if
1.1 nicm 1355: .Fl k
1.57 jmc 1356: is specified and the window is linked to only one session, it is unlinked and
1357: destroyed.
1358: .El
1359: .Sh KEY BINDINGS
1.93 nicm 1360: .Nm
1361: allows a command to be bound to most keys, with or without a prefix key.
1362: When specifying keys, most represent themselves (for example
1363: .Ql A
1364: to
1.95 jmc 1365: .Ql Z ) .
1.93 nicm 1366: Ctrl keys may be prefixed with
1367: .Ql C-
1368: or
1.95 jmc 1369: .Ql ^ ,
1370: and Alt (meta) with
1.93 nicm 1371: .Ql M- .
1372: In addition, the following special key names are accepted:
1.126 nicm 1373: .Em Up ,
1374: .Em Down ,
1375: .Em Left ,
1376: .Em Right ,
1.93 nicm 1377: .Em BSpace ,
1378: .Em BTab ,
1379: .Em DC
1380: (Delete),
1381: .Em End ,
1382: .Em Enter ,
1383: .Em Escape ,
1384: .Em F1
1385: to
1386: .Em F20 ,
1387: .Em Home ,
1388: .Em IC
1389: (Insert),
1390: .Em NPage
1391: (Page Up),
1392: .Em PPage
1393: (Page Down),
1394: .Em Space ,
1395: and
1396: .Em Tab .
1397: Note that to bind the
1398: .Ql \&"
1399: or
1400: .Ql '
1401: keys, quotation marks are necessary, for example:
1402: .Bd -literal -offset indent
1403: bind-key '"' split-window
1.167 nicm 1404: bind-key "'" new-window
1.93 nicm 1405: .Ed
1406: .Pp
1.57 jmc 1407: Commands related to key bindings are as follows:
1408: .Bl -tag -width Ds
1409: .It Xo Ic bind-key
1410: .Op Fl cnr
1411: .Op Fl t Ar key-table
1412: .Ar key Ar command Op Ar arguments
1.1 nicm 1413: .Xc
1.57 jmc 1414: .D1 (alias: Ic bind )
1415: Bind key
1416: .Ar key
1417: to
1418: .Ar command .
1419: By default (without
1420: .Fl t )
1421: the primary key bindings are modified (those normally activated with the prefix
1422: key); in this case, if
1423: .Fl n
1424: is specified, it is not necessary to use the prefix key,
1425: .Ar command
1426: is bound to
1427: .Ar key
1428: alone.
1.1 nicm 1429: The
1.57 jmc 1430: .Fl r
1431: flag indicates this key may repeat, see the
1432: .Ic repeat-time
1433: option.
1434: .Pp
1435: If
1436: .Fl t
1437: is present,
1438: .Ar key
1439: is bound in
1440: .Ar key-table :
1441: the binding for command mode with
1442: .Fl c
1443: or for normal mode without.
1444: To view the default bindings and possible commands, see the
1445: .Ic list-keys
1446: command.
1447: .It Ic list-keys Op Fl t Ar key-table
1448: .D1 (alias: Ic lsk )
1449: List all key bindings.
1450: Without
1451: .Fl t
1452: the primary key bindings - those executed when preceded by the prefix key -
1453: are printed.
1454: Keys bound without the prefix key (see
1455: .Ic bind-key
1456: .Fl n )
1.119 nicm 1457: are marked with
1458: .Ql (no prefix) .
1.57 jmc 1459: .Pp
1460: With
1461: .Fl t ,
1462: the key bindings in
1463: .Ar key-table
1464: are listed; this may be one of:
1465: .Em vi-edit ,
1466: .Em emacs-edit ,
1467: .Em vi-choice ,
1468: .Em emacs-choice ,
1469: .Em vi-copy
1470: or
1471: .Em emacs-copy .
1472: .It Xo Ic send-keys
1.72 nicm 1473: .Op Fl t Ar target-pane
1.57 jmc 1474: .Ar key Ar ...
1.1 nicm 1475: .Xc
1.57 jmc 1476: .D1 (alias: Ic send )
1477: Send a key or keys to a window.
1478: Each argument
1479: .Ar key
1480: is the name of the key (such as
1481: .Ql C-a
1482: or
1483: .Ql npage
1484: ) to send; if the string is not recognised as a key, it is sent as a series of
1485: characters.
1486: All arguments are sent sequentially from first to last.
1.72 nicm 1487: .It Ic send-prefix Op Fl t Ar target-pane
1.57 jmc 1488: Send the prefix key to a window as if it was pressed.
1.89 nicm 1489: If multiple prefix keys are configured, only the first is sent.
1.57 jmc 1490: .It Xo Ic unbind-key
1.189 nicm 1491: .Op Fl acn
1.57 jmc 1492: .Op Fl t Ar key-table
1493: .Ar key
1.2 nicm 1494: .Xc
1.57 jmc 1495: .D1 (alias: Ic unbind )
1496: Unbind the command bound to
1497: .Ar key .
1498: Without
1499: .Fl t
1500: the primary key bindings are modified; in this case, if
1501: .Fl n
1502: is specified, the command bound to
1503: .Ar key
1504: without a prefix (if any) is removed.
1.189 nicm 1505: If
1506: .Fl a
1507: is present, all key bindings are removed.
1.57 jmc 1508: .Pp
1.47 nicm 1509: If
1.57 jmc 1510: .Fl t
1511: is present,
1512: .Ar key
1513: in
1514: .Ar key-table
1515: is unbound: the binding for command mode with
1516: .Fl c
1517: or for normal mode without.
1518: .El
1519: .Sh OPTIONS
1520: The appearance and behaviour of
1521: .Nm
1522: may be modified by changing the value of various options.
1.133 nicm 1523: There are three types of option:
1524: .Em server options ,
1.57 jmc 1525: .Em session options
1526: and
1527: .Em window options .
1528: .Pp
1.133 nicm 1529: The
1530: .Nm
1531: server has a set of global options which do not apply to any particular
1532: window or session.
1533: These are altered with the
1534: .Ic set-option
1535: .Fl s
1536: command, or displayed with the
1537: .Ic show-options
1538: .Fl s
1539: command.
1540: .Pp
1541: In addition, each individual session may have a set of session options, and
1542: there is a separate set of global session options.
1.57 jmc 1543: Sessions which do not have a particular option configured inherit the value
1544: from the global session options.
1545: Session options are set or unset with the
1546: .Ic set-option
1547: command and may be listed with the
1548: .Ic show-options
1549: command.
1.133 nicm 1550: The available server and session options are listed under the
1.57 jmc 1551: .Ic set-option
1552: command.
1553: .Pp
1554: Similarly, a set of window options is attached to each window, and there is
1555: a set of global window options from which any unset options are inherited.
1556: Window options are altered with the
1557: .Ic set-window-option
1558: command and can be listed with the
1559: .Ic show-window-options
1560: command.
1561: All window options are documented with the
1562: .Ic set-window-option
1563: command.
1564: .Pp
1565: Commands which set options are as follows:
1566: .Bl -tag -width Ds
1.1 nicm 1567: .It Xo Ic set-option
1.133 nicm 1568: .Op Fl agsuw
1.129 nicm 1569: .Op Fl t Ar target-session | Ar target-window
1.1 nicm 1570: .Ar option Ar value
1571: .Xc
1572: .D1 (alias: Ic set )
1.133 nicm 1573: Set a window option with
1574: .Fl w
1575: (equivalent to the
1576: .Ic set-window-option
1577: command),
1578: a server option with
1579: .Fl s ,
1580: otherwise a session option.
1581: .Pp
1582: If
1583: .Fl g
1584: is specified, the global session or window option is set.
1.58 nicm 1585: With
1586: .Fl a ,
1587: and if the option expects a string,
1588: .Ar value
1589: is appended to the existing setting.
1.1 nicm 1590: The
1591: .Fl u
1592: flag unsets an option, so a session inherits the option from the global
1.133 nicm 1593: options.
1594: It is not possible to unset a global option.
1.1 nicm 1595: .Pp
1.133 nicm 1596: Available window options are listed under
1597: .Ic set-window-option .
1598: .Pp
1599: Available server options are:
1600: .Bl -tag -width Ds
1.198 nicm 1601: .It Ic buffer-limit Ar number
1602: Set the number of buffers; as new buffers are added to the top of the stack,
1603: old ones are removed from the bottom if necessary to maintain this maximum
1604: length.
1.134 nicm 1605: .It Ic escape-time
1606: Set the time in milliseconds for which
1607: .Nm
1608: waits after an escape is input to determine if it is part of a function or meta
1609: key sequences.
1610: The default is 500 milliseconds.
1.185 nicm 1611: .It Ic exit-unattached
1612: If enabled, the server will exit when there are no attached clients, rather
1613: than when there are no attached sessions.
1.133 nicm 1614: .It Ic quiet
1.134 nicm 1615: Enable or disable the display of various informational messages (see also the
1.133 nicm 1616: .Fl q
1617: command line flag).
1618: .El
1.129 nicm 1619: .Pp
1.18 nicm 1620: Available session options are:
1.1 nicm 1621: .Bl -tag -width Ds
1.69 nicm 1622: .It Ic base-index Ar index
1623: Set the base index from which an unused index should be searched when a new
1624: window is created.
1625: The default is zero.
1.1 nicm 1626: .It Xo Ic bell-action
1.56 jmc 1627: .Op Ic any | none | current
1.1 nicm 1628: .Xc
1629: Set action on window bell.
1630: .Ic any
1631: means a bell in any window linked to a session causes a bell in the current
1632: window of that session,
1633: .Ic none
1634: means all bells are ignored and
1635: .Ic current
1636: means only bell in windows other than the current window are ignored.
1.153 nicm 1637: .It Ic default-command Ar shell-command
1.1 nicm 1638: Set the command used for new windows (if not specified when the window is
1639: created) to
1.153 nicm 1640: .Ar shell-command ,
1.79 nicm 1641: which may be any
1642: .Xr sh 1
1643: command.
1.19 nicm 1644: The default is an empty string, which instructs
1645: .Nm
1.79 nicm 1646: to create a login shell using the value of the
1647: .Ic default-shell
1648: option.
1.196 nicm 1649: .It Ic default-path Ar path
1650: Set the default working directory for processes created from keys, or
1651: interactively from the prompt.
1652: The default is empty, which means to use the working directory of the shell
1653: from which the server was started if it is available or the user's home if not.
1.79 nicm 1654: .It Ic default-shell Ar path
1655: Specify the default shell.
1656: This is used as the login shell for new windows when the
1657: .Ic default-command
1658: option is set to empty, and must be the full path of the executable.
1659: When started
1660: .Nm
1661: tries to set a default value from the first suitable of the
1.19 nicm 1662: .Ev SHELL
1.79 nicm 1663: environment variable, the shell returned by
1664: .Xr getpwuid 3 ,
1665: or
1666: .Pa /bin/sh .
1667: This option should be configured when
1668: .Nm
1669: is used as a login shell.
1.22 nicm 1670: .It Ic default-terminal Ar terminal
1671: Set the default terminal for new windows created in this session - the
1672: default value of the
1673: .Ev TERM
1674: environment variable.
1675: For
1676: .Nm
1677: to work correctly, this
1678: .Em must
1679: be set to
1680: .Ql screen
1681: or a derivative of it.
1.185 nicm 1682: .It Ic destroy-unattached
1683: If enabled and the session is no longer attached to any clients, it is
1684: destroyed.
1.184 nicm 1685: .It Ic detach-on-destroy
1686: If on (the default), the client is detached when the session it is attached to
1687: is destroyed.
1688: If off, the client is switched to the most recently active of the remaining
1689: sessions.
1.145 nicm 1690: .It Ic display-panes-active-colour Ar colour
1691: Set the colour used by the
1692: .Ic display-panes
1693: command to show the indicator for the active pane.
1.78 nicm 1694: .It Ic display-panes-colour Ar colour
1.145 nicm 1695: Set the colour used by the
1.78 nicm 1696: .Ic display-panes
1.145 nicm 1697: command to show the indicators for inactive panes.
1.78 nicm 1698: .It Ic display-panes-time Ar time
1699: Set the time in milliseconds for which the indicators shown by the
1700: .Ic display-panes
1701: command appear.
1.21 nicm 1702: .It Ic display-time Ar time
1.78 nicm 1703: Set the amount of time for which status line messages and other on-screen
1704: indicators are displayed.
1.21 nicm 1705: .Ar time
1706: is in milliseconds.
1.1 nicm 1707: .It Ic history-limit Ar lines
1708: Set the maximum number of lines held in window history.
1709: This setting applies only to new windows - existing window histories are not
1710: resized and retain the limit at the point they were created.
1711: .It Ic lock-after-time Ar number
1.100 nicm 1712: Lock the session (like the
1713: .Ic lock-session
1.90 nicm 1714: command) after
1.1 nicm 1715: .Ar number
1.100 nicm 1716: seconds of inactivity, or the entire server (all sessions) if the
1717: .Ic lock-server
1718: option is set.
1719: The default is not to lock (set to 0).
1.153 nicm 1720: .It Ic lock-command Ar shell-command
1.90 nicm 1721: Command to run when locking each client.
1722: The default is to run
1723: .Xr lock 1
1724: with
1725: .Fl np .
1.100 nicm 1726: .It Xo Ic lock-server
1727: .Op Ic on | off
1728: .Xc
1729: If this option is
1.102 nicm 1730: .Ic on
1.100 nicm 1731: (the default),
1732: instead of each session locking individually as each has been
1733: idle for
1.108 jmc 1734: .Ic lock-after-time ,
1735: the entire server will lock after
1.100 nicm 1736: .Em all
1737: sessions would have locked.
1738: This has no effect as a session option; it must be set as a global option.
1.1 nicm 1739: .It Ic message-attr Ar attributes
1740: Set status line message attributes, where
1741: .Ar attributes
1742: is either
1.168 nicm 1743: .Ic none
1.1 nicm 1744: or a comma-delimited list of one or more of:
1745: .Ic bright
1746: (or
1747: .Ic bold ) ,
1748: .Ic dim ,
1749: .Ic underscore ,
1750: .Ic blink ,
1751: .Ic reverse ,
1752: .Ic hidden ,
1753: or
1754: .Ic italics .
1755: .It Ic message-bg Ar colour
1756: Set status line message background colour, where
1757: .Ar colour
1758: is one of:
1759: .Ic black ,
1760: .Ic red ,
1761: .Ic green ,
1762: .Ic yellow ,
1763: .Ic blue ,
1764: .Ic magenta ,
1765: .Ic cyan ,
1.85 nicm 1766: .Ic white ,
1767: .Ic colour0
1768: to
1769: .Ic colour255
1770: from the 256-colour palette, or
1.1 nicm 1771: .Ic default .
1772: .It Ic message-fg Ar colour
1773: Set status line message foreground colour.
1.120 nicm 1774: .It Ic message-limit Ar number
1775: Set the number of error or information messages to save in the message log for
1776: each client.
1777: The default is 20.
1.102 nicm 1778: .It Xo Ic mouse-select-pane
1779: .Op Ic on | off
1780: .Xc
1781: If on,
1782: .Nm
1783: captures the mouse and when a window is split into multiple panes the mouse may
1784: be used to select the current pane.
1785: The mouse click is also passed through to the application as normal.
1.196 nicm 1786: .It Ic pane-active-border-bg Ar colour
1787: .It Ic pane-active-border-fg Ar colour
1788: Set the pane border colour for the currently active pane.
1789: .It Ic pane-border-bg Ar colour
1.135 nicm 1790: .It Ic pane-border-fg Ar colour
1791: Set the pane border colour for panes aside from the active pane.
1.89 nicm 1792: .It Ic prefix Ar keys
1793: Set the keys accepted as a prefix key.
1794: .Ar keys
1795: is a comma-separated list of key names, each of which individually behave as
1796: the prefix key.
1.21 nicm 1797: .It Ic repeat-time Ar time
1.1 nicm 1798: Allow multiple commands to be entered without pressing the prefix-key again
1799: in the specified
1.21 nicm 1800: .Ar time
1.1 nicm 1801: milliseconds (the default is 500).
1802: Whether a key repeats may be set when it is bound using the
1803: .Fl r
1804: flag to
1805: .Ic bind-key .
1.52 nicm 1806: Repeat is enabled for the default keys bound to the
1807: .Ic resize-pane
1808: command.
1.203 ! nicm 1809: .It Xo Ic mouse-utf8
! 1810: .Op Ic on | off
! 1811: .Xc
! 1812: If enabled, request mouse input as UTF-8 on UTF-8 terminals.
1.1 nicm 1813: .It Xo Ic set-remain-on-exit
1.56 jmc 1814: .Op Ic on | off
1.1 nicm 1815: .Xc
1816: Set the
1817: .Ic remain-on-exit
1818: window option for any windows first created in this session.
1.153 nicm 1819: When this option is true, windows in which the running program has
1820: exited do not close, instead remaining open but inactivate.
1821: Use the
1822: .Ic respawn-window
1823: command to reactivate such a window, or the
1824: .Ic kill-window
1825: command to destroy it.
1.1 nicm 1826: .It Xo Ic set-titles
1.56 jmc 1827: .Op Ic on | off
1.1 nicm 1828: .Xc
1.77 stsp 1829: Attempt to set the window title using the \ee]2;...\e007 xterm code if
1.1 nicm 1830: the terminal appears to be an xterm.
1.11 nicm 1831: This option is off by default.
1.6 jmc 1832: Note that elinks
1.1 nicm 1833: will only attempt to set the window title if the STY environment
1834: variable is set.
1.86 nicm 1835: .It Ic set-titles-string Ar string
1836: String used to set the window title if
1837: .Ic set-titles
1838: is on.
1839: Character sequences are replaced as for the
1840: .Ic status-left
1841: option.
1.1 nicm 1842: .It Xo Ic status
1.56 jmc 1843: .Op Ic on | off
1.1 nicm 1844: .Xc
1845: Show or hide the status line.
1846: .It Ic status-attr Ar attributes
1847: Set status line attributes.
1848: .It Ic status-bg Ar colour
1849: Set status line background colour.
1850: .It Ic status-fg Ar colour
1851: Set status line foreground colour.
1852: .It Ic status-interval Ar interval
1853: Update the status bar every
1854: .Ar interval
1855: seconds.
1856: By default, updates will occur every 15 seconds.
1857: A setting of zero disables redrawing at interval.
1.41 nicm 1858: .It Xo Ic status-justify
1.56 jmc 1859: .Op Ic left | centre | right
1.41 nicm 1860: .Xc
1861: Set the position of the window list component of the status line: left, centre
1862: or right justified.
1.1 nicm 1863: .It Xo Ic status-keys
1.56 jmc 1864: .Op Ic vi | emacs
1.1 nicm 1865: .Xc
1.6 jmc 1866: Use vi or emacs-style
1.1 nicm 1867: key bindings in the status line, for example at the command prompt.
1.191 nicm 1868: The default is emacs, unless the
1869: .Ev VISUAL
1870: or
1871: .Ev EDITOR
1872: environment variables are set and contain the string
1873: .Ql vi .
1.1 nicm 1874: .It Ic status-left Ar string
1875: Display
1876: .Ar string
1877: to the left of the status bar.
1878: .Ar string
1879: will be passed through
1880: .Xr strftime 3
1881: before being used.
1882: By default, the session name is shown.
1883: .Ar string
1.83 nicm 1884: may contain any of the following special character sequences:
1.1 nicm 1885: .Bl -column "Character pair" "Replaced with" -offset indent
1886: .It Sy "Character pair" Ta Sy "Replaced with"
1.153 nicm 1887: .It Li "#(shell-command)" Ta "First line of the command's output"
1.83 nicm 1888: .It Li "#[attributes]" Ta "Colour or attribute change"
1.1 nicm 1889: .It Li "#H" Ta "Hostname of local host"
1.125 nicm 1890: .It Li "#F" Ta "Current window flag"
1.35 nicm 1891: .It Li "#I" Ta "Current window index"
1892: .It Li "#P" Ta "Current pane index"
1.1 nicm 1893: .It Li "#S" Ta "Session name"
1894: .It Li "#T" Ta "Current window title"
1.35 nicm 1895: .It Li "#W" Ta "Current window name"
1.1 nicm 1896: .It Li "##" Ta "A literal" Ql #
1897: .El
1.83 nicm 1898: .Pp
1.153 nicm 1899: The #(shell-command) form executes
1900: .Ql shell-command
1901: and inserts the first line of its output.
1.103 nicm 1902: Note that shell commands are only executed once at the interval specified by
1903: the
1904: .Ic status-interval
1905: option: if the status line is redrawn in the meantime, the previous result is
1906: used.
1.161 nicm 1907: Shell commands are executed with the
1908: .Nm
1909: global environment set (see the
1.162 jmc 1910: .Sx ENVIRONMENT
1911: section).
1.163 nicm 1912: .Pp
1913: The window title (#T) is the title set by the program running within the window
1914: using the OSC title setting sequence, for example:
1915: .Bd -literal -offset indent
1916: $ printf '\e033]2;My Title\e033\e\e'
1917: .Ed
1918: .Pp
1919: When a window is first created, its title is the hostname.
1.109 nicm 1920: .Pp
1.83 nicm 1921: #[attributes] allows a comma-separated list of attributes to be specified,
1922: these may be
1923: .Ql fg=colour
1924: to set the foreground colour,
1925: .Ql bg=colour
1.131 nicm 1926: to set the background colour, the name of one of the attributes (listed under
1927: the
1.83 nicm 1928: .Ic message-attr
1.109 nicm 1929: option) to turn an attribute on, or an attribute prefixed with
1930: .Ql no
1931: to turn one off, for example
1932: .Ic nobright .
1.83 nicm 1933: Examples are:
1934: .Bd -literal -offset indent
1935: #(sysctl vm.loadavg)
1936: #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
1937: .Ed
1.1 nicm 1938: .Pp
1.109 nicm 1939: Where appropriate, special character sequences may be prefixed with a number to
1940: specify the maximum length, for example
1.1 nicm 1941: .Ql #24T .
1.10 nicm 1942: .Pp
1.12 jmc 1943: By default, UTF-8 in
1.10 nicm 1944: .Ar string
1945: is not interpreted, to enable UTF-8, use the
1946: .Ic status-utf8
1947: option.
1.62 nicm 1948: .It Ic status-left-attr Ar attributes
1.66 jmc 1949: Set the attribute of the left part of the status line.
1.196 nicm 1950: .It Ic status-left-bg Ar colour
1951: Set the background colour of the left part of the status line.
1.62 nicm 1952: .It Ic status-left-fg Ar colour
1953: Set the foreground colour of the left part of the status line.
1.1 nicm 1954: .It Ic status-left-length Ar length
1955: Set the maximum
1956: .Ar length
1957: of the left component of the status bar.
1958: The default is 10.
1959: .It Ic status-right Ar string
1960: Display
1961: .Ar string
1962: to the right of the status bar.
1.151 nicm 1963: By default, the current window title in double quotes, the date and the time
1964: are shown.
1.1 nicm 1965: As with
1966: .Ic status-left ,
1967: .Ar string
1968: will be passed to
1.10 nicm 1969: .Xr strftime 3 ,
1970: character pairs are replaced, and UTF-8 is dependent on the
1971: .Ic status-utf8
1972: option.
1.62 nicm 1973: .It Ic status-right-attr Ar attributes
1.66 jmc 1974: Set the attribute of the right part of the status line.
1.196 nicm 1975: .It Ic status-right-bg Ar colour
1976: Set the background colour of the right part of the status line.
1.62 nicm 1977: .It Ic status-right-fg Ar colour
1978: Set the foreground colour of the right part of the status line.
1.1 nicm 1979: .It Ic status-right-length Ar length
1980: Set the maximum
1981: .Ar length
1982: of the right component of the status bar.
1983: The default is 40.
1.10 nicm 1984: .It Xo Ic status-utf8
1.56 jmc 1985: .Op Ic on | off
1.10 nicm 1986: .Xc
1987: Instruct
1988: .Nm
1989: to treat top-bit-set characters in the
1990: .Ic status-left
1991: and
1992: .Ic status-right
1993: strings as UTF-8; notably, this is important for wide characters.
1994: This option defaults to off.
1.55 jmc 1995: .It Ic terminal-overrides Ar string
1.54 nicm 1996: Contains a list of entries which override terminal descriptions read using
1997: .Xr terminfo 5 .
1998: .Ar string
1999: is a comma-separated list of items each a colon-separated string made up of a
2000: terminal type pattern (matched using
2001: .Xr fnmatch 3 )
2002: and a set of
2003: .Em name=value
2004: entries.
2005: .Pp
2006: For example, to set the
2007: .Ql clear
2008: .Xr terminfo 5
2009: entry to
2010: .Ql \ee[H\ee[2J
2011: for all terminal types and the
2012: .Ql dch1
2013: entry to
2014: .Ql \ee[P
1.55 jmc 2015: for the
1.54 nicm 2016: .Ql rxvt
2017: terminal type, the option could be set to the string:
2018: .Bd -literal -offset indent
2019: "*:clear=\ee[H\ee[2J,rxvt:dch1=\ee[P"
2020: .Ed
2021: .Pp
2022: The terminal entry value is passed through
2023: .Xr strunvis 3
2024: before interpretation.
2025: The default value forcibly corrects the
2026: .Ql colors
2027: entry for terminals which support 88 or 256 colours:
2028: .Bd -literal -offset indent
2029: "*88col*:colors=88,*256col*:colors=256"
2030: .Ed
1.63 nicm 2031: .It Ic update-environment Ar variables
2032: Set a space-separated string containing a list of environment variables to be
2033: copied into the session environment when a new session is created or an
2034: existing session is attached.
2035: Any variables that do not exist in the source environment are set to be
2036: removed from the session environment (as if
2037: .Fl r
2038: was given to the
2039: .Ic set-environment
2040: command).
2041: The default is
1.190 nicm 2042: "DISPLAY SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION WINDOWID
2043: XAUTHORITY".
1.37 nicm 2044: .It Xo Ic visual-activity
1.56 jmc 2045: .Op Ic on | off
1.37 nicm 2046: .Xc
2047: If on, display a status line message when activity occurs in a window
1.39 jmc 2048: for which the
1.37 nicm 2049: .Ic monitor-activity
2050: window option is enabled.
2051: .It Xo Ic visual-bell
1.56 jmc 2052: .Op Ic on | off
1.37 nicm 2053: .Xc
2054: If this option is on, a message is shown on a bell instead of it being passed
2055: through to the terminal (which normally makes a sound).
2056: Also see the
2057: .Ic bell-action
2058: option.
2059: .It Xo Ic visual-content
1.56 jmc 2060: .Op Ic on | off
1.37 nicm 2061: .Xc
2062: Like
2063: .Ic visual-activity ,
2064: display a message when content is present in a window
1.39 jmc 2065: for which the
1.37 nicm 2066: .Ic monitor-content
2067: window option is enabled.
1.192 nicm 2068: .It Xo Ic visual-silence
2069: .Op Ic on | off
2070: .Xc
2071: If
2072: .Ic monitor-silence
2073: is enabled, prints a message after the interval has expired on a given window.
1.1 nicm 2074: .El
2075: .It Xo Ic set-window-option
1.58 nicm 2076: .Op Fl agu
1.1 nicm 2077: .Op Fl t Ar target-window
2078: .Ar option Ar value
2079: .Xc
2080: .D1 (alias: Ic setw )
1.18 nicm 2081: Set a window option.
1.1 nicm 2082: The
1.58 nicm 2083: .Fl a ,
1.1 nicm 2084: .Fl g
2085: and
2086: .Fl u
2087: flags work similarly to the
2088: .Ic set-option
2089: command.
2090: .Pp
1.18 nicm 2091: Supported window options are:
1.56 jmc 2092: .Pp
2093: .Bl -tag -width Ds -compact
1.1 nicm 2094: .It Xo Ic aggressive-resize
1.56 jmc 2095: .Op Ic on | off
1.1 nicm 2096: .Xc
2097: Aggressively resize the chosen window.
2098: This means that
2099: .Nm
2100: will resize the window to the size of the smallest session for which it is the
2101: current window, rather than the smallest session to which it is attached.
2102: The window may resize when the current window is changed on another sessions;
1.6 jmc 2103: this option is good for full-screen programs which support
2104: .Dv SIGWINCH
2105: and poor for interactive programs such as shells.
1.56 jmc 2106: .Pp
1.196 nicm 2107: .It Xo Ic alternate-screen
2108: .Op Ic on | off
2109: .Xc
2110: This option configures whether programs running inside
2111: .Nm
2112: may use the terminal alternate screen feature, which allows the
2113: .Em smcup
2114: and
2115: .Em rmcup
2116: .Xr terminfo 5
2117: capabilities to be issued to preserve the existing window content on start and
2118: restore it on exit.
2119: .Pp
1.1 nicm 2120: .It Xo Ic automatic-rename
1.56 jmc 2121: .Op Ic on | off
1.1 nicm 2122: .Xc
2123: Control automatic window renaming.
2124: When this setting is enabled,
2125: .Nm
2126: will attempt - on supported platforms - to rename the window to reflect the
2127: command currently running in it.
2128: This flag is automatically disabled for an individual window when a name
2129: is specified at creation with
1.186 nicm 2130: .Ic new-window
2131: or
1.1 nicm 2132: .Ic new-session ,
2133: or later with
2134: .Ic rename-window .
2135: It may be switched off globally with:
2136: .Bd -literal -offset indent
2137: set-window-option -g automatic-rename off
2138: .Ed
1.56 jmc 2139: .Pp
1.1 nicm 2140: .It Ic clock-mode-colour Ar colour
2141: Set clock colour.
1.56 jmc 2142: .Pp
1.1 nicm 2143: .It Xo Ic clock-mode-style
1.56 jmc 2144: .Op Ic 12 | 24
1.1 nicm 2145: .Xc
2146: Set clock hour format.
1.56 jmc 2147: .Pp
1.1 nicm 2148: .It Ic force-height Ar height
2149: .It Ic force-width Ar width
2150: Prevent
2151: .Nm
2152: from resizing a window to greater than
2153: .Ar width
2154: or
2155: .Ar height .
2156: A value of zero restores the default unlimited setting.
1.56 jmc 2157: .Pp
1.196 nicm 2158: .It Ic main-pane-height Ar height
1.2 nicm 2159: .It Ic main-pane-width Ar width
2160: Set the width or height of the main (left or top) pane in the
2161: .Ic main-horizontal
2162: or
2163: .Ic main-vertical
2164: layouts.
1.56 jmc 2165: .Pp
1.1 nicm 2166: .It Ic mode-attr Ar attributes
2167: Set window modes attributes.
1.56 jmc 2168: .Pp
1.1 nicm 2169: .It Ic mode-bg Ar colour
2170: Set window modes background colour.
1.56 jmc 2171: .Pp
1.1 nicm 2172: .It Ic mode-fg Ar colour
2173: Set window modes foreground colour.
1.56 jmc 2174: .Pp
1.1 nicm 2175: .It Xo Ic mode-keys
1.56 jmc 2176: .Op Ic vi | emacs
1.1 nicm 2177: .Xc
1.105 nicm 2178: Use vi or emacs-style key bindings in copy and choice modes.
1.191 nicm 2179: As with the
2180: .Ic status-keys
2181: option, the default is emacs, unless
2182: .Ev VISUAL
2183: or
2184: .Ev EDITOR
2185: contains
2186: .Ql vi .
1.56 jmc 2187: .Pp
1.50 nicm 2188: .It Xo Ic mode-mouse
1.56 jmc 2189: .Op Ic on | off
1.50 nicm 2190: .Xc
1.51 jmc 2191: Mouse state in modes.
1.173 nicm 2192: If on, the mouse may be used to copy a selection by dragging in copy mode, or
2193: to select an option in choice mode.
1.56 jmc 2194: .Pp
1.1 nicm 2195: .It Xo Ic monitor-activity
1.56 jmc 2196: .Op Ic on | off
1.1 nicm 2197: .Xc
2198: Monitor for activity in the window.
2199: Windows with activity are highlighted in the status line.
1.56 jmc 2200: .Pp
2201: .It Ic monitor-content Ar match-string
1.6 jmc 2202: Monitor content in the window.
2203: When
1.16 nicm 2204: .Xr fnmatch 3
2205: pattern
1.1 nicm 2206: .Ar match-string
2207: appears in the window, it is highlighted in the status line.
1.56 jmc 2208: .Pp
1.192 nicm 2209: .It Xo Ic monitor-silence
2210: .Op Ic interval
2211: .Xc
2212: Monitor for silence (no activity) in the window within
2213: .Ic interval
2214: seconds.
2215: Windows that have been silent for the interval are highlighted in the
2216: status line.
2217: An interval of zero disables the monitoring.
1.195 nicm 2218: .Pp
2219: .It Ic other-pane-height Ar height
2220: Set the height of the other panes (not the main pane) in the
2221: .Ic main-horizontal
2222: layout.
2223: If this option is set to 0 (the default), it will have no effect.
2224: If both the
2225: .Ic main-pane-height
2226: and
2227: .Ic other-pane-height
2228: options are set, the main pane will grow taller to make the other panes the
2229: specified height, but will never shrink to do so.
2230: .Pp
2231: .It Ic other-pane-width Ar width
2232: Like
2233: .Ic other-pane-height ,
2234: but set the width of other panes in the
2235: .Ic main-vertical
2236: layout.
1.192 nicm 2237: .Pp
1.1 nicm 2238: .It Xo Ic remain-on-exit
1.56 jmc 2239: .Op Ic on | off
1.1 nicm 2240: .Xc
2241: A window with this flag set is not destroyed when the program running in it
2242: exits.
2243: The window may be reactivated with the
2244: .Ic respawn-window
2245: command.
1.56 jmc 2246: .Pp
1.99 nicm 2247: .It Xo Ic synchronize-panes
2248: .Op Ic on | off
2249: .Xc
1.164 nicm 2250: Duplicate input to any pane to all other panes in the same window (only
2251: for panes that are not in any special mode).
1.139 nicm 2252: .Pp
1.1 nicm 2253: .It Xo Ic utf8
1.56 jmc 2254: .Op Ic on | off
1.1 nicm 2255: .Xc
2256: Instructs
2257: .Nm
2258: to expect UTF-8 sequences to appear in this window.
1.56 jmc 2259: .Pp
1.1 nicm 2260: .It Ic window-status-attr Ar attributes
2261: Set status line attributes for a single window.
1.56 jmc 2262: .Pp
1.1 nicm 2263: .It Ic window-status-bg Ar colour
2264: Set status line background colour for a single window.
1.56 jmc 2265: .Pp
1.1 nicm 2266: .It Ic window-status-fg Ar colour
2267: Set status line foreground colour for a single window.
1.56 jmc 2268: .Pp
1.125 nicm 2269: .It Ic window-status-format Ar string
2270: Set the format in which the window is displayed in the status line window list.
2271: See the
2272: .Ar status-left
2273: option for details of special character sequences available.
2274: The default is
2275: .Ql #I:#W#F .
1.169 nicm 2276: .Pp
2277: .It Ic window-status-alert-attr Ar attributes
2278: Set status line attributes for windows which have an alert (bell, activity
2279: or content).
2280: .Pp
2281: .It Ic window-status-alert-bg Ar colour
2282: Set status line background colour for windows with an alert.
2283: .Pp
2284: .It Ic window-status-alert-fg Ar colour
2285: Set status line foreground colour for windows with an alert.
1.125 nicm 2286: .Pp
1.40 nicm 2287: .It Ic window-status-current-attr Ar attributes
2288: Set status line attributes for the currently active window.
1.56 jmc 2289: .Pp
1.40 nicm 2290: .It Ic window-status-current-bg Ar colour
2291: Set status line background colour for the currently active window.
1.56 jmc 2292: .Pp
1.40 nicm 2293: .It Ic window-status-current-fg Ar colour
2294: Set status line foreground colour for the currently active window.
1.56 jmc 2295: .Pp
1.125 nicm 2296: .It Ic window-status-current-format Ar string
2297: Like
2298: .Ar window-status-format ,
2299: but is the format used when the window is the current window.
1.154 nicm 2300: .Pp
2301: .It Ic word-separators Ar string
2302: Sets the window's conception of what characters are considered word
2303: separators, for the purposes of the next and previous word commands in
2304: copy mode.
2305: The default is
2306: .Ql \ -_@ .
1.125 nicm 2307: .Pp
1.1 nicm 2308: .It Xo Ic xterm-keys
1.56 jmc 2309: .Op Ic on | off
1.1 nicm 2310: .Xc
2311: If this option is set,
2312: .Nm
2313: will generate
1.57 jmc 2314: .Xr xterm 1 -style
2315: function key sequences; these have a number included to indicate modifiers such
2316: as Shift, Alt or Ctrl.
1.123 nicm 2317: The default is off.
1.57 jmc 2318: .El
2319: .It Xo Ic show-options
1.133 nicm 2320: .Op Fl gsw
1.129 nicm 2321: .Op Fl t Ar target-session | Ar target-window
1.57 jmc 2322: .Xc
2323: .D1 (alias: Ic show )
1.133 nicm 2324: Show the window options with
1.129 nicm 2325: .Fl w
1.133 nicm 2326: (equivalent to
1.134 nicm 2327: .Ic show-window-options ) ,
1.133 nicm 2328: the server options with
2329: .Fl s ,
2330: otherwise the session options for
2331: .Ar target session .
2332: Global session or window options are listed if
2333: .Fl g
2334: is used.
1.57 jmc 2335: .It Xo Ic show-window-options
2336: .Op Fl g
2337: .Op Fl t Ar target-window
2338: .Xc
2339: .D1 (alias: Ic showw )
2340: List the window options for
2341: .Ar target-window ,
2342: or the global window options if
2343: .Fl g
2344: is used.
1.63 nicm 2345: .El
2346: .Sh ENVIRONMENT
2347: When the server is started,
2348: .Nm
2349: copies the environment into the
2350: .Em global environment ;
2351: in addition, each session has a
2352: .Em session environment .
1.193 nicm 2353: When a window is created, the session and global environments are merged.
2354: If a variable exists in both, the value from the session environment is used.
2355: The result is the initial environment passed to the new process.
1.63 nicm 2356: .Pp
2357: The
2358: .Ic update-environment
2359: session option may be used to update the session environment from the client
2360: when a new session is created or an old reattached.
2361: .Nm
2362: also initialises the
2363: .Ev TMUX
2364: variable with some internal information to allow commands to be executed
2365: from inside, and the
2366: .Ev TERM
2367: variable with the correct terminal setting of
2368: .Ql screen .
2369: .Pp
2370: Commands to alter and view the environment are:
2371: .Bl -tag -width Ds
2372: .It Xo Ic set-environment
2373: .Op Fl gru
2374: .Op Fl t Ar target-session
2375: .Ar name Op Ar value
2376: .Xc
1.115 nicm 2377: .D1 (alias: Ic setenv )
1.63 nicm 2378: Set or unset an environment variable.
2379: If
2380: .Fl g
2381: is used, the change is made in the global environment; otherwise, it is applied
2382: to the session environment for
2383: .Ar target-session .
2384: The
2385: .Fl u
2386: flag unsets a variable.
2387: .Fl r
2388: indicates the variable is to be removed from the environment before starting a
2389: new process.
2390: .It Xo Ic show-environment
2391: .Op Fl g
2392: .Op Fl t Ar target-session
2393: .Xc
1.115 nicm 2394: .D1 (alias: Ic showenv )
1.63 nicm 2395: Display the environment for
2396: .Ar target-session
2397: or the global environment with
2398: .Fl g .
2399: Variables removed from the environment are prefixed with
2400: .Ql - .
1.57 jmc 2401: .El
2402: .Sh STATUS LINE
2403: .Nm
2404: includes an optional status line which is displayed in the bottom line of each
2405: terminal.
2406: By default, the status line is enabled (it may be disabled with the
2407: .Ic status
2408: session option) and contains, from left-to-right: the name of the current
2409: session in square brackets; the window list; the current window title in double
2410: quotes; and the time and date.
2411: .Pp
2412: The status line is made of three parts: configurable left and right sections
2413: (which may contain dynamic content such as the time or output from a shell
2414: command, see the
2415: .Ic status-left ,
2416: .Ic status-left-length ,
2417: .Ic status-right ,
2418: and
2419: .Ic status-right-length
2420: options below), and a central window list.
1.125 nicm 2421: By default, the window list shows the index, name and (if any) flag of the
2422: windows present in the current session in ascending numerical order.
2423: It may be customised with the
2424: .Ar window-status-format
2425: and
2426: .Ar window-status-current-format
2427: options.
1.57 jmc 2428: The flag is one of the following symbols appended to the window name:
2429: .Bl -column "Symbol" "Meaning" -offset indent
2430: .It Sy "Symbol" Ta Sy "Meaning"
2431: .It Li "*" Ta "Denotes the current window."
2432: .It Li "-" Ta "Marks the last window (previously selected)."
2433: .It Li "#" Ta "Window is monitored and activity has been detected."
2434: .It Li "!" Ta "A bell has occurred in the window."
2435: .It Li "+" Ta "Window is monitored for content and it has appeared."
1.192 nicm 2436: .It Li "~" Ta "The window has been silent for the monitor-silence interval."
1.57 jmc 2437: .El
2438: .Pp
2439: The # symbol relates to the
2440: .Ic monitor-activity
2441: and + to the
2442: .Ic monitor-content
2443: window options.
2444: The window name is printed in inverted colours if an alert (bell, activity or
2445: content) is present.
2446: .Pp
1.131 nicm 2447: The colour and attributes of the status line may be configured, the entire
2448: status line using the
1.57 jmc 2449: .Ic status-attr ,
2450: .Ic status-fg
2451: and
2452: .Ic status-bg
2453: session options and individual windows using the
2454: .Ic window-status-attr ,
2455: .Ic window-status-fg
2456: and
2457: .Ic window-status-bg
2458: window options.
2459: .Pp
1.131 nicm 2460: The status line is automatically refreshed at interval if it has changed, the
2461: interval may be controlled with the
1.57 jmc 2462: .Ic status-interval
2463: session option.
2464: .Pp
2465: Commands related to the status line are as follows:
2466: .Bl -tag -width Ds
2467: .It Xo Ic command-prompt
1.73 nicm 2468: .Op Fl p Ar prompts
1.57 jmc 2469: .Op Fl t Ar target-client
2470: .Op Ar template
2471: .Xc
2472: Open the command prompt in a client.
2473: This may be used from inside
2474: .Nm
2475: to execute commands interactively.
2476: If
2477: .Ar template
1.73 nicm 2478: is specified, it is used as the command.
2479: If
2480: .Fl p
2481: is given,
2482: .Ar prompts
2483: is a comma-separated list of prompts which are displayed in order; otherwise
2484: a single prompt is displayed, constructed from
2485: .Ar template
2486: if it is present, or
2487: .Ql \&:
2488: if not.
2489: Before the command is executed, the first occurrence of the string
2490: .Ql %%
1.74 jmc 2491: and all occurrences of
1.73 nicm 2492: .Ql %1
2493: are replaced by the response to the first prompt, the second
2494: .Ql %%
2495: and all
2496: .Ql %2
2497: are replaced with the response to the second prompt, and so on for further
1.74 jmc 2498: prompts.
2499: Up to nine prompt responses may be replaced
2500: .Po
2501: .Ql %1
1.73 nicm 2502: to
1.74 jmc 2503: .Ql %9
2504: .Pc .
1.57 jmc 2505: .It Xo Ic confirm-before
2506: .Op Fl t Ar target-client
2507: .Ar command
2508: .Xc
2509: .D1 (alias: Ic confirm )
2510: Ask for confirmation before executing
2511: .Ar command .
2512: This command works only from inside
2513: .Nm .
2514: .It Xo Ic display-message
1.127 nicm 2515: .Op Fl p
1.57 jmc 2516: .Op Fl t Ar target-client
2517: .Op Ar message
2518: .Xc
2519: .D1 (alias: Ic display )
1.127 nicm 2520: Display a message.
2521: If
2522: .Fl p
2523: is given, the output is printed to stdout, otherwise it is displayed in the
2524: .Ar target-client
2525: status line.
1.122 nicm 2526: The format of
1.124 jmc 2527: .Ar message
2528: is as for
1.122 nicm 2529: .Ic status-left ,
2530: with the exception that #() are not handled.
1.57 jmc 2531: .El
2532: .Sh BUFFERS
2533: .Nm
2534: maintains a stack of
1.199 nicm 2535: .Em paste buffers .
1.57 jmc 2536: Up to the value of the
2537: .Ic buffer-limit
2538: option are kept; when a new buffer is added, the buffer at the bottom of the
2539: stack is removed.
2540: Buffers may be added using
2541: .Ic copy-mode
2542: or the
2543: .Ic set-buffer
2544: command, and pasted into a window using the
2545: .Ic paste-buffer
2546: command.
2547: .Pp
2548: A configurable history buffer is also maintained for each window.
2549: By default, up to 2000 lines are kept; this can be altered with the
2550: .Ic history-limit
2551: option (see the
2552: .Ic set-option
2553: command above).
2554: .Pp
2555: The buffer commands are as follows:
2556: .Bl -tag -width Ds
1.178 nicm 2557: .It Xo
2558: .Ic choose-buffer
2559: .Op Fl t Ar target-window
2560: .Op Ar template
2561: .Xc
2562: Put a window into buffer choice mode, where a buffer may be chosen
2563: interactively from a list.
2564: After a buffer is selected,
2565: .Ql %%
2566: is replaced by the buffer index in
2567: .Ar template
2568: and the result executed as a command.
2569: If
2570: .Ar template
2571: is not given, "paste-buffer -b '%%'" is used.
2572: This command works only from inside
2573: .Nm .
1.57 jmc 2574: .It Ic clear-history Op Fl t Ar target-pane
2575: .D1 (alias: Ic clearhist )
2576: Remove and free the history for the specified pane.
1.198 nicm 2577: .It Ic delete-buffer Op Fl b Ar buffer-index
1.57 jmc 2578: .D1 (alias: Ic deleteb )
2579: Delete the buffer at
2580: .Ar buffer-index ,
2581: or the top buffer if not specified.
1.198 nicm 2582: .It Ic list-buffers
1.57 jmc 2583: .D1 (alias: Ic lsb )
1.198 nicm 2584: List the global buffers.
1.200 jmc 2585: .It Xo Ic load-buffer
1.57 jmc 2586: .Op Fl b Ar buffer-index
2587: .Ar path
2588: .Xc
2589: .D1 (alias: Ic loadb )
2590: Load the contents of the specified paste buffer from
2591: .Ar path .
2592: .It Xo Ic paste-buffer
2593: .Op Fl dr
2594: .Op Fl b Ar buffer-index
1.170 nicm 2595: .Op Fl s Ar separator
1.158 nicm 2596: .Op Fl t Ar target-pane
1.57 jmc 2597: .Xc
2598: .D1 (alias: Ic pasteb )
1.158 nicm 2599: Insert the contents of a paste buffer into the specified pane.
2600: If not specified, paste into the current one.
1.57 jmc 2601: With
2602: .Fl d ,
2603: also delete the paste buffer from the stack.
2604: When output, any linefeed (LF) characters in the paste buffer are replaced with
1.170 nicm 2605: a separator, by default carriage return (CR).
2606: A custom separator may be specified using the
2607: .Fl s
2608: flag.
2609: The
1.57 jmc 2610: .Fl r
1.170 nicm 2611: flag means to do no replacement (equivalent to a separator of LF).
1.57 jmc 2612: .It Xo Ic save-buffer
2613: .Op Fl a
2614: .Op Fl b Ar buffer-index
2615: .Ar path
2616: .Xc
2617: .D1 (alias: Ic saveb )
2618: Save the contents of the specified paste buffer to
2619: .Ar path .
2620: The
2621: .Fl a
2622: option appends to rather than overwriting the file.
2623: .It Xo Ic set-buffer
2624: .Op Fl b Ar buffer-index
2625: .Ar data
2626: .Xc
2627: .D1 (alias: Ic setb )
2628: Set the contents of the specified buffer to
2629: .Ar data .
1.1 nicm 2630: .It Xo Ic show-buffer
2631: .Op Fl b Ar buffer-index
2632: .Xc
2633: .D1 (alias: Ic showb )
2634: Display the contents of the specified buffer.
1.57 jmc 2635: .El
2636: .Sh MISCELLANEOUS
2637: Miscellaneous commands are as follows:
2638: .Bl -tag -width Ds
1.72 nicm 2639: .It Ic clock-mode Op Fl t Ar target-pane
1.57 jmc 2640: Display a large clock.
2641: .It Ic if-shell Ar shell-command command
2642: .D1 (alias: Ic if )
2643: Execute
2644: .Ar command
2645: if
2646: .Ar shell-command
2647: returns success.
2648: .It Ic lock-server
2649: .D1 (alias: Ic lock )
1.90 nicm 2650: Lock each client individually by running the command specified by the
2651: .Ic lock-command
2652: option.
1.153 nicm 2653: .It Ic run-shell Ar shell-command
1.87 nicm 2654: .D1 (alias: Ic run )
2655: Execute
1.153 nicm 2656: .Ar shell-command
1.106 nicm 2657: in the background without creating a window.
1.164 nicm 2658: After it finishes, any output to stdout is displayed in copy mode.
1.153 nicm 2659: If the command doesn't return success, the exit status is also displayed.
1.57 jmc 2660: .It Ic server-info
2661: .D1 (alias: Ic info )
2662: Show server information and terminal details.
1.1 nicm 2663: .El
2664: .Sh FILES
1.26 nicm 2665: .Bl -tag -width "/etc/tmux.confXXX" -compact
1.1 nicm 2666: .It Pa ~/.tmux.conf
1.6 jmc 2667: Default
1.1 nicm 2668: .Nm
1.6 jmc 2669: configuration file.
1.26 nicm 2670: .It Pa /etc/tmux.conf
2671: System-wide configuration file.
1.1 nicm 2672: .El
1.57 jmc 2673: .Sh EXAMPLES
2674: To create a new
2675: .Nm
2676: session running
2677: .Xr vi 1 :
2678: .Pp
2679: .Dl $ tmux new-session vi
2680: .Pp
2681: Most commands have a shorter form, known as an alias.
2682: For new-session, this is
2683: .Ic new :
2684: .Pp
2685: .Dl $ tmux new vi
2686: .Pp
2687: Alternatively, the shortest unambiguous form of a command is accepted.
2688: If there are several options, they are listed:
2689: .Bd -literal -offset indent
2690: $ tmux n
2691: ambiguous command: n, could be: new-session, new-window, next-window
2692: .Ed
2693: .Pp
2694: Within an active session, a new window may be created by typing
2695: .Ql C-b c
2696: (Ctrl
2697: followed by the
2698: .Ql b
2699: key
2700: followed by the
2701: .Ql c
2702: key).
2703: .Pp
2704: Windows may be navigated with:
2705: .Ql C-b 0
2706: (to select window 0),
2707: .Ql C-b 1
2708: (to select window 1), and so on;
2709: .Ql C-b n
2710: to select the next window; and
2711: .Ql C-b p
2712: to select the previous window.
2713: .Pp
2714: A session may be detached using
2715: .Ql C-b d
1.64 nicm 2716: (or by an external event such as
2717: .Xr ssh 1
2718: disconnection) and reattached with:
1.57 jmc 2719: .Pp
2720: .Dl $ tmux attach-session
2721: .Pp
2722: Typing
2723: .Ql C-b \&?
2724: lists the current key bindings in the current window; up and down may be used
2725: to navigate the list or
2726: .Ql q
2727: to exit from it.
2728: .Pp
2729: Commands to be run when the
2730: .Nm
2731: server is started may be placed in the
2732: .Pa ~/.tmux.conf
2733: configuration file.
2734: Common examples include:
2735: .Pp
2736: Changing the default prefix key:
2737: .Bd -literal -offset indent
2738: set-option -g prefix C-a
2739: unbind-key C-b
2740: bind-key C-a send-prefix
2741: .Ed
2742: .Pp
2743: Turning the status line off, or changing its colour:
2744: .Bd -literal -offset indent
2745: set-option -g status off
2746: set-option -g status-bg blue
2747: .Ed
2748: .Pp
2749: Setting other options, such as the default command,
2750: or locking after 30 minutes of inactivity:
2751: .Bd -literal -offset indent
2752: set-option -g default-command "exec /bin/ksh"
2753: set-option -g lock-after-time 1800
2754: .Ed
2755: .Pp
2756: Creating new key bindings:
2757: .Bd -literal -offset indent
2758: bind-key b set-option status
2759: bind-key / command-prompt "split-window 'exec man %%'"
1.73 nicm 2760: bind-key S command-prompt "new-window -n %1 'ssh %1'"
1.57 jmc 2761: .Ed
1.1 nicm 2762: .Sh SEE ALSO
2763: .Xr pty 4
2764: .Sh AUTHORS
2765: .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