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