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