aboutsummaryrefslogtreecommitdiff
path: root/swaynag/swaynag.1.scd
diff options
context:
space:
mode:
authorBrian Ashworth <bosrsf04@gmail.com>2018-07-27 11:19:42 -0400
committerBrian Ashworth <bosrsf04@gmail.com>2018-08-01 22:47:54 -0400
commita4f7bf23b21d0d838a8a19261d5fd69719003a03 (patch)
treee46a226d8c3ded2d93e1933323263b6756199a68 /swaynag/swaynag.1.scd
parent72db10c2f1a1a216c50f68461a840eea3948e878 (diff)
Address first round review for swaynag
Diffstat (limited to 'swaynag/swaynag.1.scd')
-rw-r--r--swaynag/swaynag.1.scd52
1 files changed, 52 insertions, 0 deletions
diff --git a/swaynag/swaynag.1.scd b/swaynag/swaynag.1.scd
new file mode 100644
index 00000000..879aaf2e
--- /dev/null
+++ b/swaynag/swaynag.1.scd
@@ -0,0 +1,52 @@
+swaynagbar(1)
+
+# NAME
+
+swaynag - Show a warning or error message with buttons
+
+# SYNOPSIS
+
+_swaynag_ [options...]
+
+# OPTIONS
+*-b, --button* <text> <action>
+ Create a button with the text _text_ that executes _action_ when pressed.
+ Multiple buttons can be defined by providing the flag multiple times.
+
+*-d, --debug*
+ Enable debugging.
+
+*-e, --edge top|bottom*
+ Set the edge to use.
+
+*-f, --font <font>*
+ Set the font to use.
+
+*-h, --help*
+ Show help message and quit.
+
+*-l, --detailed-message*
+ Read a detailed message from stdin. A button to toggle details will be
+ added. Details are shown in a scrollable multi-line text area.
+
+*-L, --detailed-button <text>*
+ Set the text for the button that toggles details. This has no effect if
+ there is not a detailed message. The default is _Toggle Details_.
+
+*-m, --message <msg>*
+ Set the message text.
+
+*-o, --output <output>*
+ Set the output to use. This should be the name of a _xdg\_output_. If
+ _xdg\_output\_manager_ is not supported, then the first detected output
+ will be used
+
+*-s, --dismiss-button <text>*
+ Sets the text for the dismiss nagbar button. The default is _X_.
+
+*-t, --type error|warning*
+ Set the message type.
+
+*-v, --version
+ Show the version number and quit.
+