docs: update README with tag, untag, and flag changes
This commit is contained in:
parent
9c217409ca
commit
9a39e22d52
2 changed files with 86 additions and 2 deletions
83
README.md
83
README.md
|
|
@ -1,5 +1,33 @@
|
||||||
nag, a bash script for setting one-off or repeating alarms
|
nag, a bash script for setting one-off or repeating alarms
|
||||||
|
|
||||||
|
```text
|
||||||
|
Usage:
|
||||||
|
nag list all alarms
|
||||||
|
nag <time> <message...> one-shot alarm
|
||||||
|
nag every <rules> <time> <message...> repeating alarm
|
||||||
|
nag stop <id> delete alarm
|
||||||
|
nag skip <id> skip next occurrence
|
||||||
|
nag tag <id> <tags...> add tags to an alarm
|
||||||
|
nag tag <tag> list alarms with a tag
|
||||||
|
nag untag <id> <tags...> remove tags from an alarm
|
||||||
|
nag check check and fire due alarms
|
||||||
|
nag mute mute alarm sounds
|
||||||
|
nag unmute unmute alarm sounds
|
||||||
|
nag edit edit alarms file directly
|
||||||
|
nag help [<subcommand>] show help
|
||||||
|
nag version show version
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-e Edit alarms file directly.
|
||||||
|
-f Skip all prompts.
|
||||||
|
-v Show version.
|
||||||
|
|
||||||
|
Environment:
|
||||||
|
NAG_DIR Alarm storage directory (default: ~/.local/share/nag)
|
||||||
|
NAG_CMD Notification command (default: notify-send)
|
||||||
|
NAG_SOUND Sound file to play (default: freedesktop bell sound)
|
||||||
|
```
|
||||||
|
|
||||||
### Help
|
### Help
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
|
|
@ -14,9 +42,12 @@ nag, a bash script for setting one-off or repeating alarms
|
||||||
<a href="#nag-every"><code>every</code></a> ·
|
<a href="#nag-every"><code>every</code></a> ·
|
||||||
<a href="#nag-stop"><code>stop</code></a> ·
|
<a href="#nag-stop"><code>stop</code></a> ·
|
||||||
<a href="#nag-skip"><code>skip</code></a> ·
|
<a href="#nag-skip"><code>skip</code></a> ·
|
||||||
|
<a href="#nag-tag"><code>tag</code></a> ·
|
||||||
|
<a href="#nag-untag"><code>untag</code></a> ·
|
||||||
<a href="#nag-check"><code>check</code></a> ·
|
<a href="#nag-check"><code>check</code></a> ·
|
||||||
<a href="#nag-mute"><code>mute</code></a> ·
|
<a href="#nag-mute"><code>mute</code></a> ·
|
||||||
<a href="#nag-unmute"><code>unmute</code></a> ·
|
<a href="#nag-unmute"><code>unmute</code></a> ·
|
||||||
|
<a href="#nag-edit"><code>edit</code></a> ·
|
||||||
<a href="#nag-help"><code>help</code></a> ·
|
<a href="#nag-help"><code>help</code></a> ·
|
||||||
<a href="#nag-version"><code>version</code></a>
|
<a href="#nag-version"><code>version</code></a>
|
||||||
</div>
|
</div>
|
||||||
|
|
@ -122,6 +153,40 @@ Description:
|
||||||
For one-shot alarms, this deletes them.
|
For one-shot alarms, this deletes them.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### `nag tag`
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<sup>
|
||||||
|
<a href="#help">↑</a>
|
||||||
|
</sup>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
```text
|
||||||
|
Usage:
|
||||||
|
nag tag <id> <tags...> add tags to an alarm
|
||||||
|
nag tag <tag> list alarms with a tag
|
||||||
|
|
||||||
|
Description:
|
||||||
|
Add tags to an alarm by ID, or list all alarms matching a tag.
|
||||||
|
Tags must not be pure integers.
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `nag untag`
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<sup>
|
||||||
|
<a href="#help">↑</a>
|
||||||
|
</sup>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
```text
|
||||||
|
Usage:
|
||||||
|
nag untag <id> <tags...>
|
||||||
|
|
||||||
|
Description:
|
||||||
|
Remove one or more tags from an alarm.
|
||||||
|
```
|
||||||
|
|
||||||
#### `nag check`
|
#### `nag check`
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
|
|
@ -173,6 +238,22 @@ Description:
|
||||||
Unmute alarm sounds.
|
Unmute alarm sounds.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### `nag edit`
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<sup>
|
||||||
|
<a href="#help">↑</a>
|
||||||
|
</sup>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
```text
|
||||||
|
Usage:
|
||||||
|
nag ( edit | -e )
|
||||||
|
|
||||||
|
Description:
|
||||||
|
Open the alarms file in $EDITOR (falls back to $VISUAL, then vi).
|
||||||
|
```
|
||||||
|
|
||||||
#### `nag help`
|
#### `nag help`
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
|
|
@ -199,7 +280,7 @@ Description:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
Usage:
|
Usage:
|
||||||
nag ( version | --version )
|
nag ( version | -v )
|
||||||
|
|
||||||
Description:
|
Description:
|
||||||
Display the current program version.
|
Display the current program version.
|
||||||
|
|
|
||||||
5
nag
5
nag
|
|
@ -1131,10 +1131,13 @@ Usage:
|
||||||
${_ME} every <rules> <time> <message...> repeating alarm
|
${_ME} every <rules> <time> <message...> repeating alarm
|
||||||
${_ME} stop <id> delete alarm
|
${_ME} stop <id> delete alarm
|
||||||
${_ME} skip <id> skip next occurrence
|
${_ME} skip <id> skip next occurrence
|
||||||
|
${_ME} tag <id> <tags...> add tags to an alarm
|
||||||
|
${_ME} tag <tag> list alarms with a tag
|
||||||
|
${_ME} untag <id> <tags...> remove tags from an alarm
|
||||||
${_ME} check check and fire due alarms
|
${_ME} check check and fire due alarms
|
||||||
${_ME} edit edit alarms file directly
|
|
||||||
${_ME} mute mute alarm sounds
|
${_ME} mute mute alarm sounds
|
||||||
${_ME} unmute unmute alarm sounds
|
${_ME} unmute unmute alarm sounds
|
||||||
|
${_ME} edit edit alarms file directly
|
||||||
${_ME} help [<subcommand>] show help
|
${_ME} help [<subcommand>] show help
|
||||||
${_ME} version show version
|
${_ME} version show version
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue