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