~novakane/agertu

389a30cefc4f57250ca51a089c25f7cd2f521b84 — Hugo Machet a month ago cfff032
doc: Improve man page format
1 files changed, 125 insertions(+), 188 deletions(-)

M doc/agertu.1
M doc/agertu.1 => doc/agertu.1 +125 -188
@@ 1,252 1,189 @@
.TH AGERTU 1 2022-05-05 "git.sr.ht/~novakane/agertu" "General Commands Manual"
.TH AGERTU 1 2022-05-05 "sr.ht/~novakane/agertu"
.
.SH NAME
.P
.BR agertu
.B agertu
\- popup information for
.BR river (1)
Wayland compositor
.
.SH SYNOPSIS
.P
.BR agertu
.SY agertu
.YS
.
.SH DESCRIPTION
.P
.BR agertu
.B agertu
is a popup with tags information for
.BR river (1).
.P
It appears every time a new tag is focused or when a tag gain urgency. It
displays information about \fIfocused, occupied\fR and \fIurgent\fR tags as
well as the tags number.
displays information about
.IR focused ,
.I occupied
and
.I urgent
tags as well as the tags number.
.
.SH CONFIGURATION
.P
On startup agertu will look for a file at
\fI$XDG_CONFIG_HOME/agertu/config.ini\fR. If unset
.IR $XDG_CONFIG_HOME
defaults to \fI\(ti/.config/\fR. If the file is not found default values
will be used.
.P
An example config with the default value is provided in the \fIexample/\fR
.IR $XDG_CONFIG_HOME/agertu/config.ini .
If unset
.I $XDG_CONFIG_HOME
defaults to
.IR \(ti/.config/ .
If the file is not found default values will be used.
.P
An example config with the default value is provided in the
.I example/
directory.
.P
Format is:
.P
.RS 4
.IP
.EE
# This is a commentary (Note that \(aq;\(aq is not a commentary)
.IP
<option-name> = <value>;
.EX
.RE
.
.SS Surface
.P
.B surface_borders_size
<int>
.RS 4
.TP
.BI surface_borders_size\  int
Set the surface borders size.
.P
Default: 0
.P
.RE
.B surface_anchors
<top>:<right>:<bottom>:<left>
.RS 4
.IP
\(bu Default: 0
.TP
.BI surface_anchors\  top:right:bottom:left
Set the surface anchors.
.P
Default: 0:1:1:0
.P
.RE
.B surface_margins
<top>:<right>:<bottom>:<left>
.RS 4
.IP
\(bu Default: 0:1:1:0
.TP
.BI surface_margins\  top:right:bottom:left
Set the surface margins from the anchors point.
.P
Default: 0:10:10:0
.P
.RE
.B surface_background_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0:10:10:0
.TP
.BI surface_background_color\  0xRRGGBB|0xRRGGBBAA
Set the surface background color.
.P
Default: 0x202325
.P
.RE
.B surface_borders_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0x202325
.TP
.BI surface_borders_color\  0xRRGGBB|0xRRGGBBAA
Set the surface borders color.
.P
Default: 0x9e2f59
.P
.RE
.IP
\(bu Default: 0x9e2f59
.
.SS Tags
.P
.B tags_amounts
<amount>
.RS 4
.TP
.BI tags_amounts\  amount
Set the number of tags displayed. The maximum number of tags in
.BR river (1)
is 32.
.P
Default: 9
.P
.RE
.B tags_number_text
<true|false>
.RS 4
.IP
\(bu Default: 9
.TP
.BI tags_number_text\  true|false
Enable or disable text number in tags.
.P
.RE
.B tags_square_size
<int>
.RS 4
.TP
.BI tags_square_size\  int
Set the size of the tags square.
.P
Default: 50
.P
.RE
.B tags_borders_size
<int>
.RS 4
.IP
\(bu Default: 50
.TP
.BI tags_borders_size\  int
Set the size of the square borders.
.P
Default: 2
.P
.RE
.B tags_margins
<int>
.RS 4
.IP
\(bu Default: 2
.TP
.BI tags_margins\  int
Set the size of the margins between square.
.P
Default: 5
.P
.RE
.B tags_background_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 5
.TP
.BI tags_background_color\  0xRRGGBB|0xRRGGBBAA
Set the tags square default background color.
.P
Default: 0x3a4043
.P
.RE
.B tags_foreground_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0x3a4043
.TP
.BI tags_foreground_color\  0xRRGGBB|0xRRGGBBAA
Set the tags square default foreground color.
.P
Default: 0xdce1e4
.P
.RE
.B tags_borders_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0xdce1e4
.TP
.BI tags_borders_color\  0xRRGGBB|0xRRGGBBAA
Set the tags square default borders color.
.P
Default: 0x646e73
.P
.RE
.B tags_focused_background_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0x646e73
.TP
.BI tags_focused_background_color\  0xRRGGBB|0xRRGGBBAA
Set the square background color for focused tags.
.P
Default: 0xf9f9fa
.P
.RE
.B tags_focused_foreground_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0xf9f9fa
.TP
.BI tags_focused_foreground_color\  0xRRGGBB|0xRRGGBBAA
Set the square foreground color for focused tags.
.P
Default: 0x202325
.P
.RE
.B tags_focused_borders_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0x202325
.TP
.BI tags_focused_borders_color\  0xRRGGBB|0xRRGGBBAA
Set the square borders color for focused tags.
.P
Default: 0xdce1e4
.P
.RE
.B tags_occupied_background_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0xdce1e4
.TP
.BI tags_occupied_background_color\  0xRRGGBB|0xRRGGBBAA
Set the square background color for occupied tags.
.P
Default: 0x2e3f9f
.P
.RE
.B tags_occupied_foreground_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0x2e3f9f
.TP
.BI tags_occupied_foreground_color\  0xRRGGBB|0xRRGGBBAA
Set the square foreground color for occupied tags.
.P
Default: 0xdce1e4
.P
.RE
.B tags_occupied_borders_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0xdce1e4
.TP
.BI tags_occupied_borders_color\  0xRRGGBB|0xRRGGBBAA
Set the square borders color for occupied tags.
.P
Default: 0xdbf1fd
.P
.RE
.B tags_urgent_background_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0xdbf1fd
.TP
.BI tags_urgent_background_color\  0xRRGGBB|0xRRGGBBAA
Set the square background color for urgent tags.
.P
Default: 0x9e2f59
.P
.RE
.B tags_urgent_foreground_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0x9e2f59
.TP
.BI tags_urgent_foreground_color\  0xRRGGBB|0xRRGGBBAA
Set the square foreground color for urgent tags.
.P
Default: 0x202325
.P
.RE
.B tags_urgent_borders_color
<0xRRGGBB|0xRRGGBBAA>
.RS 4
.IP
\(bu Default: 0x202325
.TP
.BI tags_urgent_borders_color\  0xRRGGBB|0xRRGGBBAA
Set the square borders color for urgent tags.
.P
Default: 0xfde7f6
.P
.RE
.IP
\(bu Default: 0xfde7f6
.
.SS Fonts
.P
.B fonts
"<first-font>, <other-font>"
.RS 4
.TP
.BI fonts\  \(dqfirst-font[,other-font]\(dq
Comma separated list of fonts to use, in
.I fontconfig
format. That is,
a font name followed by a list of colon separated options.
.P
The first-font is the primary font, the remaining fonts are fallback
.B fontconfig
format. That is, a font name followed by a list of colon separated options.
.IP
The
.I first-font
is the primary font, the remaining fonts are fallback
fonts that will be used whenever a glyph cannot be found in the primary font.
.P
.IP
Examples:
.RE
.IP
.EX
\- VictorMono Mono:size=14, Noto Color Emoji:size=8.5
\- Dina:weight=bold:slant=italic
\- Fantasque Sans Mono:fontfeatures=ss01
\(bu IBM Plex Mono:size=12, Noto Color Emoji:size=8.5
\(bu Dina:weight=bold:slant=italic
\(bu Fantasque Sans Mono:fontfeatures=ss01
.EE
.P
.RS 4
Default: monospace:size=18
.P
.RE
.IP
\(bu Default: monospace:size=18
.
.SH AUTHORS
.P
.MT mail@hmachet.com