aboutsummaryrefslogtreecommitdiffstats
path: root/swaynag/swaynag.1.scd
diff options
context:
space:
mode:
authorLibravatar Brian Ashworth <bosrsf04@gmail.com>2018-07-27 11:19:42 -0400
committerLibravatar Brian Ashworth <bosrsf04@gmail.com>2018-08-01 22:47:54 -0400
commita4f7bf23b21d0d838a8a19261d5fd69719003a03 (patch)
treee46a226d8c3ded2d93e1933323263b6756199a68 /swaynag/swaynag.1.scd
parentSupport a detailed message in swaynagbar (diff)
downloadsway-a4f7bf23b21d0d838a8a19261d5fd69719003a03.tar.gz
sway-a4f7bf23b21d0d838a8a19261d5fd69719003a03.tar.zst
sway-a4f7bf23b21d0d838a8a19261d5fd69719003a03.zip
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 @@
1swaynagbar(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*-b, --button* <text> <action>
13 Create a button with the text _text_ that executes _action_ when pressed.
14 Multiple buttons can be defined by providing the flag multiple times.
15
16*-d, --debug*
17 Enable debugging.
18
19*-e, --edge top|bottom*
20 Set the edge to use.
21
22*-f, --font <font>*
23 Set the font to use.
24
25*-h, --help*
26 Show help message and quit.
27
28*-l, --detailed-message*
29 Read a detailed message from stdin. A button to toggle details will be
30 added. Details are shown in a scrollable multi-line text area.
31
32*-L, --detailed-button <text>*
33 Set the text for the button that toggles details. This has no effect if
34 there is not a detailed message. The default is _Toggle Details_.
35
36*-m, --message <msg>*
37 Set the message text.
38
39*-o, --output <output>*
40 Set the output to use. This should be the name of a _xdg\_output_. If
41 _xdg\_output\_manager_ is not supported, then the first detected output
42 will be used
43
44*-s, --dismiss-button <text>*
45 Sets the text for the dismiss nagbar button. The default is _X_.
46
47*-t, --type error|warning*
48 Set the message type.
49
50*-v, --version
51 Show the version number and quit.
52