aboutsummaryrefslogtreecommitdiff
path: root/tmux.1
diff options
context:
space:
mode:
Diffstat (limited to 'tmux.1')
-rw-r--r--tmux.1113
1 files changed, 84 insertions, 29 deletions
diff --git a/tmux.1 b/tmux.1
index 0c078fba..4c4b94aa 100644
--- a/tmux.1
+++ b/tmux.1
@@ -23,7 +23,7 @@
.Sh SYNOPSIS
.Nm tmux
.Bk -words
-.Op Fl 2CDluvV
+.Op Fl 2CDlNuVv
.Op Fl c Ar shell-command
.Op Fl f Ar file
.Op Fl L Ar socket-name
@@ -206,6 +206,12 @@ If
is specified, the default socket directory is not used and any
.Fl L
flag is ignored.
+.It Fl T Ar features
+Set terminal features for the client.
+This is a comma-separated list of features.
+See the
+.Ic terminal-features
+option.
.It Fl u
Write UTF-8 output to the terminal even if the first environment
variable of
@@ -217,14 +223,10 @@ that is set does not contain
.Qq UTF-8
or
.Qq UTF8 .
-This is equivalent to
-.Fl T Ar UTF-8 .
-.It Fl T Ar features
-Set terminal features for the client.
-This is a comma-separated list of features.
-See the
-.Ic terminal-features
-option.
+.It Fl V
+Report the
+.Nm
+version.
.It Fl v
Request verbose logging.
Log messages will be saved into
@@ -249,10 +251,6 @@ signal may be sent to the
server process to toggle logging between on (as if
.Fl v
was given) and off.
-.It Fl V
-Report the
-.Nm
-version.
.It Ar command Op Ar flags
This specifies one of a set of commands used to control
.Nm ,
@@ -547,7 +545,7 @@ for example in these
.Xr sh 1
commands:
.Bd -literal -offset indent
-$ tmux neww\e\e; splitw
+$ tmux neww\e; splitw
.Ed
.Pp
Or:
@@ -966,7 +964,7 @@ Will run
directly without invoking the shell.
.Pp
.Ar command
-.Op Ar arguments
+.Op Ar argument ...
refers to a
.Nm
command, either passed with the command and arguments separately, for example:
@@ -1543,8 +1541,7 @@ show debugging information about jobs and terminals.
.Tg source
.It Xo Ic source-file
.Op Fl Fnqv
-.Ar path
-.Ar ...
+.Ar path ...
.Xc
.D1 Pq alias: Ic source
Execute commands from one or more files specified by
@@ -1813,6 +1810,9 @@ The following commands are supported in copy mode:
.It Li "search-forward <for>" Ta "/" Ta ""
.It Li "search-forward-incremental <for>" Ta "" Ta "C-s"
.It Li "search-forward-text <for>" Ta "" Ta ""
+.It Li "scroll-bottom" Ta "" Ta ""
+.It Li "scroll-middle" Ta "z" Ta ""
+.It Li "scroll-top" Ta "" Ta ""
.It Li "search-reverse" Ta "N" Ta "N"
.It Li "select-line" Ta "V" Ta ""
.It Li "select-word" Ta "" Ta ""
@@ -1974,7 +1974,7 @@ For example:
$ tmux list-windows
0: ksh [159x48]
layout: bb62,159x48,0,0{79x48,0,0,79x48,80,0}
-$ tmux select-layout bb62,159x48,0,0{79x48,0,0,79x48,80,0}
+$ tmux select-layout 'bb62,159x48,0,0{79x48,0,0,79x48,80,0}'
.Ed
.Pp
.Nm
@@ -2015,7 +2015,7 @@ but a different format may be specified with
.Fl F .
.Tg capturep
.It Xo Ic capture-pane
-.Op Fl aepPqCJN
+.Op Fl aAepPqCJN
.Op Fl b Ar buffer-name
.Op Fl E Ar end-line
.Op Fl S Ar start-line
@@ -2040,10 +2040,15 @@ is given, the output includes escape sequences for text and background
attributes.
.Fl C
also escapes non-printable characters as octal \exxx.
+.Fl T
+ignores trailing positions that do not contain a character.
.Fl N
preserves trailing spaces at each line's end and
.Fl J
-preserves trailing spaces and joins any wrapped lines.
+preserves trailing spaces and joins any wrapped lines;
+.Fl J
+implies
+.Fl T .
.Fl P
captures only any output that the pane has received that is the beginning of an
as-yet incomplete escape sequence.
@@ -3117,7 +3122,7 @@ Commands related to key bindings are as follows:
.Op Fl nr
.Op Fl N Ar note
.Op Fl T Ar key-table
-.Ar key command Op Ar arguments
+.Ar key command Op Ar argument ...
.Xc
.D1 Pq alias: Ic bind
Bind key
@@ -3209,13 +3214,14 @@ lists only the first matching key.
lists the command for keys that do not have a note rather than skipping them.
.Tg send
.It Xo Ic send-keys
-.Op Fl FHlMRX
+.Op Fl FHKlMRX
+.Op Fl c Ar target-client
.Op Fl N Ar repeat-count
.Op Fl t Ar target-pane
-.Ar key Ar ...
+.Ar key ...
.Xc
.D1 Pq alias: Ic send
-Send a key or keys to a window.
+Send a key or keys to a window or client.
Each argument
.Ar key
is the name of the key (such as
@@ -3224,6 +3230,12 @@ or
.Ql NPage )
to send; if the string is not recognised as a key, it is sent as a series of
characters.
+If
+.Fl K
+is given, keys are sent to
+.Ar target-client ,
+so they are looked up in the client's key table, rather than to
+.Ar target-pane .
All arguments are sent sequentially from first to last.
If no keys are given and the command is bound to a key, then that key is used.
.Pp
@@ -3684,6 +3696,8 @@ Supports the overline SGR attribute.
Supports the DECFRA rectangle fill escape sequence.
.It RGB
Supports RGB colour with the SGR escape sequences.
+.It sixel
+Supports SIXEL graphics.
.It strikethrough
Supports the strikethrough SGR escape sequence.
.It sync
@@ -3877,6 +3891,10 @@ For how to specify
see the
.Sx STYLES
section.
+.It Xo Ic message-line
+.Op Ic 0 | 1 | 2 | 3 | 4
+.Xc
+Set line on which status line messages and the command prompt are shown.
.It Ic message-style Ar style
Set status line message style.
This is used for messages and for the command prompt.
@@ -4466,11 +4484,17 @@ Available pane options are:
.Pp
.Bl -tag -width Ds -compact
.It Xo Ic allow-passthrough
-.Op Ic on | off
+.Op Ic on | off | all
.Xc
Allow programs in the pane to bypass
.Nm
using a terminal escape sequence (\eePtmux;...\ee\e\e).
+If set to
+.Ic on ,
+passthrough sequences will be allowed only if the pane is visible.
+If set to
+.Ic all ,
+they will be allowed even if the pane is invisible.
.Pp
.It Xo Ic allow-rename
.Op Ic on | off
@@ -5067,6 +5091,15 @@ would change
.Ql abABab
into
.Ql bxBxbx .
+A different delimiter character may also be used, to avoid collisions with
+literal slashes in the pattern.
+For example,
+.Ql s|foo/|bar/|:
+will substitute
+.Ql foo/
+with
+.Ql bar/
+throughout.
.Pp
In addition, the last line of a shell command's output may be inserted using
.Ql #() .
@@ -5785,13 +5818,13 @@ until it is dismissed.
.Op Fl O
.Op Fl c Ar target-client
.Op Fl t Ar target-pane
+.Op Fl S Ar starting-choice
.Op Fl T Ar title
.Op Fl x Ar position
.Op Fl y Ar position
.Ar name
.Ar key
-.Ar command
-.Ar ...
+.Ar command Op Ar argument ...
.Xc
.D1 Pq alias: Ic menu
Display a menu on
@@ -5815,6 +5848,9 @@ command should be omitted.
.Fl T
is a format for the menu title (see
.Sx FORMATS ) .
+.Fl S
+sets the menu item selected by default, if the menu is not bound to a mouse key
+binding.
.Pp
.Fl x
and
@@ -5874,7 +5910,7 @@ The following keys are also available:
.El
.Tg display
.It Xo Ic display-message
-.Op Fl aINpv
+.Op Fl aIlNpv
.Op Fl c Ar target-client
.Op Fl d Ar delay
.Op Fl t Ar target-pane
@@ -5896,7 +5932,12 @@ is not given, the
option is used; a delay of zero waits for a key press.
.Ql N
ignores key presses and closes only after the delay expires.
-The format of
+If
+.Fl l
+is given,
+.Ar message
+is printed unchanged.
+Otherwise, the format of
.Ar message
is described in the
.Sx FORMATS
@@ -6429,6 +6470,10 @@ These are set automatically if the
capability is present.
.It Em \&Hls
Set or clear a hyperlink annotation.
+.It Em \&Nobr
+Tell
+.Nm
+that the terminal does not use bright colors for bold display.
.It Em \&Rect
Tell
.Nm
@@ -6460,6 +6505,8 @@ Set the opening sequence for the working directory notification.
The sequence is terminated using the standard
.Em fsl
capability.
+.It Em \&Sxl
+Indicates that the terminal supports SIXEL.
.It Em \&Sync
Start (parameter is 1) or end (parameter is 2) a synchronized update.
.It Em \&Tc
@@ -6591,6 +6638,14 @@ escapes non-printable characters and backslash as octal \\xxx.
The pane with ID
.Ar pane-id
has changed mode.
+.It Ic %paste-buffer-changed Ar name
+Paste buffer
+.Ar name
+has been changed.
+.It Ic %paste-buffer-deleted Ar name
+Paste buffer
+.Ar name
+has been deleted.
.It Ic %pause Ar pane-id
The pane has been paused (if the
.Ar pause-after