From 3b49e8be6f02037f70df557b71be11c6a6d069eb Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Mon, 30 Sep 2019 21:44:40 -0400 Subject: [PATCH] updated man page and docs for --dry-run switch --- apprise/cli.py | 4 ++-- packaging/man/apprise.1 | 6 +++++- packaging/man/apprise.md | 4 ++++ 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/apprise/cli.py b/apprise/cli.py index 962ebcc0..e898efc1 100644 --- a/apprise/cli.py +++ b/apprise/cli.py @@ -113,8 +113,8 @@ def print_version_msg(): 'If no tags are specified then all services are notified.') @click.option('--dry-run', '-d', is_flag=True, help='Perform a trial run but only prints the notification ' - 'services to-be triggered to the screen instead of actually ' - 'performing the action.') + 'services to-be triggered to stdout. Notifications are never ' + 'sent using this mode.') @click.option('--verbose', '-v', count=True) @click.option('--version', '-V', is_flag=True, help='Display the apprise version and exit.') diff --git a/packaging/man/apprise.1 b/packaging/man/apprise.1 index 969579f7..c70cee45 100644 --- a/packaging/man/apprise.1 +++ b/packaging/man/apprise.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "APPRISE" "1" "March 2019" "" "" +.TH "APPRISE" "1" "September 2019" "" "" . .SH "NAME" \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\. . .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 The more of these you specify, the more verbose the output is\. . diff --git a/packaging/man/apprise.md b/packaging/man/apprise.md index 08af086f..a0245ab3 100644 --- a/packaging/man/apprise.md +++ b/packaging/man/apprise.md @@ -42,6 +42,10 @@ The Apprise options are as follows: **--tag** (**-g**) entries to `OR` the tags together and comma separated 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`: The more of these you specify, the more verbose the output is.