version 1.377, 2014/01/22 14:43:42 |
version 1.378, 2014/01/28 23:07:09 |
|
|
If |
If |
.Fl g |
.Fl g |
is specified, the global session or window option is set. |
is specified, the global session or window option is set. |
With |
|
.Fl a , |
|
and if the option expects a string, |
|
.Ar value |
|
is appended to the existing setting. |
|
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 |
|
|
.Ic quiet |
.Ic quiet |
server option was set). |
server option was set). |
.Pp |
.Pp |
|
With |
|
.Fl a , |
|
and if the option expects a string or a style, |
|
.Ar value |
|
is appended to the existing setting. |
|
For example: |
|
.Bd -literal -offset indent |
|
set -g status-left "foo" |
|
set -ag status-left "bar" |
|
.Ed |
|
.Pp |
|
Will result in |
|
.Ql foobar . |
|
And: |
|
.Bd -literal -offset indent |
|
set -g status-style "bg=red" |
|
set -ag status-style "fg=blue" |
|
.Ed |
|
.Pp |
|
Will result in a red background |
|
.Em and |
|
blue foreground. |
|
Without |
|
.Fl a , |
|
the result would be the default background and a blue foreground. |
|
.Pp |
Available window options are listed under |
Available window options are listed under |
.Ic set-window-option . |
.Ic set-window-option . |
.Pp |
.Pp |
|
|
.Em all |
.Em all |
sessions would have locked. |
sessions would have locked. |
This has no effect as a session option; it must be set as a global option. |
This has no effect as a session option; it must be set as a global option. |
.It Ic message-attr Ar attributes |
.It Ic message-command-style Ar style |
Set status line message attributes, where |
Set status line message command style, where |
.Ar attributes |
.Ar style |
is either |
is a comma-separated list of characteristics to be specified. |
.Ic none |
.Pp |
or a comma-delimited list of one or more of: |
These may be |
.Ic bright |
.Ql bg=colour |
(or |
to set the background colour, |
.Ic bold ) , |
.Ql fg=colour |
.Ic dim , |
to set the foreground colour, and a list of attributes as specified below. |
.Ic underscore , |
.Pp |
.Ic blink , |
The colour is one of: |
.Ic reverse , |
|
.Ic hidden , |
|
or |
|
.Ic italics . |
|
.It Ic message-bg Ar colour |
|
Set status line message background colour, where |
|
.Ar colour |
|
is one of: |
|
.Ic black , |
.Ic black , |
.Ic red , |
.Ic red , |
.Ic green , |
.Ic green , |
|
|
or a hexadecimal RGB string such as |
or a hexadecimal RGB string such as |
.Ql #ffffff , |
.Ql #ffffff , |
which chooses the closest match from the default 256-colour set. |
which chooses the closest match from the default 256-colour set. |
.It Ic message-command-attr Ar attributes |
.Pp |
Set status line message attributes when in command mode. |
The attributes is either |
.It Ic message-command-bg Ar colour |
.Ic none |
Set status line message background colour when in command mode. |
or a comma-delimited list of one or more of: |
.It Ic message-command-fg Ar colour |
.Ic bright |
Set status line message foreground colour when in command mode. |
(or |
.It Ic message-fg Ar colour |
.Ic bold ) , |
Set status line message foreground colour. |
.Ic dim , |
|
.Ic underscore , |
|
.Ic blink , |
|
.Ic reverse , |
|
.Ic hidden , |
|
or |
|
.Ic italics , |
|
to turn an attribute on, or an attribute prefixed with |
|
.Ql no |
|
to turn one off. |
|
.Pp |
|
Examples are: |
|
.Bd -literal -offset indent |
|
fg=yellow,bold,underscore,blink |
|
bg=black,fg=default,noreverse |
|
.Ed |
|
.Pp |
|
With the |
|
.Fl a |
|
flag to the |
|
.Ic set-option |
|
command the new style is added otherwise the existing style is replaced. |
.It Ic message-limit Ar number |
.It Ic message-limit Ar number |
Set the number of error or information messages to save in the message log for |
Set the number of error or information messages to save in the message log for |
each client. |
each client. |
The default is 20. |
The default is 20. |
|
.It Ic message-style Ar style |
|
Set status line message style. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
.It Xo Ic mouse-resize-pane |
.It Xo Ic mouse-resize-pane |
.Op Ic on | off |
.Op Ic on | off |
.Xc |
.Xc |
|
|
.Op Ic on | off |
.Op Ic on | off |
.Xc |
.Xc |
If enabled, request mouse input as UTF-8 on UTF-8 terminals. |
If enabled, request mouse input as UTF-8 on UTF-8 terminals. |
.It Ic pane-active-border-bg Ar colour |
.It Ic pane-active-border-style Ar style |
.It Ic pane-active-border-fg Ar colour |
Set the pane border style for the currently active pane. |
Set the pane border colour for the currently active pane. |
For how to specify |
.It Ic pane-border-bg Ar colour |
.Ar style , |
.It Ic pane-border-fg Ar colour |
see the |
Set the pane border colour for panes aside from the active pane. |
.Ic message-command-style |
|
option. |
|
Attributes are ignored. |
|
.It Ic pane-border-style Ar style |
|
Set the pane border style for paneas aside from the active pane. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
|
Attributes are ignored. |
.It Ic prefix Ar key |
.It Ic prefix Ar key |
Set the key accepted as a prefix key. |
Set the key accepted as a prefix key. |
.It Ic prefix2 Ar key |
.It Ic prefix2 Ar key |
|
|
.Op Ic on | off |
.Op Ic on | off |
.Xc |
.Xc |
Show or hide the status line. |
Show or hide the status line. |
.It Ic status-attr Ar attributes |
|
Set status line attributes. |
|
.It Ic status-bg Ar colour |
|
Set status line background colour. |
|
.It Ic status-fg Ar colour |
|
Set status line foreground colour. |
|
.It Ic status-interval Ar interval |
.It Ic status-interval Ar interval |
Update the status bar every |
Update the status bar every |
.Ar interval |
.Ar interval |
|
|
For details on how the names and titles can be set see the |
For details on how the names and titles can be set see the |
.Sx "NAMES AND TITLES" |
.Sx "NAMES AND TITLES" |
section. |
section. |
|
For a list of allowed attributes see the |
|
.Ic message-command-style |
|
option. |
.Pp |
.Pp |
#[attributes] allows a comma-separated list of attributes to be specified, |
|
these may be |
|
.Ql fg=colour |
|
to set the foreground colour, |
|
.Ql bg=colour |
|
to set the background colour, the name of one of the attributes (listed under |
|
the |
|
.Ic message-attr |
|
option) to turn an attribute on, or an attribute prefixed with |
|
.Ql no |
|
to turn one off, for example |
|
.Ic nobright . |
|
Examples are: |
Examples are: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
#(sysctl vm.loadavg) |
#(sysctl vm.loadavg) |
|
|
is not interpreted, to enable UTF-8, use the |
is not interpreted, to enable UTF-8, use the |
.Ic status-utf8 |
.Ic status-utf8 |
option. |
option. |
.It Ic status-left-attr Ar attributes |
|
Set the attribute of the left part of the status line. |
|
.It Ic status-left-bg Ar colour |
|
Set the background colour of the left part of the status line. |
|
.It Ic status-left-fg Ar colour |
|
Set the foreground colour of the left part of the status line. |
|
.It Ic status-left-length Ar length |
.It Ic status-left-length Ar length |
Set the maximum |
Set the maximum |
.Ar length |
.Ar length |
of the left component of the status bar. |
of the left component of the status bar. |
The default is 10. |
The default is 10. |
|
.It Ic status-left-style Ar style |
|
Set the style of the left part of the status line. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
.It Xo Ic status-position |
.It Xo Ic status-position |
.Op Ic top | bottom |
.Op Ic top | bottom |
.Xc |
.Xc |
|
|
character pairs are replaced, and UTF-8 is dependent on the |
character pairs are replaced, and UTF-8 is dependent on the |
.Ic status-utf8 |
.Ic status-utf8 |
option. |
option. |
.It Ic status-right-attr Ar attributes |
|
Set the attribute of the right part of the status line. |
|
.It Ic status-right-bg Ar colour |
|
Set the background colour of the right part of the status line. |
|
.It Ic status-right-fg Ar colour |
|
Set the foreground colour of the right part of the status line. |
|
.It Ic status-right-length Ar length |
.It Ic status-right-length Ar length |
Set the maximum |
Set the maximum |
.Ar length |
.Ar length |
of the right component of the status bar. |
of the right component of the status bar. |
The default is 40. |
The default is 40. |
|
.It Ic status-right-style Ar style |
|
Set the style of the right part of the status line. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
|
.It Ic status-style Ar style |
|
Set status line style. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
.It Xo Ic status-utf8 |
.It Xo Ic status-utf8 |
.Op Ic on | off |
.Op Ic on | off |
.Xc |
.Xc |
|
|
.Ic main-vertical |
.Ic main-vertical |
layouts. |
layouts. |
.Pp |
.Pp |
.It Ic mode-attr Ar attributes |
|
Set window modes attributes. |
|
.Pp |
|
.It Ic mode-bg Ar colour |
|
Set window modes background colour. |
|
.Pp |
|
.It Ic mode-fg Ar colour |
|
Set window modes foreground colour. |
|
.Pp |
|
.It Xo Ic mode-keys |
.It Xo Ic mode-keys |
.Op Ic vi | emacs |
.Op Ic vi | emacs |
.Xc |
.Xc |
|
|
the mouse behaves as set to on, but cannot be used to enter copy |
the mouse behaves as set to on, but cannot be used to enter copy |
mode. |
mode. |
.Pp |
.Pp |
|
.It Ic mode-style Ar style |
|
Set window modes style. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
|
.Pp |
.It Xo Ic monitor-activity |
.It Xo Ic monitor-activity |
.Op Ic on | off |
.Op Ic on | off |
.Xc |
.Xc |
|
|
.Nm |
.Nm |
to expect UTF-8 sequences to appear in this window. |
to expect UTF-8 sequences to appear in this window. |
.Pp |
.Pp |
.It Ic window-status-bell-attr Ar attributes |
.It Ic window-status-activity-style Ar style |
Set status line attributes for windows which have a bell alert. |
Set status line style for windows with an activity alert. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
.Pp |
.Pp |
.It Ic window-status-bell-bg Ar colour |
.It Ic window-status-bell-style Ar style |
Set status line background colour for windows with a bell alert. |
Set status line style for windows with a bell alert. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
.Pp |
.Pp |
.It Ic window-status-bell-fg Ar colour |
.It Ic window-status-content-style Ar style |
Set status line foreground colour for windows with a bell alert. |
Set status line style for windows with a content alert. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
.Pp |
.Pp |
.It Ic window-status-content-attr Ar attributes |
|
Set status line attributes for windows which have a content alert. |
|
.Pp |
|
.It Ic window-status-content-bg Ar colour |
|
Set status line background colour for windows with a content alert. |
|
.Pp |
|
.It Ic window-status-content-fg Ar colour |
|
Set status line foreground colour for windows with a content alert. |
|
.Pp |
|
.It Ic window-status-activity-attr Ar attributes |
|
Set status line attributes for windows which have an activity (or silence) alert. |
|
.Pp |
|
.It Ic window-status-activity-bg Ar colour |
|
Set status line background colour for windows with an activity alert. |
|
.Pp |
|
.It Ic window-status-activity-fg Ar colour |
|
Set status line foreground colour for windows with an activity alert. |
|
.Pp |
|
.It Ic window-status-attr Ar attributes |
|
Set status line attributes for a single window. |
|
.Pp |
|
.It Ic window-status-bg Ar colour |
|
Set status line background colour for a single window. |
|
.Pp |
|
.It Ic window-status-current-attr Ar attributes |
|
Set status line attributes for the currently active window. |
|
.Pp |
|
.It Ic window-status-current-bg Ar colour |
|
Set status line background colour for the currently active window. |
|
.Pp |
|
.It Ic window-status-current-fg Ar colour |
|
Set status line foreground colour for the currently active window. |
|
.Pp |
|
.It Ic window-status-current-format Ar string |
.It Ic window-status-current-format Ar string |
Like |
Like |
.Ar window-status-format , |
.Ar window-status-format , |
but is the format used when the window is the current window. |
but is the format used when the window is the current window. |
.Pp |
.Pp |
.It Ic window-status-last-attr Ar attributes |
.It Ic window-status-current-style Ar style |
Set status line attributes for the last active window. |
Set status line style for the currently active window. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
.Pp |
.Pp |
.It Ic window-status-last-bg Ar colour |
|
Set status line background colour for the last active window. |
|
.Pp |
|
.It Ic window-status-last-fg Ar colour |
|
Set status line foreground colour for the last active window. |
|
.Pp |
|
.It Ic window-status-fg Ar colour |
|
Set status line foreground colour for a single window. |
|
.Pp |
|
.It Ic window-status-format Ar string |
.It Ic window-status-format Ar string |
Set the format in which the window is displayed in the status line window list. |
Set the format in which the window is displayed in the status line window list. |
See the |
See the |
|
|
The default is |
The default is |
.Ql #I:#W#F . |
.Ql #I:#W#F . |
.Pp |
.Pp |
|
.It Ic window-status-last-style Ar style |
|
Set status line style for the last active window. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
|
.Pp |
.It Ic window-status-separator Ar string |
.It Ic window-status-separator Ar string |
Sets the separator drawn between windows in the status line. |
Sets the separator drawn between windows in the status line. |
The default is a single space character. |
The default is a single space character. |
.Pp |
.Pp |
|
.It Ic window-status-style Ar style |
|
Set status line style for a single window. |
|
For how to specify |
|
.Ar style , |
|
see the |
|
.Ic message-command-style |
|
option. |
|
.Pp |
.It Xo Ic xterm-keys |
.It Xo Ic xterm-keys |
.Op Ic on | off |
.Op Ic on | off |
.Xc |
.Xc |
|
|
.Pp |
.Pp |
The colour and attributes of the status line may be configured, the entire |
The colour and attributes of the status line may be configured, the entire |
status line using the |
status line using the |
.Ic status-attr , |
.Ic status-style |
.Ic status-fg |
session option and individual windows using the |
and |
.Ic window-status-style |
.Ic status-bg |
window option. |
session options and individual windows using the |
|
.Ic window-status-attr , |
|
.Ic window-status-fg |
|
and |
|
.Ic window-status-bg |
|
window options. |
|
.Pp |
.Pp |
The status line is automatically refreshed at interval if it has changed, the |
The status line is automatically refreshed at interval if it has changed, the |
interval may be controlled with the |
interval may be controlled with the |
|
|
Turning the status line off, or changing its colour: |
Turning the status line off, or changing its colour: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
set-option -g status off |
set-option -g status off |
set-option -g status-bg blue |
set-option -g status-style bg=blue |
.Ed |
.Ed |
.Pp |
.Pp |
Setting other options, such as the default command, |
Setting other options, such as the default command, |