.\" Generated by scdoc 1.11.3
.\" 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 "wob.ini" "5" "2024-07-07"
.PP
.SH NAME
.PP
wob.\&ini - wob configuration file
.PP
You can run `wob -vv` to find the default values.\&
.PP
.SH SECTION: default
.PP
\fBtimeout\fR
.RS 4
Timeout after which wob hides itself, in milliseconds.\&
.PP
.RE
\fBmax\fR
.RS 4
This value will be represented as fully filled bar.\&
.PP
.RE
\fBwidth\fR
.RS 4
Width of wob, in pixels.\&
.PP
.RE
\fBheight\fR
.RS 4
Height of wob, in pixels.\&
.PP
.RE
\fBborder_offset\fR
.RS 4
Border offset, in pixels.\&
.PP
.RE
\fBborder_size\fR
.RS 4
Border size, in pixels.\&
.PP
.RE
\fBbar_padding\fR
.RS 4
Bar padding, in pixels.\&
.PP
.RE
\fBanchor\fR
.RS 4
Anchor point, combination of \fBtop\fR, \fBleft\fR, \fBright\fR, \fBbottom\fR, \fBcenter\fR.\&
.PP
Example: \fBbottom\fR \fBright\fR
.PP
.RE
\fBmargin\fR
.RS 4
Anchor margin, in pixels.\& Either as a single value or 4 values (top right bottom left).\&
.PP
.RE
\fBborder_color\fR
.RS 4
Border color, in RRGGBB[AA] format.\&
.PP
.RE
\fBbackground_color\fR
.RS 4
Background color, in RRGGBB[AA] format.\&
.PP
.RE
\fBbar_color\fR
.RS 4
Bar color, in RRGGBB[AA] format.\&
.PP
.RE
\fBoverflow_mode\fR
.RS 4
Overflow mode, one of \fBwrap\fR, and \fBnowrap\fR.\&
.PP
\fBwrap\fR: wrap value so \fBmax\fR + 20 will be displayed as 20
.PP
\fBnowrap\fR values > \fBmax\fR will be displayed as just \fBmax\fR
.PP
.RE
\fBoverflow_bar_color\fR
.RS 4
Overflow bar color, in RRGGBB[AA] format.\&
.PP
.RE
\fBoverflow_background_color\fR
.RS 4
Overflow background color, in RRGGBB[AA] format.\&
.PP
.RE
\fBoverflow_border_color\fR
.RS 4
Overflow border color, in RRGGBB[AA] format.\&
.PP
.RE
\fBoutput_mode\fR
.RS 4
Output mode, one of \fBwhitelist\fR, \fBall\fR, \fBfocused\fR.\&
.PP
\fBwhitelist\fR: show wob only on outputs defined in \fBoutput.\&*\fR sections of config file
.PP
\fBall\fR: show wob on all available outputs
.PP
\fBfocused\fR: show wob on compositor default (focused) output
.PP
.RE
\fBorientation\fR
.RS 4
Orientation of the bar, one of \fBhorizontal\fR and \fBvertical\fR.\&
.PP
\fBwidth\fR and \fBheight\fR is kept as is, you most likely want to set \fBheight\fR greater than \fBwidth\fR in \fBvertical\fR mode
.PP
.RE
.SH SECTION: output.*
.PP
This section will be used in future releases of wob to provide per output configuration.\&
Currently this servers only as list of outputs to show wob on in \fBwhitelist\fR mode.\&
.PP
Replace \fB*\fR with user friendly name of your choosing.\&
.PP
\fBname\fR
.RS 4
Output name.\&
.PP
Example: DP-1
.PP
.RE
.SH SECTION: style.*
.PP
\fBborder_color\fR
.RS 4
Border color, in RRGGBB[AA] format.\&
.PP
.RE
\fBbackground_color\fR
.RS 4
Background color, in RRGGBB[AA] format.\&
.PP
.RE
\fBbar_color\fR
.RS 4
Bar color, in RRGGBB[AA] format.\&
.PP
.RE
\fBoverflow_bar_color\fR
.RS 4
Overflow bar color, in RRGGBB[AA] format.\&
.PP
.RE
\fBoverflow_background_color\fR
.RS 4
Overflow background color, in RRGGBB[AA] format.\&
.PP
.RE
\fBoverflow_border_color\fR
.RS 4
Overflow border color, in RRGGBB[AA] format.\&
.PP
.RE
.SH EXAMPLE
.PP
.nf
.RS 4
timeout = 1000
max = 100
output_mode = whitelist
bar_color = FFFFFF

[output\&.left]
name = DP-1

[output\&.ips]
name = HDMI-1

[style\&.muted]
background_color = 032cfc
.fi
.RE
.PP
.SH See also
.PP
\fBwob\fR(1)