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