.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "AERC-STYLESETS" "7" "2023-04-23"
.P
.SH NAME
.P
aerc-stylesets - styleset file specification for \fBaerc\fR(1)
.P
.SH SYNOPSIS
.P
aerc uses a simple configuration syntax to configure the styleset for
its ui.\&
.P
.SH STYLESET CONFIGURATION
.P
The styleset is described as \fB<object>\fR.\&\fB<attribute>\fR = \fI<value>\fR pairs.\&
.P
For example, in the line below, the foreground color of the
style object \fBmsglist_unread\fR is set to \fIcornflowerblue\fR
.P
.RS 4
\fBmsglist_unread\fR.\&\fBfg\fR = \fIcornflowerblue\fR
.P
.RE
The configuration also allows wildcard matching of the keys
to configure multiple style objects at a time.\&
.P
.SS ATTRIBUTES
.P
The following options are available to be modified for each of the
style objects.\&
.P
\fB<object>\fR.\&\fBfg\fR = \fI<color>\fR
.RS 4
The foreground color of the style object is set.\&
.P
.RE
\fB<object>\fR.\&\fBbg\fR = \fI<color>\fR
.RS 4
The background color of the style object is set.\&
.P
.RE
\fB<object>\fR.\&\fBbold\fR = \fItrue\fR|\fIfalse\fR|\fItoggle\fR
.RS 4
The bold attribute of the style object is set/unset.\&
.P
.RE
\fB<object>\fR.\&\fBblink\fR = \fItrue\fR|\fIfalse\fR|\fItoggle\fR
.RS 4
The blink attribute of the style object is set/unset.\&
The terminal needs to support blinking text.\&
.P
.RE
\fB<object>\fR.\&\fBunderline\fR = \fItrue\fR|\fIfalse\fR|\fItoggle\fR
.RS 4
The underline attribute of the style object is set/unset.\&
The terminal needs to support underline text.\&
.P
.RE
\fB<object>\fR.\&\fBitalic\fR = \fItrue\fR|\fIfalse\fR|\fItoggle\fR
.RS 4
The italic attribute of the style object is set/unset.\&
The terminal needs to support italic text.\&
.P
.RE
\fB<object>\fR.\&\fBreverse\fR = \fItrue\fR|\fIfalse\fR|\fItoggle\fR
.RS 4
Reverses the color of the style object.\& Exchanges the foreground
and background colors.\&
.P
If the value is \fIfalse\fR, it doesn'\&t change anything.\&
.P
.RE
\fB<object>\fR.\&\fBnormal\fR = true
.RS 4
All the attributes of the style object are unset.\&
.P
The value doesn'\&t matter.\&
.P
.RE
\fB<object>\fR.\&\fBdefault\fR = true
.RS 4
Set the style object to the default style of the context.\& Usually
based on the terminal.\&
.P
The value doesn'\&t matter.\&
.P
.RE
.SS STYLE OBJECTS
.P
The style objects represent the various ui elements or ui instances for
styling.\&
.P
.TS
allbox;l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l.
T{
\fBStyle Object\fR
T}	T{
\fBDescription\fR
T}
T{
\fBdefault\fR
T}	T{
The default style object used for normal ui elements while not using specialized configuration.\&
T}
T{
\fBerror\fR
T}	T{
The style used to show errors.\&
T}
T{
\fBwarning\fR
T}	T{
The style used when showing warnings.\&
T}
T{
\fBsuccess\fR
T}	T{
The style used for success messages.\&
T}
T{
\fBtitle\fR
T}	T{
The style object used to style titles in ui elements.\&
T}
T{
\fBheader\fR
T}	T{
The style object used to style headers in ui elements.\&
T}
T{
\fBstatusline_default\fR
T}	T{
The default style applied to the statusline.\&
T}
T{
\fBstatusline_error\fR
T}	T{
The style used for error messages in statusline.\&
T}
T{
\fBstatusline_success\fR
T}	T{
The style used for success messages in statusline.\&
T}
T{
\fBmsglist_default\fR
T}	T{
The default style for messages in a message list.\&
T}
T{
\fBmsglist_unread\fR
T}	T{
Unread messages in a message list.\&
T}
T{
\fBmsglist_read\fR
T}	T{
Read messages in a message list.\&
T}
T{
\fBmsglist_flagged\fR
T}	T{
The messages with the flagged flag.\&
T}
T{
\fBmsglist_deleted\fR
T}	T{
The messages marked as deleted.\&
T}
T{
\fBmsglist_marked\fR
T}	T{
The messages with the marked flag.\&
T}
T{
\fBmsglist_result\fR
T}	T{
The messages which match the current search.\&
T}
T{
\fBdirlist_default\fR
T}	T{
The default style for directories in the directory list.\&
T}
T{
\fBdirlist_unread\fR
T}	T{
The style used for directories with unread messages
T}
T{
\fBdirlist_recent\fR
T}	T{
The style used for directories with recent messages
T}
T{
\fBcompletion_default\fR
T}	T{
The default style for the completion engine.\&
T}
T{
\fBcompletion_gutter\fR
T}	T{
The completion gutter.\&
T}
T{
\fBcompletion_pill\fR
T}	T{
The completion pill.\&
T}
T{
\fBtab\fR
T}	T{
The style for the tab bar.\&
T}
T{
\fBstack\fR
T}	T{
The style for ui stack element.\&
T}
T{
\fBspinner\fR
T}	T{
The style for the loading spinner.\&
T}
T{
\fBborder\fR
T}	T{
The style used to draw borders (only the \fBbg\fR color is used unless you customize \fBborder-char-vertical\fR and/or \fBborder-char-horizontal\fR in \fIaerc.\&conf\fR).\&
T}
T{
\fBselector_default\fR
T}	T{
The default style for the selector ui element.\&
T}
T{
\fBselector_focused\fR
T}	T{
The focused item in a selector ui element.\&
T}
T{
\fBselector_chooser\fR
T}	T{
The item chooser in a selector ui element.\&
T}
.TE
.sp 1
.SS FNMATCH STYLE WILDCARD MATCHING
.P
The styleset configuration can be made simpler by using the fnmatch
style wildcard matching for the style object.\&
.P
The special characters used in the fnmatch wildcards are:
.P
.TS
allbox;l l
l l
l l.
T{
\fBPattern\fR
T}	T{
\fBMeaning\fR
T}
T{
\fB*\fR
T}	T{
Matches everything
T}
T{
\fB?\fR
T}	T{
Matches any single character
T}
.TE
.sp 1
For example, the following wildcards can be made using this syntax.\&
.P
.TS
allbox;l l
l l
l l.
T{
\fBExample\fR
T}	T{
\fBDescription\fR
T}
T{
\fB*\fR.\&\fBfg\fR = \fIblue\fR
T}	T{
Set the foreground color of all style objects to blue.\&
T}
T{
\fB*list\fR.\&\fBbg\fR = \fIhotpink\fR
T}	T{
Set the background color of all style objects that end in list to hotpink.\&
T}
.TE
.sp 1
.SS SELECTED MODIFIER
.P
The \fBselected\fR modifier can be applied to any style object.\& The style provided for
the \fBselected\fR modifier is applied on top of the style object it corresponds to.\&
.P
If you would like to make sure message that are flagged as read in the msglist
appear in yellow foreground and black background.\& You can specify that with
this:
.P
.RS 4
\fBmsglist_default\fR.\&\fBselected\fR.\&\fBfg\fR = \fIyellow\fR
.P
\fBmsglist_default\fR.\&\fBselected\fR.\&\fBbg\fR = \fIblack\fR
.P
.RE
If we specify the global style selected modifier using fnmatch as below:
.P
.RS 4
\fB*\fR.\&\fBselected\fR.\&\fBreverse\fR = \fItoggle\fR
.P
.RE
This toggles the reverse switch for selected version of all the style objects.\&
.P
.SS LAYERED STYLES
.P
Some styles, (currently the \fBmsglist_*\fR and \fBdirlist_*\fR ones) are applied in
layers.\& If a style differs from the base (in this case \fB*list_default\fR) then
that style applies, unless overridden by a higher layer.\&
.P
The order that \fBmsglist_*\fR styles are applied in is, from first to last:
.P
.RS 4
.ie n \{\
\h'-04'1.\h'+03'\c
.\}
.el \{\
.IP 1. 4
.\}
\fBmsglist_default\fR
.RE
.RS 4
.ie n \{\
\h'-04'2.\h'+03'\c
.\}
.el \{\
.IP 2. 4
.\}
\fBmsglist_unread\fR
.RE
.RS 4
.ie n \{\
\h'-04'3.\h'+03'\c
.\}
.el \{\
.IP 3. 4
.\}
\fBmsglist_read\fR
.RE
.RS 4
.ie n \{\
\h'-04'4.\h'+03'\c
.\}
.el \{\
.IP 4. 4
.\}
\fBmsglist_flagged\fR
.RE
.RS 4
.ie n \{\
\h'-04'5.\h'+03'\c
.\}
.el \{\
.IP 5. 4
.\}
\fBmsglist_deleted\fR
.RE
.RS 4
.ie n \{\
\h'-04'6.\h'+03'\c
.\}
.el \{\
.IP 6. 4
.\}
\fBmsglist_marked\fR

.RE
.P
So, the marked style will override all other msglist styles.\&
.P
The order for \fBdirlist_*\fR styles is:
.P
.RS 4
.ie n \{\
\h'-04'1.\h'+03'\c
.\}
.el \{\
.IP 1. 4
.\}
\fBdirlist_default\fR
.RE
.RS 4
.ie n \{\
\h'-04'2.\h'+03'\c
.\}
.el \{\
.IP 2. 4
.\}
\fBdirlist_unread\fR
.RE
.RS 4
.ie n \{\
\h'-04'3.\h'+03'\c
.\}
.el \{\
.IP 3. 4
.\}
\fBdirlist_recent\fR

.RE
.P
.SS COLORS
.P
The color values are set using the values accepted by the tcell library.\&
The values can be one of the following.\&
.P
\fIdefault\fR
.RS 4
The color is set as per the system or terminal default.\&
.P
.RE
\fI<Color name>\fR
.RS 4
Any w3c approved color name is used to set colors for the style.\&
.P
.RE
\fI<Hex code>\fR
.RS 4
Hexcode for a color can be used.\& The format must be \fI#XXXXXX\fR.\&
.P
.RE
\fI<Dec number>\fR
.RS 4
Color based on the terminal palette index.\& Valid numbers are
between \fI0\fR and \fI255\fR.\&
.P
.RE
.SH SEE ALSO
.P
\fBaerc\fR(1) \fBaerc-config\fR(5)
.P
.SH AUTHORS
.P
Originally created by Drew DeVault <sir@cmpwn.\&com> and maintained by Robin
Jarry <robin@jarry.\&cc> who is assisted by other open source contributors.\& For
more information about aerc development, see https://sr.\&ht/~rjarry/aerc/.\&