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