~novakane/agertu

agertu/doc/agertu.1 -rw-r--r-- 4.0 KiB
9ea83d8fHugo Machet build: Bump to version 2.0.0-dev 3 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
.TH AGERTU 1 2022-05-05 "sr.ht/~novakane/agertu"
.
.SH NAME
.P
.B agertu
\- popup information for
.BR river (1)
Wayland compositor
.
.SH SYNOPSIS
.P
.SY agertu
.YS
.
.SH DESCRIPTION
.P
.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
.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
.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:
.IP
.EE
# This is a commentary (Note that \(aq;\(aq is not a commentary)
.IP
<option-name> = <value>;
.EX
.
.SS Surface
.TP
.BI surface_borders_size\  int
Set the surface borders size.
.IP
\(bu Default: 0
.TP
.BI surface_anchors\  top:right:bottom:left
Set the surface anchors.
.IP
\(bu Default: 0:1:1:0
.TP
.BI surface_margins\  top:right:bottom:left
Set the surface margins from the anchors point.
.IP
\(bu Default: 0:10:10:0
.TP
.BI surface_background_color\  0xRRGGBB|0xRRGGBBAA
Set the surface background color.
.IP
\(bu Default: 0x202325
.TP
.BI surface_borders_color\  0xRRGGBB|0xRRGGBBAA
Set the surface borders color.
.IP
\(bu Default: 0x9e2f59
.
.SS Tags
.TP
.BI tags_amounts\  amount
Set the number of tags displayed. The maximum number of tags in
.BR river (1)
is 32.
.IP
\(bu Default: 9
.TP
.BI tags_number_text\  true|false
Enable or disable text number in tags.
.TP
.BI tags_square_size\  int
Set the size of the tags square.
.IP
\(bu Default: 50
.TP
.BI tags_borders_size\  int
Set the size of the square borders.
.IP
\(bu Default: 2
.TP
.BI tags_margins\  int
Set the size of the margins between square.
.IP
\(bu Default: 5
.TP
.BI tags_background_color\  0xRRGGBB|0xRRGGBBAA
Set the tags square default background color.
.IP
\(bu Default: 0x3a4043
.TP
.BI tags_foreground_color\  0xRRGGBB|0xRRGGBBAA
Set the tags square default foreground color.
.IP
\(bu Default: 0xdce1e4
.TP
.BI tags_borders_color\  0xRRGGBB|0xRRGGBBAA
Set the tags square default borders color.
.IP
\(bu Default: 0x646e73
.TP
.BI tags_focused_background_color\  0xRRGGBB|0xRRGGBBAA
Set the square background color for focused tags.
.IP
\(bu Default: 0xf9f9fa
.TP
.BI tags_focused_foreground_color\  0xRRGGBB|0xRRGGBBAA
Set the square foreground color for focused tags.
.IP
\(bu Default: 0x202325
.TP
.BI tags_focused_borders_color\  0xRRGGBB|0xRRGGBBAA
Set the square borders color for focused tags.
.IP
\(bu Default: 0xdce1e4
.TP
.BI tags_occupied_background_color\  0xRRGGBB|0xRRGGBBAA
Set the square background color for occupied tags.
.IP
\(bu Default: 0x2e3f9f
.TP
.BI tags_occupied_foreground_color\  0xRRGGBB|0xRRGGBBAA
Set the square foreground color for occupied tags.
.IP
\(bu Default: 0xdce1e4
.TP
.BI tags_occupied_borders_color\  0xRRGGBB|0xRRGGBBAA
Set the square borders color for occupied tags.
.IP
\(bu Default: 0xdbf1fd
.TP
.BI tags_urgent_background_color\  0xRRGGBB|0xRRGGBBAA
Set the square background color for urgent tags.
.IP
\(bu Default: 0x9e2f59
.TP
.BI tags_urgent_foreground_color\  0xRRGGBB|0xRRGGBBAA
Set the square foreground color for urgent tags.
.IP
\(bu Default: 0x202325
.TP
.BI tags_urgent_borders_color\  0xRRGGBB|0xRRGGBBAA
Set the square borders color for urgent tags.
.IP
\(bu Default: 0xfde7f6
.
.SS Fonts
.TP
.BI fonts\  \(dqfirst-font[,other-font]\(dq
Comma separated list of fonts to use, in
.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.
.IP
Examples:
.IP
.EX
\(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
.IP
\(bu Default: monospace:size=18
.
.SH AUTHORS
.P
.MT mail@hmachet.com
Hugo Machet
.ME