Annotation of src/usr.bin/tmux/tmux.1, Revision 1.9
1.9 ! nicm 1: .\" $OpenBSD: tmux.1,v 1.8 2009/06/03 15:47:14 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.7 jmc 17: .Dd $Mdocdate: June 3 2009 $
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
26: .Op Fl 28dqUuv
27: .Op Fl f Ar file
28: .Op Fl L Ar socket-name
29: .Op Fl S Ar socket-path
30: .Op Ar command Op Ar flags
31: .Ek
32: .Sh DESCRIPTION
33: .Nm
1.6 jmc 34: is a terminal multiplexer: it enables a number of terminals to be accessed and
1.1 nicm 35: controlled from a single terminal.
36: .Pp
37: .Nm
38: runs as a server-client system.
39: A server is created automatically when necessary and holds a number of
40: .Em sessions ,
41: each of which may have a number of
42: .Em windows
43: linked to it.
44: A window may be split on screen into one or more
45: .Em panes ,
46: each of which is a separate terminal.
47: Any number of
48: .Em clients
49: may connect to a session, or the server
50: may be controlled by issuing commands with
51: .Nm .
52: Communication takes place through a socket, by default placed in
53: .Pa /tmp .
54: .Pp
55: The options are as follows:
56: .Bl -tag -width "XXXXXXXXXXXX"
57: .It Fl 2
58: Force
59: .Nm
60: to assume the terminal supports 256 colours.
61: .It Fl 8
62: Like
63: .Fl 2 ,
1.6 jmc 64: but indicates that the terminal supports 88 colours.
1.1 nicm 65: .It Fl d
66: Force
67: .Nm
68: to assume the terminal supports default colours.
69: .It Fl f Ar file
70: Specify an alternative configuration file.
71: By default,
72: .Nm
73: will look for a config file at
74: .Pa ~/.tmux.conf .
75: The configuration file is a set of
76: .Nm
77: commands which are executed in sequence when the server is first started.
78: .It Fl L Ar socket-name
79: .Nm
80: stores the server socket in a directory under
81: .Pa /tmp ;
82: the default socket is named
83: .Em default .
84: This option allows a different socket name to be specified, allowing several
85: independent
86: .Nm
87: servers to be run.
88: Unlike
89: .Fl S
90: a full path is not necessary: the sockets are all created in the same
91: directory.
1.2 nicm 92: .Pp
93: If the socket is accidentally removed, the
1.6 jmc 94: .Dv SIGUSR1
1.2 nicm 95: signal may be sent to the
96: .Nm
97: server process to recreate it.
1.4 sobrado 98: .It Fl q
1.6 jmc 99: Prevent the server sending various informational messages, for example when
1.4 sobrado 100: window flags are altered.
1.1 nicm 101: .It Fl S Ar socket-path
102: Specify a full alternative path to the server socket.
103: If
104: .Fl S
105: is specified, the default socket directory is not used and any
106: .Fl L
107: flag is ignored.
108: .It Fl U
109: Unlock the server.
110: .It Fl u
111: .Nm
1.5 nicm 112: attempts to guess if the terminal is likely to support UTF-8 by checking
1.2 nicm 113: the
114: .Ev LANG
1.5 nicm 115: environment variable for the string "UTF-8".
116: This is not always correct: the
1.2 nicm 117: .Fl u
118: flag explicitly informs
119: .Nm
1.6 jmc 120: that UTF-8 is supported.
1.1 nicm 121: .It Fl v
122: Request verbose logging.
123: This option may be specified multiple times for increasing verbosity.
124: Log messages will be saved into
125: .Pa tmux-client-PID.log
126: and
127: .Pa tmux-server-PID.log
128: files in the current directory, where
129: .Em PID
1.6 jmc 130: is the PID of the server or client process.
1.1 nicm 131: .It Ar command Op Ar flags
132: This specifies one of a set of commands used to control
133: .Nm ,
1.6 jmc 134: as described in the following sections.
135: If no command and flags are specified, the
1.1 nicm 136: .Ic new-session
137: command is assumed.
138: .El
139: .Sh QUICK START
1.6 jmc 140: To create a new
141: .Nm
142: session running
1.1 nicm 143: .Xr vi 1 :
144: .Pp
145: .Dl $ tmux new-session vi
146: .Pp
147: Most commands have a shorter form, known as an alias.
148: For new-session, this is
149: .Ic new :
150: .Pp
151: .Dl $ tmux new vi
152: .Pp
153: Alternatively, the shortest unambiguous form of a command is accepted.
154: If there are several options, they are listed:
155: .Bd -literal -offset indent
156: $ tmux n
157: ambiguous command: n, could be: new-session, new-window, next-window
158: .Ed
159: .Pp
160: Within an active session, a new window may be created by typing
1.7 jmc 161: .Ql C-b c
162: (Ctrl
1.1 nicm 163: followed by the
1.6 jmc 164: .Ql b
1.7 jmc 165: key
166: followed by the
167: .Ql c
1.6 jmc 168: key).
1.1 nicm 169: .Pp
170: Windows may be navigated with:
171: .Ql C-b 0
172: (to select window 0),
173: .Ql C-b 1
174: (to select window 1), and so on;
175: .Ql C-b n
176: to select the next window; and
177: .Ql C-b p
178: to select the previous window.
179: .Pp
180: A session may be detached using
181: .Ql C-b d
182: and reattached with:
183: .Pp
184: .Dl $ tmux attach-session
185: .Pp
186: Typing
187: .Ql C-b \&?
188: lists the current key bindings in the current window; up and down may be used
189: to navigate the list or
1.6 jmc 190: .Ql q
1.1 nicm 191: to exit from it.
192: .Sh KEY BINDINGS
193: .Nm
194: may be controlled from an attached client by using a key combination of a
195: prefix key,
196: .Ql C-b
1.6 jmc 197: (Ctrl-b) by default, followed by a command key.
1.1 nicm 198: .Pp
199: Some of the default key bindings include:
200: .Pp
1.6 jmc 201: .Bl -tag -width Ds -offset 3n -compact
202: .It c
203: Create new window.
204: .It d
1.1 nicm 205: Detach current client.
1.6 jmc 206: .It l
207: Move to last (previously selected) window in the current session.
208: .It n
1.1 nicm 209: Change to next window in the current session.
1.6 jmc 210: .It p
1.1 nicm 211: Change to previous window in the current session.
1.6 jmc 212: .It t
1.1 nicm 213: Display a large clock.
1.6 jmc 214: .It \&?
1.1 nicm 215: List current key bindings.
216: .El
217: .Pp
218: A complete list may be obtained with the
219: .Ic list-keys
220: command (bound to
221: .Ql \&?
222: by default).
223: Key bindings may be changed with the
224: .Ic bind-key
225: and
226: .Ic unbind-key
227: commands.
228: .Sh HISTORY
229: .Nm
230: maintains a configurable history buffer for each window.
1.6 jmc 231: By default, up to 2000 lines are kept; this can be altered with the
1.1 nicm 232: .Ic history-limit
233: option (see the
234: .Ic set-option
235: command below).
236: .Sh MODES
237: A
238: .Nm
239: window may be in one of several modes.
240: The default permits direct access to the terminal attached to the window.
241: The others are:
242: .Bl -tag -width Ds
243: .It Em output mode
244: This is entered when a command which produces output, such as
245: .Ic list-keys ,
246: is executed from a key binding.
247: .It Em scroll mode
248: This is entered with the
249: .Ic scroll-mode
250: command (bound to
251: .Ql =
252: by default) and permits the window history buffer to be inspected.
253: .It Em copy mode
254: This permits a section of a window or its history to be copied to a
255: .Em paste buffer
256: for later insertion into another window.
257: This mode is entered with the
258: .Ic copy-mode
259: command, bound to
260: .Ql [
261: by default.
262: .El
263: .Pp
1.6 jmc 264: The keys available depend on whether emacs or vi mode is selected
265: (see the
1.1 nicm 266: .Ic mode-keys
267: option).
268: The following keys are supported as appropriate for the mode:
269: .Bl -column "FunctionXXXXXXXXXXXX" "viXXXXXX" "emacs" -offset indent
270: .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
271: .It Li "Start of line" Ta "0 or ^" Ta "C-a"
272: .It Li "Clear selection" Ta "Escape" Ta "C-g"
273: .It Li "Copy selection" Ta "Enter" Ta "M-w"
274: .It Li "Cursor down" Ta "j" Ta "Down"
275: .It Li "End of line" Ta "$" Ta "C-e"
276: .It Li "Cursor left" Ta "h" Ta "Left"
277: .It Li "Next page" Ta "C-f" Ta "Page down"
278: .It Li "Next word" Ta "w" Ta "M-f"
279: .It Li "Previous page" Ta "C-u" Ta "Page up"
280: .It Li "Previous word" Ta "b" Ta "M-b"
281: .It Li "Quit mode" Ta "q" Ta "Escape"
282: .It Li "Cursor right" Ta "l" Ta "Right"
283: .It Li "Start selection" Ta "Space" Ta "C-Space"
284: .It Li "Cursor up" Ta "k" Ta "Up"
1.2 nicm 285: .It Li "Paste buffer" Ta "p" Ta "C-y"
1.1 nicm 286: .El
287: .Pp
1.2 nicm 288: The paste buffer key pastes the first line from the top paste buffer on the
289: stack.
1.1 nicm 290: .Sh BUFFERS
291: .Nm
292: maintains a stack of
293: .Em paste buffers
294: for each session.
295: Up to the value of the
296: .Ic buffer-limit
297: option are kept; when a new buffer is added, the buffer at the bottom of the
298: stack is removed.
299: Buffers may be added using
300: .Ic copy-mode
301: or the
302: .Ic set-buffer
303: command, and pasted into a window using the
304: .Ic paste-buffer
305: command.
306: .Sh PANES AND LAYOUTS
307: Each window displayed by
308: .Nm
309: may be split into one or more
310: .Em panes ;
311: each pane takes up a certain area of the display and is a separate terminal.
312: A window may be split into panes using the
313: .Ic split-window
314: command.
315: .Pp
316: Panes are numbered beginning from zero; in horizontal layouts zero is the
317: leftmost pane and in vertical the topmost.
318: .Pp
319: Panes may be arranged using several layouts.
320: The layout may be cycled with the
321: .Ic next-layout
322: command (bound to
323: .Ql C-space
324: by default), the current pane may be changed with the
325: .Ic up-pane
326: and
327: .Ic down-pane
328: commands and the
329: .Ic rotate-window
330: and
331: .Ic swap-pane
332: commands may be used to swap panes without changing the window layout.
333: .Pp
334: The following layouts are supported:
335: .Bl -tag -width Ds
336: .It Ic active-only
1.6 jmc 337: Only the active pane is shown \(en all other panes are hidden.
1.1 nicm 338: .It Ic even-horizontal
339: Panes are spread out evenly from left to right across the window.
340: .It Ic even-vertical
341: Panes are spread evenly from top to bottom.
1.2 nicm 342: .It Ic main-horizontal
343: A large (main) pane is shown at the top of the window and the remaining panes are
1.6 jmc 344: spread from left to right in the leftover space at the bottom.
1.2 nicm 345: Use the
346: .Em main-pane-height
347: window option to specify the height of the top pane.
1.1 nicm 348: .It Ic main-vertical
1.2 nicm 349: Similar to
350: .Ic main-horizontal
351: but the large pane is placed on the left and the others spread from top to
352: bottom along the right.
353: See the
354: .Em main-pane-width
355: window option.
1.6 jmc 356: .It Ic manual
357: Manual layout splits windows vertically (running across); only with this layout
358: may panes be resized using the
359: .Ic resize-pane
360: command.
1.1 nicm 361: .El
1.8 nicm 362: .Sh STATUS LINE
363: .Nm
364: includes an optional status line which is displayed in the bottom line of each
365: terminal.
366: By default, the status line is enabled (it may be disabled with the
367: .Ic status
368: session option) and contains, from left-to-right: the name of the current
369: session in square brackets; the window list; the current window title in double
370: quotes; and the time and date.
371: .Pp
372: The status line is made of three parts: configurable left and right sections
373: (which may contain dynamic content such as the time or output from a shell
374: command, see the
375: .Ic status-left ,
376: .Ic status-left-length ,
377: .Ic status-right ,
378: and
379: .Ic status-right-length
380: options below), and a central window list.
381: The window list shows the index, name and (if any) flag of the windows
382: present in the current session in ascending numerical order.
383: The flag is one of the following symbols appended to the window name:
384: .Bl -column "Symbol" "Meaning" -offset indent
385: .It Sy "Symbol" Ta Sy "Meaning"
386: .It Li "*" Ta "Denotes the current window."
387: .It Li "-" Ta "Marks the last window (previously selected)."
388: .It Li "#" Ta "Window is monitored and activity has been detected."
389: .It Li "!" Ta "A bell has occurred in the window."
390: .It Li "+" Ta "Window is monitored for content and it has appeared."
391: .El
392: .Pp
393: The # symbol relates to the
394: .Ic monitor-activity
395: and + to the
396: .Ic monitor-content
397: window options.
398: The window name is printed in inverted colours if an alert (bell, activity or
399: content) is present.
400: .Pp
401: The colour and attributes of the status line may be configured, the entire status line using
402: the
403: .Ic status-attr ,
404: .Ic status-fg
405: and
406: .Ic status-bg
407: session options and individual windows using the
408: .Ic window-status-attr ,
409: .Ic window-status-fg
410: and
411: .Ic window-status-bg
412: window options.
413: .Pp
414: The status line is automatically refreshed at interval if it has changed, the interval may be
415: controlled with the
416: .Ic status-interval
417: session option.
1.1 nicm 418: .Sh COMMANDS
419: This section contains a list of the commands supported by
420: .Nm .
421: Most commands accept the optional
422: .Fl t
423: argument with one of
424: .Ar target-client ,
425: .Ar target-session
426: or
427: .Ar target-window .
428: These specify the client, session or window which a command should affect.
429: .Ar target-client
430: is the name of the
431: .Xr pty 4
432: file to which the client is connected, for example
433: .Pa /dev/ttyp1 .
434: Clients may be listed with the
435: .Ic list-clients
436: command.
437: .Pp
438: .Ar target-session
439: is either the name of a session (as listed by the
440: .Ic list-sessions
1.6 jmc 441: command) or the name of a client,
1.1 nicm 442: .Ar target-client ,
1.6 jmc 443: in which case the session attached to the client is used.
1.1 nicm 444: An
445: .Xr fnmatch 3
446: pattern may be used to match the session name.
447: If a session is omitted when required,
448: .Nm tmux
449: attempts to use the current session; if no current session is available, the
450: most recently created is chosen.
451: If no client is specified, the current client is chosen, if possible, or an
452: error is reported.
453: .Pp
454: .Ar target-window
455: specifies a window in the form
456: .Em session Ns \&: Ns Em index ,
457: for example mysession:1.
458: The session is in the same form as for
459: .Ar target-session .
460: .Em session ,
461: .Em index
462: or both may be omitted.
463: If
464: .Em session
465: is omitted, the same rules as for
466: .Ar target-session
467: are followed; if
468: .Em index
469: is not present, the current window for the given session is used.
1.6 jmc 470: When the argument does not contain a colon,
1.1 nicm 471: .Nm
472: first attempts to parse it as window index; if that fails, an attempt is made
473: to match a session or client name.
474: .Pp
475: Multiple commands may be specified together as part of a
476: .Em command sequence .
1.6 jmc 477: Each command should be separated by spaces and a semicolon;
1.1 nicm 478: commands are executed sequentially from left to right.
479: A literal semicolon may be included by escaping it with a backslash (for
480: example, when specifying a command sequence to
481: .Ic bind-key ) .
482: .Pp
483: Examples include:
484: .Bd -literal -offset indent
485: refresh-client -t/dev/ttyp2
486:
487: rename-session -tfirst newname
488:
489: set-window-option -t:0 monitor-activity on
490:
491: new-window ; split-window -d
492:
493: bind-key D detach-client \e\; lock-server
494: .Ed
495: .Pp
496: The following commands are available:
497: .Bl -tag -width Ds
498: .It Xo Ic attach-session
499: .Op Fl d
500: .Op Fl t Ar target-session
501: .Xc
502: .D1 (alias: Ic attach )
503: Create a new client in the current terminal and attach it to a session.
504: If
505: .Fl d
506: is specified, any other clients attached to the session are detached.
507: .Pp
508: If no server is started,
509: .Ic attach-session
510: will attempt to start it; this will fail unless sessions are created in the
511: configuration file.
512: .It Xo Ic bind-key
513: .Op Fl r
514: .Ar key Ar command Op Ar arguments
515: .Xc
516: .D1 (alias: Ic bind )
517: Bind key
518: .Ar key
519: to
520: .Ar command .
521: Keys may be specified prefixed with
522: .Ql C-
523: or
524: .Ql ^
1.6 jmc 525: for Ctrl keys, or
1.1 nicm 526: .Ql M-
1.6 jmc 527: for Alt (meta) keys.
1.1 nicm 528: The
529: .Fl r
530: flag indicates this key may repeat, see the
531: .Ic repeat-time
532: option.
533: .It Xo Ic break-pane
534: .Op Fl d
535: .Op Fl p Ar pane-index
536: .Op Fl t Ar target-window
537: .Xc
538: .D1 (alias: Ic breakp)
539: Break the current pane off from its containing window to make it the only pane
540: in a new window.
541: If
542: .Fl d
543: is given, the new window does not become the current window.
544: .It Xo Ic choose-session
545: .Op Fl t Ar target-window
546: .Xc
547: Put a window into session choice mode, where the session for the current
548: client may be selected interactively from a list.
549: This command works only from inside
550: .Nm .
551: .It Xo Ic choose-window
552: .Op Fl t Ar target-window
553: .Xc
554: Put a window into window choice mode, where the window for the session
555: attached to the current client may be selected interactively from a list.
556: This command works only from inside
557: .Nm .
1.2 nicm 558: .It Xo Ic clear-history
559: .Op Fl p Ar pane-index
560: .Op Fl t Ar target-window
561: .Xc
562: .D1 (alias: Ic clearhist)
563: Remove and free the history for the specified pane.
1.1 nicm 564: .It Xo Ic clock-mode
565: .Op Fl t Ar target-window
566: .Xc
567: Display a large clock.
568: .It Xo Ic command-prompt
569: .Op Fl t Ar target-client
570: .Op Ar template
571: .Xc
572: Open the command prompt in a client.
573: This may be used from inside
574: .Nm
575: to execute commands interactively.
576: If
577: .Ar template
578: is specified, it is used as the command; any %% in the template will be
579: replaced by what is entered at the prompt.
580: .It Xo Ic confirm-before
581: .Op Fl t Ar target-client
582: .Ar command
583: .Xc
584: .D1 (alias: Ic confirm)
585: Ask for confirmation before executing
586: .Ar command .
587: This command works only from inside
588: .Nm .
589: .It Xo Ic copy-buffer
590: .Op Fl a Ar src-index
591: .Op Fl b Ar dst-index
592: .Op Fl s Ar src-session
593: .Op Fl t Ar dst-session
594: .Xc
595: .D1 (alias: Ic copyb)
596: Copy a session paste buffer to another session.
597: If no sessions are specified, the current one is used instead.
598: .It Xo Ic copy-mode
599: .Op Fl u
600: .Op Fl t Ar target-window
601: .Xc
602: Enter copy mode.
603: The
604: .Fl u
605: option scrolls one page up.
606: .It Xo Ic delete-buffer
607: .Op Fl b Ar buffer-index
608: .Op Fl t Ar target-session
609: .Xc
610: .D1 (alias: Ic deleteb )
611: Delete the buffer at
612: .Ar buffer-index ,
613: or the top buffer if not specified.
614: .It Xo Ic detach-client
615: .Op Fl t Ar target-client
616: .Xc
617: .D1 (alias: Ic detach )
618: Detach the current client if bound to a key, or the specified client with
619: .Fl t .
620: .It Xo Ic down-pane
621: .Op Fl p Ar pane-index
622: .Op Fl t Ar target-window
623: .Xc
624: .D1 (alias: Ic downp )
625: Move down a pane.
626: .It Xo Ic find-window
627: .Op Fl t Ar target-window
628: .Ar match-string
629: .Xc
630: .D1 (alias: Ic findw )
631: Search for
632: .Ar match-string
633: in window names, titles, and visible content (but not history).
634: If only one window is matched, it'll be automatically selected, otherwise a
635: choice list is shown.
636: This command only works from inside
637: .Nm .
638: .It Xo Ic has-session
639: .Op Fl t Ar target-session
640: .Xc
641: .D1 (alias: Ic has )
642: Report an error and exit with 1 if the specified session does not exist.
643: If it does exist, exit with 0.
644: .It Xo Ic kill-pane
645: .Op Fl p Ar pane-index
646: .Op Fl t Ar target-window
647: .Xc
648: .D1 (alias: Ic killp )
649: Destroy the given pane.
650: .It Xo Ic kill-server
651: .Xc
652: Kill the
653: .Nm
654: server and clients and destroy all sessions.
655: .It Xo Ic kill-session
656: .Op Fl t Ar target-session
657: .Xc
658: Destroy the given session, closing any windows linked to it and no other
659: sessions, and detaching all clients attached to it.
660: .It Xo Ic kill-window
661: .Op Fl t Ar target-window
662: .Xc
663: .D1 (alias: Ic killw )
664: Kill the current window or the window at
665: .Ar target-window ,
666: removing it from any sessions to which it is linked.
667: .It Xo Ic last-window
668: .Op Fl t Ar target-session
669: .Xc
670: .D1 (alias: Ic last )
671: Select the last (previously selected) window.
672: If no
673: .Ar target-session
674: is specified, select the last window of the current session.
675: .It Xo Ic link-window
676: .Op Fl dk
677: .Op Fl s Ar src-window
678: .Op Fl t Ar dst-window
679: .Xc
680: .D1 (alias: Ic linkw )
681: Link the window at
682: .Ar src-window
683: to the specified
684: .Ar dst-window .
685: If
686: .Ar dst-window
687: is specified and no such window exists, the
688: .Ar src-window
689: is linked there.
690: If
691: .Fl k
692: is given and
693: .Ar dst-window
694: exists, it is killed, otherwise an error is generated.
695: If
696: .Fl d
697: is given, the newly linked window is not selected.
698: .It Xo Ic list-buffers
699: .Op Fl t Ar target-session
700: .Xc
701: .D1 (alias: Ic lsb )
702: List the buffers in the given session.
703: .It Xo Ic list-clients
704: .Xc
705: .D1 (alias: Ic lsc )
706: List all clients attached to the server.
707: .It Xo Ic list-commands
708: .Xc
709: .D1 (alias: Ic lscm )
710: List the syntax of all commands supported by
711: .Nm .
712: .It Xo Ic list-keys
713: .Xc
714: .D1 (alias: Ic lsk )
715: List all key bindings.
716: .It Xo Ic list-sessions
717: .Xc
718: .D1 (alias: Ic ls )
719: List all sessions managed by the server.
720: .It Xo Ic list-windows
721: .Op Fl t Ar target-session
722: .Xc
723: .D1 (alias: Ic lsw )
724: List windows in the current session or in
725: .Ar target-session .
726: .It Xo Ic load-buffer
727: .Op Fl b Ar buffer-index
728: .Op Fl t Ar target-session
729: .Ar path
730: .Xc
731: .D1 (alias: Ic loadb )
732: Load the contents of the specified paste buffer from
733: .Ar path .
734: .It Xo Ic lock-server
735: .Xc
736: .D1 (alias: Ic lock )
737: Lock the server until a password is entered.
738: .It Xo Ic move-window
739: .Op Fl d
740: .Op Fl s Ar src-window
741: .Op Fl t Ar dst-window
742: .Xc
743: .D1 (alias: Ic movew )
744: This is similar to
745: .Ic link-window ,
746: except the window at
747: .Ar src-window
748: is moved to
749: .Ar dst-window .
750: .It Xo Ic new-session
751: .Op Fl d
752: .Op Fl n Ar window-name
753: .Op Fl s Ar session-name
754: .Op Ar command
755: .Xc
756: .D1 (alias: Ic new )
757: Create a new session with name
758: .Ar session-name .
759: The new session is attached to the current terminal unless
760: .Fl d
761: is given.
762: .Ar window-name
763: and
764: .Ar command
765: are the name of and command to execute in the initial window.
766: .It Xo Ic new-window
767: .Op Fl d
768: .Op Fl n Ar window-name
769: .Op Fl t Ar target-window
770: .Op Ar command
771: .Xc
772: .D1 (alias: Ic neww )
773: Create a new window.
774: If
775: .Fl d
776: is given, the session does not make the new window the current window.
777: .Ar target-window
778: represents the window to be created.
779: .Ar command
780: is the command to execute.
781: If
782: .Ar command
783: is not specified, the default command is used.
784: .Pp
785: The
786: .Ev TERM
787: environment variable must be set to
788: .Dq screen
789: for all programs running
790: .Em inside
791: .Nm .
792: New windows will automatically have
793: .Dq TERM=screen
794: added to their environment, but care must be taken not to reset this in shell
795: start-up files.
796: .It Xo Ic next-layout
797: .Op Fl t Ar target-window
798: .Xc
799: .D1 (alias: Ic nextl )
800: Move a window to the next layout and rearrange the panes to fit.
801: .It Xo Ic next-window
1.9 ! nicm 802: .Op Fl a
1.1 nicm 803: .Op Fl t Ar target-session
804: .Xc
805: .D1 (alias: Ic next )
806: Move to the next window in the session.
1.9 ! nicm 807: If
! 808: .Fl a
! 809: is used, move to the next window with a bell, activity or content alert.
1.1 nicm 810: .It Xo Ic paste-buffer
811: .Op Fl d
812: .Op Fl b Ar buffer-index
813: .Op Fl t Ar target-window
814: .Xc
815: .D1 (alias: Ic pasteb )
816: Insert the contents of a paste buffer into the current window.
817: .It Xo Ic previous-window
1.9 ! nicm 818: .Op Fl a
1.1 nicm 819: .Op Fl t Ar target-session
820: .Xc
821: .D1 (alias: Ic prev )
822: Move to the previous window in the session.
1.9 ! nicm 823: With
! 824: .Fl a ,
! 825: move to the previous window with a bell, activity or content alert.
1.1 nicm 826: .It Xo Ic refresh-client
827: .Op Fl t Ar target-client
828: .Xc
829: .D1 (alias: Ic refresh )
830: Refresh the current client if bound to a key, or a single client if one is given
831: with
832: .Fl t .
833: .It Xo Ic rename-session
834: .Op Fl t Ar target-session
835: .Ar new-name
836: .Xc
837: .D1 (alias: Ic rename )
838: Rename the session to
839: .Ar new-name .
840: .It Xo Ic rename-window
841: .Op Fl t Ar target-window
842: .Ar new-name
843: .Xc
844: .D1 (alias: Ic renamew )
845: Rename the current window, or the window at
846: .Ar target-window
847: if specified, to
848: .Ar new-name .
849: .It Xo Ic resize-pane
850: .Op Fl DU
851: .Op Fl p Ar pane-index
852: .Op Fl t Ar target-window
853: .Op Ar adjustment
854: .Xc
855: .D1 (alias: Ic resizep )
856: Resize a pane, upward with
857: .Fl U
858: (the default) or downward with
859: .Fl D .
860: The
861: .Ar adjustment
862: is given in lines (the default is 1).
863: .It Xo Ic respawn-window
864: .Op Fl k
865: .Op Fl t Ar target-window
866: .Op Ar command
867: .Xc
868: .D1 (alias: Ic respawnw )
869: Reactive a window in which the command has exited (see the
870: .Ic remain-on-exit
871: window option).
872: If
873: .Ar command
874: is not given, the command used when the window was created is executed.
875: The window must be already inactive, unless
876: .Fl k
877: is given, in which case any existing command is killed.
878: .It Xo Ic rotate-window
879: .Op Fl DU
880: .Op Fl t Ar target-window
881: .Xc
882: .D1 (alias: Ic rotatew )
883: Rotate the positions of the panes within a window, either upward (numerically
884: lower) with
885: .Fl U
886: or downward (numerically higher).
887: .It Xo Ic save-buffer
888: .Op Fl a
889: .Op Fl b Ar buffer-index
890: .Op Fl t Ar target-session
891: .Ar path
892: .Xc
893: .D1 (alias: Ic saveb )
894: Save the contents of the specified paste buffer to
895: .Ar path .
896: The
897: .Fl a
898: option appends to rather than overwriting the file.
899: .It Xo Ic scroll-mode
900: .Op Fl u
901: .Op Fl t Ar target-window
902: .Xc
903: Enter scroll mode.
904: The
905: .Fl u
906: has the same meaning as in the
907: .Ic copy-mode
908: command.
1.2 nicm 909: .It Xo Ic select-layout
910: .Op Fl t Ar target-window
911: .Ar layout-name
912: .Xc
913: .D1 (alias: selectl)
914: Choose a specific layout for a window.
1.1 nicm 915: .It Xo Ic select-pane
916: .Op Fl p Ar pane-index
917: .Op Fl t Ar target-window
918: .Xc
919: .D1 (alias: Ic selectp )
920: Make pane
921: .Ar pane-index
922: the active pane in window
923: .Ar target-window .
924: .It Xo Ic select-prompt
925: .Op Fl t Ar target-client
926: .Xc
927: Open a prompt inside
928: .Ar target-client
929: allowing a window index to be entered interactively.
930: .It Xo Ic select-window
931: .Op Fl t Ar target-window
932: .Xc
933: .D1 (alias: Ic selectw )
934: Select the window at
935: .Ar target-window .
936: .It Xo Ic send-keys
937: .Op Fl t Ar target-window
938: .Ar key Ar ...
939: .Xc
940: .D1 (alias: Ic send )
941: Send a key or keys to a window.
942: Each argument
943: .Ar key
944: is the name of the key (such as
945: .Ql C-a
946: or
947: .Ql npage
948: ) to send; if the string is not recognised as a key, it is sent as a series of
949: characters.
950: All arguments are sent sequentially from first to last.
951: .It Xo Ic send-prefix
952: .Op Fl t Ar target-window
953: .Xc
954: Send the prefix key to a window as if it was pressed.
955: .It Xo Ic server-info
956: .Xc
957: .D1 (alias: Ic info )
958: Show server information and terminal details.
959: .It Xo Ic set-buffer
960: .Op Fl b Ar buffer-index
961: .Op Fl t Ar target-session
962: .Ar data
963: .Xc
964: .D1 (alias: Ic setb )
965: Set the contents of the specified buffer to
966: .Ar data .
967: .It Xo Ic set-option
968: .Op Fl gu
969: .Op Fl t Ar target-session
970: .Ar option Ar value
971: .Xc
972: .D1 (alias: Ic set )
973: Set an option.
974: If
975: .Fl g
976: is specified, the option is set as a global option.
977: Global options apply to all sessions which don't have the option explicitly
978: set.
979: If
980: .Fl g
981: is not used, the option applies only to
982: .Ar target-session .
983: The
984: .Fl u
985: flag unsets an option, so a session inherits the option from the global
986: options - it is not possible to unset a global option.
987: .Pp
988: Possible options are:
989: .Bl -tag -width Ds
990: .It Xo Ic bell-action
991: .Op Ic any | Ic none | Ic current
992: .Xc
993: Set action on window bell.
994: .Ic any
995: means a bell in any window linked to a session causes a bell in the current
996: window of that session,
997: .Ic none
998: means all bells are ignored and
999: .Ic current
1000: means only bell in windows other than the current window are ignored.
1001: .It Ic buffer-limit Ar number
1002: Set the number of buffers kept for each session; as new buffers are added to
1003: the top of the stack, old ones are removed from the bottom if necessary to
1004: maintain this maximum length.
1005: .It Ic default-command Ar command
1006: Set the command used for new windows (if not specified when the window is
1007: created) to
1008: .Ar command .
1009: The default is
1.3 pyr 1010: .Dq exec $SHELL -l .
1.1 nicm 1011: .It Ic default-path Ar path
1012: Set the default working directory for processes created from keys, or
1013: interactively from the prompt.
1014: The default is the current working directory when the server is started.
1015: .It Ic history-limit Ar lines
1016: Set the maximum number of lines held in window history.
1017: This setting applies only to new windows - existing window histories are not
1018: resized and retain the limit at the point they were created.
1019: .It Ic lock-after-time Ar number
1020: Lock the server after
1021: .Ar number
1022: seconds of inactivity.
1023: The default is off (set to 0).
1024: This has no effect as a session option; it must be set as a global option using
1025: .Fl g .
1026: .It Ic message-attr Ar attributes
1027: Set status line message attributes, where
1028: .Ar attributes
1029: is either
1030: .Ic default
1031: or a comma-delimited list of one or more of:
1032: .Ic bright
1033: (or
1034: .Ic bold ) ,
1035: .Ic dim ,
1036: .Ic underscore ,
1037: .Ic blink ,
1038: .Ic reverse ,
1039: .Ic hidden ,
1040: or
1041: .Ic italics .
1042: .It Ic message-bg Ar colour
1043: Set status line message background colour, where
1044: .Ar colour
1045: is one of:
1046: .Ic black ,
1047: .Ic red ,
1048: .Ic green ,
1049: .Ic yellow ,
1050: .Ic blue ,
1051: .Ic magenta ,
1052: .Ic cyan ,
1053: .Ic white
1054: or
1055: .Ic default .
1056: .It Ic message-fg Ar colour
1057: Set status line message foreground colour.
1058: .It Ic prefix Ar key
1059: Set the current prefix key.
1060: .It Ic repeat-time Ar number
1061: Allow multiple commands to be entered without pressing the prefix-key again
1062: in the specified
1063: .Ar number
1064: milliseconds (the default is 500).
1065: Whether a key repeats may be set when it is bound using the
1066: .Fl r
1067: flag to
1068: .Ic bind-key .
1069: Repeat is enabled for the default keys of the
1070: .Ic up-pane ,
1071: .Ic down-pane ,
1072: .Ic resize-pane-up ,
1073: and
1074: .Ic resize-pane-down
1075: commands.
1076: .It Xo Ic set-remain-on-exit
1077: .Op Ic on | Ic off
1078: .Xc
1079: Set the
1080: .Ic remain-on-exit
1081: window option for any windows first created in this session.
1082: .It Xo Ic set-titles
1083: .Op Ic on | Ic off
1084: .Xc
1085: Attempt to set the window title using the \ee]2;...\e007 xterm code and
1086: the terminal appears to be an xterm.
1087: This option is enabled by default.
1.6 jmc 1088: Note that elinks
1.1 nicm 1089: will only attempt to set the window title if the STY environment
1090: variable is set.
1091: .It Xo Ic status
1092: .Op Ic on | Ic off
1093: .Xc
1094: Show or hide the status line.
1095: .It Ic status-attr Ar attributes
1096: Set status line attributes.
1097: .It Ic status-bg Ar colour
1098: Set status line background colour.
1099: .It Ic status-fg Ar colour
1100: Set status line foreground colour.
1101: .It Ic status-interval Ar interval
1102: Update the status bar every
1103: .Ar interval
1104: seconds.
1105: By default, updates will occur every 15 seconds.
1106: A setting of zero disables redrawing at interval.
1107: .It Xo Ic status-keys
1108: .Op Ic vi | Ic emacs
1109: .Xc
1.6 jmc 1110: Use vi or emacs-style
1.1 nicm 1111: key bindings in the status line, for example at the command prompt.
1112: Defaults to emacs.
1113: .It Ic status-left Ar string
1114: Display
1115: .Ar string
1116: to the left of the status bar.
1117: .Ar string
1118: will be passed through
1119: .Xr strftime 3
1120: before being used.
1121: By default, the session name is shown.
1122: .Ar string
1123: may contain any of the following special character pairs:
1124: .Bl -column "Character pair" "Replaced with" -offset indent
1125: .It Sy "Character pair" Ta Sy "Replaced with"
1126: .It Li "#(command)" Ta "First line of command's output"
1127: .It Li "#H" Ta "Hostname of local host"
1128: .It Li "#S" Ta "Session name"
1129: .It Li "#T" Ta "Current window title"
1130: .It Li "##" Ta "A literal" Ql #
1131: .El
1132: .Pp
1133: Where appropriate, these may be prefixed with a number to specify the maximum
1134: length, for example
1135: .Ql #24T .
1136: .It Ic status-left-length Ar length
1137: Set the maximum
1138: .Ar length
1139: of the left component of the status bar.
1140: The default is 10.
1141: .It Ic status-right Ar string
1142: Display
1143: .Ar string
1144: to the right of the status bar.
1145: By default, the date and time will be shown.
1146: As with
1147: .Ic status-left ,
1148: .Ar string
1149: will be passed to
1150: .Xr strftime 3
1151: and character pairs are replaced.
1152: .It Ic status-right-length Ar length
1153: Set the maximum
1154: .Ar length
1155: of the right component of the status bar.
1156: The default is 40.
1157: .El
1158: .It Xo Ic set-password
1159: .Op Fl c
1160: .Ar password
1161: .Xc
1162: .D1 (alias: Ic pass )
1163: Set the server password.
1164: If the
1165: .Fl c
1166: option is given, a pre-encrypted password may be specified.
1167: By default, the password is blank, thus any entered password will be accepted
1168: when unlocking the server (see the
1169: .Ic lock-server
1170: command).
1171: To prevent variable expansion when an encrypted password is read from a
1172: configuration file, enclose it in single quotes (').
1173: .It Xo Ic set-window-option
1174: .Op Fl gu
1175: .Op Fl t Ar target-window
1176: .Ar option Ar value
1177: .Xc
1178: .D1 (alias: Ic setw )
1179: Set a window-specific option.
1180: The
1181: .Fl g
1182: and
1183: .Fl u
1184: flags work similarly to the
1185: .Ic set-option
1186: command.
1187: .Pp
1188: Supported options are:
1189: .Bl -tag -width Ds
1190: .It Xo Ic aggressive-resize
1191: .Op Ic on | Ic off
1192: .Xc
1193: Aggressively resize the chosen window.
1194: This means that
1195: .Nm
1196: will resize the window to the size of the smallest session for which it is the
1197: current window, rather than the smallest session to which it is attached.
1198: The window may resize when the current window is changed on another sessions;
1.6 jmc 1199: this option is good for full-screen programs which support
1200: .Dv SIGWINCH
1201: and poor for interactive programs such as shells.
1.1 nicm 1202: .It Xo Ic automatic-rename
1203: .Op Ic on | Ic off
1204: .Xc
1205: Control automatic window renaming.
1206: When this setting is enabled,
1207: .Nm
1208: will attempt - on supported platforms - to rename the window to reflect the
1209: command currently running in it.
1210: This flag is automatically disabled for an individual window when a name
1211: is specified at creation with
1212: .Ic new-window or
1213: .Ic new-session ,
1214: or later with
1215: .Ic rename-window .
1216: It may be switched off globally with:
1217: .Bd -literal -offset indent
1218: set-window-option -g automatic-rename off
1219: .Ed
1220: .It Ic clock-mode-colour Ar colour
1221: Set clock colour.
1222: .It Xo Ic clock-mode-style
1223: .Op Ic 12 | Ic 24
1224: .Xc
1225: Set clock hour format.
1226: .It Ic force-height Ar height
1227: .It Ic force-width Ar width
1228: Prevent
1229: .Nm
1230: from resizing a window to greater than
1231: .Ar width
1232: or
1233: .Ar height .
1234: A value of zero restores the default unlimited setting.
1.2 nicm 1235: .It Ic main-pane-width Ar width
1236: .It Ic main-pane-height Ar height
1237: Set the width or height of the main (left or top) pane in the
1238: .Ic main-horizontal
1239: or
1240: .Ic main-vertical
1241: layouts.
1.1 nicm 1242: .It Ic mode-attr Ar attributes
1243: Set window modes attributes.
1244: .It Ic mode-bg Ar colour
1245: Set window modes background colour.
1246: .It Ic mode-fg Ar colour
1247: Set window modes foreground colour.
1248: .It Xo Ic mode-keys
1249: .Op Ic vi | Ic emacs
1250: .Xc
1.6 jmc 1251: Use vi or emacs-style
1.1 nicm 1252: key bindings in scroll and copy modes.
1253: Key bindings default to emacs.
1254: .It Xo Ic monitor-activity
1255: .Op Ic on | Ic off
1256: .Xc
1257: Monitor for activity in the window.
1258: Windows with activity are highlighted in the status line.
1259: .It Xo Ic monitor-content Ar match-string
1260: .Xc
1.6 jmc 1261: Monitor content in the window.
1262: When
1.1 nicm 1263: .Ar match-string
1264: appears in the window, it is highlighted in the status line.
1265: .It Xo Ic remain-on-exit
1266: .Op Ic on | Ic off
1267: .Xc
1268: A window with this flag set is not destroyed when the program running in it
1269: exits.
1270: The window may be reactivated with the
1271: .Ic respawn-window
1272: command.
1273: .It Xo Ic utf8
1274: .Op Ic on | Ic off
1275: .Xc
1276: Instructs
1277: .Nm
1278: to expect UTF-8 sequences to appear in this window.
1279: .It Ic window-status-attr Ar attributes
1280: Set status line attributes for a single window.
1281: .It Ic window-status-bg Ar colour
1282: Set status line background colour for a single window.
1283: .It Ic window-status-fg Ar colour
1284: Set status line foreground colour for a single window.
1285: .It Xo Ic xterm-keys
1286: .Op Ic on | Ic off
1287: .Xc
1288: If this option is set,
1289: .Nm
1290: will generate
1291: .Xr xterm 1 -style
1292: function key sequences; these have a number included to indicate modifiers such
1.6 jmc 1293: as Shift, Alt or Ctrl.
1.1 nicm 1294: .El
1295: .It Xo Ic show-buffer
1296: .Op Fl b Ar buffer-index
1297: .Op Fl t Ar target-session
1298: .Xc
1299: .D1 (alias: Ic showb )
1300: Display the contents of the specified buffer.
1301: .It Xo Ic show-options
1302: .Op Fl t Ar target-session
1303: .Ar option Ar value
1304: .Xc
1305: .D1 (alias: Ic show )
1306: Show the currently set options.
1307: If a
1308: .Ar target-session
1309: is specified, the options for that session are shown; otherwise, the global
1310: options are listed.
1311: .It Xo Ic show-window-options
1312: .Op Fl t Ar target-window
1313: .Ar option Ar value
1314: .Xc
1315: .D1 (alias: Ic showw )
1316: List the current options for the given window.
1317: .It Xo Ic source-file
1318: .Ar path
1319: .Xc
1320: .D1 (alias: Ic source )
1321: Execute commands from
1322: .Ar path .
1323: .It Xo Ic split-window
1324: .Op Fl d
1325: .Oo Fl l
1326: .Ar lines |
1327: .Fl p Ar percentage Oc
1328: .Op Fl t Ar target-window
1329: .Op Ar command
1330: .Xc
1331: .D1 (alias: splitw )
1332: Creates a new window by splitting it vertically.
1333: The
1334: .Fl l
1335: and
1336: .Fl p
1337: options specify the size of the new window in lines, or as a percentage,
1338: respectively.
1339: All other options have the same meaning as in the
1340: .Ic new-window
1341: command.
1342: .Pp
1343: A few notes with regard to panes:
1344: .Bl -enum -compact
1345: .It
1346: If attempting to split a window with less than eight lines, an error will be
1347: shown.
1348: .It
1349: If the window is resized, as many panes are shown as can fit without reducing
1350: them below four lines.
1351: .It
1352: The minimum pane size is four lines (including the separator line).
1353: .It
1354: The panes are indexed from top (0) to bottom, with no numbers skipped.
1355: .El
1356: .It Xo Ic start-server
1357: .Xc
1358: .D1 (alias: Ic start )
1359: Start the
1360: .Nm
1361: server, if not already running, without creating any sessions.
1362: .It Xo Ic suspend-client
1363: .Op Fl c target-client
1364: .Xc
1365: .D1 (alias: Ic suspendc )
1.6 jmc 1366: Suspend a client by sending
1367: .Dv SIGTSTP
1368: (tty stop).
1.1 nicm 1369: .It Xo Ic swap-pane
1370: .Op Fl dDU
1371: .Op Fl p Ar src-index
1372: .Op Fl t Ar target-window
1373: .Op Fl q Ar dst-index
1374: .Xc
1375: .D1 (alias: Ic swapp )
1376: Swap two panes within a window.
1377: If
1378: .Fl U
1379: is used, the pane is swapped with the pane above (before it numerically);
1380: .Fl D
1381: swaps with the pane below (the next numerically); or
1382: .Ar dst-index
1383: may be give to swap with a specific pane.
1384: .It Xo Ic swap-window
1385: .Op Fl d
1386: .Op Fl s Ar src-window
1387: .Op Fl t Ar dst-window
1388: .Xc
1389: .D1 (alias: Ic swapw )
1390: This is similar to
1391: .Ic link-window ,
1392: except the source and destination windows are swapped.
1393: It is an error if no window exists at
1394: .Ar src-window .
1395: .It Xo Ic switch-client
1396: .Op Fl c Ar target-client Fl t Ar target-session
1397: .Xc
1398: .D1 (alias: Ic switchc )
1399: Switch the current session for client
1400: .Ar target-client
1401: to
1402: .Ar target-session .
1403: .It Xo Ic unbind-key
1404: .Ar key
1405: .Xc
1406: .D1 (alias: Ic unbind )
1407: Unbind the key bound to
1408: .Ar key .
1409: .It Xo Ic unlink-window
1410: .Op Fl t Ar target-window
1411: .Xc
1412: .D1 (alias: Ic unlinkw )
1413: Unlink
1414: .Ar target-window .
1415: A window may be unlinked only if it is linked to multiple sessions - windows may
1416: not be linked to no sessions.
1417: .It Xo Ic up-pane
1418: .Op Fl p Ar pane-index
1419: .Op Fl t Ar target-window
1420: .Xc
1421: .D1 (alias: Ic upp )
1422: Move up a pane.
1423: .El
1424: .Sh FILES
1.6 jmc 1425: .Bl -tag -width "~/.tmux.confXXX" -compact
1.1 nicm 1426: .It Pa ~/.tmux.conf
1.6 jmc 1427: Default
1.1 nicm 1428: .Nm
1.6 jmc 1429: configuration file.
1.1 nicm 1430: .El
1431: .Sh SEE ALSO
1432: .Xr pty 4
1433: .Sh AUTHORS
1434: .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