sway/swaynag/swaynag.5.scd

110 lines
2.2 KiB
Plaintext
Raw Normal View History

2018-07-28 15:34:25 +02:00
swaynag(5)
# NAME
swaynag - swaynag configuration file
# SYNOPSIS
$HOME/.swaynag/config, $XDG\_CONFIG\_HOME/swaynag/config,
SYSCONFDIR/swaynag/config
# CONFIG FILE
2018-07-28 15:34:25 +02:00
At the top of the config file, _swaynag_ options can be set using the format
_long-option=value_. These will be used as default values if _swaynag_ is not
given the option. This can be useful for setting a preferred font, output, and
edge.
Below the options, custom types may be defined. To define a type, use the
following format:
```
[name-of-type]
2018-07-30 04:42:03 +02:00
option=value
2018-07-28 15:34:25 +02:00
```
All colors may be given in the form _RRGGBB_ or _RRGGBBAA_. The following
colors can be set:
2018-07-30 04:42:03 +02:00
*background=<color>*
2018-07-28 15:34:25 +02:00
The background color for _swaynag_.
2018-07-30 04:42:03 +02:00
*border=<color>*
2018-07-28 15:34:25 +02:00
The color to use for borders of buttons.
2018-07-30 04:42:03 +02:00
*border-bottom=<color>*
2018-07-28 15:34:25 +02:00
The color of the border line at the bottom of _swaynag_.
2018-07-30 04:42:03 +02:00
*button-background=<color>*
2018-07-28 15:34:25 +02:00
The background color for the buttons.
2018-07-30 04:42:03 +02:00
*text=<color>*
2018-07-28 15:34:25 +02:00
The color of the text.
*button-text=<color>*
The color of the button text.
2018-07-30 04:42:03 +02:00
The following sizing options can also be set:
*border-bottom-size=<size>*
Set the thickness of the bottom border.
*message-padding=<padding>*
Set the padding for the message.
2021-05-28 16:50:17 +02:00
*details-background=<color>*
The background color for the details.
2018-07-30 04:42:03 +02:00
*details-border-size=<size>*
Set the thickness for the details border.
*button-border-size=<size>*
Set the thickness for the button border.
*button-gap=<gap>*
Set the size of the gap between buttons.
*button-dismiss-gap=<gap>*
Set the size of the gap between the dismiss button and another button.
*button-margin-right=<margin>*
Set the margin from the right of the dismiss button to edge.
*button-padding=<padding>*
Set the padding for the button text.
Additionally, the following options can be assigned a default per-type:
*edge=top|bottom*
Set the edge to use.
*layer=overlay|top|bottom|background*
Set the layer to use.
2018-07-30 04:42:03 +02:00
*font=<font>*
Set the font to use.
*output=<output>*
Set the output to use. This should be the name of a _xdg\_output_.
2018-07-28 15:34:25 +02:00
# EXAMPLE
2018-07-28 15:34:25 +02:00
```
font=Monospace 12
2018-07-30 04:42:03 +02:00
edge=bottom
2018-07-28 15:34:25 +02:00
[green]
2018-07-30 04:42:03 +02:00
edge=top
2018-07-28 15:34:25 +02:00
background=00AA00
border=006600
border-bottom=004400
text=FFFFFF
button-background=00CC00
2018-07-30 04:42:03 +02:00
message-padding=10
2018-07-28 15:34:25 +02:00
```
# SEE
2018-07-28 15:34:25 +02:00
swaynag(1)