Annotation of src/usr.bin/tmux/tmux.1, Revision 1.516
1.516 ! nicm 1: .\" $OpenBSD: tmux.1,v 1.515 2016/11/24 13:38:44 nicm Exp $
1.1 nicm 2: .\"
1.477 nicm 3: .\" Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
1.1 nicm 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.516 ! nicm 17: .Dd $Mdocdate: November 24 2016 $
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.434 jmc 26: .Op Fl 2Cluv
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.
1.345 nicm 101: .It Fl C
1.369 nicm 102: Start in control mode (see the
103: .Sx CONTROL MODE
104: section).
1.345 nicm 105: Given twice
106: .Xo ( Fl CC ) Xc
107: disables echo.
1.91 nicm 108: .It Fl c Ar shell-command
109: Execute
110: .Ar shell-command
111: using the default shell.
112: If necessary, the
113: .Nm
114: server will be started to retrieve the
115: .Ic default-shell
116: option.
1.153 nicm 117: This option is for compatibility with
118: .Xr sh 1
119: when
120: .Nm
121: is used as a login shell.
1.1 nicm 122: .It Fl f Ar file
123: Specify an alternative configuration file.
124: By default,
125: .Nm
1.26 nicm 126: loads the system configuration file from
127: .Pa /etc/tmux.conf ,
128: if present, then looks for a user configuration file at
1.1 nicm 129: .Pa ~/.tmux.conf .
1.306 nicm 130: .Pp
1.1 nicm 131: The configuration file is a set of
132: .Nm
133: commands which are executed in sequence when the server is first started.
1.306 nicm 134: .Nm
135: loads configuration files once when the server process has started.
136: The
137: .Ic source-file
138: command may be used to load a file later.
1.61 nicm 139: .Pp
140: .Nm
1.306 nicm 141: shows any error messages from commands in configuration files in the first
142: session created, and continues to process the rest of the configuration file.
1.1 nicm 143: .It Fl L Ar socket-name
144: .Nm
145: stores the server socket in a directory under
1.455 nicm 146: .Ev TMUX_TMPDIR
147: or
1.208 nicm 148: .Pa /tmp
1.455 nicm 149: if it is unset.
1.355 nicm 150: The default socket is named
1.1 nicm 151: .Em default .
152: This option allows a different socket name to be specified, allowing several
153: independent
154: .Nm
155: servers to be run.
156: Unlike
157: .Fl S
158: a full path is not necessary: the sockets are all created in the same
159: directory.
1.2 nicm 160: .Pp
161: If the socket is accidentally removed, the
1.6 jmc 162: .Dv SIGUSR1
1.2 nicm 163: signal may be sent to the
164: .Nm
1.422 nicm 165: server process to recreate it (note that this will fail if any parent
166: directories are missing).
1.166 sobrado 167: .It Fl l
168: Behave as a login shell.
169: This flag currently has no effect and is for compatibility with other shells
170: when using tmux as a login shell.
1.1 nicm 171: .It Fl S Ar socket-path
172: Specify a full alternative path to the server socket.
173: If
174: .Fl S
175: is specified, the default socket directory is not used and any
176: .Fl L
177: flag is ignored.
178: .It Fl u
179: .Nm
1.14 nicm 180: attempts to guess if the terminal is likely to support UTF-8 by checking the
181: first of the
182: .Ev LC_ALL ,
183: .Ev LC_CTYPE
184: and
1.2 nicm 185: .Ev LANG
1.14 nicm 186: environment variables to be set for the string "UTF-8".
1.5 nicm 187: This is not always correct: the
1.2 nicm 188: .Fl u
189: flag explicitly informs
190: .Nm
1.6 jmc 191: that UTF-8 is supported.
1.33 nicm 192: .Pp
1.458 nicm 193: Note that
194: .Nm
1.459 jmc 195: itself always accepts UTF-8; this controls whether it will send UTF-8
196: characters to the terminal it is running (if not, they are replaced by
1.458 nicm 197: .Ql _ ) .
1.1 nicm 198: .It Fl v
199: Request verbose logging.
200: This option may be specified multiple times for increasing verbosity.
201: Log messages will be saved into
202: .Pa tmux-client-PID.log
203: and
204: .Pa tmux-server-PID.log
205: files in the current directory, where
206: .Em PID
1.6 jmc 207: is the PID of the server or client process.
1.1 nicm 208: .It Ar command Op Ar flags
209: This specifies one of a set of commands used to control
210: .Nm ,
1.6 jmc 211: as described in the following sections.
1.59 jmc 212: If no commands are specified, the
1.1 nicm 213: .Ic new-session
214: command is assumed.
1.57 jmc 215: .El
1.64 nicm 216: .Sh KEY BINDINGS
217: .Nm
218: may be controlled from an attached client by using a key combination of a
219: prefix key,
220: .Ql C-b
221: (Ctrl-b) by default, followed by a command key.
222: .Pp
1.172 nicm 223: The default command key bindings are:
1.64 nicm 224: .Pp
1.171 nicm 225: .Bl -tag -width "XXXXXXXXXX" -offset indent -compact
226: .It C-b
227: Send the prefix key (C-b) through to the application.
228: .It C-o
229: Rotate the panes in the current window forwards.
230: .It C-z
231: Suspend the
232: .Nm
233: client.
234: .It !
235: Break the current pane out of the window.
236: .It \&"
237: Split the current pane into two, top and bottom.
238: .It #
239: List all paste buffers.
1.236 nicm 240: .It $
241: Rename the current session.
1.171 nicm 242: .It %
243: Split the current pane into two, left and right.
244: .It &
245: Kill the current window.
246: .It '
247: Prompt for a window index to select.
1.412 nicm 248: .It \&(
249: Switch the attached client to the previous session.
250: .It \&)
251: Switch the attached client to the next session.
1.171 nicm 252: .It ,
253: Rename the current window.
254: .It -
255: Delete the most recently copied buffer of text.
256: .It .
257: Prompt for an index to move the current window.
258: .It 0 to 9
259: Select windows 0 to 9.
260: .It :
261: Enter the
262: .Nm
263: command prompt.
1.187 nicm 264: .It ;
265: Move to the previously active pane.
1.178 nicm 266: .It =
267: Choose which buffer to paste interactively from a list.
1.171 nicm 268: .It \&?
269: List all key bindings.
270: .It D
271: Choose a client to detach.
1.412 nicm 272: .It L
273: Switch the attached client back to the last session.
1.182 jmc 274: .It \&[
1.171 nicm 275: Enter copy mode to copy text or view the history.
1.182 jmc 276: .It \&]
1.171 nicm 277: Paste the most recently copied buffer of text.
1.64 nicm 278: .It c
1.65 nicm 279: Create a new window.
1.64 nicm 280: .It d
1.65 nicm 281: Detach the current client.
1.171 nicm 282: .It f
283: Prompt to search for text in open windows.
284: .It i
285: Display some information about the current window.
1.64 nicm 286: .It l
1.65 nicm 287: Move to the previously selected window.
1.64 nicm 288: .It n
1.65 nicm 289: Change to the next window.
1.171 nicm 290: .It o
291: Select the next pane in the current window.
1.64 nicm 292: .It p
1.65 nicm 293: Change to the previous window.
1.171 nicm 294: .It q
295: Briefly display pane indexes.
296: .It r
297: Force redraw of the attached client.
1.432 nicm 298: .It m
299: Mark the current pane (see
300: .Ic select-pane
301: .Fl m ) .
302: .It M
303: Clear the marked pane.
1.171 nicm 304: .It s
305: Select a new session for the attached client interactively.
306: .It t
307: Show the time.
308: .It w
309: Choose the current window interactively.
310: .It x
311: Kill the current pane.
1.412 nicm 312: .It z
313: Toggle zoom state of the current pane.
1.171 nicm 314: .It {
315: Swap the current pane with the previous pane.
316: .It }
317: Swap the current pane with the next pane.
318: .It ~
319: Show previous messages from
320: .Nm ,
321: if any.
322: .It Page Up
323: Enter copy mode and scroll one page up.
324: .It Up, Down
325: .It Left, Right
326: Change to the pane above, below, to the left, or to the right of the current
327: pane.
328: .It M-1 to M-5
329: Arrange panes in one of the five preset layouts: even-horizontal,
330: even-vertical, main-horizontal, main-vertical, or tiled.
1.412 nicm 331: .It Space
332: Arrange the current window in the next preset layout.
1.171 nicm 333: .It M-n
334: Move to the next window with a bell or activity marker.
335: .It M-o
336: Rotate the panes in the current window backwards.
337: .It M-p
338: Move to the previous window with a bell or activity marker.
339: .It C-Up, C-Down
340: .It C-Left, C-Right
341: Resize the current pane in steps of one cell.
342: .It M-Up, M-Down
343: .It M-Left, M-Right
344: Resize the current pane in steps of five cells.
1.64 nicm 345: .El
346: .Pp
347: Key bindings may be changed with the
348: .Ic bind-key
349: and
350: .Ic unbind-key
351: commands.
1.57 jmc 352: .Sh COMMANDS
353: This section contains a list of the commands supported by
354: .Nm .
355: Most commands accept the optional
356: .Fl t
1.432 nicm 357: (and sometimes
358: .Fl s )
1.57 jmc 359: argument with one of
360: .Ar target-client ,
361: .Ar target-session
362: .Ar target-window ,
363: or
364: .Ar target-pane .
365: These specify the client, session, window or pane which a command should affect.
1.423 nicm 366: .Pp
1.57 jmc 367: .Ar target-client
1.423 nicm 368: should be the name of the
1.57 jmc 369: .Xr pty 4
370: file to which the client is connected, for example either of
371: .Pa /dev/ttyp1
372: or
373: .Pa ttyp1
374: for the client attached to
375: .Pa /dev/ttyp1 .
1.423 nicm 376: If no client is specified,
377: .Nm
378: attempts to work out the client currently in use; if that fails, an error is
379: reported.
1.57 jmc 380: Clients may be listed with the
381: .Ic list-clients
382: command.
1.1 nicm 383: .Pp
1.57 jmc 384: .Ar target-session
1.423 nicm 385: is tried as, in order:
386: .Bl -enum -offset Ds
387: .It
388: A session ID prefixed with a $.
389: .It
390: An exact name of a session (as listed by the
1.57 jmc 391: .Ic list-sessions
1.423 nicm 392: command).
393: .It
394: The start of a session name, for example
395: .Ql mysess
396: would match a session named
397: .Ql mysession .
398: .It
399: An
1.57 jmc 400: .Xr fnmatch 3
1.423 nicm 401: pattern which is matched against the session name.
402: .El
403: .Pp
1.441 nicm 404: If the session name is prefixed with an
405: .Ql = ,
1.435 nicm 406: only an exact match is accepted (so
407: .Ql =mysess
408: will only match exactly
409: .Ql mysess ,
410: not
411: .Ql mysession ) .
1.441 nicm 412: .Pp
1.423 nicm 413: If a single session is found, it is used as the target session; multiple matches
1.57 jmc 414: produce an error.
415: If a session is omitted, the current session is used if available; if no
1.117 nicm 416: current session is available, the most recently used is chosen.
1.1 nicm 417: .Pp
1.57 jmc 418: .Ar target-window
1.472 nicm 419: (or
420: .Ar src-window
421: or
422: .Ar dst-window )
1.57 jmc 423: specifies a window in the form
424: .Em session Ns \&: Ns Em window .
425: .Em session
426: follows the same rules as for
427: .Ar target-session ,
428: and
429: .Em window
1.423 nicm 430: is looked for in order as:
431: .Bl -enum -offset Ds
432: .It
433: A special token, listed below.
434: .It
435: A window index, for example
436: .Ql mysession:1
437: is window 1 in session
438: .Ql mysession .
439: .It
440: A window ID, such as @1.
441: .It
442: An exact window name, such as
443: .Ql mysession:mywindow .
444: .It
445: The start of a window name, such as
446: .Ql mysession:mywin .
447: .It
448: As an
1.57 jmc 449: .Xr fnmatch 3
1.423 nicm 450: pattern matched against the window name.
451: .El
452: .Pp
1.435 nicm 453: Like sessions, a
454: .Ql =
455: prefix will do an exact match only.
1.57 jmc 456: An empty window name specifies the next unused index if appropriate (for
457: example the
458: .Ic new-window
459: and
460: .Ic link-window
461: commands)
462: otherwise the current window in
463: .Em session
464: is chosen.
1.423 nicm 465: .Pp
1.424 nicm 466: The following special tokens are available to indicate particular windows.
467: Each has a single-character alternative form.
1.423 nicm 468: .Bl -column "XXXXXXXXXX" "X"
469: .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
470: .It Li "{start}" Ta "^" Ta "The lowest-numbered window"
471: .It Li "{end}" Ta "$" Ta "The highest-numbered window"
472: .It Li "{last}" Ta "!" Ta "The last (previously current) window"
473: .It Li "{next}" Ta "+" Ta "The next window by number"
474: .It Li "{previous}" Ta "-" Ta "The previous window by number"
475: .El
1.1 nicm 476: .Pp
1.57 jmc 477: .Ar target-pane
1.472 nicm 478: (or
479: .Ar src-pane
480: or
481: .Ar dst-pane )
482: may be a pane ID or takes a similar form to
1.57 jmc 483: .Ar target-window
1.423 nicm 484: but with the optional addition of a period followed by a pane index or pane ID,
485: for example:
486: .Ql mysession:mywindow.1 .
1.57 jmc 487: If the pane index is omitted, the currently active pane in the specified
488: window is used.
1.423 nicm 489: The following special tokens are available for the pane index:
490: .Bl -column "XXXXXXXXXXXXXX" "X"
491: .It Sy "Token" Ta Sy "" Ta Sy "Meaning"
492: .It Li "{last}" Ta "!" Ta "The last (previously active) pane"
493: .It Li "{next}" Ta "+" Ta "The next pane by number"
494: .It Li "{previous}" Ta "-" Ta "The previous pane by number"
495: .It Li "{top}" Ta "" Ta "The top pane"
496: .It Li "{bottom}" Ta "" Ta "The bottom pane"
497: .It Li "{left}" Ta "" Ta "The leftmost pane"
498: .It Li "{right}" Ta "" Ta "The rightmost pane"
499: .It Li "{top-left}" Ta "" Ta "The top-left pane"
500: .It Li "{top-right}" Ta "" Ta "The top-right pane"
501: .It Li "{bottom-left}" Ta "" Ta "The bottom-left pane"
502: .It Li "{bottom-right}" Ta "" Ta "The bottom-right pane"
1.447 nicm 503: .It Li "{up-of}" Ta "" Ta "The pane above the active pane"
504: .It Li "{down-of}" Ta "" Ta "The pane below the active pane"
505: .It Li "{left-of}" Ta "" Ta "The pane to the left of the active pane"
506: .It Li "{right-of}" Ta "" Ta "The pane to the right of the active pane"
1.423 nicm 507: .El
1.177 nicm 508: .Pp
1.423 nicm 509: The tokens
1.177 nicm 510: .Ql +
511: and
512: .Ql -
513: may be followed by an offset, for example:
514: .Bd -literal -offset indent
515: select-window -t:+2
516: .Ed
517: .Pp
1.432 nicm 518: In addition,
519: .Em target-session ,
520: .Em target-window
521: or
522: .Em target-pane
523: may consist entirely of the token
524: .Ql {mouse}
525: (alternative form
526: .Ql = )
527: to specify the most recent mouse event
528: (see the
529: .Sx MOUSE SUPPORT
530: section)
531: or
532: .Ql {marked}
533: (alternative form
534: .Ql ~ )
535: to specify the marked pane (see
536: .Ic select-pane
537: .Fl m ) .
538: .Pp
1.423 nicm 539: Sessions, window and panes are each numbered with a unique ID; session IDs are
540: prefixed with a
541: .Ql $ ,
542: windows with a
543: .Ql @ ,
544: and panes with a
545: .Ql % .
546: These are unique and are unchanged for the life of the session, window or pane
547: in the
1.212 nicm 548: .Nm
1.423 nicm 549: server.
550: The pane ID is passed to the child process of the pane in the
1.212 nicm 551: .Ev TMUX_PANE
552: environment variable.
1.423 nicm 553: IDs may be displayed using the
554: .Ql session_id ,
555: .Ql window_id ,
556: or
557: .Ql pane_id
558: formats (see the
559: .Sx FORMATS
560: section) and the
561: .Ic display-message ,
562: .Ic list-sessions ,
563: .Ic list-windows
564: or
565: .Ic list-panes
566: commands.
1.15 jmc 567: .Pp
1.153 nicm 568: .Ar shell-command
569: arguments are
570: .Xr sh 1
571: commands.
1.394 nicm 572: This may be a single argument passed to the shell, for example:
1.153 nicm 573: .Bd -literal -offset indent
574: new-window 'vi /etc/passwd'
575: .Ed
1.394 nicm 576: .Pp
577: Will run:
578: .Bd -literal -offset indent
579: /bin/sh -c 'vi /etc/passwd'
580: .Ed
581: .Pp
582: Additionally, the
583: .Ic new-window ,
584: .Ic new-session ,
585: .Ic split-window ,
586: .Ic respawn-window
587: and
588: .Ic respawn-pane
589: commands allow
590: .Ar shell-command
591: to be given as multiple arguments and executed directly (without
592: .Ql sh -c ) .
593: This can avoid issues with shell quoting.
594: For example:
595: .Bd -literal -offset indent
596: $ tmux new-window vi /etc/passwd
597: .Ed
598: .Pp
599: Will run
600: .Xr vi 1
601: directly without invoking the shell.
1.153 nicm 602: .Pp
603: .Ar command
604: .Op Ar arguments
605: refers to a
606: .Nm
607: command, passed with the command and arguments separately, for example:
608: .Bd -literal -offset indent
609: bind-key F1 set-window-option force-width 81
610: .Ed
611: .Pp
612: Or if using
613: .Xr sh 1 :
614: .Bd -literal -offset indent
615: $ tmux bind-key F1 set-window-option force-width 81
616: .Ed
617: .Pp
1.57 jmc 618: Multiple commands may be specified together as part of a
619: .Em command sequence .
620: Each command should be separated by spaces and a semicolon;
1.244 nicm 621: commands are executed sequentially from left to right and
1.293 nicm 622: lines ending with a backslash continue on to the next line,
623: except when escaped by another backslash.
1.57 jmc 624: A literal semicolon may be included by escaping it with a backslash (for
625: example, when specifying a command sequence to
626: .Ic bind-key ) .
1.13 nicm 627: .Pp
1.153 nicm 628: Example
629: .Nm
630: commands include:
1.13 nicm 631: .Bd -literal -offset indent
1.57 jmc 632: refresh-client -t/dev/ttyp2
633:
634: rename-session -tfirst newname
635:
636: set-window-option -t:0 monitor-activity on
637:
638: new-window ; split-window -d
1.244 nicm 639:
640: bind-key R source-file ~/.tmux.conf \e; \e
641: display-message "source-file done"
1.13 nicm 642: .Ed
1.153 nicm 643: .Pp
644: Or from
645: .Xr sh 1 :
646: .Bd -literal -offset indent
647: $ tmux kill-window -t :1
648:
1.159 jmc 649: $ tmux new-window \e; split-window -d
1.153 nicm 650:
1.159 jmc 651: $ tmux new-session -d 'vi /etc/passwd' \e; split-window -d \e; attach
1.153 nicm 652: .Ed
1.57 jmc 653: .Sh CLIENTS AND SESSIONS
1.153 nicm 654: The
655: .Nm
656: server manages clients, sessions, windows and panes.
657: Clients are attached to sessions to interact with them, either
658: when they are created with the
659: .Ic new-session
660: command, or later with the
661: .Ic attach-session
662: command.
1.188 nicm 663: Each session has one or more windows
1.153 nicm 664: .Em linked
665: into it.
666: Windows may be linked to multiple sessions and are made up of one or
667: more panes,
668: each of which contains a pseudo terminal.
669: Commands for creating, linking and otherwise manipulating windows
670: are covered
671: in the
672: .Sx WINDOWS AND PANES
673: section.
674: .Pp
675: The following commands are available to manage clients and sessions:
1.57 jmc 676: .Bl -tag -width Ds
677: .It Xo Ic attach-session
1.436 nicm 678: .Op Fl dEr
1.372 nicm 679: .Op Fl c Ar working-directory
1.57 jmc 680: .Op Fl t Ar target-session
681: .Xc
682: .D1 (alias: Ic attach )
683: If run from outside
684: .Nm ,
685: create a new client in the current terminal and attach it to
686: .Ar target-session .
687: If used from inside, switch the current client.
688: If
689: .Fl d
690: is specified, any other clients attached to the session are detached.
1.148 nicm 691: .Fl r
692: signifies the client is read-only (only keys bound to the
693: .Ic detach-client
1.242 nicm 694: or
695: .Ic switch-client
696: commands have any effect)
1.13 nicm 697: .Pp
1.57 jmc 698: If no server is started,
699: .Ic attach-session
700: will attempt to start it; this will fail unless sessions are created in the
701: configuration file.
1.217 nicm 702: .Pp
703: The
704: .Ar target-session
705: rules for
706: .Ic attach-session
707: are slightly adjusted: if
708: .Nm
709: needs to select the most recently used session, it will prefer the most
710: recently used
711: .Em unattached
712: session.
1.372 nicm 713: .Pp
714: .Fl c
715: will set the session working directory (used for new windows) to
716: .Ar working-directory .
1.436 nicm 717: .Pp
718: If
719: .Fl E
1.480 nicm 720: is used, the
1.436 nicm 721: .Ic update-environment
722: option will not be applied.
1.211 nicm 723: .It Xo Ic detach-client
1.463 nicm 724: .Op Fl aP
1.219 nicm 725: .Op Fl s Ar target-session
1.211 nicm 726: .Op Fl t Ar target-client
727: .Xc
1.57 jmc 728: .D1 (alias: Ic detach )
1.218 nicm 729: Detach the current client if bound to a key, the client specified with
730: .Fl t ,
1.258 jmc 731: or all clients currently attached to the session specified by
1.218 nicm 732: .Fl s .
1.296 nicm 733: The
734: .Fl a
735: option kills all but the client given with
736: .Fl t .
1.211 nicm 737: If
738: .Fl P
739: is given, send SIGHUP to the parent process of the client, typically causing it
740: to exit.
1.57 jmc 741: .It Ic has-session Op Fl t Ar target-session
742: .D1 (alias: Ic has )
743: Report an error and exit with 1 if the specified session does not exist.
744: If it does exist, exit with 0.
745: .It Ic kill-server
746: Kill the
1.1 nicm 747: .Nm
1.57 jmc 748: server and clients and destroy all sessions.
1.369 nicm 749: .It Xo Ic kill-session
1.464 nicm 750: .Op Fl aC
1.297 nicm 751: .Op Fl t Ar target-session
1.369 nicm 752: .Xc
1.57 jmc 753: Destroy the given session, closing any windows linked to it and no other
754: sessions, and detaching all clients attached to it.
1.297 nicm 755: If
756: .Fl a
757: is given, all sessions but the specified one is killed.
1.464 nicm 758: The
759: .Fl C
1.467 nicm 760: flag clears alerts (bell, activity, or silence) in all windows linked to the
1.464 nicm 761: session.
1.250 nicm 762: .It Xo Ic list-clients
763: .Op Fl F Ar format
764: .Op Fl t Ar target-session
765: .Xc
1.57 jmc 766: .D1 (alias: Ic lsc )
1.221 jmc 767: List all clients attached to the server.
1.250 nicm 768: For the meaning of the
769: .Fl F
770: flag, see the
1.252 jmc 771: .Sx FORMATS
772: section.
1.221 jmc 773: If
1.220 nicm 774: .Ar target-session
775: is specified, list only clients connected to that session.
1.489 nicm 776: .It Xo Ic list-commands
777: .Op Fl F Ar format
778: .Xc
1.57 jmc 779: .D1 (alias: Ic lscm )
780: List the syntax of all commands supported by
781: .Nm .
1.247 nicm 782: .It Ic list-sessions Op Fl F Ar format
1.57 jmc 783: .D1 (alias: Ic ls )
784: List all sessions managed by the server.
1.247 nicm 785: For the meaning of the
786: .Fl F
787: flag, see the
788: .Sx FORMATS
789: section.
1.175 nicm 790: .It Ic lock-client Op Fl t Ar target-client
791: .D1 (alias: Ic lockc )
1.92 nicm 792: Lock
793: .Ar target-client ,
794: see the
795: .Ic lock-server
796: command.
1.175 nicm 797: .It Ic lock-session Op Fl t Ar target-session
798: .D1 (alias: Ic locks )
1.92 nicm 799: Lock all clients attached to
800: .Ar target-session .
1.57 jmc 801: .It Xo Ic new-session
1.436 nicm 802: .Op Fl AdDEP
1.371 nicm 803: .Op Fl c Ar start-directory
1.351 nicm 804: .Op Fl F Ar format
1.57 jmc 805: .Op Fl n Ar window-name
806: .Op Fl s Ar session-name
1.101 nicm 807: .Op Fl t Ar target-session
1.210 nicm 808: .Op Fl x Ar width
809: .Op Fl y Ar height
1.153 nicm 810: .Op Ar shell-command
1.57 jmc 811: .Xc
812: .D1 (alias: Ic new )
813: Create a new session with name
814: .Ar session-name .
1.153 nicm 815: .Pp
1.57 jmc 816: The new session is attached to the current terminal unless
817: .Fl d
818: is given.
819: .Ar window-name
1.1 nicm 820: and
1.153 nicm 821: .Ar shell-command
822: are the name of and shell command to execute in the initial window.
1.210 nicm 823: If
824: .Fl d
825: is used,
826: .Fl x
827: and
828: .Fl y
829: specify the size of the initial window (80 by 24 if not given).
1.68 nicm 830: .Pp
831: If run from a terminal, any
832: .Xr termios 4
833: special characters are saved and used for new windows in the new session.
1.338 nicm 834: .Pp
835: The
836: .Fl A
837: flag makes
838: .Ic new-session
839: behave like
840: .Ic attach-session
841: if
842: .Ar session-name
1.416 nicm 843: already exists; in this case,
1.338 nicm 844: .Fl D
845: behaves like
846: .Fl d
847: to
848: .Ic attach-session .
1.101 nicm 849: .Pp
850: If
851: .Fl t
852: is given, the new session is
853: .Em grouped
854: with
855: .Ar target-session .
856: This means they share the same set of windows - all windows from
857: .Ar target-session
1.480 nicm 858: are linked to the new session, any new windows are linked to both sessions and
859: any windows closed removed from both sessions.
1.101 nicm 860: The current and previous window and any session options remain independent and
861: either session may be killed without affecting the other.
862: .Fl n
1.480 nicm 863: and
1.153 nicm 864: .Ar shell-command
1.101 nicm 865: are invalid if
866: .Fl t
867: is used.
1.351 nicm 868: .Pp
869: The
870: .Fl P
871: option prints information about the new session after it has been created.
872: By default, it uses the format
873: .Ql #{session_name}:
874: but a different format may be specified with
875: .Fl F .
1.436 nicm 876: .Pp
877: If
878: .Fl E
1.480 nicm 879: is used, the
1.436 nicm 880: .Ic update-environment
881: option will not be applied.
1.248 nicm 882: .It Xo Ic refresh-client
883: .Op Fl S
884: .Op Fl t Ar target-client
885: .Xc
1.57 jmc 886: .D1 (alias: Ic refresh )
887: Refresh the current client if bound to a key, or a single client if one is given
888: with
889: .Fl t .
1.248 nicm 890: If
891: .Fl S
892: is specified, only update the client's status bar.
1.57 jmc 893: .It Xo Ic rename-session
894: .Op Fl t Ar target-session
895: .Ar new-name
896: .Xc
897: .D1 (alias: Ic rename )
898: Rename the session to
899: .Ar new-name .
1.121 nicm 900: .It Xo Ic show-messages
1.465 nicm 901: .Op Fl JT
1.120 nicm 902: .Op Fl t Ar target-client
903: .Xc
904: .D1 (alias: Ic showmsgs )
1.377 nicm 905: Show client messages or server information.
1.120 nicm 906: Any messages displayed on the status line are saved in a per-client message
907: log, up to a maximum of the limit set by the
908: .Ar message-limit
1.384 nicm 909: server option.
1.377 nicm 910: With
911: .Fl t ,
912: display the log for
1.120 nicm 913: .Ar target-client .
1.377 nicm 914: .Fl J
915: and
916: .Fl T
1.465 nicm 917: show debugging information about jobs and terminals.
1.488 tim 918: .It Xo Ic source-file
919: .Op Fl q
920: .Ar path
921: .Xc
1.57 jmc 922: .D1 (alias: Ic source )
923: Execute commands from
924: .Ar path .
1.488 tim 925: If
926: .Fl q
927: is given, no error will be returned if
928: .Ar path
929: does not exist.
1.57 jmc 930: .It Ic start-server
931: .D1 (alias: Ic start )
932: Start the
1.1 nicm 933: .Nm
1.57 jmc 934: server, if not already running, without creating any sessions.
935: .It Xo Ic suspend-client
1.202 nicm 936: .Op Fl t Ar target-client
1.57 jmc 937: .Xc
938: .D1 (alias: Ic suspendc )
939: Suspend a client by sending
940: .Dv SIGTSTP
941: (tty stop).
942: .It Xo Ic switch-client
1.436 nicm 943: .Op Fl Elnpr
1.57 jmc 944: .Op Fl c Ar target-client
945: .Op Fl t Ar target-session
1.421 nicm 946: .Op Fl T Ar key-table
1.57 jmc 947: .Xc
948: .D1 (alias: Ic switchc )
949: Switch the current session for client
950: .Ar target-client
951: to
952: .Ar target-session .
1.183 nicm 953: If
1.197 jmc 954: .Fl l ,
1.183 nicm 955: .Fl n
956: or
957: .Fl p
1.194 nicm 958: is used, the client is moved to the last, next or previous session
959: respectively.
1.242 nicm 960: .Fl r
961: toggles whether a client is read-only (see the
962: .Ic attach-session
963: command).
1.436 nicm 964: .Pp
965: If
966: .Fl E
967: is used,
968: .Ic update-environment
969: option will not be applied.
1.421 nicm 970: .Pp
971: .Fl T
972: sets the client's key table; the next key from the client will be interpreted from
973: .Ar key-table .
974: This may be used to configure multiple prefix keys, or to bind commands to
975: sequences of keys.
976: For example, to make typing
977: .Ql abc
978: run the
979: .Ic list-keys
980: command:
981: .Bd -literal -offset indent
982: bind-key -Ttable2 c list-keys
983: bind-key -Ttable1 b switch-client -Ttable2
984: bind-key -Troot a switch-client -Ttable1
985: .Ed
1.57 jmc 986: .El
987: .Sh WINDOWS AND PANES
1.1 nicm 988: A
989: .Nm
1.493 nicm 990: window may be in one of two modes.
1.1 nicm 991: The default permits direct access to the terminal attached to the window.
1.164 nicm 992: The other is copy mode, which permits a section of a window or its
993: history to be copied to a
1.1 nicm 994: .Em paste buffer
995: for later insertion into another window.
996: This mode is entered with the
997: .Ic copy-mode
998: command, bound to
1.113 nicm 999: .Ql \&[
1.1 nicm 1000: by default.
1.164 nicm 1001: It is also entered when a command that produces output, such as
1002: .Ic list-keys ,
1003: is executed from a key binding.
1.1 nicm 1004: .Pp
1.497 nicm 1005: Commands are sent to copy mode using the
1006: .Fl X
1007: flag to the
1008: .Ic send-keys
1009: command.
1010: When a key is pressed, copy mode automatically uses one of two key tables,
1011: depending on the
1.1 nicm 1012: .Ic mode-keys
1.497 nicm 1013: option:
1014: .Ic copy-mode
1015: for emacs, or
1016: .Ic copy-mode-vi
1017: for vi.
1018: Key tables may be viewed with the
1019: .Ic list-keys
1020: command.
1021: .Pp
1022: The following commands are supported in copy mode:
1023: .Bl -column "CommandXXXXXXXXXXXXXXXXX" "viXXXXXXXXXX" "emacs" -offset indent
1024: .It Sy "Command" Ta Sy "vi" Ta Sy "emacs"
1025: .It Li "append-selection" Ta "" Ta ""
1026: .It Li "append-selection-and-cancel" Ta "A" Ta ""
1027: .It Li "back-to-indentation" Ta "^" Ta "M-m"
1028: .It Li "begin-selection" Ta "Space" Ta "C-Space"
1029: .It Li "bottom-line" Ta "L" Ta ""
1030: .It Li "cancel" Ta "q" Ta "Escape"
1031: .It Li "clear-selection" Ta "Escape" Ta "C-g"
1032: .It Li "copy-end-of-line" Ta "D" Ta "C-k"
1033: .It Li "copy-line" Ta "" Ta ""
1034: .It Li "copy-pipe <command>" Ta "" Ta ""
1.514 nicm 1035: .It Li "copy-pipe-and-cancel <command>" Ta "" Ta ""
1.497 nicm 1036: .It Li "copy-selection" Ta "" Ta ""
1037: .It Li "copy-selection-and-cancel" Ta "Enter" Ta "M-w"
1038: .It Li "cursor-down" Ta "j" Ta "Down"
1039: .It Li "cursor-left" Ta "h" Ta "Left"
1040: .It Li "cursor-right" Ta "l" Ta "Right"
1041: .It Li "cursor-up" Ta "k" Ta "Up"
1042: .It Li "end-of-line" Ta "$" Ta "C-e"
1043: .It Li "goto-line <line>" Ta ":" Ta "g"
1044: .It Li "halfpage-down" Ta "C-d" Ta "M-Down"
1045: .It Li "halfpage-up" Ta "C-u" Ta "M-Up"
1046: .It Li "history-bottom" Ta "G" Ta "M-<"
1047: .It Li "history-top" Ta "g" Ta "M->"
1048: .It Li "jump-again" Ta ";" Ta ";"
1049: .It Li "jump-backward <to>" Ta "F" Ta "F"
1050: .It Li "jump-forward <to>" Ta "f" Ta "f"
1051: .It Li "jump-reverse" Ta "," Ta ","
1052: .It Li "jump-to-backward <to>" Ta "T" Ta ""
1053: .It Li "jump-to-forward <to>" Ta "t" Ta ""
1054: .It Li "middle-line" Ta "M" Ta "M-r"
1055: .It Li "next-paragraph" Ta "}" Ta "M-}"
1056: .It Li "next-space" Ta "W" Ta ""
1057: .It Li "next-space-end" Ta "E" Ta ""
1058: .It Li "next-word" Ta "w" Ta ""
1059: .It Li "next-word-end" Ta "e" Ta "M-f"
1060: .It Li "other-end" Ta "o" Ta ""
1061: .It Li "page-down" Ta "C-f" Ta "PageDown"
1062: .It Li "page-up" Ta "C-b" Ta "PageUp"
1063: .It Li "previous-paragraph" Ta "{" Ta "M-{"
1064: .It Li "previous-space" Ta "B" Ta ""
1065: .It Li "previous-word" Ta "b" Ta "M-b"
1066: .It Li "rectangle-toggle" Ta "v" Ta "R"
1067: .It Li "scroll-down" Ta "C-e" Ta "C-Down"
1068: .It Li "scroll-up" Ta "C-y" Ta "C-Up"
1069: .It Li "search-again" Ta "n" Ta "n"
1070: .It Li "search-backward <for>" Ta "?" Ta "C-r"
1071: .It Li "search-forward <for>" Ta "/" Ta "C-s"
1072: .It Li "search-reverse" Ta "N" Ta "N"
1073: .It Li "select-line" Ta "V" Ta ""
1074: .It Li "start-of-line" Ta "0" Ta "C-a"
1.515 nicm 1075: .It Li "stop-selection" Ta "" Ta ""
1.497 nicm 1076: .It Li "top-line" Ta "H" Ta "M-R"
1.1 nicm 1077: .El
1.146 nicm 1078: .Pp
1079: The next and previous word keys use space and the
1080: .Ql - ,
1.154 nicm 1081: .Ql _
1.146 nicm 1082: and
1083: .Ql @
1.154 nicm 1084: characters as word delimiters by default, but this can be adjusted by
1085: setting the
1086: .Em word-separators
1.255 nicm 1087: session option.
1.146 nicm 1088: Next word moves to the start of the next word, next word end to the end of the
1089: next word and previous word to the start of the previous word.
1090: The three next and previous space keys work similarly but use a space alone as
1091: the word separator.
1.157 nicm 1092: .Pp
1093: The jump commands enable quick movement within a line.
1094: For instance, typing
1095: .Ql f
1096: followed by
1097: .Ql /
1098: will move the cursor to the next
1099: .Ql /
1100: character on the current line.
1101: A
1102: .Ql \&;
1103: will then jump to the next occurrence.
1.1 nicm 1104: .Pp
1.155 nicm 1105: Commands in copy mode may be prefaced by an optional repeat count.
1106: With vi key bindings, a prefix is entered using the number keys; with
1107: emacs, the Alt (meta) key and a number begins prefix entry.
1108: .Pp
1.500 nicm 1109: Mode key bindings are defined in two tables:
1.48 nicm 1110: .Em vi-choice
1111: and
1112: .Em emacs-choice
1113: for keys used when choosing from lists (such as produced by the
1.144 nicm 1114: .Ic choose-window
1.497 nicm 1115: command).
1.57 jmc 1116: .Pp
1.164 nicm 1117: The synopsis for the
1118: .Ic copy-mode
1119: command is:
1.57 jmc 1120: .Bl -tag -width Ds
1121: .It Xo Ic copy-mode
1.450 nicm 1122: .Op Fl Meu
1.72 nicm 1123: .Op Fl t Ar target-pane
1.57 jmc 1124: .Xc
1125: Enter copy mode.
1126: The
1127: .Fl u
1128: option scrolls one page up.
1.419 nicm 1129: .Fl M
1130: begins a mouse drag (only valid if bound to a mouse key binding, see
1.420 jmc 1131: .Sx MOUSE SUPPORT ) .
1.450 nicm 1132: .Fl e
1133: specifies that scrolling to the bottom of the history (to the visible screen)
1134: should exit copy mode.
1135: While in copy mode, pressing a key other than those used for scrolling will
1136: disable this behaviour.
1137: This is intended to allow fast scrolling through a pane's history, for
1138: example with:
1139: .Bd -literal -offset indent
1140: bind PageUp copy-mode -eu
1141: .Ed
1.57 jmc 1142: .El
1.18 nicm 1143: .Pp
1.1 nicm 1144: Each window displayed by
1145: .Nm
1146: may be split into one or more
1147: .Em panes ;
1148: each pane takes up a certain area of the display and is a separate terminal.
1149: A window may be split into panes using the
1150: .Ic split-window
1151: command.
1.38 nicm 1152: Windows may be split horizontally (with the
1153: .Fl h
1154: flag) or vertically.
1155: Panes may be resized with the
1156: .Ic resize-pane
1.1 nicm 1157: command (bound to
1.38 nicm 1158: .Ql C-up ,
1159: .Ql C-down
1160: .Ql C-left
1161: and
1162: .Ql C-right
1.1 nicm 1163: by default), the current pane may be changed with the
1.156 nicm 1164: .Ic select-pane
1165: command and the
1.1 nicm 1166: .Ic rotate-window
1167: and
1168: .Ic swap-pane
1.38 nicm 1169: commands may be used to swap panes without changing their position.
1170: Panes are numbered beginning from zero in the order they are created.
1171: .Pp
1172: A number of preset
1173: .Em layouts
1174: are available.
1175: These may be selected with the
1176: .Ic select-layout
1177: command or cycled with
1178: .Ic next-layout
1179: (bound to
1.149 nicm 1180: .Ql Space
1.131 nicm 1181: by default); once a layout is chosen, panes within it may be moved and resized
1182: as normal.
1.1 nicm 1183: .Pp
1184: The following layouts are supported:
1185: .Bl -tag -width Ds
1186: .It Ic even-horizontal
1187: Panes are spread out evenly from left to right across the window.
1188: .It Ic even-vertical
1189: Panes are spread evenly from top to bottom.
1.2 nicm 1190: .It Ic main-horizontal
1.131 nicm 1191: A large (main) pane is shown at the top of the window and the remaining panes
1192: are spread from left to right in the leftover space at the bottom.
1.2 nicm 1193: Use the
1194: .Em main-pane-height
1195: window option to specify the height of the top pane.
1.1 nicm 1196: .It Ic main-vertical
1.2 nicm 1197: Similar to
1198: .Ic main-horizontal
1199: but the large pane is placed on the left and the others spread from top to
1200: bottom along the right.
1201: See the
1202: .Em main-pane-width
1203: window option.
1.165 nicm 1204: .It Ic tiled
1205: Panes are spread out as evenly as possible over the window in both rows and
1206: columns.
1.1 nicm 1207: .El
1.8 nicm 1208: .Pp
1.181 nicm 1209: In addition,
1210: .Ic select-layout
1211: may be used to apply a previously used layout - the
1212: .Ic list-windows
1213: command displays the layout of each window in a form suitable for use with
1214: .Ic select-layout .
1215: For example:
1216: .Bd -literal -offset indent
1217: $ tmux list-windows
1218: 0: ksh [159x48]
1219: layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1220: $ tmux select-layout bb62,159x48,0,0{79x48,0,0,79x48,80,0}
1221: .Ed
1.196 nicm 1222: .Pp
1.181 nicm 1223: .Nm
1224: automatically adjusts the size of the layout for the current window size.
1225: Note that a layout cannot be applied to a window with more panes than that
1226: from which the layout was originally defined.
1227: .Pp
1.57 jmc 1228: Commands related to windows and panes are as follows:
1229: .Bl -tag -width Ds
1230: .It Xo Ic break-pane
1.280 nicm 1231: .Op Fl dP
1232: .Op Fl F Ar format
1.440 nicm 1233: .Op Fl s Ar src-pane
1.480 nicm 1234: .Op Fl t Ar dst-window
1.57 jmc 1235: .Xc
1236: .D1 (alias: Ic breakp )
1237: Break
1.440 nicm 1238: .Ar src-pane
1239: off from its containing window to make it the only pane in
1240: .Ar dst-window .
1.57 jmc 1241: If
1242: .Fl d
1243: is given, the new window does not become the current window.
1.280 nicm 1244: The
1245: .Fl P
1246: option prints information about the new window after it has been created.
1247: By default, it uses the format
1248: .Ql #{session_name}:#{window_index}
1249: but a different format may be specified with
1250: .Fl F .
1.128 nicm 1251: .It Xo Ic capture-pane
1.506 nicm 1252: .Op Fl aepPqCJ
1.392 nicm 1253: .Op Fl b Ar buffer-name
1.213 nicm 1254: .Op Fl E Ar end-line
1255: .Op Fl S Ar start-line
1.128 nicm 1256: .Op Fl t Ar target-pane
1257: .Xc
1258: .D1 (alias: Ic capturep )
1.322 nicm 1259: Capture the contents of a pane.
1260: If
1261: .Fl p
1.325 nicm 1262: is given, the output goes to stdout, otherwise to the buffer specified with
1.322 nicm 1263: .Fl b
1264: or a new buffer if omitted.
1.339 nicm 1265: If
1266: .Fl a
1267: is given, the alternate screen is used, and the history is not accessible.
1.340 nicm 1268: If no alternate screen exists, an error will be returned unless
1269: .Fl q
1270: is given.
1.326 nicm 1271: If
1272: .Fl e
1.328 nicm 1273: is given, the output includes escape sequences for text and background
1274: attributes.
1275: .Fl C
1.330 nicm 1276: also escapes non-printable characters as octal \exxx.
1.328 nicm 1277: .Fl J
1.341 nicm 1278: joins wrapped lines and preserves trailing spaces at each line's end.
1.346 nicm 1279: .Fl P
1280: captures only any output that the pane has received that is the beginning of an
1281: as-yet incomplete escape sequence.
1.213 nicm 1282: .Pp
1283: .Fl S
1284: and
1285: .Fl E
1286: specify the starting and ending line numbers, zero is the first line of the
1287: visible pane and negative numbers are lines in the history.
1.397 nicm 1288: .Ql -
1289: to
1290: .Fl S
1291: is the start of the history and to
1292: .Fl E
1293: the end of the visible pane.
1.213 nicm 1294: The default is to capture only the visible contents of the pane.
1.76 nicm 1295: .It Xo
1296: .Ic choose-client
1.294 nicm 1297: .Op Fl F Ar format
1.76 nicm 1298: .Op Fl t Ar target-window
1299: .Op Ar template
1300: .Xc
1301: Put a window into client choice mode, allowing a client to be selected
1302: interactively from a list.
1303: After a client is chosen,
1304: .Ql %%
1305: is replaced by the client
1306: .Xr pty 4
1307: path in
1308: .Ar template
1309: and the result executed as a command.
1310: If
1311: .Ar template
1312: is not given, "detach-client -t '%%'" is used.
1.294 nicm 1313: For the meaning of the
1314: .Fl F
1315: flag, see the
1316: .Sx FORMATS
1317: section.
1.314 nicm 1318: This command works only if at least one client is attached.
1.76 nicm 1319: .It Xo
1320: .Ic choose-session
1.294 nicm 1321: .Op Fl F Ar format
1.76 nicm 1322: .Op Fl t Ar target-window
1323: .Op Ar template
1324: .Xc
1325: Put a window into session choice mode, where a session may be selected
1326: interactively from a list.
1327: When one is chosen,
1328: .Ql %%
1329: is replaced by the session name in
1330: .Ar template
1331: and the result executed as a command.
1332: If
1333: .Ar template
1334: is not given, "switch-client -t '%%'" is used.
1.294 nicm 1335: For the meaning of the
1336: .Fl F
1337: flag, see the
1338: .Sx FORMATS
1339: section.
1.314 nicm 1340: This command works only if at least one client is attached.
1.298 nicm 1341: .It Xo
1342: .Ic choose-tree
1.319 nicm 1343: .Op Fl suw
1.298 nicm 1344: .Op Fl b Ar session-template
1345: .Op Fl c Ar window-template
1346: .Op Fl S Ar format
1347: .Op Fl W Ar format
1348: .Op Fl t Ar target-window
1349: .Xc
1350: Put a window into tree choice mode, where either sessions or windows may be
1351: selected interactively from a list.
1352: By default, windows belonging to a session are indented to show their
1353: relationship to a session.
1354: .Pp
1355: Note that the
1356: .Ic choose-window
1357: and
1358: .Ic choose-session
1359: commands are wrappers around
1360: .Ic choose-tree .
1361: .Pp
1362: If
1363: .Fl s
1364: is given, will show sessions.
1365: If
1366: .Fl w
1367: is given, will show windows.
1.320 nicm 1368: .Pp
1369: By default, the tree is collapsed and sessions must be expanded to windows
1370: with the right arrow key.
1371: The
1.309 nicm 1372: .Fl u
1.321 jmc 1373: option will start with all sessions expanded instead.
1.320 nicm 1374: .Pp
1.298 nicm 1375: If
1376: .Fl b
1377: is given, will override the default session command.
1378: Note that
1379: .Ql %%
1.320 nicm 1380: can be used and will be replaced with the session name.
1.298 nicm 1381: The default option if not specified is "switch-client -t '%%'".
1382: If
1383: .Fl c
1384: is given, will override the default window command.
1.320 nicm 1385: Like
1386: .Fl b ,
1.298 nicm 1387: .Ql %%
1.320 nicm 1388: can be used and will be replaced with the session name and window index.
1389: When a window is chosen from the list, the session command is run before the
1390: window command.
1391: .Pp
1.298 nicm 1392: .Fl S
1.506 nicm 1393: uses
1394: .Ar format
1395: instead of the default session
1396: format and
1.298 nicm 1397: .Fl W
1.506 nicm 1398: instead of the default window format.
1399: For the meaning of
1400: .Ar format ,
1401: see the
1.298 nicm 1402: .Sx FORMATS
1403: section.
1.320 nicm 1404: .Pp
1.314 nicm 1405: This command works only if at least one client is attached.
1.76 nicm 1406: .It Xo
1407: .Ic choose-window
1.294 nicm 1408: .Op Fl F Ar format
1.76 nicm 1409: .Op Fl t Ar target-window
1410: .Op Ar template
1411: .Xc
1412: Put a window into window choice mode, where a window may be chosen
1413: interactively from a list.
1414: After a window is selected,
1415: .Ql %%
1416: is replaced by the session name and window index in
1417: .Ar template
1418: and the result executed as a command.
1419: If
1420: .Ar template
1421: is not given, "select-window -t '%%'" is used.
1.294 nicm 1422: For the meaning of the
1423: .Fl F
1424: flag, see the
1425: .Sx FORMATS
1426: section.
1.314 nicm 1427: This command works only if at least one client is attached.
1.491 nicm 1428: .It Xo
1429: .Ic display-panes
1430: .Op Fl t Ar target-client
1431: .Op Ar template
1432: .Xc
1.398 nicm 1433: .D1 (alias: Ic displayp )
1.78 nicm 1434: Display a visible indicator of each pane shown by
1435: .Ar target-client .
1436: See the
1.145 nicm 1437: .Ic display-panes-time ,
1438: .Ic display-panes-colour ,
1.78 nicm 1439: and
1.145 nicm 1440: .Ic display-panes-active-colour
1.78 nicm 1441: session options.
1.491 nicm 1442: While the indicator is on screen, a pane may be chosen with the
1.84 nicm 1443: .Ql 0
1444: to
1445: .Ql 9
1.491 nicm 1446: keys, which will cause
1447: .Ar template
1448: to be executed as a command with
1449: .Ql %%
1450: substituted by the pane ID.
1451: The default
1452: .Ar template
1453: is "select-pane -t '%%'".
1.57 jmc 1454: .It Xo Ic find-window
1.285 nicm 1455: .Op Fl CNT
1.294 nicm 1456: .Op Fl F Ar format
1.57 jmc 1457: .Op Fl t Ar target-window
1458: .Ar match-string
1459: .Xc
1460: .D1 (alias: Ic findw )
1461: Search for the
1462: .Xr fnmatch 3
1463: pattern
1464: .Ar match-string
1465: in window names, titles, and visible content (but not history).
1.285 nicm 1466: The flags control matching behavior:
1467: .Fl C
1468: matches only visible window contents,
1469: .Fl N
1470: matches only the window name and
1471: .Fl T
1472: matches only the window title.
1473: The default is
1474: .Fl CNT .
1475: If only one window is matched, it'll be automatically selected,
1476: otherwise a choice list is shown.
1.294 nicm 1477: For the meaning of the
1478: .Fl F
1479: flag, see the
1480: .Sx FORMATS
1481: section.
1.314 nicm 1482: This command works only if at least one client is attached.
1.137 nicm 1483: .It Xo Ic join-pane
1.277 nicm 1484: .Op Fl bdhv
1.137 nicm 1485: .Oo Fl l
1486: .Ar size |
1487: .Fl p Ar percentage Oc
1488: .Op Fl s Ar src-pane
1489: .Op Fl t Ar dst-pane
1490: .Xc
1491: .D1 (alias: Ic joinp )
1492: Like
1493: .Ic split-window ,
1494: but instead of splitting
1495: .Ar dst-pane
1496: and creating a new pane, split it and move
1497: .Ar src-pane
1498: into the space.
1499: This can be used to reverse
1500: .Ic break-pane .
1.277 nicm 1501: The
1502: .Fl b
1503: option causes
1504: .Ar src-pane
1505: to be joined to left of or above
1506: .Ar dst-pane .
1.432 nicm 1507: .Pp
1508: If
1509: .Fl s
1510: is omitted and a marked pane is present (see
1511: .Ic select-pane
1512: .Fl m ) ,
1513: the marked pane is used rather than the current pane.
1.112 nicm 1514: .It Xo Ic kill-pane
1515: .Op Fl a
1516: .Op Fl t Ar target-pane
1517: .Xc
1.57 jmc 1518: .D1 (alias: Ic killp )
1519: Destroy the given pane.
1520: If no panes remain in the containing window, it is also destroyed.
1.112 nicm 1521: The
1522: .Fl a
1523: option kills all but the pane given with
1524: .Fl t .
1.289 nicm 1525: .It Xo Ic kill-window
1526: .Op Fl a
1527: .Op Fl t Ar target-window
1528: .Xc
1.57 jmc 1529: .D1 (alias: Ic killw )
1530: Kill the current window or the window at
1531: .Ar target-window ,
1.1 nicm 1532: removing it from any sessions to which it is linked.
1.289 nicm 1533: The
1534: .Fl a
1535: option kills all but the window given with
1536: .Fl t .
1.398 nicm 1537: .It Xo Ic last-pane
1538: .Op Fl de
1539: .Op Fl t Ar target-window
1540: .Xc
1.187 nicm 1541: .D1 (alias: Ic lastp )
1542: Select the last (previously selected) pane.
1.398 nicm 1543: .Fl e
1544: enables or
1545: .Fl d
1546: disables input to the pane.
1.56 jmc 1547: .It Ic last-window Op Fl t Ar target-session
1.1 nicm 1548: .D1 (alias: Ic last )
1549: Select the last (previously selected) window.
1550: If no
1551: .Ar target-session
1552: is specified, select the last window of the current session.
1553: .It Xo Ic link-window
1.439 nicm 1554: .Op Fl adk
1.1 nicm 1555: .Op Fl s Ar src-window
1556: .Op Fl t Ar dst-window
1557: .Xc
1558: .D1 (alias: Ic linkw )
1559: Link the window at
1560: .Ar src-window
1561: to the specified
1562: .Ar dst-window .
1563: If
1564: .Ar dst-window
1565: is specified and no such window exists, the
1566: .Ar src-window
1567: is linked there.
1.439 nicm 1568: With
1569: .Fl a ,
1570: the window is moved to the next index up (following windows
1571: are moved if necessary).
1.1 nicm 1572: If
1573: .Fl k
1574: is given and
1575: .Ar dst-window
1576: exists, it is killed, otherwise an error is generated.
1577: If
1578: .Fl d
1579: is given, the newly linked window is not selected.
1.214 nicm 1580: .It Xo Ic list-panes
1581: .Op Fl as
1.245 nicm 1582: .Op Fl F Ar format
1.214 nicm 1583: .Op Fl t Ar target
1584: .Xc
1.104 nicm 1585: .D1 (alias: Ic lsp )
1.214 nicm 1586: If
1587: .Fl a
1588: is given,
1589: .Ar target
1590: is ignored and all panes on the server are listed.
1591: If
1592: .Fl s
1593: is given,
1594: .Ar target
1595: is a session (or the current session).
1596: If neither is given,
1597: .Ar target
1598: is a window (or the current window).
1.247 nicm 1599: For the meaning of the
1600: .Fl F
1601: flag, see the
1602: .Sx FORMATS
1603: section.
1.214 nicm 1604: .It Xo Ic list-windows
1605: .Op Fl a
1.245 nicm 1606: .Op Fl F Ar format
1.214 nicm 1607: .Op Fl t Ar target-session
1608: .Xc
1.1 nicm 1609: .D1 (alias: Ic lsw )
1.214 nicm 1610: If
1611: .Fl a
1612: is given, list all windows on the server.
1613: Otherwise, list windows in the current session or in
1.1 nicm 1614: .Ar target-session .
1.245 nicm 1615: For the meaning of the
1616: .Fl F
1617: flag, see the
1618: .Sx FORMATS
1619: section.
1.277 nicm 1620: .It Xo Ic move-pane
1621: .Op Fl bdhv
1622: .Oo Fl l
1623: .Ar size |
1624: .Fl p Ar percentage Oc
1625: .Op Fl s Ar src-pane
1626: .Op Fl t Ar dst-pane
1627: .Xc
1628: .D1 (alias: Ic movep )
1629: Like
1630: .Ic join-pane ,
1631: but
1632: .Ar src-pane
1633: and
1634: .Ar dst-pane
1635: may belong to the same window.
1.1 nicm 1636: .It Xo Ic move-window
1.439 nicm 1637: .Op Fl ardk
1.1 nicm 1638: .Op Fl s Ar src-window
1639: .Op Fl t Ar dst-window
1640: .Xc
1641: .D1 (alias: Ic movew )
1642: This is similar to
1643: .Ic link-window ,
1644: except the window at
1645: .Ar src-window
1646: is moved to
1647: .Ar dst-window .
1.291 nicm 1648: With
1649: .Fl r ,
1650: all windows in the session are renumbered in sequential order, respecting
1651: the
1652: .Ic base-index
1653: option.
1.1 nicm 1654: .It Xo Ic new-window
1.201 nicm 1655: .Op Fl adkP
1.272 nicm 1656: .Op Fl c Ar start-directory
1.351 nicm 1657: .Op Fl F Ar format
1.1 nicm 1658: .Op Fl n Ar window-name
1659: .Op Fl t Ar target-window
1.153 nicm 1660: .Op Ar shell-command
1.1 nicm 1661: .Xc
1662: .D1 (alias: Ic neww )
1663: Create a new window.
1.160 nicm 1664: With
1665: .Fl a ,
1666: the new window is inserted at the next index up from the specified
1667: .Ar target-window ,
1668: moving windows up if necessary,
1669: otherwise
1670: .Ar target-window
1671: is the new window location.
1672: .Pp
1.1 nicm 1673: If
1674: .Fl d
1675: is given, the session does not make the new window the current window.
1676: .Ar target-window
1.28 nicm 1677: represents the window to be created; if the target already exists an error is
1678: shown, unless the
1679: .Fl k
1680: flag is used, in which case it is destroyed.
1.153 nicm 1681: .Ar shell-command
1.1 nicm 1682: is the command to execute.
1683: If
1.153 nicm 1684: .Ar shell-command
1685: is not specified, the value of the
1686: .Ic default-command
1687: option is used.
1.272 nicm 1688: .Fl c
1689: specifies the working directory in which the new window is created.
1.153 nicm 1690: .Pp
1691: When the shell command completes, the window closes.
1692: See the
1693: .Ic remain-on-exit
1694: option to change this behaviour.
1.1 nicm 1695: .Pp
1696: The
1697: .Ev TERM
1698: environment variable must be set to
1699: .Dq screen
1700: for all programs running
1701: .Em inside
1702: .Nm .
1703: New windows will automatically have
1704: .Dq TERM=screen
1705: added to their environment, but care must be taken not to reset this in shell
1706: start-up files.
1.201 nicm 1707: .Pp
1708: The
1709: .Fl P
1.279 nicm 1710: option prints information about the new window after it has been created.
1711: By default, it uses the format
1712: .Ql #{session_name}:#{window_index}
1713: but a different format may be specified with
1714: .Fl F .
1.56 jmc 1715: .It Ic next-layout Op Fl t Ar target-window
1.1 nicm 1716: .D1 (alias: Ic nextl )
1717: Move a window to the next layout and rearrange the panes to fit.
1718: .It Xo Ic next-window
1.9 nicm 1719: .Op Fl a
1.1 nicm 1720: .Op Fl t Ar target-session
1721: .Xc
1722: .D1 (alias: Ic next )
1723: Move to the next window in the session.
1.9 nicm 1724: If
1.12 jmc 1725: .Fl a
1.295 nicm 1726: is used, move to the next window with an alert.
1.107 nicm 1727: .It Xo Ic pipe-pane
1728: .Op Fl o
1729: .Op Fl t Ar target-pane
1.153 nicm 1730: .Op Ar shell-command
1.107 nicm 1731: .Xc
1732: .D1 (alias: Ic pipep )
1733: Pipe any output sent by the program in
1734: .Ar target-pane
1735: to a shell command.
1736: A pane may only be piped to one command at a time, any existing pipe is
1737: closed before
1.153 nicm 1738: .Ar shell-command
1.107 nicm 1739: is executed.
1.174 nicm 1740: The
1741: .Ar shell-command
1742: string may contain the special character sequences supported by the
1743: .Ic status-left
1.231 nicm 1744: option.
1.107 nicm 1745: If no
1.153 nicm 1746: .Ar shell-command
1.107 nicm 1747: is given, the current pipe (if any) is closed.
1748: .Pp
1749: The
1750: .Fl o
1751: option only opens a new pipe if no previous pipe exists, allowing a pipe to
1752: be toggled with a single key, for example:
1753: .Bd -literal -offset indent
1.174 nicm 1754: bind-key C-p pipe-pane -o 'cat >>~/output.#I-#P'
1.107 nicm 1755: .Ed
1.176 nicm 1756: .It Xo Ic previous-layout
1757: .Op Fl t Ar target-window
1758: .Xc
1759: .D1 (alias: Ic prevl )
1760: Move to the previous layout in the session.
1.1 nicm 1761: .It Xo Ic previous-window
1.9 nicm 1762: .Op Fl a
1.1 nicm 1763: .Op Fl t Ar target-session
1764: .Xc
1765: .D1 (alias: Ic prev )
1766: Move to the previous window in the session.
1.9 nicm 1767: With
1768: .Fl a ,
1.295 nicm 1769: move to the previous window with an alert.
1.1 nicm 1770: .It Xo Ic rename-window
1771: .Op Fl t Ar target-window
1772: .Ar new-name
1773: .Xc
1774: .D1 (alias: Ic renamew )
1775: Rename the current window, or the window at
1776: .Ar target-window
1777: if specified, to
1778: .Ar new-name .
1779: .It Xo Ic resize-pane
1.419 nicm 1780: .Op Fl DLMRUZ
1.52 nicm 1781: .Op Fl t Ar target-pane
1.324 nicm 1782: .Op Fl x Ar width
1783: .Op Fl y Ar height
1.1 nicm 1784: .Op Ar adjustment
1785: .Xc
1786: .D1 (alias: Ic resizep )
1.324 nicm 1787: Resize a pane, up, down, left or right by
1788: .Ar adjustment
1789: with
1790: .Fl U ,
1.57 jmc 1791: .Fl D ,
1792: .Fl L
1.324 nicm 1793: or
1794: .Fl R ,
1795: or
1796: to an absolute size
1797: with
1798: .Fl x
1799: or
1800: .Fl y .
1.57 jmc 1801: The
1802: .Ar adjustment
1803: is given in lines or cells (the default is 1).
1.337 nicm 1804: .Pp
1805: With
1806: .Fl Z ,
1.349 nicm 1807: the active pane is toggled between zoomed (occupying the whole of the window)
1808: and unzoomed (its normal position in the layout).
1.419 nicm 1809: .Pp
1810: .Fl M
1811: begins mouse resizing (only valid if bound to a mouse key binding, see
1.420 jmc 1812: .Sx MOUSE SUPPORT ) .
1.234 nicm 1813: .It Xo Ic respawn-pane
1814: .Op Fl k
1815: .Op Fl t Ar target-pane
1816: .Op Ar shell-command
1817: .Xc
1818: .D1 (alias: Ic respawnp )
1819: Reactivate a pane in which the command has exited (see the
1820: .Ic remain-on-exit
1821: window option).
1822: If
1823: .Ar shell-command
1824: is not given, the command used when the pane was created is executed.
1825: The pane must be already inactive, unless
1826: .Fl k
1827: is given, in which case any existing command is killed.
1.57 jmc 1828: .It Xo Ic respawn-window
1829: .Op Fl k
1830: .Op Fl t Ar target-window
1.153 nicm 1831: .Op Ar shell-command
1.57 jmc 1832: .Xc
1833: .D1 (alias: Ic respawnw )
1.153 nicm 1834: Reactivate a window in which the command has exited (see the
1.57 jmc 1835: .Ic remain-on-exit
1836: window option).
1837: If
1.153 nicm 1838: .Ar shell-command
1.57 jmc 1839: is not given, the command used when the window was created is executed.
1840: The window must be already inactive, unless
1841: .Fl k
1842: is given, in which case any existing command is killed.
1843: .It Xo Ic rotate-window
1844: .Op Fl DU
1845: .Op Fl t Ar target-window
1846: .Xc
1847: .D1 (alias: Ic rotatew )
1848: Rotate the positions of the panes within a window, either upward (numerically
1849: lower) with
1850: .Fl U
1851: or downward (numerically higher).
1852: .It Xo Ic select-layout
1.424 nicm 1853: .Op Fl nop
1.57 jmc 1854: .Op Fl t Ar target-window
1855: .Op Ar layout-name
1856: .Xc
1.176 nicm 1857: .D1 (alias: Ic selectl )
1.57 jmc 1858: Choose a specific layout for a window.
1859: If
1860: .Ar layout-name
1.181 nicm 1861: is not given, the last preset layout used (if any) is reapplied.
1.204 nicm 1862: .Fl n
1863: and
1864: .Fl p
1865: are equivalent to the
1866: .Ic next-layout
1867: and
1868: .Ic previous-layout
1869: commands.
1.424 nicm 1870: .Fl o
1871: applies the last set layout if possible (undoes the most recent layout change).
1.156 nicm 1872: .It Xo Ic select-pane
1.432 nicm 1873: .Op Fl DdegLlMmRU
1.418 nicm 1874: .Op Fl P Ar style
1.156 nicm 1875: .Op Fl t Ar target-pane
1876: .Xc
1.57 jmc 1877: .D1 (alias: Ic selectp )
1878: Make pane
1879: .Ar target-pane
1880: the active pane in window
1.418 nicm 1881: .Ar target-window ,
1.420 jmc 1882: or set its style (with
1.418 nicm 1883: .Fl P ) .
1.156 nicm 1884: If one of
1885: .Fl D ,
1886: .Fl L ,
1887: .Fl R ,
1888: or
1889: .Fl U
1890: is used, respectively the pane below, to the left, to the right, or above the
1891: target pane is used.
1.204 nicm 1892: .Fl l
1893: is the same as using the
1894: .Ic last-pane
1895: command.
1.398 nicm 1896: .Fl e
1897: enables or
1898: .Fl d
1899: disables input to the pane.
1.418 nicm 1900: .Pp
1.432 nicm 1901: .Fl m
1902: and
1903: .Fl M
1904: are used to set and clear the
1905: .Em marked pane .
1906: There is one marked pane at a time, setting a new marked pane clears the last.
1907: The marked pane is the default target for
1908: .Fl s
1909: to
1910: .Ic join-pane ,
1911: .Ic swap-pane
1912: and
1913: .Ic swap-window .
1914: .Pp
1.418 nicm 1915: Each pane has a style: by default the
1916: .Ic window-style
1917: and
1918: .Ic window-active-style
1919: options are used,
1920: .Ic select-pane
1921: .Fl P
1922: sets the style for a single pane.
1923: For example, to set the pane 1 background to red:
1924: .Bd -literal -offset indent
1925: select-pane -t:.1 -P 'bg=red'
1926: .Ed
1927: .Pp
1928: .Fl g
1929: shows the current pane style.
1.204 nicm 1930: .It Xo Ic select-window
1.310 nicm 1931: .Op Fl lnpT
1.204 nicm 1932: .Op Fl t Ar target-window
1933: .Xc
1.57 jmc 1934: .D1 (alias: Ic selectw )
1935: Select the window at
1936: .Ar target-window .
1.204 nicm 1937: .Fl l ,
1938: .Fl n
1939: and
1940: .Fl p
1941: are equivalent to the
1942: .Ic last-window ,
1943: .Ic next-window
1944: and
1945: .Ic previous-window
1946: commands.
1.310 nicm 1947: If
1948: .Fl T
1949: is given and the selected window is already the current window,
1950: the command behaves like
1951: .Ic last-window .
1.57 jmc 1952: .It Xo Ic split-window
1.502 nicm 1953: .Op Fl bdfhvP
1.272 nicm 1954: .Op Fl c Ar start-directory
1.57 jmc 1955: .Oo Fl l
1956: .Ar size |
1957: .Fl p Ar percentage Oc
1.136 nicm 1958: .Op Fl t Ar target-pane
1.153 nicm 1959: .Op Ar shell-command
1.279 nicm 1960: .Op Fl F Ar format
1.57 jmc 1961: .Xc
1.176 nicm 1962: .D1 (alias: Ic splitw )
1.136 nicm 1963: Create a new pane by splitting
1964: .Ar target-pane :
1.57 jmc 1965: .Fl h
1966: does a horizontal split and
1967: .Fl v
1968: a vertical split; if neither is specified,
1969: .Fl v
1970: is assumed.
1971: The
1972: .Fl l
1973: and
1974: .Fl p
1.136 nicm 1975: options specify the size of the new pane in lines (for vertical split) or in
1.57 jmc 1976: cells (for horizontal split), or as a percentage, respectively.
1.408 nicm 1977: The
1978: .Fl b
1979: option causes the new pane to be created to the left of or above
1980: .Ar target-pane .
1.494 nicm 1981: The
1982: .Fl f
1983: option creates a new pane spanning the full window height (with
1984: .Fl h )
1985: or full window width (with
1986: .Fl v ) ,
1987: instead of splitting the active pane.
1.136 nicm 1988: All other options have the same meaning as for the
1.57 jmc 1989: .Ic new-window
1990: command.
1991: .It Xo Ic swap-pane
1992: .Op Fl dDU
1993: .Op Fl s Ar src-pane
1994: .Op Fl t Ar dst-pane
1995: .Xc
1996: .D1 (alias: Ic swapp )
1997: Swap two panes.
1998: If
1999: .Fl U
2000: is used and no source pane is specified with
2001: .Fl s ,
2002: .Ar dst-pane
2003: is swapped with the previous pane (before it numerically);
2004: .Fl D
2005: swaps with the next pane (after it numerically).
1.138 nicm 2006: .Fl d
2007: instructs
2008: .Nm
2009: not to change the active pane.
1.432 nicm 2010: .Pp
2011: If
2012: .Fl s
2013: is omitted and a marked pane is present (see
2014: .Ic select-pane
2015: .Fl m ) ,
2016: the marked pane is used rather than the current pane.
1.57 jmc 2017: .It Xo Ic swap-window
2018: .Op Fl d
2019: .Op Fl s Ar src-window
2020: .Op Fl t Ar dst-window
2021: .Xc
2022: .D1 (alias: Ic swapw )
2023: This is similar to
2024: .Ic link-window ,
2025: except the source and destination windows are swapped.
2026: It is an error if no window exists at
2027: .Ar src-window .
1.432 nicm 2028: .Pp
2029: Like
2030: .Ic swap-pane ,
2031: if
2032: .Fl s
2033: is omitted and a marked pane is present (see
2034: .Ic select-pane
2035: .Fl m ) ,
2036: the window containing the marked pane is used rather than the current window.
1.57 jmc 2037: .It Xo Ic unlink-window
1.1 nicm 2038: .Op Fl k
2039: .Op Fl t Ar target-window
2040: .Xc
1.57 jmc 2041: .D1 (alias: Ic unlinkw )
2042: Unlink
2043: .Ar target-window .
2044: Unless
2045: .Fl k
2046: is given, a window may be unlinked only if it is linked to multiple sessions -
2047: windows may not be linked to no sessions;
2048: if
1.1 nicm 2049: .Fl k
1.57 jmc 2050: is specified and the window is linked to only one session, it is unlinked and
2051: destroyed.
2052: .El
2053: .Sh KEY BINDINGS
1.93 nicm 2054: .Nm
2055: allows a command to be bound to most keys, with or without a prefix key.
2056: When specifying keys, most represent themselves (for example
2057: .Ql A
2058: to
1.95 jmc 2059: .Ql Z ) .
1.93 nicm 2060: Ctrl keys may be prefixed with
2061: .Ql C-
2062: or
1.95 jmc 2063: .Ql ^ ,
2064: and Alt (meta) with
1.93 nicm 2065: .Ql M- .
2066: In addition, the following special key names are accepted:
1.126 nicm 2067: .Em Up ,
2068: .Em Down ,
2069: .Em Left ,
2070: .Em Right ,
1.93 nicm 2071: .Em BSpace ,
2072: .Em BTab ,
2073: .Em DC
2074: (Delete),
2075: .Em End ,
2076: .Em Enter ,
2077: .Em Escape ,
2078: .Em F1
2079: to
1.402 nicm 2080: .Em F12 ,
1.93 nicm 2081: .Em Home ,
2082: .Em IC
2083: (Insert),
1.254 nicm 2084: .Em NPage/PageDown/PgDn ,
2085: .Em PPage/PageUp/PgUp ,
1.93 nicm 2086: .Em Space ,
2087: and
2088: .Em Tab .
2089: Note that to bind the
2090: .Ql \&"
2091: or
2092: .Ql '
2093: keys, quotation marks are necessary, for example:
2094: .Bd -literal -offset indent
2095: bind-key '"' split-window
1.167 nicm 2096: bind-key "'" new-window
1.93 nicm 2097: .Ed
2098: .Pp
1.57 jmc 2099: Commands related to key bindings are as follows:
2100: .Bl -tag -width Ds
2101: .It Xo Ic bind-key
1.501 nicm 2102: .Op Fl nr
1.395 nicm 2103: .Op Fl t Ar mode-table
1.421 nicm 2104: .Op Fl T Ar key-table
1.57 jmc 2105: .Ar key Ar command Op Ar arguments
1.1 nicm 2106: .Xc
1.57 jmc 2107: .D1 (alias: Ic bind )
2108: Bind key
2109: .Ar key
2110: to
2111: .Ar command .
1.421 nicm 2112: Keys are bound in a key table.
2113: By default (without -T), the key is bound in
2114: the
2115: .Em prefix
2116: key table.
2117: This table is used for keys pressed after the prefix key (for example,
2118: by default
2119: .Ql c
2120: is bound to
2121: .Ic new-window
2122: in the
2123: .Em prefix
2124: table, so
2125: .Ql C-b c
2126: creates a new window).
2127: The
2128: .Em root
2129: table is used for keys pressed without the prefix key: binding
2130: .Ql c
2131: to
2132: .Ic new-window
2133: in the
2134: .Em root
2135: table (not recommended) means a plain
2136: .Ql c
2137: will create a new window.
1.57 jmc 2138: .Fl n
1.421 nicm 2139: is an alias
2140: for
2141: .Fl T Ar root .
2142: Keys may also be bound in custom key tables and the
2143: .Ic switch-client
2144: .Fl T
2145: command used to switch to them from a key binding.
1.1 nicm 2146: The
1.57 jmc 2147: .Fl r
2148: flag indicates this key may repeat, see the
2149: .Ic repeat-time
2150: option.
2151: .Pp
2152: If
2153: .Fl t
2154: is present,
2155: .Ar key
2156: is bound in
1.501 nicm 2157: .Ar mode-table .
1.421 nicm 2158: .Pp
1.57 jmc 2159: To view the default bindings and possible commands, see the
2160: .Ic list-keys
2161: command.
1.421 nicm 2162: .It Xo Ic list-keys
2163: .Op Fl t Ar mode-table
2164: .Op Fl T Ar key-table
2165: .Xc
1.57 jmc 2166: .D1 (alias: Ic lsk )
2167: List all key bindings.
2168: Without
1.421 nicm 2169: .Fl T
2170: all key tables are printed.
2171: With
2172: .Fl T
2173: only
2174: .Ar key-table .
1.57 jmc 2175: .Pp
2176: With
2177: .Fl t ,
2178: the key bindings in
1.421 nicm 2179: .Ar mode-table
1.57 jmc 2180: are listed; this may be one of:
1.503 nicm 2181: .Em vi-choice
1.57 jmc 2182: or
1.503 nicm 2183: .Em emacs-choice .
1.57 jmc 2184: .It Xo Ic send-keys
1.497 nicm 2185: .Op Fl lMRX
2186: .Op Fl N Ar repeat-count
1.72 nicm 2187: .Op Fl t Ar target-pane
1.57 jmc 2188: .Ar key Ar ...
1.1 nicm 2189: .Xc
1.57 jmc 2190: .D1 (alias: Ic send )
2191: Send a key or keys to a window.
2192: Each argument
2193: .Ar key
2194: is the name of the key (such as
2195: .Ql C-a
2196: or
2197: .Ql npage
2198: ) to send; if the string is not recognised as a key, it is sent as a series of
2199: characters.
1.273 nicm 2200: The
2201: .Fl l
2202: flag disables key name lookup and sends the keys literally.
1.57 jmc 2203: All arguments are sent sequentially from first to last.
1.265 nicm 2204: The
2205: .Fl R
2206: flag causes the terminal state to be reset.
1.419 nicm 2207: .Pp
2208: .Fl M
2209: passes through a mouse event (only valid if bound to a mouse key binding, see
1.420 jmc 2210: .Sx MOUSE SUPPORT ) .
1.497 nicm 2211: .Pp
2212: .Fl X
2213: is used to send a command into copy mode - see
2214: the
2215: .Sx WINDOWS AND PANES
2216: section.
2217: .Fl N
1.516 ! nicm 2218: specifies a repeat count.
1.267 nicm 2219: .It Xo Ic send-prefix
2220: .Op Fl 2
2221: .Op Fl t Ar target-pane
2222: .Xc
2223: Send the prefix key, or with
2224: .Fl 2
2225: the secondary prefix key, to a window as if it was pressed.
1.57 jmc 2226: .It Xo Ic unbind-key
1.501 nicm 2227: .Op Fl an
1.395 nicm 2228: .Op Fl t Ar mode-table
1.421 nicm 2229: .Op Fl T Ar key-table
1.57 jmc 2230: .Ar key
1.2 nicm 2231: .Xc
1.57 jmc 2232: .D1 (alias: Ic unbind )
2233: Unbind the command bound to
2234: .Ar key .
1.421 nicm 2235: .Fl n ,
2236: .Fl T
2237: and
1.57 jmc 2238: .Fl t
1.421 nicm 2239: are the same as for
2240: .Ic bind-key .
1.189 nicm 2241: If
2242: .Fl a
2243: is present, all key bindings are removed.
1.57 jmc 2244: .El
2245: .Sh OPTIONS
2246: The appearance and behaviour of
2247: .Nm
2248: may be modified by changing the value of various options.
1.133 nicm 2249: There are three types of option:
2250: .Em server options ,
1.57 jmc 2251: .Em session options
2252: and
2253: .Em window options .
2254: .Pp
1.133 nicm 2255: The
2256: .Nm
2257: server has a set of global options which do not apply to any particular
2258: window or session.
2259: These are altered with the
2260: .Ic set-option
2261: .Fl s
2262: command, or displayed with the
2263: .Ic show-options
2264: .Fl s
2265: command.
2266: .Pp
2267: In addition, each individual session may have a set of session options, and
2268: there is a separate set of global session options.
1.57 jmc 2269: Sessions which do not have a particular option configured inherit the value
2270: from the global session options.
2271: Session options are set or unset with the
2272: .Ic set-option
2273: command and may be listed with the
2274: .Ic show-options
2275: command.
1.133 nicm 2276: The available server and session options are listed under the
1.57 jmc 2277: .Ic set-option
2278: command.
2279: .Pp
2280: Similarly, a set of window options is attached to each window, and there is
2281: a set of global window options from which any unset options are inherited.
2282: Window options are altered with the
2283: .Ic set-window-option
2284: command and can be listed with the
2285: .Ic show-window-options
2286: command.
2287: All window options are documented with the
2288: .Ic set-window-option
2289: command.
1.318 nicm 2290: .Pp
2291: .Nm
2292: also supports user options which are prefixed with a
2293: .Ql \&@ .
1.321 jmc 2294: User options may have any name, so long as they are prefixed with
2295: .Ql \&@ ,
1.318 nicm 2296: and be set to any string.
1.418 nicm 2297: For example:
1.318 nicm 2298: .Bd -literal -offset indent
2299: $ tmux setw -q @foo "abc123"
2300: $ tmux showw -v @foo
2301: abc123
2302: .Ed
1.57 jmc 2303: .Pp
2304: Commands which set options are as follows:
2305: .Bl -tag -width Ds
1.1 nicm 2306: .It Xo Ic set-option
1.336 nicm 2307: .Op Fl agoqsuw
1.129 nicm 2308: .Op Fl t Ar target-session | Ar target-window
1.1 nicm 2309: .Ar option Ar value
2310: .Xc
2311: .D1 (alias: Ic set )
1.133 nicm 2312: Set a window option with
2313: .Fl w
2314: (equivalent to the
2315: .Ic set-window-option
2316: command),
2317: a server option with
2318: .Fl s ,
2319: otherwise a session option.
2320: If
2321: .Fl g
1.433 nicm 2322: is given, the global session or window option is set.
1.1 nicm 2323: The
2324: .Fl u
2325: flag unsets an option, so a session inherits the option from the global
1.433 nicm 2326: options (or with
2327: .Fl g ,
2328: restores a global option to the default).
1.336 nicm 2329: .Pp
2330: The
2331: .Fl o
1.446 nicm 2332: flag prevents setting an option that is already set and the
1.281 nicm 2333: .Fl q
1.446 nicm 2334: flag suppresses errors about unknown or ambiguous options.
1.281 nicm 2335: .Pp
1.378 nicm 2336: With
2337: .Fl a ,
2338: and if the option expects a string or a style,
2339: .Ar value
2340: is appended to the existing setting.
2341: For example:
2342: .Bd -literal -offset indent
2343: set -g status-left "foo"
2344: set -ag status-left "bar"
2345: .Ed
2346: .Pp
2347: Will result in
2348: .Ql foobar .
2349: And:
2350: .Bd -literal -offset indent
2351: set -g status-style "bg=red"
2352: set -ag status-style "fg=blue"
2353: .Ed
2354: .Pp
2355: Will result in a red background
2356: .Em and
2357: blue foreground.
2358: Without
2359: .Fl a ,
2360: the result would be the default background and a blue foreground.
2361: .Pp
1.133 nicm 2362: Available window options are listed under
2363: .Ic set-window-option .
1.274 nicm 2364: .Pp
2365: .Ar value
2366: depends on the option and may be a number, a string, or a flag (on, off, or
2367: omitted to toggle).
1.133 nicm 2368: .Pp
2369: Available server options are:
2370: .Bl -tag -width Ds
1.198 nicm 2371: .It Ic buffer-limit Ar number
2372: Set the number of buffers; as new buffers are added to the top of the stack,
2373: old ones are removed from the bottom if necessary to maintain this maximum
2374: length.
1.425 nicm 2375: .It Ic default-terminal Ar terminal
2376: Set the default terminal for new windows created in this session - the
2377: default value of the
2378: .Ev TERM
2379: environment variable.
2380: For
2381: .Nm
2382: to work correctly, this
2383: .Em must
2384: be set to
2385: .Ql screen ,
2386: .Ql tmux
2387: or a derivative of them.
1.239 nicm 2388: .It Ic escape-time Ar time
2389: Set the time in milliseconds for which
2390: .Nm
2391: waits after an escape is input to determine if it is part of a function or meta
2392: key sequences.
2393: The default is 500 milliseconds.
2394: .It Xo Ic exit-unattached
2395: .Op Ic on | off
2396: .Xc
2397: If enabled, the server will exit when there are no attached clients.
1.362 nicm 2398: .It Xo Ic focus-events
2399: .Op Ic on | off
2400: .Xc
2401: When enabled, focus events are requested from the terminal if supported and
2402: passed through to applications running in
2403: .Nm .
2404: Attached clients should be detached and attached again after changing this
2405: option.
1.445 nicm 2406: .It Ic history-file Ar path
2407: If not empty, a file to which
2408: .Nm
2409: will write command prompt history on exit and load it from on start.
1.384 nicm 2410: .It Ic message-limit Ar number
2411: Set the number of error or information messages to save in the message log for
2412: each client.
2413: The default is 100.
1.228 nicm 2414: .It Xo Ic set-clipboard
2415: .Op Ic on | off
2416: .Xc
2417: Attempt to set the terminal clipboard content using the
2418: \ee]52;...\e007
2419: .Xr xterm 1
2420: escape sequences.
2421: This option is on by default if there is an
2422: .Em \&Ms
2423: entry in the
2424: .Xr terminfo 5
2425: description for the client terminal.
2426: Note that this feature needs to be enabled in
2427: .Xr xterm 1
2428: by setting the resource:
2429: .Bd -literal -offset indent
2430: disallowedWindowOps: 20,21,SetXprop
2431: .Ed
2432: .Pp
2433: Or changing this property from the
2434: .Xr xterm 1
2435: interactive menu when required.
1.381 nicm 2436: .It Ic terminal-overrides Ar string
2437: Contains a list of entries which override terminal descriptions read using
2438: .Xr terminfo 5 .
2439: .Ar string
2440: is a comma-separated list of items each a colon-separated string made up of a
2441: terminal type pattern (matched using
2442: .Xr fnmatch 3 )
2443: and a set of
2444: .Em name=value
2445: entries.
2446: .Pp
2447: For example, to set the
2448: .Ql clear
2449: .Xr terminfo 5
2450: entry to
2451: .Ql \ee[H\ee[2J
2452: for all terminal types and the
2453: .Ql dch1
2454: entry to
2455: .Ql \ee[P
2456: for the
2457: .Ql rxvt
2458: terminal type, the option could be set to the string:
2459: .Bd -literal -offset indent
2460: "*:clear=\ee[H\ee[2J,rxvt:dch1=\ee[P"
2461: .Ed
2462: .Pp
2463: The terminal entry value is passed through
2464: .Xr strunvis 3
2465: before interpretation.
2466: The default value forcibly corrects the
2467: .Ql colors
2468: entry for terminals which support 256 colours:
2469: .Bd -literal -offset indent
2470: "*256col*:colors=256,xterm*:XT"
2471: .Ed
1.133 nicm 2472: .El
1.129 nicm 2473: .Pp
1.18 nicm 2474: Available session options are:
1.1 nicm 2475: .Bl -tag -width Ds
1.312 nicm 2476: .It Ic assume-paste-time Ar milliseconds
2477: If keys are entered faster than one in
2478: .Ar milliseconds ,
2479: they are assumed to have been pasted rather than typed and
2480: .Nm
2481: key bindings are not processed.
2482: The default is one millisecond and zero disables.
1.69 nicm 2483: .It Ic base-index Ar index
2484: Set the base index from which an unused index should be searched when a new
2485: window is created.
2486: The default is zero.
1.1 nicm 2487: .It Xo Ic bell-action
1.429 nicm 2488: .Op Ic any | none | current | other
1.1 nicm 2489: .Xc
2490: Set action on window bell.
2491: .Ic any
2492: means a bell in any window linked to a session causes a bell in the current
2493: window of that session,
2494: .Ic none
1.429 nicm 2495: means all bells are ignored,
1.1 nicm 2496: .Ic current
1.429 nicm 2497: means only bells in windows other than the current window are ignored and
2498: .Ic other
2499: means bells in the current window are ignored but not those in other windows.
1.237 nicm 2500: .It Xo Ic bell-on-alert
2501: .Op Ic on | off
2502: .Xc
1.295 nicm 2503: If on, ring the terminal bell when an alert
1.237 nicm 2504: occurs.
1.153 nicm 2505: .It Ic default-command Ar shell-command
1.1 nicm 2506: Set the command used for new windows (if not specified when the window is
2507: created) to
1.153 nicm 2508: .Ar shell-command ,
1.79 nicm 2509: which may be any
2510: .Xr sh 1
2511: command.
1.19 nicm 2512: The default is an empty string, which instructs
2513: .Nm
1.79 nicm 2514: to create a login shell using the value of the
2515: .Ic default-shell
2516: option.
2517: .It Ic default-shell Ar path
2518: Specify the default shell.
2519: This is used as the login shell for new windows when the
2520: .Ic default-command
2521: option is set to empty, and must be the full path of the executable.
2522: When started
2523: .Nm
2524: tries to set a default value from the first suitable of the
1.19 nicm 2525: .Ev SHELL
1.79 nicm 2526: environment variable, the shell returned by
2527: .Xr getpwuid 3 ,
2528: or
2529: .Pa /bin/sh .
2530: This option should be configured when
2531: .Nm
2532: is used as a login shell.
1.206 nicm 2533: .It Xo Ic destroy-unattached
2534: .Op Ic on | off
2535: .Xc
1.185 nicm 2536: If enabled and the session is no longer attached to any clients, it is
2537: destroyed.
1.206 nicm 2538: .It Xo Ic detach-on-destroy
2539: .Op Ic on | off
2540: .Xc
1.184 nicm 2541: If on (the default), the client is detached when the session it is attached to
2542: is destroyed.
2543: If off, the client is switched to the most recently active of the remaining
2544: sessions.
1.145 nicm 2545: .It Ic display-panes-active-colour Ar colour
2546: Set the colour used by the
2547: .Ic display-panes
2548: command to show the indicator for the active pane.
1.78 nicm 2549: .It Ic display-panes-colour Ar colour
1.145 nicm 2550: Set the colour used by the
1.78 nicm 2551: .Ic display-panes
1.145 nicm 2552: command to show the indicators for inactive panes.
1.78 nicm 2553: .It Ic display-panes-time Ar time
2554: Set the time in milliseconds for which the indicators shown by the
2555: .Ic display-panes
2556: command appear.
1.21 nicm 2557: .It Ic display-time Ar time
1.78 nicm 2558: Set the amount of time for which status line messages and other on-screen
2559: indicators are displayed.
1.462 tim 2560: If set to 0, messages and indicators are displayed until a key is pressed.
1.21 nicm 2561: .Ar time
2562: is in milliseconds.
1.1 nicm 2563: .It Ic history-limit Ar lines
2564: Set the maximum number of lines held in window history.
2565: This setting applies only to new windows - existing window histories are not
2566: resized and retain the limit at the point they were created.
1.474 nicm 2567: .It Ic key-table Ar key-table
2568: Set the default key table to
2569: .Ar key-table
2570: instead of
2571: .Em root .
1.1 nicm 2572: .It Ic lock-after-time Ar number
1.100 nicm 2573: Lock the session (like the
2574: .Ic lock-session
1.90 nicm 2575: command) after
1.1 nicm 2576: .Ar number
1.448 nicm 2577: seconds of inactivity.
1.100 nicm 2578: The default is not to lock (set to 0).
1.153 nicm 2579: .It Ic lock-command Ar shell-command
1.90 nicm 2580: Command to run when locking each client.
2581: The default is to run
2582: .Xr lock 1
2583: with
2584: .Fl np .
1.378 nicm 2585: .It Ic message-command-style Ar style
2586: Set status line message command style, where
2587: .Ar style
2588: is a comma-separated list of characteristics to be specified.
2589: .Pp
2590: These may be
2591: .Ql bg=colour
2592: to set the background colour,
2593: .Ql fg=colour
2594: to set the foreground colour, and a list of attributes as specified below.
2595: .Pp
2596: The colour is one of:
1.1 nicm 2597: .Ic black ,
2598: .Ic red ,
2599: .Ic green ,
2600: .Ic yellow ,
2601: .Ic blue ,
2602: .Ic magenta ,
2603: .Ic cyan ,
1.85 nicm 2604: .Ic white ,
1.266 nicm 2605: aixterm bright variants (if supported:
2606: .Ic brightred ,
2607: .Ic brightgreen ,
2608: and so on),
1.85 nicm 2609: .Ic colour0
2610: to
2611: .Ic colour255
1.205 nicm 2612: from the 256-colour set,
2613: .Ic default ,
2614: or a hexadecimal RGB string such as
2615: .Ql #ffffff ,
2616: which chooses the closest match from the default 256-colour set.
1.378 nicm 2617: .Pp
2618: The attributes is either
2619: .Ic none
2620: or a comma-delimited list of one or more of:
2621: .Ic bright
2622: (or
2623: .Ic bold ) ,
2624: .Ic dim ,
2625: .Ic underscore ,
2626: .Ic blink ,
2627: .Ic reverse ,
2628: .Ic hidden ,
2629: or
2630: .Ic italics ,
2631: to turn an attribute on, or an attribute prefixed with
2632: .Ql no
2633: to turn one off.
2634: .Pp
2635: Examples are:
2636: .Bd -literal -offset indent
2637: fg=yellow,bold,underscore,blink
2638: bg=black,fg=default,noreverse
2639: .Ed
2640: .Pp
2641: With the
2642: .Fl a
2643: flag to the
2644: .Ic set-option
2645: command the new style is added otherwise the existing style is replaced.
2646: .It Ic message-style Ar style
2647: Set status line message style.
2648: For how to specify
2649: .Ar style ,
2650: see the
2651: .Ic message-command-style
2652: option.
1.419 nicm 2653: .It Xo Ic mouse
1.226 nicm 2654: .Op Ic on | off
2655: .Xc
2656: If on,
2657: .Nm
1.419 nicm 2658: captures the mouse and allows mouse events to be bound as key bindings.
2659: See the
2660: .Sx MOUSE SUPPORT
2661: section for details.
1.267 nicm 2662: .It Ic prefix Ar key
2663: Set the key accepted as a prefix key.
1.473 nicm 2664: In addition to the standard keys described under
2665: .Sx KEY BINDINGS ,
2666: .Ic prefix
2667: can be set to the special key
2668: .Ql None
2669: to set no prefix.
1.267 nicm 2670: .It Ic prefix2 Ar key
2671: Set a secondary key accepted as a prefix key.
1.473 nicm 2672: Like
2673: .Ic prefix ,
2674: .Ic prefix2
2675: can be set to
2676: .Ql None .
1.291 nicm 2677: .It Xo Ic renumber-windows
2678: .Op Ic on | off
2679: .Xc
2680: If on, when a window is closed in a session, automatically renumber the other
2681: windows in numerical order.
2682: This respects the
2683: .Ic base-index
2684: option if it has been set.
2685: If off, do not renumber the windows.
1.21 nicm 2686: .It Ic repeat-time Ar time
1.1 nicm 2687: Allow multiple commands to be entered without pressing the prefix-key again
2688: in the specified
1.21 nicm 2689: .Ar time
1.1 nicm 2690: milliseconds (the default is 500).
2691: Whether a key repeats may be set when it is bound using the
2692: .Fl r
2693: flag to
2694: .Ic bind-key .
1.52 nicm 2695: Repeat is enabled for the default keys bound to the
2696: .Ic resize-pane
2697: command.
1.1 nicm 2698: .It Xo Ic set-titles
1.56 jmc 2699: .Op Ic on | off
1.1 nicm 2700: .Xc
1.261 nicm 2701: Attempt to set the client terminal title using the
2702: .Em tsl
2703: and
2704: .Em fsl
2705: .Xr terminfo 5
2706: entries if they exist.
2707: .Nm
1.444 nicm 2708: automatically sets these to the \ee]0;...\e007 sequence if
2709: the terminal appears to be
2710: .Xr xterm 1 .
1.11 nicm 2711: This option is off by default.
1.86 nicm 2712: .It Ic set-titles-string Ar string
2713: String used to set the window title if
2714: .Ic set-titles
2715: is on.
1.414 nicm 2716: Formats are expanded, see the
2717: .Sx FORMATS
2718: section.
1.1 nicm 2719: .It Xo Ic status
1.56 jmc 2720: .Op Ic on | off
1.1 nicm 2721: .Xc
2722: Show or hide the status line.
2723: .It Ic status-interval Ar interval
2724: Update the status bar every
2725: .Ar interval
2726: seconds.
2727: By default, updates will occur every 15 seconds.
2728: A setting of zero disables redrawing at interval.
1.41 nicm 2729: .It Xo Ic status-justify
1.56 jmc 2730: .Op Ic left | centre | right
1.41 nicm 2731: .Xc
2732: Set the position of the window list component of the status line: left, centre
2733: or right justified.
1.1 nicm 2734: .It Xo Ic status-keys
1.56 jmc 2735: .Op Ic vi | emacs
1.1 nicm 2736: .Xc
1.6 jmc 2737: Use vi or emacs-style
1.1 nicm 2738: key bindings in the status line, for example at the command prompt.
1.191 nicm 2739: The default is emacs, unless the
2740: .Ev VISUAL
2741: or
2742: .Ev EDITOR
2743: environment variables are set and contain the string
2744: .Ql vi .
1.1 nicm 2745: .It Ic status-left Ar string
2746: Display
2747: .Ar string
1.359 nicm 2748: (by default the session name) to the left of the status bar.
1.1 nicm 2749: .Ar string
2750: will be passed through
2751: .Xr strftime 3
1.359 nicm 2752: and formats (see
1.379 jmc 2753: .Sx FORMATS )
1.359 nicm 2754: will be expanded.
1.486 jmc 2755: It may also contain the special character sequence #[] to change the colour
1.485 nicm 2756: or attributes, for example
2757: .Ql #[fg=red,bright]
2758: to set a bright red foreground.
2759: See the
2760: .Ic message-command-style
2761: option for a description of colours and attributes.
1.83 nicm 2762: .Pp
1.263 nicm 2763: For details on how the names and titles can be set see the
1.261 nicm 2764: .Sx "NAMES AND TITLES"
2765: section.
1.109 nicm 2766: .Pp
1.83 nicm 2767: Examples are:
2768: .Bd -literal -offset indent
2769: #(sysctl vm.loadavg)
2770: #[fg=yellow,bold]#(apm -l)%%#[default] [#S]
2771: .Ed
1.10 nicm 2772: .Pp
1.405 nicm 2773: The default is
2774: .Ql "[#S] " .
1.1 nicm 2775: .It Ic status-left-length Ar length
2776: Set the maximum
2777: .Ar length
2778: of the left component of the status bar.
2779: The default is 10.
1.378 nicm 2780: .It Ic status-left-style Ar style
2781: Set the style of the left part of the status line.
2782: For how to specify
2783: .Ar style ,
2784: see the
2785: .Ic message-command-style
2786: option.
1.269 nicm 2787: .It Xo Ic status-position
2788: .Op Ic top | bottom
2789: .Xc
2790: Set the position of the status line.
1.1 nicm 2791: .It Ic status-right Ar string
2792: Display
2793: .Ar string
2794: to the right of the status bar.
1.151 nicm 2795: By default, the current window title in double quotes, the date and the time
2796: are shown.
1.1 nicm 2797: As with
2798: .Ic status-left ,
2799: .Ar string
2800: will be passed to
1.459 jmc 2801: .Xr strftime 3
2802: and character pairs are replaced.
1.1 nicm 2803: .It Ic status-right-length Ar length
2804: Set the maximum
2805: .Ar length
2806: of the right component of the status bar.
2807: The default is 40.
1.378 nicm 2808: .It Ic status-right-style Ar style
2809: Set the style of the right part of the status line.
2810: For how to specify
2811: .Ar style ,
2812: see the
2813: .Ic message-command-style
2814: option.
2815: .It Ic status-style Ar style
2816: Set status line style.
2817: For how to specify
2818: .Ar style ,
2819: see the
2820: .Ic message-command-style
2821: option.
1.63 nicm 2822: .It Ic update-environment Ar variables
2823: Set a space-separated string containing a list of environment variables to be
2824: copied into the session environment when a new session is created or an
2825: existing session is attached.
2826: Any variables that do not exist in the source environment are set to be
2827: removed from the session environment (as if
2828: .Fl r
2829: was given to the
2830: .Ic set-environment
2831: command).
2832: The default is
1.190 nicm 2833: "DISPLAY SSH_ASKPASS SSH_AUTH_SOCK SSH_AGENT_PID SSH_CONNECTION WINDOWID
2834: XAUTHORITY".
1.37 nicm 2835: .It Xo Ic visual-activity
1.56 jmc 2836: .Op Ic on | off
1.37 nicm 2837: .Xc
2838: If on, display a status line message when activity occurs in a window
1.39 jmc 2839: for which the
1.37 nicm 2840: .Ic monitor-activity
2841: window option is enabled.
2842: .It Xo Ic visual-bell
1.56 jmc 2843: .Op Ic on | off
1.37 nicm 2844: .Xc
2845: If this option is on, a message is shown on a bell instead of it being passed
2846: through to the terminal (which normally makes a sound).
2847: Also see the
2848: .Ic bell-action
2849: option.
1.192 nicm 2850: .It Xo Ic visual-silence
2851: .Op Ic on | off
2852: .Xc
2853: If
2854: .Ic monitor-silence
2855: is enabled, prints a message after the interval has expired on a given window.
1.255 nicm 2856: .It Ic word-separators Ar string
2857: Sets the session's conception of what characters are considered word
2858: separators, for the purposes of the next and previous word commands in
2859: copy mode.
2860: The default is
2861: .Ql \ -_@ .
1.1 nicm 2862: .El
2863: .It Xo Ic set-window-option
1.356 nicm 2864: .Op Fl agoqu
1.1 nicm 2865: .Op Fl t Ar target-window
2866: .Ar option Ar value
2867: .Xc
2868: .D1 (alias: Ic setw )
1.18 nicm 2869: Set a window option.
1.1 nicm 2870: The
1.58 nicm 2871: .Fl a ,
1.281 nicm 2872: .Fl g ,
1.356 nicm 2873: .Fl o ,
1.281 nicm 2874: .Fl q
1.1 nicm 2875: and
2876: .Fl u
2877: flags work similarly to the
2878: .Ic set-option
2879: command.
2880: .Pp
1.18 nicm 2881: Supported window options are:
1.56 jmc 2882: .Pp
2883: .Bl -tag -width Ds -compact
1.1 nicm 2884: .It Xo Ic aggressive-resize
1.56 jmc 2885: .Op Ic on | off
1.1 nicm 2886: .Xc
2887: Aggressively resize the chosen window.
2888: This means that
2889: .Nm
2890: will resize the window to the size of the smallest session for which it is the
2891: current window, rather than the smallest session to which it is attached.
2892: The window may resize when the current window is changed on another sessions;
1.6 jmc 2893: this option is good for full-screen programs which support
2894: .Dv SIGWINCH
2895: and poor for interactive programs such as shells.
1.262 nicm 2896: .Pp
2897: .It Xo Ic allow-rename
2898: .Op Ic on | off
2899: .Xc
2900: Allow programs to change the window name using a terminal escape
1.478 nicm 2901: sequence (\eek...\ee\e\e).
1.262 nicm 2902: The default is on.
1.56 jmc 2903: .Pp
1.196 nicm 2904: .It Xo Ic alternate-screen
2905: .Op Ic on | off
2906: .Xc
2907: This option configures whether programs running inside
2908: .Nm
2909: may use the terminal alternate screen feature, which allows the
2910: .Em smcup
2911: and
2912: .Em rmcup
2913: .Xr terminfo 5
1.209 nicm 2914: capabilities.
2915: The alternate screen feature preserves the contents of the window when an
2916: interactive application starts and restores it on exit, so that any output
2917: visible before the application starts reappears unchanged after it exits.
2918: The default is on.
1.196 nicm 2919: .Pp
1.1 nicm 2920: .It Xo Ic automatic-rename
1.56 jmc 2921: .Op Ic on | off
1.1 nicm 2922: .Xc
2923: Control automatic window renaming.
2924: When this setting is enabled,
2925: .Nm
1.368 nicm 2926: will rename the window automatically using the format specified by
2927: .Ic automatic-rename-format .
1.1 nicm 2928: This flag is automatically disabled for an individual window when a name
2929: is specified at creation with
1.186 nicm 2930: .Ic new-window
2931: or
1.1 nicm 2932: .Ic new-session ,
2933: or later with
1.261 nicm 2934: .Ic rename-window ,
2935: or with a terminal escape sequence.
1.1 nicm 2936: It may be switched off globally with:
2937: .Bd -literal -offset indent
2938: set-window-option -g automatic-rename off
2939: .Ed
1.368 nicm 2940: .Pp
2941: .It Ic automatic-rename-format Ar format
2942: The format (see
2943: .Sx FORMATS )
2944: used when the
2945: .Ic automatic-rename
2946: option is enabled.
1.56 jmc 2947: .Pp
1.1 nicm 2948: .It Ic clock-mode-colour Ar colour
2949: Set clock colour.
1.56 jmc 2950: .Pp
1.1 nicm 2951: .It Xo Ic clock-mode-style
1.56 jmc 2952: .Op Ic 12 | 24
1.1 nicm 2953: .Xc
2954: Set clock hour format.
1.56 jmc 2955: .Pp
1.1 nicm 2956: .It Ic force-height Ar height
2957: .It Ic force-width Ar width
2958: Prevent
2959: .Nm
2960: from resizing a window to greater than
2961: .Ar width
2962: or
2963: .Ar height .
2964: A value of zero restores the default unlimited setting.
1.56 jmc 2965: .Pp
1.196 nicm 2966: .It Ic main-pane-height Ar height
1.2 nicm 2967: .It Ic main-pane-width Ar width
2968: Set the width or height of the main (left or top) pane in the
2969: .Ic main-horizontal
2970: or
2971: .Ic main-vertical
2972: layouts.
1.56 jmc 2973: .Pp
1.1 nicm 2974: .It Xo Ic mode-keys
1.56 jmc 2975: .Op Ic vi | emacs
1.1 nicm 2976: .Xc
1.500 nicm 2977: Use vi or emacs-style key bindings in copy mode.
2978: The default is emacs, unless
1.191 nicm 2979: .Ev VISUAL
2980: or
2981: .Ev EDITOR
2982: contains
2983: .Ql vi .
1.56 jmc 2984: .Pp
1.378 nicm 2985: .It Ic mode-style Ar style
2986: Set window modes style.
2987: For how to specify
2988: .Ar style ,
2989: see the
2990: .Ic message-command-style
2991: option.
2992: .Pp
1.1 nicm 2993: .It Xo Ic monitor-activity
1.56 jmc 2994: .Op Ic on | off
1.1 nicm 2995: .Xc
2996: Monitor for activity in the window.
2997: Windows with activity are highlighted in the status line.
1.56 jmc 2998: .Pp
1.192 nicm 2999: .It Xo Ic monitor-silence
3000: .Op Ic interval
3001: .Xc
3002: Monitor for silence (no activity) in the window within
3003: .Ic interval
3004: seconds.
3005: Windows that have been silent for the interval are highlighted in the
3006: status line.
3007: An interval of zero disables the monitoring.
1.195 nicm 3008: .Pp
3009: .It Ic other-pane-height Ar height
3010: Set the height of the other panes (not the main pane) in the
3011: .Ic main-horizontal
3012: layout.
3013: If this option is set to 0 (the default), it will have no effect.
3014: If both the
3015: .Ic main-pane-height
3016: and
3017: .Ic other-pane-height
3018: options are set, the main pane will grow taller to make the other panes the
3019: specified height, but will never shrink to do so.
3020: .Pp
3021: .It Ic other-pane-width Ar width
3022: Like
3023: .Ic other-pane-height ,
3024: but set the width of other panes in the
3025: .Ic main-vertical
3026: layout.
1.243 nicm 3027: .Pp
1.413 nicm 3028: .It Ic pane-active-border-style Ar style
3029: Set the pane border style for the currently active pane.
3030: For how to specify
3031: .Ar style ,
3032: see the
3033: .Ic message-command-style
3034: option.
3035: Attributes are ignored.
3036: .Pp
1.243 nicm 3037: .It Ic pane-base-index Ar index
3038: Like
3039: .Ic base-index ,
3040: but set the starting index for pane numbers.
1.484 nicm 3041: .Pp
3042: .It Ic pane-border-format Ar format
3043: Set the text shown in pane border status lines.
3044: .Pp
3045: .It Xo Ic pane-border-status
3046: .Op Ic off | top | bottom
3047: .Xc
3048: Turn pane border status lines off or set their position.
1.413 nicm 3049: .Pp
3050: .It Ic pane-border-style Ar style
3051: Set the pane border style for panes aside from the active pane.
3052: For how to specify
3053: .Ar style ,
3054: see the
3055: .Ic message-command-style
3056: option.
3057: Attributes are ignored.
1.192 nicm 3058: .Pp
1.1 nicm 3059: .It Xo Ic remain-on-exit
1.56 jmc 3060: .Op Ic on | off
1.1 nicm 3061: .Xc
3062: A window with this flag set is not destroyed when the program running in it
3063: exits.
3064: The window may be reactivated with the
3065: .Ic respawn-window
3066: command.
1.56 jmc 3067: .Pp
1.99 nicm 3068: .It Xo Ic synchronize-panes
3069: .Op Ic on | off
3070: .Xc
1.164 nicm 3071: Duplicate input to any pane to all other panes in the same window (only
3072: for panes that are not in any special mode).
1.56 jmc 3073: .Pp
1.418 nicm 3074: .It Ic window-active-style Ar style
3075: Set the style for the window's active pane.
3076: For how to specify
3077: .Ar style ,
3078: see the
3079: .Ic message-command-style
3080: option.
3081: .Pp
1.378 nicm 3082: .It Ic window-status-activity-style Ar style
3083: Set status line style for windows with an activity alert.
3084: For how to specify
3085: .Ar style ,
3086: see the
3087: .Ic message-command-style
3088: option.
1.169 nicm 3089: .Pp
1.378 nicm 3090: .It Ic window-status-bell-style Ar style
3091: Set status line style for windows with a bell alert.
3092: For how to specify
3093: .Ar style ,
3094: see the
3095: .Ic message-command-style
3096: option.
1.169 nicm 3097: .Pp
1.125 nicm 3098: .It Ic window-status-current-format Ar string
3099: Like
3100: .Ar window-status-format ,
3101: but is the format used when the window is the current window.
1.307 nicm 3102: .Pp
1.378 nicm 3103: .It Ic window-status-current-style Ar style
3104: Set status line style for the currently active window.
3105: For how to specify
3106: .Ar style ,
3107: see the
3108: .Ic message-command-style
3109: option.
1.239 nicm 3110: .Pp
3111: .It Ic window-status-format Ar string
3112: Set the format in which the window is displayed in the status line window list.
3113: See the
3114: .Ar status-left
3115: option for details of special character sequences available.
3116: The default is
3117: .Ql #I:#W#F .
1.290 nicm 3118: .Pp
1.378 nicm 3119: .It Ic window-status-last-style Ar style
3120: Set status line style for the last active window.
3121: For how to specify
3122: .Ar style ,
3123: see the
3124: .Ic message-command-style
3125: option.
3126: .Pp
1.290 nicm 3127: .It Ic window-status-separator Ar string
3128: Sets the separator drawn between windows in the status line.
3129: The default is a single space character.
1.125 nicm 3130: .Pp
1.378 nicm 3131: .It Ic window-status-style Ar style
3132: Set status line style for a single window.
1.418 nicm 3133: For how to specify
3134: .Ar style ,
3135: see the
3136: .Ic message-command-style
3137: option.
3138: .Pp
3139: .It Ic window-style Ar style
3140: Set the default window style.
1.378 nicm 3141: For how to specify
3142: .Ar style ,
3143: see the
3144: .Ic message-command-style
3145: option.
3146: .Pp
1.512 nicm 3147: .It Xo Ic wrap-search
3148: .Op Ic on | off
3149: .Xc
3150: If this option is set, searches will wrap around the end of the pane contents.
3151: The default is on.
1.513 nicm 3152: .Pp
1.1 nicm 3153: .It Xo Ic xterm-keys
1.56 jmc 3154: .Op Ic on | off
1.1 nicm 3155: .Xc
3156: If this option is set,
3157: .Nm
3158: will generate
1.57 jmc 3159: .Xr xterm 1 -style
3160: function key sequences; these have a number included to indicate modifiers such
3161: as Shift, Alt or Ctrl.
1.123 nicm 3162: The default is off.
1.57 jmc 3163: .El
3164: .It Xo Ic show-options
1.340 nicm 3165: .Op Fl gqsvw
1.129 nicm 3166: .Op Fl t Ar target-session | Ar target-window
1.276 nicm 3167: .Op Ar option
1.57 jmc 3168: .Xc
3169: .D1 (alias: Ic show )
1.276 nicm 3170: Show the window options (or a single window option if given) with
1.129 nicm 3171: .Fl w
1.133 nicm 3172: (equivalent to
1.134 nicm 3173: .Ic show-window-options ) ,
1.133 nicm 3174: the server options with
3175: .Fl s ,
3176: otherwise the session options for
3177: .Ar target session .
3178: Global session or window options are listed if
3179: .Fl g
3180: is used.
1.317 nicm 3181: .Fl v
3182: shows only the option value, not the name.
1.340 nicm 3183: If
3184: .Fl q
3185: is set, no error will be returned if
3186: .Ar option
3187: is unset.
1.57 jmc 3188: .It Xo Ic show-window-options
1.317 nicm 3189: .Op Fl gv
1.57 jmc 3190: .Op Fl t Ar target-window
1.276 nicm 3191: .Op Ar option
1.57 jmc 3192: .Xc
3193: .D1 (alias: Ic showw )
1.276 nicm 3194: List the window options or a single option for
1.57 jmc 3195: .Ar target-window ,
3196: or the global window options if
3197: .Fl g
3198: is used.
1.317 nicm 3199: .Fl v
3200: shows only the option value, not the name.
1.63 nicm 3201: .El
1.469 nicm 3202: .Sh HOOKS
3203: .Nm
3204: allows commands to run on various triggers, called
3205: .Em hooks .
1.505 nicm 3206: Most
1.483 nicm 3207: .Nm
1.505 nicm 3208: commands have an
1.483 nicm 3209: .Em after
3210: hook and there are a number of hooks not associated with commands.
3211: .Pp
1.505 nicm 3212: A command's after
3213: hook is run after it completes, except when the command is run as part of a hook
1.483 nicm 3214: itself.
1.505 nicm 3215: They are named with an
1.483 nicm 3216: .Ql after-
3217: prefix.
3218: For example, the following command adds a hook to select the even-vertical
3219: layout after every
3220: .Ic split-window :
3221: .Bd -literal -offset indent
3222: set-hook after-split-window "selectl even-vertical"
3223: .Ed
3224: .Pp
3225: In addition, the following hooks are available:
1.469 nicm 3226: .Bl -tag -width "XXXXXXXXXXXXXXXX"
1.476 nicm 3227: .It alert-activity
3228: Run when a window has activity.
3229: See
3230: .Ic monitor-activity .
3231: .It alert-bell
3232: Run when a window has received a bell.
3233: .It alert-silence
3234: Run when a window has been silent.
3235: See
3236: .Ic monitor-silence .
1.469 nicm 3237: .It client-attached
3238: Run when a client is attached.
3239: .It client-detached
3240: Run when a client is detached
3241: .It client-resized
3242: Run when a client is resized.
1.511 nicm 3243: .It client-session-changed
3244: Run when a client's attached session is changed.
1.475 nicm 3245: .It pane-died
3246: Run when the program running in a pane exits, but
3247: .Ic remain-on-exit
3248: is on so the pane has not closed.
3249: .It pane-exited
3250: Run when the program running in a pane exits.
1.510 nicm 3251: .It session-created
3252: Run when a new session created.
3253: .It session-closed
3254: Run when a session closed.
1.507 nicm 3255: .It session-renamed
3256: Run when a session is renamed.
1.511 nicm 3257: .It window-linked
3258: Run when a window is linked into a session.
1.507 nicm 3259: .It window-renamed
3260: Run when a window is renamed.
1.511 nicm 3261: .It window-unlinked
3262: Run when a window is unlinked from a session.
1.469 nicm 3263: .El
3264: .Pp
3265: Hooks are managed with these commands:
3266: .Bl -tag -width Ds
3267: .It Xo Ic set-hook
1.496 nicm 3268: .Op Fl gu
1.469 nicm 3269: .Op Fl t Ar target-session
3270: .Ar hook-name
3271: .Ar command
3272: .Xc
1.496 nicm 3273: Sets (or with
3274: .Fl u
3275: unsets) hook
1.469 nicm 3276: .Ar hook-name
3277: to
3278: .Ar command .
3279: If
3280: .Fl g
3281: is given,
3282: .Em hook-name
3283: is added to the global list of hooks, otherwise it is added to the session
3284: hooks (for
3285: .Ar target-session
3286: with
3287: .Fl t ) .
3288: Like options, session hooks inherit from the global ones.
3289: .It Xo Ic show-hooks
3290: .Op Fl g
3291: .Op Fl t Ar target-session
3292: .Xc
3293: Shows the global list of hooks with
3294: .Fl g ,
3295: otherwise the session hooks.
1.470 jmc 3296: .El
1.419 nicm 3297: .Sh MOUSE SUPPORT
3298: If the
3299: .Ic mouse
3300: option is on (the default is off),
3301: .Nm
3302: allows mouse events to be bound as keys.
3303: The name of each key is made up of a mouse event (such as
3304: .Ql MouseUp1 )
3305: and a location suffix (one of
3306: .Ql Pane
3307: for the contents of a pane,
3308: .Ql Border
3309: for a pane border or
3310: .Ql Status
3311: for the status line).
3312: The following mouse events are available:
3313: .Bl -column "MouseDown1" "MouseDrag1" "WheelDown" -offset indent
1.498 nicm 3314: .It Li "WheelUp" Ta "WheelDown" Ta ""
1.481 nicm 3315: .It Li "MouseDown1" Ta "MouseUp1" Ta "MouseDrag1" Ta "MouseDragEnd1"
3316: .It Li "MouseDown2" Ta "MouseUp2" Ta "MouseDrag2" Ta "MouseDragEnd2"
3317: .It Li "MouseDown3" Ta "MouseUp3" Ta "MouseDrag3" Ta "MouseDragEnd3"
1.498 nicm 3318: .It Li "DoubleClick1" Ta "DoubleClick2" Ta "DoubleClick3" Ta "WheelUp"
3319: .It Li "TripleClick1" Ta "TripleClick2" Ta "TripleClick3" Ta "WheelDown"
1.419 nicm 3320: .El
3321: .Pp
3322: Each should be suffixed with a location, for example
3323: .Ql MouseDown1Status .
3324: .Pp
1.423 nicm 3325: The special token
3326: .Ql {mouse}
3327: or
1.419 nicm 3328: .Ql =
3329: may be used as
3330: .Ar target-window
3331: or
3332: .Ar target-pane
3333: in commands bound to mouse key bindings.
3334: It resolves to the window or pane over which the mouse event took place
3335: (for example, the window in the status line over which button 1 was released for a
3336: .Ql MouseUp1Status
3337: binding, or the pane over which the wheel was scrolled for a
3338: .Ql WheelDownPane
3339: binding).
3340: .Pp
3341: The
3342: .Ic send-keys
3343: .Fl M
3344: flag may be used to forward a mouse event to a pane.
3345: .Pp
3346: The default key bindings allow the mouse to be used to select and resize panes,
3347: to copy text and to change window using the status line.
3348: These take effect if the
3349: .Ic mouse
3350: option is turned on.
1.245 nicm 3351: .Sh FORMATS
1.294 nicm 3352: Certain commands accept the
1.245 nicm 3353: .Fl F
3354: flag with a
3355: .Ar format
3356: argument.
3357: This is a string which controls the output format of the command.
3358: Replacement variables are enclosed in
3359: .Ql #{
3360: and
3361: .Ql } ,
3362: for example
1.359 nicm 3363: .Ql #{session_name} .
1.409 nicm 3364: The possible variables are listed in the table below, or the name of a
3365: .Nm
3366: option may be used for an option's value.
3367: Some variables have a shorter alias such as
3368: .Ql #S ,
3369: and
1.376 nicm 3370: .Ql ##
3371: is replaced by a single
3372: .Ql # .
1.409 nicm 3373: .Pp
3374: Conditionals are available by prefixing with
1.246 jmc 3375: .Ql \&?
1.245 nicm 3376: and separating two alternatives with a comma;
3377: if the specified variable exists and is not zero, the first alternative
1.246 jmc 3378: is chosen, otherwise the second is used.
3379: For example
1.245 nicm 3380: .Ql #{?session_attached,attached,not attached}
3381: will include the string
3382: .Ql attached
3383: if the session is attached and the string
3384: .Ql not attached
1.409 nicm 3385: if it is unattached, or
3386: .Ql #{?automatic-rename,yes,no}
3387: will include
3388: .Ql yes
3389: if
3390: .Ic automatic-rename
3391: is enabled, or
3392: .Ql no
3393: if not.
1.453 nicm 3394: .Pp
1.367 nicm 3395: A limit may be placed on the length of the resultant string by prefixing it
3396: by an
3397: .Ql = ,
1.479 nicm 3398: a number and a colon.
3399: Positive numbers count from the start of the string and negative from the end,
3400: so
3401: .Ql #{=5:pane_title}
3402: will include at most the first 5 characters of the pane title, or
3403: .Ql #{=-5:pane_title}
3404: the last 5 characters.
1.453 nicm 3405: Prefixing a time variable with
3406: .Ql t:
3407: will convert it to a string, so if
3408: .Ql #{window_activity}
3409: gives
1.454 jmc 3410: .Ql 1445765102 ,
1.453 nicm 3411: .Ql #{t:window_activity}
3412: gives
3413: .Ql Sun Oct 25 09:25:02 2015 .
3414: The
3415: .Ql b:
3416: and
3417: .Ql d:
3418: prefixes are
3419: .Xr basename 3
3420: and
3421: .Xr dirname 3
3422: of the variable respectively.
1.461 nicm 3423: A prefix of the form
3424: .Ql s/foo/bar/:
3425: will substitute
3426: .Ql foo
3427: with
3428: .Ql bar
3429: throughout.
1.431 nicm 3430: .Pp
3431: In addition, the first line of a shell command's output may be inserted using
3432: .Ql #() .
3433: For example,
3434: .Ql #(uptime)
3435: will insert the system's uptime.
3436: When constructing formats,
3437: .Nm
3438: does not wait for
3439: .Ql #()
3440: commands to finish; instead, the previous result from running the same command is used,
3441: or a placeholder if the command has not been run before.
3442: Commands are executed with the
3443: .Nm
3444: global environment set (see the
3445: .Sx ENVIRONMENT
3446: section).
1.245 nicm 3447: .Pp
3448: The following variables are available, where appropriate:
1.359 nicm 3449: .Bl -column "XXXXXXXXXXXXXXXXXXX" "XXXXX"
3450: .It Sy "Variable name" Ta Sy "Alias" Ta Sy "Replaced with"
3451: .It Li "alternate_on" Ta "" Ta "If pane is in alternate screen"
3452: .It Li "alternate_saved_x" Ta "" Ta "Saved cursor X in alternate screen"
3453: .It Li "alternate_saved_y" Ta "" Ta "Saved cursor Y in alternate screen"
1.490 nicm 3454: .It Li "buffer_name" Ta "" Ta "Name of buffer"
1.386 nicm 3455: .It Li "buffer_sample" Ta "" Ta "Sample of start of buffer"
1.359 nicm 3456: .It Li "buffer_size" Ta "" Ta "Size of the specified buffer in bytes"
3457: .It Li "client_activity" Ta "" Ta "Integer time client last had activity"
3458: .It Li "client_created" Ta "" Ta "Integer time client created"
1.443 nicm 3459: .It Li "client_control_mode" Ta "" Ta "1 if client is in control mode"
1.359 nicm 3460: .It Li "client_height" Ta "" Ta "Height of client"
1.451 nicm 3461: .It Li "client_key_table" Ta "" Ta "Current key table"
1.359 nicm 3462: .It Li "client_last_session" Ta "" Ta "Name of the client's last session"
1.437 nicm 3463: .It Li "client_pid" Ta "" Ta "PID of client process"
1.359 nicm 3464: .It Li "client_prefix" Ta "" Ta "1 if prefix key has been pressed"
3465: .It Li "client_readonly" Ta "" Ta "1 if client is readonly"
3466: .It Li "client_session" Ta "" Ta "Name of the client's session"
3467: .It Li "client_termname" Ta "" Ta "Terminal name of client"
3468: .It Li "client_tty" Ta "" Ta "Pseudo terminal of client"
3469: .It Li "client_utf8" Ta "" Ta "1 if client supports utf8"
3470: .It Li "client_width" Ta "" Ta "Width of client"
1.509 nicm 3471: .It Li "command" Ta "" Ta "Name of command in use, if any"
1.489 nicm 3472: .It Li "command_list_name" Ta "" Ta "Command name if listing commands"
3473: .It Li "command_list_alias" Ta "" Ta "Command alias if listing commands"
3474: .It Li "command_list_usage" Ta "" Ta "Command usage if listing commands"
1.359 nicm 3475: .It Li "cursor_flag" Ta "" Ta "Pane cursor flag"
3476: .It Li "cursor_x" Ta "" Ta "Cursor X position in pane"
3477: .It Li "cursor_y" Ta "" Ta "Cursor Y position in pane"
3478: .It Li "history_bytes" Ta "" Ta "Number of bytes in window history"
3479: .It Li "history_limit" Ta "" Ta "Maximum window history lines"
3480: .It Li "history_size" Ta "" Ta "Size of history in bytes"
1.509 nicm 3481: .It Li "hook" Ta "" Ta "Name of running hook, if any"
1.511 nicm 3482: .It Li "hook_pane" Ta "" Ta "ID of pane where hook was run, if any"
1.510 nicm 3483: .It Li "hook_session" Ta "" Ta "ID of session where hook was run, if any"
3484: .It Li "hook_session_name" Ta "" Ta "Name of session where hook was run, if any"
3485: .It Li "hook_window" Ta "" Ta "ID of window where hook was run, if any"
3486: .It Li "hook_window_name" Ta "" Ta "Name of window where hook was run, if any"
1.359 nicm 3487: .It Li "host" Ta "#H" Ta "Hostname of local host"
3488: .It Li "host_short" Ta "#h" Ta "Hostname of local host (no domain name)"
3489: .It Li "insert_flag" Ta "" Ta "Pane insert flag"
3490: .It Li "keypad_cursor_flag" Ta "" Ta "Pane keypad cursor flag"
3491: .It Li "keypad_flag" Ta "" Ta "Pane keypad flag"
3492: .It Li "line" Ta "" Ta "Line number in the list"
3493: .It Li "mouse_any_flag" Ta "" Ta "Pane mouse any flag"
3494: .It Li "mouse_button_flag" Ta "" Ta "Pane mouse button flag"
3495: .It Li "mouse_standard_flag" Ta "" Ta "Pane mouse standard flag"
3496: .It Li "pane_active" Ta "" Ta "1 if active pane"
1.396 nicm 3497: .It Li "pane_bottom" Ta "" Ta "Bottom of pane"
1.359 nicm 3498: .It Li "pane_current_command" Ta "" Ta "Current command if available"
3499: .It Li "pane_dead" Ta "" Ta "1 if pane is dead"
1.411 nicm 3500: .It Li "pane_dead_status" Ta "" Ta "Exit status of process in dead pane"
1.359 nicm 3501: .It Li "pane_height" Ta "" Ta "Height of pane"
3502: .It Li "pane_id" Ta "#D" Ta "Unique pane ID"
3503: .It Li "pane_in_mode" Ta "" Ta "If pane is in a mode"
1.404 nicm 3504: .It Li "pane_input_off" Ta "" Ta "If input to pane is disabled"
1.359 nicm 3505: .It Li "pane_index" Ta "#P" Ta "Index of pane"
1.396 nicm 3506: .It Li "pane_left" Ta "" Ta "Left of pane"
1.359 nicm 3507: .It Li "pane_pid" Ta "" Ta "PID of first process in pane"
1.396 nicm 3508: .It Li "pane_right" Ta "" Ta "Right of pane"
1.359 nicm 3509: .It Li "pane_start_command" Ta "" Ta "Command pane started with"
1.396 nicm 3510: .It Li "pane_synchronized" Ta "" Ta "If pane is synchronized"
1.359 nicm 3511: .It Li "pane_tabs" Ta "" Ta "Pane tab positions"
3512: .It Li "pane_title" Ta "#T" Ta "Title of pane"
1.396 nicm 3513: .It Li "pane_top" Ta "" Ta "Top of pane"
1.359 nicm 3514: .It Li "pane_tty" Ta "" Ta "Pseudo terminal of pane"
3515: .It Li "pane_width" Ta "" Ta "Width of pane"
1.437 nicm 3516: .It Li "pid" Ta "" Ta "Server PID"
1.359 nicm 3517: .It Li "scroll_region_lower" Ta "" Ta "Bottom of scroll region in pane"
3518: .It Li "scroll_region_upper" Ta "" Ta "Top of scroll region in pane"
1.452 nicm 3519: .It Li "scroll_position" Ta "" Ta "Scroll position in copy mode"
1.430 nicm 3520: .It Li "session_alerts" Ta "" Ta "List of window indexes with alerts"
1.382 nicm 3521: .It Li "session_attached" Ta "" Ta "Number of clients session is attached to"
1.415 nicm 3522: .It Li "session_activity" Ta "" Ta "Integer time of session last activity"
1.359 nicm 3523: .It Li "session_created" Ta "" Ta "Integer time session created"
1.449 nicm 3524: .It Li "session_last_attached" Ta "" Ta "Integer time session last attached"
1.359 nicm 3525: .It Li "session_group" Ta "" Ta "Number of session group"
3526: .It Li "session_grouped" Ta "" Ta "1 if session in a group"
3527: .It Li "session_height" Ta "" Ta "Height of session"
3528: .It Li "session_id" Ta "" Ta "Unique session ID"
1.382 nicm 3529: .It Li "session_many_attached" Ta "" Ta "1 if multiple clients attached"
1.359 nicm 3530: .It Li "session_name" Ta "#S" Ta "Name of session"
3531: .It Li "session_width" Ta "" Ta "Width of session"
3532: .It Li "session_windows" Ta "" Ta "Number of windows in session"
1.487 nicm 3533: .It Li "socket_path" Ta "" Ta "Server socket path"
1.465 nicm 3534: .It Li "start_time" Ta "" Ta "Server start time"
1.438 nicm 3535: .It Li "window_activity" Ta "" Ta "Integer time of window last activity"
1.487 nicm 3536: .It Li "window_activity_flag" Ta "" Ta "1 if window has activity"
1.359 nicm 3537: .It Li "window_active" Ta "" Ta "1 if window active"
1.366 nicm 3538: .It Li "window_bell_flag" Ta "" Ta "1 if window has bell"
1.359 nicm 3539: .It Li "window_find_matches" Ta "" Ta "Matched data from the find-window"
3540: .It Li "window_flags" Ta "#F" Ta "Window flags"
3541: .It Li "window_height" Ta "" Ta "Height of window"
3542: .It Li "window_id" Ta "" Ta "Unique window ID"
3543: .It Li "window_index" Ta "#I" Ta "Index of window"
1.400 nicm 3544: .It Li "window_last_flag" Ta "" Ta "1 if window is the last used"
1.460 nicm 3545: .It Li "window_layout" Ta "" Ta "Window layout description, ignoring zoomed window panes"
1.426 nicm 3546: .It Li "window_linked" Ta "" Ta "1 if window is linked across sessions"
1.359 nicm 3547: .It Li "window_name" Ta "#W" Ta "Name of window"
3548: .It Li "window_panes" Ta "" Ta "Number of panes in window"
1.366 nicm 3549: .It Li "window_silence_flag" Ta "" Ta "1 if window has silence alert"
1.460 nicm 3550: .It Li "window_visible_layout" Ta "" Ta "Window layout description, respecting zoomed window panes"
1.359 nicm 3551: .It Li "window_width" Ta "" Ta "Width of window"
1.400 nicm 3552: .It Li "window_zoomed_flag" Ta "" Ta "1 if window is zoomed"
1.359 nicm 3553: .It Li "wrap_flag" Ta "" Ta "Pane wrap flag"
1.245 nicm 3554: .El
1.261 nicm 3555: .Sh NAMES AND TITLES
3556: .Nm
3557: distinguishes between names and titles.
3558: Windows and sessions have names, which may be used to specify them in targets
3559: and are displayed in the status line and various lists: the name is the
3560: .Nm
3561: identifier for a window or session.
3562: Only panes have titles.
3563: A pane's title is typically set by the program running inside the pane and
3564: is not modified by
3565: .Nm .
3566: It is the same mechanism used to set for example the
3567: .Xr xterm 1
3568: window title in an
3569: .Xr X 7
3570: window manager.
1.268 nicm 3571: Windows themselves do not have titles - a window's title is the title of its
1.261 nicm 3572: active pane.
3573: .Nm
3574: itself may set the title of the terminal in which the client is running, see
3575: the
3576: .Ic set-titles
3577: option.
3578: .Pp
3579: A session's name is set with the
3580: .Ic new-session
3581: and
3582: .Ic rename-session
3583: commands.
3584: A window's name is set with one of:
3585: .Bl -enum -width Ds
3586: .It
3587: A command argument (such as
3588: .Fl n
3589: for
3590: .Ic new-window
3591: or
3592: .Ic new-session ) .
3593: .It
3594: An escape sequence:
3595: .Bd -literal -offset indent
3596: $ printf '\e033kWINDOW_NAME\e033\e\e'
3597: .Ed
3598: .It
3599: Automatic renaming, which sets the name to the active command in the window's
3600: active pane.
3601: See the
3602: .Ic automatic-rename
3603: option.
3604: .El
3605: .Pp
3606: When a pane is first created, its title is the hostname.
3607: A pane's title can be set via the OSC title setting sequence, for example:
3608: .Bd -literal -offset indent
3609: $ printf '\e033]2;My Title\e033\e\e'
3610: .Ed
1.63 nicm 3611: .Sh ENVIRONMENT
3612: When the server is started,
3613: .Nm
3614: copies the environment into the
3615: .Em global environment ;
3616: in addition, each session has a
3617: .Em session environment .
1.193 nicm 3618: When a window is created, the session and global environments are merged.
3619: If a variable exists in both, the value from the session environment is used.
3620: The result is the initial environment passed to the new process.
1.63 nicm 3621: .Pp
3622: The
3623: .Ic update-environment
3624: session option may be used to update the session environment from the client
3625: when a new session is created or an old reattached.
3626: .Nm
3627: also initialises the
3628: .Ev TMUX
3629: variable with some internal information to allow commands to be executed
3630: from inside, and the
3631: .Ev TERM
3632: variable with the correct terminal setting of
3633: .Ql screen .
3634: .Pp
3635: Commands to alter and view the environment are:
3636: .Bl -tag -width Ds
3637: .It Xo Ic set-environment
3638: .Op Fl gru
3639: .Op Fl t Ar target-session
3640: .Ar name Op Ar value
3641: .Xc
1.115 nicm 3642: .D1 (alias: Ic setenv )
1.63 nicm 3643: Set or unset an environment variable.
3644: If
3645: .Fl g
3646: is used, the change is made in the global environment; otherwise, it is applied
3647: to the session environment for
3648: .Ar target-session .
3649: The
3650: .Fl u
3651: flag unsets a variable.
3652: .Fl r
3653: indicates the variable is to be removed from the environment before starting a
3654: new process.
3655: .It Xo Ic show-environment
1.442 nicm 3656: .Op Fl gs
1.63 nicm 3657: .Op Fl t Ar target-session
1.286 nicm 3658: .Op Ar variable
1.63 nicm 3659: .Xc
1.115 nicm 3660: .D1 (alias: Ic showenv )
1.63 nicm 3661: Display the environment for
3662: .Ar target-session
3663: or the global environment with
3664: .Fl g .
1.286 nicm 3665: If
3666: .Ar variable
3667: is omitted, all variables are shown.
1.63 nicm 3668: Variables removed from the environment are prefixed with
3669: .Ql - .
1.442 nicm 3670: If
3671: .Fl s
3672: is used, the output is formatted as a set of Bourne shell commands.
1.57 jmc 3673: .El
3674: .Sh STATUS LINE
3675: .Nm
3676: includes an optional status line which is displayed in the bottom line of each
3677: terminal.
3678: By default, the status line is enabled (it may be disabled with the
3679: .Ic status
3680: session option) and contains, from left-to-right: the name of the current
1.261 nicm 3681: session in square brackets; the window list; the title of the active pane
3682: in double quotes; and the time and date.
1.57 jmc 3683: .Pp
3684: The status line is made of three parts: configurable left and right sections
3685: (which may contain dynamic content such as the time or output from a shell
3686: command, see the
3687: .Ic status-left ,
3688: .Ic status-left-length ,
3689: .Ic status-right ,
3690: and
3691: .Ic status-right-length
3692: options below), and a central window list.
1.125 nicm 3693: By default, the window list shows the index, name and (if any) flag of the
3694: windows present in the current session in ascending numerical order.
3695: It may be customised with the
3696: .Ar window-status-format
3697: and
3698: .Ar window-status-current-format
3699: options.
1.57 jmc 3700: The flag is one of the following symbols appended to the window name:
3701: .Bl -column "Symbol" "Meaning" -offset indent
3702: .It Sy "Symbol" Ta Sy "Meaning"
3703: .It Li "*" Ta "Denotes the current window."
3704: .It Li "-" Ta "Marks the last window (previously selected)."
3705: .It Li "#" Ta "Window is monitored and activity has been detected."
3706: .It Li "!" Ta "A bell has occurred in the window."
1.192 nicm 3707: .It Li "~" Ta "The window has been silent for the monitor-silence interval."
1.432 nicm 3708: .It Li "M" Ta "The window contains the marked pane."
1.349 nicm 3709: .It Li "Z" Ta "The window's active pane is zoomed."
1.57 jmc 3710: .El
3711: .Pp
3712: The # symbol relates to the
3713: .Ic monitor-activity
1.388 nicm 3714: window option.
1.57 jmc 3715: The window name is printed in inverted colours if an alert (bell, activity or
1.388 nicm 3716: silence) is present.
1.57 jmc 3717: .Pp
1.131 nicm 3718: The colour and attributes of the status line may be configured, the entire
3719: status line using the
1.378 nicm 3720: .Ic status-style
3721: session option and individual windows using the
3722: .Ic window-status-style
3723: window option.
1.57 jmc 3724: .Pp
1.131 nicm 3725: The status line is automatically refreshed at interval if it has changed, the
3726: interval may be controlled with the
1.57 jmc 3727: .Ic status-interval
3728: session option.
3729: .Pp
3730: Commands related to the status line are as follows:
3731: .Bl -tag -width Ds
3732: .It Xo Ic command-prompt
1.500 nicm 3733: .Op Fl 1
1.235 nicm 3734: .Op Fl I Ar inputs
1.73 nicm 3735: .Op Fl p Ar prompts
1.57 jmc 3736: .Op Fl t Ar target-client
3737: .Op Ar template
3738: .Xc
3739: Open the command prompt in a client.
3740: This may be used from inside
3741: .Nm
3742: to execute commands interactively.
1.231 nicm 3743: .Pp
1.57 jmc 3744: If
3745: .Ar template
1.73 nicm 3746: is specified, it is used as the command.
1.235 nicm 3747: If present,
3748: .Fl I
3749: is a comma-separated list of the initial text for each prompt.
1.73 nicm 3750: If
3751: .Fl p
3752: is given,
3753: .Ar prompts
3754: is a comma-separated list of prompts which are displayed in order; otherwise
3755: a single prompt is displayed, constructed from
3756: .Ar template
3757: if it is present, or
3758: .Ql \&:
3759: if not.
1.231 nicm 3760: .Pp
1.73 nicm 3761: Before the command is executed, the first occurrence of the string
3762: .Ql %%
1.74 jmc 3763: and all occurrences of
1.73 nicm 3764: .Ql %1
1.492 nicm 3765: are replaced by the response to the first prompt, all
1.73 nicm 3766: .Ql %2
3767: are replaced with the response to the second prompt, and so on for further
1.74 jmc 3768: prompts.
3769: Up to nine prompt responses may be replaced
3770: .Po
3771: .Ql %1
1.73 nicm 3772: to
1.74 jmc 3773: .Ql %9
3774: .Pc .
1.513 nicm 3775: .Ql %%%
3776: is like
3777: .Ql %%
3778: but any quotation marks are escaped.
1.497 nicm 3779: .Pp
3780: .Fl 1
3781: makes the prompt only accept one key press, in this case the resulting input
3782: is a single character.
1.500 nicm 3783: .Pp
3784: The following keys have a special meaning in the command prompt, depending
3785: on the value of the
3786: .Ic status-keys
3787: option:
3788: .Bl -column "FunctionXXXXXXXXXXXXXXXXXXXXXXXXX" "viXXXX" "emacsX" -offset indent
3789: .It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
3790: .It Li "Cancel command prompt" Ta "Escape" Ta "Escape"
3791: .It Li "Delete current word" Ta "" Ta "C-w"
3792: .It Li "Delete entire command" Ta "d" Ta "C-u"
3793: .It Li "Delete from cursor to end" Ta "D" Ta "C-k"
3794: .It Li "Execute command" Ta "Enter" Ta "Enter"
3795: .It Li "Get next command from history" Ta "" Ta "Down"
3796: .It Li "Get previous command from history" Ta "" Ta "Up"
3797: .It Li "Insert top paste buffer" Ta "p" Ta "C-y"
3798: .It Li "Look for completions" Ta "Tab" Ta "Tab"
3799: .It Li "Move cursor left" Ta "h" Ta "Left"
3800: .It Li "Move cursor right" Ta "l" Ta "Right"
3801: .It Li "Move cursor to end" Ta "$" Ta "C-e"
3802: .It Li "Move cursor to next word" Ta "w" Ta "M-f"
3803: .It Li "Move cursor to previous word" Ta "b" Ta "M-b"
3804: .It Li "Move cursor to start" Ta "0" Ta "C-a"
3805: .It Li "Transpose characters" Ta "" Ta "C-t"
3806: .El
1.57 jmc 3807: .It Xo Ic confirm-before
1.238 nicm 3808: .Op Fl p Ar prompt
1.57 jmc 3809: .Op Fl t Ar target-client
3810: .Ar command
3811: .Xc
3812: .D1 (alias: Ic confirm )
3813: Ask for confirmation before executing
3814: .Ar command .
1.238 nicm 3815: If
3816: .Fl p
3817: is given,
3818: .Ar prompt
3819: is the prompt to display; otherwise a prompt is constructed from
3820: .Ar command .
3821: It may contain the special character sequences supported by the
3822: .Ic status-left
3823: option.
3824: .Pp
1.57 jmc 3825: This command works only from inside
3826: .Nm .
3827: .It Xo Ic display-message
1.127 nicm 3828: .Op Fl p
1.215 nicm 3829: .Op Fl c Ar target-client
3830: .Op Fl t Ar target-pane
1.57 jmc 3831: .Op Ar message
3832: .Xc
3833: .D1 (alias: Ic display )
1.127 nicm 3834: Display a message.
3835: If
3836: .Fl p
3837: is given, the output is printed to stdout, otherwise it is displayed in the
3838: .Ar target-client
3839: status line.
1.122 nicm 3840: The format of
1.124 jmc 3841: .Ar message
1.275 nicm 3842: is described in the
3843: .Sx FORMATS
3844: section; information is taken from
1.215 nicm 3845: .Ar target-pane
3846: if
3847: .Fl t
3848: is given, otherwise the active pane for the session attached to
3849: .Ar target-client .
1.57 jmc 3850: .El
3851: .Sh BUFFERS
3852: .Nm
1.392 nicm 3853: maintains a set of named
1.199 nicm 3854: .Em paste buffers .
1.392 nicm 3855: Each buffer may be either explicitly or automatically named.
3856: Explicitly named buffers are named when created with the
3857: .Ic set-buffer
3858: or
3859: .Ic load-buffer
3860: commands, or by renaming an automatically named buffer with
3861: .Ic set-buffer
3862: .Fl n .
3863: Automatically named buffers are given a name such as
3864: .Ql buffer0001 ,
3865: .Ql buffer0002
3866: and so on.
3867: When the
3868: .Ic buffer-limit
3869: option is reached, the oldest automatically named buffer is deleted.
1.493 nicm 3870: Explicitly named buffers are not subject to
1.57 jmc 3871: .Ic buffer-limit
1.392 nicm 3872: and may be deleted with
3873: .Ic delete-buffer
3874: command.
3875: .Pp
1.57 jmc 3876: Buffers may be added using
3877: .Ic copy-mode
3878: or the
3879: .Ic set-buffer
1.392 nicm 3880: and
3881: .Ic load-buffer
3882: commands, and pasted into a window using the
1.57 jmc 3883: .Ic paste-buffer
3884: command.
1.392 nicm 3885: If a buffer command is used and no buffer is specified, the most
3886: recently added automatically named buffer is assumed.
1.57 jmc 3887: .Pp
3888: A configurable history buffer is also maintained for each window.
3889: By default, up to 2000 lines are kept; this can be altered with the
3890: .Ic history-limit
3891: option (see the
3892: .Ic set-option
3893: command above).
3894: .Pp
3895: The buffer commands are as follows:
3896: .Bl -tag -width Ds
1.178 nicm 3897: .It Xo
3898: .Ic choose-buffer
1.294 nicm 3899: .Op Fl F Ar format
1.178 nicm 3900: .Op Fl t Ar target-window
3901: .Op Ar template
3902: .Xc
3903: Put a window into buffer choice mode, where a buffer may be chosen
3904: interactively from a list.
3905: After a buffer is selected,
3906: .Ql %%
1.392 nicm 3907: is replaced by the buffer name in
1.178 nicm 3908: .Ar template
3909: and the result executed as a command.
3910: If
3911: .Ar template
3912: is not given, "paste-buffer -b '%%'" is used.
1.294 nicm 3913: For the meaning of the
3914: .Fl F
3915: flag, see the
3916: .Sx FORMATS
3917: section.
1.314 nicm 3918: This command works only if at least one client is attached.
1.57 jmc 3919: .It Ic clear-history Op Fl t Ar target-pane
3920: .D1 (alias: Ic clearhist )
3921: Remove and free the history for the specified pane.
1.392 nicm 3922: .It Ic delete-buffer Op Fl b Ar buffer-name
1.57 jmc 3923: .D1 (alias: Ic deleteb )
1.392 nicm 3924: Delete the buffer named
3925: .Ar buffer-name ,
3926: or the most recently added automatically named buffer if not specified.
1.294 nicm 3927: .It Xo Ic list-buffers
3928: .Op Fl F Ar format
3929: .Xc
1.57 jmc 3930: .D1 (alias: Ic lsb )
1.198 nicm 3931: List the global buffers.
1.294 nicm 3932: For the meaning of the
3933: .Fl F
3934: flag, see the
3935: .Sx FORMATS
3936: section.
1.200 jmc 3937: .It Xo Ic load-buffer
1.392 nicm 3938: .Op Fl b Ar buffer-name
1.57 jmc 3939: .Ar path
3940: .Xc
3941: .D1 (alias: Ic loadb )
3942: Load the contents of the specified paste buffer from
3943: .Ar path .
3944: .It Xo Ic paste-buffer
1.278 nicm 3945: .Op Fl dpr
1.392 nicm 3946: .Op Fl b Ar buffer-name
1.170 nicm 3947: .Op Fl s Ar separator
1.158 nicm 3948: .Op Fl t Ar target-pane
1.57 jmc 3949: .Xc
3950: .D1 (alias: Ic pasteb )
1.158 nicm 3951: Insert the contents of a paste buffer into the specified pane.
3952: If not specified, paste into the current one.
1.57 jmc 3953: With
3954: .Fl d ,
1.392 nicm 3955: also delete the paste buffer.
1.57 jmc 3956: When output, any linefeed (LF) characters in the paste buffer are replaced with
1.170 nicm 3957: a separator, by default carriage return (CR).
3958: A custom separator may be specified using the
3959: .Fl s
3960: flag.
3961: The
1.57 jmc 3962: .Fl r
1.170 nicm 3963: flag means to do no replacement (equivalent to a separator of LF).
1.278 nicm 3964: If
3965: .Fl p
3966: is specified, paste bracket control codes are inserted around the
3967: buffer if the application has requested bracketed paste mode.
1.57 jmc 3968: .It Xo Ic save-buffer
3969: .Op Fl a
1.392 nicm 3970: .Op Fl b Ar buffer-name
1.57 jmc 3971: .Ar path
3972: .Xc
3973: .D1 (alias: Ic saveb )
3974: Save the contents of the specified paste buffer to
3975: .Ar path .
3976: The
3977: .Fl a
3978: option appends to rather than overwriting the file.
3979: .It Xo Ic set-buffer
1.383 nicm 3980: .Op Fl a
1.392 nicm 3981: .Op Fl b Ar buffer-name
3982: .Op Fl n Ar new-buffer-name
1.57 jmc 3983: .Ar data
3984: .Xc
3985: .D1 (alias: Ic setb )
3986: Set the contents of the specified buffer to
3987: .Ar data .
1.383 nicm 3988: The
3989: .Fl a
3990: option appends to rather than overwriting the buffer.
1.392 nicm 3991: The
3992: .Fl n
3993: option renames the buffer to
3994: .Ar new-buffer-name .
1.1 nicm 3995: .It Xo Ic show-buffer
1.392 nicm 3996: .Op Fl b Ar buffer-name
1.1 nicm 3997: .Xc
3998: .D1 (alias: Ic showb )
3999: Display the contents of the specified buffer.
1.57 jmc 4000: .El
4001: .Sh MISCELLANEOUS
4002: Miscellaneous commands are as follows:
4003: .Bl -tag -width Ds
1.72 nicm 4004: .It Ic clock-mode Op Fl t Ar target-pane
1.57 jmc 4005: Display a large clock.
1.334 nicm 4006: .It Xo Ic if-shell
1.410 nicm 4007: .Op Fl bF
1.334 nicm 4008: .Op Fl t Ar target-pane
4009: .Ar shell-command command
4010: .Op Ar command
4011: .Xc
1.57 jmc 4012: .D1 (alias: Ic if )
1.251 nicm 4013: Execute the first
1.57 jmc 4014: .Ar command
4015: if
4016: .Ar shell-command
1.251 nicm 4017: returns success or the second
4018: .Ar command
4019: otherwise.
1.410 nicm 4020: Before being executed,
4021: .Ar shell-command
4022: is expanded using the rules specified in the
1.334 nicm 4023: .Sx FORMATS
4024: section, including those relevant to
4025: .Ar target-pane .
1.335 nicm 4026: With
4027: .Fl b ,
4028: .Ar shell-command
4029: is run in the background.
1.410 nicm 4030: .Pp
4031: If
4032: .Fl F
4033: is given,
4034: .Ar shell-command
4035: is not executed but considered success if neither empty nor zero (after formats
4036: are expanded).
1.57 jmc 4037: .It Ic lock-server
4038: .D1 (alias: Ic lock )
1.90 nicm 4039: Lock each client individually by running the command specified by the
4040: .Ic lock-command
4041: option.
1.308 nicm 4042: .It Xo Ic run-shell
1.357 nicm 4043: .Op Fl b
1.308 nicm 4044: .Op Fl t Ar target-pane
4045: .Ar shell-command
4046: .Xc
1.87 nicm 4047: .D1 (alias: Ic run )
4048: Execute
1.153 nicm 4049: .Ar shell-command
1.106 nicm 4050: in the background without creating a window.
1.334 nicm 4051: Before being executed, shell-command is expanded using the rules specified in
4052: the
4053: .Sx FORMATS
4054: section.
1.335 nicm 4055: With
4056: .Fl b ,
4057: the command is run in the background.
1.308 nicm 4058: After it finishes, any output to stdout is displayed in copy mode (in the pane
4059: specified by
4060: .Fl t
4061: or the current pane if omitted).
1.153 nicm 4062: If the command doesn't return success, the exit status is also displayed.
1.342 nicm 4063: .It Xo Ic wait-for
1.370 nicm 4064: .Op Fl L | S | U
1.342 nicm 4065: .Ar channel
4066: .Xc
4067: .D1 (alias: Ic wait )
1.343 nicm 4068: When used without options, prevents the client from exiting until woken using
1.342 nicm 4069: .Ic wait-for
4070: .Fl S
4071: with the same channel.
1.343 nicm 4072: When
4073: .Fl L
4074: is used, the channel is locked and any clients that try to lock the same
4075: channel are made to wait until the channel is unlocked with
4076: .Ic wait-for
4077: .Fl U .
1.342 nicm 4078: This command only works from outside
4079: .Nm .
1.228 nicm 4080: .El
4081: .Sh TERMINFO EXTENSIONS
4082: .Nm
1.478 nicm 4083: understands some unofficial extensions to
1.228 nicm 4084: .Xr terminfo 5 :
4085: .Bl -tag -width Ds
1.360 nicm 4086: .It Em Cs , Cr
1.233 nicm 4087: Set the cursor colour.
1.232 jmc 4088: The first takes a single string argument and is used to set the colour;
4089: the second takes no arguments and restores the default cursor colour.
4090: If set, a sequence such as this may be used
4091: to change the cursor colour from inside
4092: .Nm :
4093: .Bd -literal -offset indent
4094: $ printf '\e033]12;red\e033\e\e'
4095: .Ed
1.361 jmc 4096: .It Em \&Ss , Se
1.403 nicm 4097: Set or reset the cursor style.
1.232 jmc 4098: If set, a sequence such as this may be used
4099: to change the cursor to an underline:
1.230 nicm 4100: .Bd -literal -offset indent
4101: $ printf '\e033[4 q'
4102: .Ed
4103: .Pp
4104: If
1.403 nicm 4105: .Em Se
4106: is not set, \&Ss with argument 0 will be used to reset the cursor style instead.
1.478 nicm 4107: .It Em \&Tc
4108: Indicate that the terminal supports the
4109: .Ql direct colour
4110: RGB escape sequence (for example, \ee[38;2;255;255;255m).
1.232 jmc 4111: .It Em \&Ms
1.478 nicm 4112: Store the current buffer in the host terminal's selection (clipboard).
1.232 jmc 4113: See the
4114: .Em set-clipboard
4115: option above and the
4116: .Xr xterm 1
4117: man page.
1.345 nicm 4118: .El
4119: .Sh CONTROL MODE
4120: .Nm
4121: offers a textual interface called
4122: .Em control mode .
4123: This allows applications to communicate with
4124: .Nm
4125: using a simple text-only protocol.
4126: .Pp
4127: In control mode, a client sends
4128: .Nm
4129: commands or command sequences terminated by newlines on standard input.
4130: Each command will produce one block of output on standard output.
4131: An output block consists of a
4132: .Em %begin
4133: line followed by the output (which may be empty).
4134: The output block ends with a
4135: .Em %end
4136: or
4137: .Em %error .
4138: .Em %begin
4139: and matching
4140: .Em %end
4141: or
4142: .Em %error
4143: have two arguments: an integer time (as seconds from epoch) and command number.
4144: For example:
4145: .Bd -literal -offset indent
4146: %begin 1363006971 2
4147: 0: ksh* (1 panes) [80x24] [layout b25f,80x24,0,0,2] @2 (active)
4148: %end 1363006971 2
4149: .Ed
4150: .Pp
4151: In control mode,
4152: .Nm
4153: outputs notifications.
4154: A notification will never occur inside an output block.
4155: .Pp
4156: The following notifications are defined:
4157: .Bl -tag -width Ds
4158: .It Ic %exit Op Ar reason
4159: The
4160: .Nm
4161: client is exiting immediately, either because it is not attached to any session
4162: or an error occurred.
4163: If present,
4164: .Ar reason
4165: describes why the client exited.
1.460 nicm 4166: .It Ic %layout-change Ar window-id Ar window-layout Ar window-visible-layout Ar window-flags
1.345 nicm 4167: The layout of a window with ID
4168: .Ar window-id
4169: changed.
4170: The new layout is
4171: .Ar window-layout .
1.460 nicm 4172: The window's visible layout is
4173: .Ar window-visible-layout
4174: and the window flags are
4175: .Ar window-flags .
1.347 nicm 4176: .It Ic %output Ar pane-id Ar value
4177: A window pane produced output.
1.345 nicm 4178: .Ar value
1.350 nicm 4179: escapes non-printable characters and backslash as octal \\xxx.
1.345 nicm 4180: .It Ic %session-changed Ar session-id Ar name
4181: The client is now attached to the session with ID
4182: .Ar session-id ,
4183: which is named
4184: .Ar name .
4185: .It Ic %session-renamed Ar name
4186: The current session was renamed to
4187: .Ar name .
4188: .It Ic %sessions-changed
4189: A session was created or destroyed.
4190: .It Ic %unlinked-window-add Ar window-id
4191: The window with ID
4192: .Ar window-id
4193: was created but is not linked to the current session.
4194: .It Ic %window-add Ar window-id
4195: The window with ID
4196: .Ar window-id
4197: was linked to the current session.
4198: .It Ic %window-close Ar window-id
4199: The window with ID
4200: .Ar window-id
4201: closed.
4202: .It Ic %window-renamed Ar window-id Ar name
4203: The window with ID
4204: .Ar window-id
4205: was renamed to
4206: .Ar name .
1.1 nicm 4207: .El
4208: .Sh FILES
1.26 nicm 4209: .Bl -tag -width "/etc/tmux.confXXX" -compact
1.1 nicm 4210: .It Pa ~/.tmux.conf
1.6 jmc 4211: Default
1.1 nicm 4212: .Nm
1.6 jmc 4213: configuration file.
1.26 nicm 4214: .It Pa /etc/tmux.conf
4215: System-wide configuration file.
1.1 nicm 4216: .El
1.57 jmc 4217: .Sh EXAMPLES
4218: To create a new
4219: .Nm
4220: session running
4221: .Xr vi 1 :
4222: .Pp
4223: .Dl $ tmux new-session vi
4224: .Pp
4225: Most commands have a shorter form, known as an alias.
4226: For new-session, this is
4227: .Ic new :
4228: .Pp
4229: .Dl $ tmux new vi
4230: .Pp
4231: Alternatively, the shortest unambiguous form of a command is accepted.
4232: If there are several options, they are listed:
4233: .Bd -literal -offset indent
4234: $ tmux n
4235: ambiguous command: n, could be: new-session, new-window, next-window
4236: .Ed
4237: .Pp
4238: Within an active session, a new window may be created by typing
4239: .Ql C-b c
4240: (Ctrl
4241: followed by the
4242: .Ql b
4243: key
4244: followed by the
4245: .Ql c
4246: key).
4247: .Pp
4248: Windows may be navigated with:
4249: .Ql C-b 0
4250: (to select window 0),
4251: .Ql C-b 1
4252: (to select window 1), and so on;
4253: .Ql C-b n
4254: to select the next window; and
4255: .Ql C-b p
4256: to select the previous window.
4257: .Pp
4258: A session may be detached using
4259: .Ql C-b d
1.64 nicm 4260: (or by an external event such as
4261: .Xr ssh 1
4262: disconnection) and reattached with:
1.57 jmc 4263: .Pp
4264: .Dl $ tmux attach-session
4265: .Pp
4266: Typing
4267: .Ql C-b \&?
4268: lists the current key bindings in the current window; up and down may be used
4269: to navigate the list or
4270: .Ql q
4271: to exit from it.
4272: .Pp
4273: Commands to be run when the
4274: .Nm
4275: server is started may be placed in the
4276: .Pa ~/.tmux.conf
4277: configuration file.
4278: Common examples include:
4279: .Pp
4280: Changing the default prefix key:
4281: .Bd -literal -offset indent
4282: set-option -g prefix C-a
4283: unbind-key C-b
4284: bind-key C-a send-prefix
4285: .Ed
4286: .Pp
4287: Turning the status line off, or changing its colour:
4288: .Bd -literal -offset indent
4289: set-option -g status off
1.378 nicm 4290: set-option -g status-style bg=blue
1.57 jmc 4291: .Ed
4292: .Pp
4293: Setting other options, such as the default command,
4294: or locking after 30 minutes of inactivity:
4295: .Bd -literal -offset indent
4296: set-option -g default-command "exec /bin/ksh"
4297: set-option -g lock-after-time 1800
4298: .Ed
4299: .Pp
4300: Creating new key bindings:
4301: .Bd -literal -offset indent
4302: bind-key b set-option status
4303: bind-key / command-prompt "split-window 'exec man %%'"
1.73 nicm 4304: bind-key S command-prompt "new-window -n %1 'ssh %1'"
1.57 jmc 4305: .Ed
1.1 nicm 4306: .Sh SEE ALSO
4307: .Xr pty 4
4308: .Sh AUTHORS
1.477 nicm 4309: .An Nicholas Marriott Aq Mt nicholas.marriott@gmail.com
![[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