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