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