diff options
Diffstat (limited to 'swaynag/swaynag.5.scd')
-rw-r--r-- | swaynag/swaynag.5.scd | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/swaynag/swaynag.5.scd b/swaynag/swaynag.5.scd new file mode 100644 index 00000000..d3daadf7 --- /dev/null +++ b/swaynag/swaynag.5.scd | |||
@@ -0,0 +1,100 @@ | |||
1 | swaynag(5) | ||
2 | |||
3 | # NAME | ||
4 | |||
5 | swaynag - swaynag configuration file | ||
6 | |||
7 | # SYNOPSIS | ||
8 | |||
9 | $HOME/.swaynag/config, $XDG\_CONFIG\_HOME/swaynag/config, | ||
10 | SYSCONFDIR/swaynag/config | ||
11 | |||
12 | # CONFIG FILE | ||
13 | |||
14 | At the top of the config file, _swaynag_ options can be set using the format | ||
15 | _long-option=value_. These will be used as default values if _swaynag_ is not | ||
16 | given the option. This can be useful for setting a preferred font, output, and | ||
17 | edge. | ||
18 | |||
19 | Below the options, custom types may be defined. To define a type, use the | ||
20 | following format: | ||
21 | |||
22 | ``` | ||
23 | [name-of-type] | ||
24 | option=value | ||
25 | ``` | ||
26 | |||
27 | All colors may be given in the form _RRGGBB_ or _RRGGBBAA_. The following | ||
28 | colors can be set: | ||
29 | |||
30 | *background=<color>* | ||
31 | The background color for _swaynag_. | ||
32 | |||
33 | *border=<color>* | ||
34 | The color to use for borders of buttons. | ||
35 | |||
36 | *border-bottom=<color>* | ||
37 | The color of the border line at the bottom of _swaynag_. | ||
38 | |||
39 | *button-background=<color>* | ||
40 | The background color for the buttons. | ||
41 | |||
42 | *text=<color>* | ||
43 | The color of the text. | ||
44 | |||
45 | The following sizing options can also be set: | ||
46 | |||
47 | *border-bottom-size=<size>* | ||
48 | Set the thickness of the bottom border. | ||
49 | |||
50 | *message-padding=<padding>* | ||
51 | Set the padding for the message. | ||
52 | |||
53 | *details-border-size=<size>* | ||
54 | Set the thickness for the details border. | ||
55 | |||
56 | *button-border-size=<size>* | ||
57 | Set the thickness for the button border. | ||
58 | |||
59 | *button-gap=<gap>* | ||
60 | Set the size of the gap between buttons. | ||
61 | |||
62 | *button-dismiss-gap=<gap>* | ||
63 | Set the size of the gap between the dismiss button and another button. | ||
64 | |||
65 | *button-margin-right=<margin>* | ||
66 | Set the margin from the right of the dismiss button to edge. | ||
67 | |||
68 | *button-padding=<padding>* | ||
69 | Set the padding for the button text. | ||
70 | |||
71 | Additionally, the following options can be assigned a default per-type: | ||
72 | |||
73 | *edge=top|bottom* | ||
74 | Set the edge to use. | ||
75 | |||
76 | *font=<font>* | ||
77 | Set the font to use. | ||
78 | |||
79 | *output=<output>* | ||
80 | Set the output to use. This should be the name of a _xdg\_output_. | ||
81 | |||
82 | # EXAMPLE | ||
83 | |||
84 | ``` | ||
85 | font=Monospace 12 | ||
86 | edge=bottom | ||
87 | |||
88 | [green] | ||
89 | edge=top | ||
90 | background=00AA00 | ||
91 | border=006600 | ||
92 | border-bottom=004400 | ||
93 | text=FFFFFF | ||
94 | button-background=00CC00 | ||
95 | message-padding=10 | ||
96 | ``` | ||
97 | |||
98 | # SEE | ||
99 | |||
100 | swaynag(1) | ||