mirror of
https://github.com/tmate-io/tmate.git
synced 2025-02-17 02:41:07 +01:00
Add a section summarising how options work, make the distinction between window
and session options clearer, and fix the incorrect synopses and descriptions of show-options and show-window-options.
This commit is contained in:
parent
fe5edad1fc
commit
69e150b7e3
67
tmux.1
67
tmux.1
@ -339,6 +339,38 @@ or the
|
|||||||
command, and pasted into a window using the
|
command, and pasted into a window using the
|
||||||
.Ic paste-buffer
|
.Ic paste-buffer
|
||||||
command.
|
command.
|
||||||
|
.Sh OPTIONS
|
||||||
|
The appearance and behaviour of
|
||||||
|
.Nm
|
||||||
|
may be modified by changing the value of various options.
|
||||||
|
There are two types of option:
|
||||||
|
.Em session options
|
||||||
|
and
|
||||||
|
.Em window options .
|
||||||
|
.Pp
|
||||||
|
Each individual session may have a set of session options, and there is a
|
||||||
|
separate set of global session options.
|
||||||
|
Sessions which do not have a particular option configured inherit the value
|
||||||
|
from the global session options.
|
||||||
|
Session options are set or unset with the
|
||||||
|
.Ic set-option
|
||||||
|
command and may be listed with the
|
||||||
|
.Ic show-options
|
||||||
|
command.
|
||||||
|
The available session options are listed under the
|
||||||
|
.Ic set-option
|
||||||
|
command.
|
||||||
|
.Pp
|
||||||
|
Similarly, a set of window options is attached to each window, and there is
|
||||||
|
a set of global window options from which any unset options are inherited.
|
||||||
|
Window options are altered with the
|
||||||
|
.Ic set-window-option
|
||||||
|
command and can be listed with the
|
||||||
|
.Ic show-window-options
|
||||||
|
command.
|
||||||
|
All window options are documented with the
|
||||||
|
.Ic set-window-option
|
||||||
|
command.
|
||||||
.Sh PANES AND LAYOUTS
|
.Sh PANES AND LAYOUTS
|
||||||
Each window displayed by
|
Each window displayed by
|
||||||
.Nm
|
.Nm
|
||||||
@ -1008,22 +1040,16 @@ Set the contents of the specified buffer to
|
|||||||
.Ar option Ar value
|
.Ar option Ar value
|
||||||
.Xc
|
.Xc
|
||||||
.D1 (alias: Ic set )
|
.D1 (alias: Ic set )
|
||||||
Set an option.
|
Set a session option.
|
||||||
If
|
If
|
||||||
.Fl g
|
.Fl g
|
||||||
is specified, the option is set as a global option.
|
is specified, the global session option is set.
|
||||||
Global options apply to all sessions which don't have the option explicitly
|
|
||||||
set.
|
|
||||||
If
|
|
||||||
.Fl g
|
|
||||||
is not used, the option applies only to
|
|
||||||
.Ar target-session .
|
|
||||||
The
|
The
|
||||||
.Fl u
|
.Fl u
|
||||||
flag unsets an option, so a session inherits the option from the global
|
flag unsets an option, so a session inherits the option from the global
|
||||||
options - it is not possible to unset a global option.
|
options - it is not possible to unset a global option.
|
||||||
.Pp
|
.Pp
|
||||||
Possible options are:
|
Available session options are:
|
||||||
.Bl -tag -width Ds
|
.Bl -tag -width Ds
|
||||||
.It Xo Ic bell-action
|
.It Xo Ic bell-action
|
||||||
.Op Ic any | Ic none | Ic current
|
.Op Ic any | Ic none | Ic current
|
||||||
@ -1234,7 +1260,7 @@ configuration file, enclose it in single quotes (').
|
|||||||
.Ar option Ar value
|
.Ar option Ar value
|
||||||
.Xc
|
.Xc
|
||||||
.D1 (alias: Ic setw )
|
.D1 (alias: Ic setw )
|
||||||
Set a window-specific option.
|
Set a window option.
|
||||||
The
|
The
|
||||||
.Fl g
|
.Fl g
|
||||||
and
|
and
|
||||||
@ -1243,7 +1269,7 @@ flags work similarly to the
|
|||||||
.Ic set-option
|
.Ic set-option
|
||||||
command.
|
command.
|
||||||
.Pp
|
.Pp
|
||||||
Supported options are:
|
Supported window options are:
|
||||||
.Bl -tag -width Ds
|
.Bl -tag -width Ds
|
||||||
.It Xo Ic aggressive-resize
|
.It Xo Ic aggressive-resize
|
||||||
.Op Ic on | Ic off
|
.Op Ic on | Ic off
|
||||||
@ -1359,21 +1385,24 @@ as Shift, Alt or Ctrl.
|
|||||||
.D1 (alias: Ic showb )
|
.D1 (alias: Ic showb )
|
||||||
Display the contents of the specified buffer.
|
Display the contents of the specified buffer.
|
||||||
.It Xo Ic show-options
|
.It Xo Ic show-options
|
||||||
|
.Op Fl g
|
||||||
.Op Fl t Ar target-session
|
.Op Fl t Ar target-session
|
||||||
.Ar option Ar value
|
|
||||||
.Xc
|
.Xc
|
||||||
.D1 (alias: Ic show )
|
.D1 (alias: Ic show )
|
||||||
Show the currently set options.
|
Show the session options for
|
||||||
If a
|
.Ar target session ,
|
||||||
.Ar target-session
|
or the global session options with
|
||||||
is specified, the options for that session are shown; otherwise, the global
|
.Fl g .
|
||||||
options are listed.
|
|
||||||
.It Xo Ic show-window-options
|
.It Xo Ic show-window-options
|
||||||
|
.Op Fl g
|
||||||
.Op Fl t Ar target-window
|
.Op Fl t Ar target-window
|
||||||
.Ar option Ar value
|
|
||||||
.Xc
|
.Xc
|
||||||
.D1 (alias: Ic showw )
|
.D1 (alias: Ic showw )
|
||||||
List the current options for the given window.
|
List the window options for
|
||||||
|
.Ar target-window ,
|
||||||
|
or the global window options if
|
||||||
|
.Fl g
|
||||||
|
is used.
|
||||||
.It Xo Ic source-file
|
.It Xo Ic source-file
|
||||||
.Ar path
|
.Ar path
|
||||||
.Xc
|
.Xc
|
||||||
|
Loading…
Reference in New Issue
Block a user