summaryrefslogtreecommitdiffstats
path: root/swaynag/swaynag.1.scd
diff options
context:
space:
mode:
Diffstat (limited to 'swaynag/swaynag.1.scd')
-rw-r--r--swaynag/swaynag.1.scd106
1 files changed, 106 insertions, 0 deletions
diff --git a/swaynag/swaynag.1.scd b/swaynag/swaynag.1.scd
new file mode 100644
index 00000000..1c395aee
--- /dev/null
+++ b/swaynag/swaynag.1.scd
@@ -0,0 +1,106 @@
1swaynag(1)
2
3# NAME
4
5swaynag - Show a warning or error message with buttons
6
7# SYNOPSIS
8
9_swaynag_ [options...]
10
11# OPTIONS
12
13*-b, --button* <text> <action>
14 Create a button with the text _text_ that executes _action_ when pressed.
15 Multiple buttons can be defined by providing the flag multiple times.
16
17*-c, --config* <path>
18 The config file to use. By default, the following paths are checked:
19 _$HOME/.swaynag/config_, _$XDG\_CONFIG\_HOME/swaynag/config_, and
20 _SYSCONFDIR/swaynag/config_. All flags aside from this one and _debug_ are
21 valid options in the configuration file using the format
22 _long-option=value_. All leading dashes should be omitted and the equals
23 sign is required. See swaynag(5) for more information.
24
25*-d, --debug*
26 Enable debugging.
27
28*-e, --edge* top|bottom
29 Set the edge to use.
30
31*-f, --font* <font>
32 Set the font to use.
33
34*-h, --help*
35 Show help message and quit.
36
37*-l, --detailed-message*
38 Read a detailed message from stdin. A button to toggle details will be
39 added. Details are shown in a scrollable multi-line text area.
40
41*-L, --detailed-button* <text>
42 Set the text for the button that toggles details. This has no effect if
43 there is not a detailed message. The default is _Toggle Details_.
44
45*-m, --message* <msg>
46 Set the message text.
47
48*-o, --output* <output>
49 Set the output to use. This should be the name of a _xdg\_output_.
50
51*-s, --dismiss-button* <text>
52 Sets the text for the dismiss nagbar button. The default is _X_.
53
54*-t, --type* <type>
55 Set the message type. Two types are created by default _error_ and
56 _warning_. Custom types can be defined in the config file. See
57 _--config_ and swaynag(5) for details. Both of the default types can be
58 overridden in the config file as well.
59
60*-v, --version*
61 Show the version number and quit.
62
63# APPEARANCE OPTIONS
64
65*--background* <RRGGBB[AA]>
66 Set the color of the background.
67
68*--border* <RRGGBB[AA]>
69 Set the color of the border.
70
71*--border-bottom* <RRGGBB[AA]>
72 Set the color of the bottom border.
73
74*--button-background* <RRGGBB[AA]>
75 Set the color for the background for buttons.
76
77*--text* <RRGGBB[AA]>
78 Set the text color.
79
80*--border-bottom-size* <size>
81 Set the thickness of the bottom border.
82
83*--message-padding* <padding>
84 Set the padding for the message.
85
86*--details-border-size* <size>
87 Set the thickness for the details border.
88
89*--button-border-size* <size>
90 Set the thickness for the button border.
91
92*--button-gap* <gap>
93 Set the size of the gap between buttons.
94
95*--button-dismiss-gap* <gap>
96 Set the size of the gap between the dismiss button and another button.
97
98*--button-margin-right* <margin>
99 Set the margin from the right of the dismiss button to edge.
100
101*--button-padding* <padding>
102 Set the padding for the button text.
103
104# SEE
105
106swaynag(5)