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