extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-11-23 00:23:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

updated man page and docs for --dry-run switch

Browse Source
This commit is contained in:
Chris Caron 2019-09-30 21:44:40 -04:00
parent 7f60fff521
commit 3b49e8be6f
3 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
apprise/cli.py
View File

@ -113,8 +113,8 @@ def print_version_msg():
'If no tags are specified then all services are notified.') 'If no tags are specified then all services are notified.')
@click.option('--dry-run', '-d', is_flag=True, @click.option('--dry-run', '-d', is_flag=True,
help='Perform a trial run but only prints the notification ' help='Perform a trial run but only prints the notification '
'services to-be triggered to the screen instead of actually ' 'services to-be triggered to stdout. Notifications are never '
'performing the action.') 'sent using this mode.')
@click.option('--verbose', '-v', count=True) @click.option('--verbose', '-v', count=True)
@click.option('--version', '-V', is_flag=True, @click.option('--version', '-V', is_flag=True,
help='Display the apprise version and exit.') help='Display the apprise version and exit.')

6
packaging/man/apprise.1
View File

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3 .\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3
. .
.TH "APPRISE" "1" "March 2019" "" "" .TH "APPRISE" "1" "September 2019" "" ""
. .
.SH "NAME" .SH "NAME"
\fBapprise\fR \- Push Notifications that work with just about every platform! \fBapprise\fR \- Push Notifications that work with just about every platform!
@ -53,6 +53,10 @@ Specify the default theme\.
Specify one or more tags to filter which services to notify\. Use multiple \fB\-\-tag\fR (\fB\-g\fR) entries to \fBOR\fR the tags together and comma separated to \fBAND\fR them\. If no tags are specified then all services are notified\. Specify one or more tags to filter which services to notify\. Use multiple \fB\-\-tag\fR (\fB\-g\fR) entries to \fBOR\fR the tags together and comma separated to \fBAND\fR them\. If no tags are specified then all services are notified\.
. .
.TP .TP
\fB\-d\fR, \fB\-\-dry\-run\fR
Perform a trial run but only prints the notification services to\-be triggered to \fBstdout\fR\. Notifications are never sent using this mode\.
.
.TP
\fB\-v\fR, \fB\-\-verbose\fR \fB\-v\fR, \fB\-\-verbose\fR
The more of these you specify, the more verbose the output is\. The more of these you specify, the more verbose the output is\.
. .

4
packaging/man/apprise.md
View File

@ -42,6 +42,10 @@ The Apprise options are as follows:
**--tag** (**-g**) entries to `OR` the tags together and comma separated **--tag** (**-g**) entries to `OR` the tags together and comma separated
to `AND` them. If no tags are specified then all services are notified. to `AND` them. If no tags are specified then all services are notified.
* `-d`, `--dry-run`:
Perform a trial run but only prints the notification services to-be
triggered to **stdout**. Notifications are never sent using this mode.
* `-v`, `--verbose`: * `-v`, `--verbose`:
The more of these you specify, the more verbose the output is. The more of these you specify, the more verbose the output is.