diff options
author | Brian Ashworth <bosrsf04@gmail.com> | 2018-07-28 09:34:25 -0400 |
---|---|---|
committer | Brian Ashworth <bosrsf04@gmail.com> | 2018-08-01 22:47:54 -0400 |
commit | 8463a2896a932cd99f3dc93608b03cb4aba93293 (patch) | |
tree | b8c4ba994cf4d9ca7510d0f80a1864cce144092a /swaynag/swaynag.1.scd | |
parent | Address first round review for swaynag (diff) | |
download | sway-8463a2896a932cd99f3dc93608b03cb4aba93293.tar.gz sway-8463a2896a932cd99f3dc93608b03cb4aba93293.tar.zst sway-8463a2896a932cd99f3dc93608b03cb4aba93293.zip |
swaynag: implement config file support
Diffstat (limited to 'swaynag/swaynag.1.scd')
-rw-r--r-- | swaynag/swaynag.1.scd | 33 |
1 files changed, 23 insertions, 10 deletions
diff --git a/swaynag/swaynag.1.scd b/swaynag/swaynag.1.scd index 879aaf2e..7d250a45 100644 --- a/swaynag/swaynag.1.scd +++ b/swaynag/swaynag.1.scd | |||
@@ -1,4 +1,4 @@ | |||
1 | swaynagbar(1) | 1 | swaynag(1) |
2 | 2 | ||
3 | # NAME | 3 | # NAME |
4 | 4 | ||
@@ -13,13 +13,21 @@ _swaynag_ [options...] | |||
13 | Create a button with the text _text_ that executes _action_ when pressed. | 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. | 14 | Multiple buttons can be defined by providing the flag multiple times. |
15 | 15 | ||
16 | *-c, --config* <path> | ||
17 | The config file to use. By default, the following paths are checked: | ||
18 | _$HOME/.swaynag/config_, _$XDG\_CONFIG\_HOME/swaynag/config_, and | ||
19 | _SYSCONFDIR/swaynag/config_. All flags aside from this one and _debug_ are | ||
20 | valid options in the configuration file using the format | ||
21 | _long-option=value_. All leading dashes should be omitted and the equals | ||
22 | sign is required. See swaynag(5) for more information. | ||
23 | |||
16 | *-d, --debug* | 24 | *-d, --debug* |
17 | Enable debugging. | 25 | Enable debugging. |
18 | 26 | ||
19 | *-e, --edge top|bottom* | 27 | *-e, --edge* top|bottom |
20 | Set the edge to use. | 28 | Set the edge to use. |
21 | 29 | ||
22 | *-f, --font <font>* | 30 | *-f, --font* <font> |
23 | Set the font to use. | 31 | Set the font to use. |
24 | 32 | ||
25 | *-h, --help* | 33 | *-h, --help* |
@@ -29,24 +37,29 @@ _swaynag_ [options...] | |||
29 | Read a detailed message from stdin. A button to toggle details will be | 37 | 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. | 38 | added. Details are shown in a scrollable multi-line text area. |
31 | 39 | ||
32 | *-L, --detailed-button <text>* | 40 | *-L, --detailed-button* <text> |
33 | Set the text for the button that toggles details. This has no effect if | 41 | 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_. | 42 | there is not a detailed message. The default is _Toggle Details_. |
35 | 43 | ||
36 | *-m, --message <msg>* | 44 | *-m, --message* <msg> |
37 | Set the message text. | 45 | Set the message text. |
38 | 46 | ||
39 | *-o, --output <output>* | 47 | *-o, --output* <output> |
40 | Set the output to use. This should be the name of a _xdg\_output_. If | 48 | 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 | 49 | _xdg\_output\_manager_ is not supported, then the first detected output |
42 | will be used | 50 | will be used |
43 | 51 | ||
44 | *-s, --dismiss-button <text>* | 52 | *-s, --dismiss-button* <text> |
45 | Sets the text for the dismiss nagbar button. The default is _X_. | 53 | Sets the text for the dismiss nagbar button. The default is _X_. |
46 | 54 | ||
47 | *-t, --type error|warning* | 55 | *-t, --type* |
48 | Set the message type. | 56 | Set the message type. Two types are created by default _error_ and |
57 | _warning_. Custom types can be defined in the config file. See | ||
58 | _--config_ and swaynag(5) for details. Both of the default types can be | ||
59 | overridden in the config file as well. | ||
49 | 60 | ||
50 | *-v, --version | 61 | *-v, --version* |
51 | Show the version number and quit. | 62 | Show the version number and quit. |
52 | 63 | ||
64 | # SEE | ||
65 | swaynag(5) | ||