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