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