\fB\-n\fR, \fB\-\-notification\-type=\fR\fITYPE\fR: Specify the message type (default=info)\. Possible values are "info", "success", "failure", and "warning"\.
Specify the message type (default=info)\. Possible values are "info", "success", "failure", and "warning"\.
.
.
.TP
.P
\fB\-i\fR, \fB\-\-input\-format=\fR\fIFORMAT\fR
\fB\-i\fR, \fB\-\-input\-format=\fR\fIFORMAT\fR: Specify the input message format (default=text)\. Possible values are "text", "html", and "markdown"\.
Specify the input message format (default=text)\. Possible values are "text", "html", and "markdown"\.
.
.
.TP
.P
\fB\-T\fR, \fB\-\-theme=\fRTHEME
\fB\-T\fR, \fB\-\-theme=\fRTHEME: Specify the default theme\.
Specify the default theme\.
.
.
.TP
.P
\fB\-g\fR, \fB\-\-tag=\fRTAG
\fB\-g\fR, \fB\-\-tag=\fRTAG: 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
.P
\fB\-d\fR, \fB\-\-dry\-run\fR
\fB\-Da\fR, \fB\-\-disable\-async\fR: Send notifications synchronously (one after the other) instead of all at once\.
Perform a trial run but only prints the notification services to\-be triggered to \fBstdout\fR\. Notifications are never sent using this mode\.
.
.
.TP
.P
\fB\-v\fR, \fB\-\-verbose\fR
\fB\-R\fR, \fB\-\-recursion\-depth\fR: he number of recursive import entries that can be loaded from within Apprise configuration\. By default this is set to 1\. If this is set to zero, then import statements found in any configuration is ignored\.
The more of these you specify, the more verbose the output is\.
.
.
.TP
.P
\fB\-Da\fR, \fB\-\-disable\-async\fR
\fB\-e\fR, \fB\-\-interpret\-escapes\fR Enable interpretation of backslash escapes\. For example, this would convert sequences such as \en and \er to their respected ascii new\-line and carriage
Send notifications synchronously (one after the other) instead of all at once\.
.
.
.TP
.P
\fB\-R\fR, \fB\-\-recursion\-depth\fR
\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\.
he number of recursive import entries that can be loaded from within Apprise configuration\. By default this is set to 1\. If this is set to zero, then import statements found in any configuration is ignored\.
.
.
.TP
.P
\fB\-D\fR, \fB\-\-debug\fR
return characters prior to the delivery of the notification\.
A debug mode; useful for troubleshooting\.
.
.
.TP
.P
\fB\-V\fR, \fB\-\-version\fR
\fB\-v\fR, \fB\-\-verbose\fR: The more of these you specify, the more verbose the output is\. e\.g: \-vvvv
Display the apprise version and exit\.
.
.
.TP
.P
\fB\-\-help\fR
\fB\-D\fR, \fB\-\-debug\fR: A debug mode; useful for troubleshooting\.
Show this message and exit\.
.
.
.SH"EXIT STATUS"
.P
\fBapprise\fR exits with a status 0 if all notifications were sent successfully otherwise \fBapprise\fR returns a value of 1\.\fBapprise\fR returns a value of 2 if there was an error specified on the command line (such as not providing an valid argument)\.
\fB\-V\fR, \fB\-\-version\fR: Display the apprise version and exit\.
.
.
.P
.P
\fBapprise\fR exits with a status of 3 if there were no notifcations sent due (as a result of end user actions)\. This occurs in the case where you have assigned one or more tags to all of the Apprise URLs being notified and did not match any when actually executing the \fBapprise\fR tool\. This can also occur if you specified a tag that has not been assigned to anything defined in your configuration\.
\fB\-h\fR, \fB\-\-help\fR: Show this message and exit\.
.
.SH"EXIT STATUS"
\fBapprise\fR exits with a status of:
.
.IP"\(bu"4
\fB0\fR if all of the notifications were sent successfully\.
.
.IP"\(bu"4
\fB1\fR if one or more notifications could not be sent\.
.
.IP"\(bu"4
\fB2\fR if there was an error specified on the command line such as not providing an valid argument\.
.
.IP"\(bu"4
\fB3\fR if there was one or more Apprise Service URLs successfully loaded but none could be notified due to user filtering (via tags)\.
.
.IP""0
.
.
.SH"SERVICE URLS"
.SH"SERVICE URLS"
There are to many service URL and combinations to list here\. It\'s best to visit the Apprise GitHub page \fIhttps://github\.com/caronc/apprise/wiki#notification\-services\fR and see what\'s available\.
There are to many service URL and combinations to list here\. It\'s best to visit the Apprise GitHub page \fIhttps://github\.com/caronc/apprise/wiki#notification\-services\fR and see what\'s available\.
@ -104,9 +106,9 @@ Send a notification to as many servers as you want to specify as you can easily
$ apprise \-vv \-t "School Assignment" \-b "See attached"\e
\-\-attach=Documents/FinalReport\.docx
\-\-attach=Documents/FinalReport\.docx
.
.
.fi
.fi
.
.
.IP""0
.IP""0
.
.
.SH"CONFIGURATION"
A configuration file can be in the format of either \fBTEXT\fR or \fBYAML\fR where [TEXT][textconfig] is the easiest and most ideal solution for most users\. However YAML \fIhttps://github\.com/caronc/apprise/wiki/config_yaml\fR configuration files grants the user a bit more leverage and access to some of the internal features of Apprise\. Reguardless of which format you choose, both provide the users the ability to leverage \fBtagging\fR which adds a more rich and powerful notification environment\.
.
.P
Configuration files can be directly referenced via \fBapprise\fR when referencing the \fB\-\-config=\fR (\fB\-c\fR) CLI directive\. You can identify as many as you like on the command line and all of them will be loaded\. You can also point your configuration to a cloud location (by referencing \fBhttp://\fR or \fBhttps://\fR\. By default \fBapprise\fR looks in the following local locations for configuration files and loads them:
.
.IP""4
.
.nf
$ ~/\.apprise
$ ~/\.apprise\.yml
$ ~/\.config/apprise
$ ~/\.config/apprise\.yml
.
.fi
.
.IP""0
.
.P
If a default configuration file is referenced in any way by the \fBapprise\fR tool, you no longer need to provide it a Service URL\. Usage of the \fBapprise\fR tool simplifies to:
.
.IP""4
.
.nf
$ apprise \-vv \-t "my title" \-b "my notification body"
.
.fi
.
.IP""0
.
.P
If you leveraged tagging \fIhttps://github\.com/caronc/apprise/wiki/CLI_Usage#label\-leverage\-tagging\fR, you can define all of Apprise Service URLs in your configuration that you want and only specifically notify a subset of them:
.
.IP""4
.
.nf
$ apprise \-vv \-t "Will Be Late" \-b "Go ahead and make dinner without me" \e
\-\-tag=family
.
.fi
.
.IP""0
.
.SH"BUGS"
.SH"BUGS"
If you find any bugs, please make them known at: \fIhttps://github\.com/caronc/apprise/issues\fR
If you find any bugs, please make them known at: \fIhttps://github\.com/caronc/apprise/issues\fR
.
.
.SH"COPYRIGHT"
.SH"COPYRIGHT"
Apprise is Copyright (C) 2020 Chris Caron \fIlead2gold@gmail\.com\fR
Apprise is Copyright (C) 2021 Chris Caron \fIlead2gold@gmail\.com\fR
@ -20,68 +20,76 @@ Telegram, Pushbullet, Slack, Twitter, etc.
The Apprise options are as follows:
The Apprise options are as follows:
* `-b`, `--body=`<TEXT>:
`-b`, `--body=`<TEXT>:
Specify the message body. If no body is specified then content is read from
Specify the message body. If no body is specified then content is read from
<stdin>.
<stdin>.
* `-t`, `--title=`<TEXT>:
`-t`, `--title=`<TEXT>:
Specify the message title. This field is complete optional.
Specify the message title. This field is complete optional.
* `-c`, `--config=`<CONFIG-URL>:
`-c`, `--config=`<CONFIG-URL>:
Specify one or more configuration locations.
Specify one or more configuration locations.
* `-a`, `--attach=`<ATTACH-URL>:
`-a`, `--attach=`<ATTACH-URL>:
Specify one or more file attachment locations.
Specify one or more file attachment locations.
* `-n`, `--notification-type=`<TYPE>:
`-n`, `--notification-type=`<TYPE>:
Specify the message type (default=info). Possible values are "info",
Specify the message type (default=info). Possible values are "info",
"success", "failure", and "warning".
"success", "failure", and "warning".
* `-i`, `--input-format=`<FORMAT>:
`-i`, `--input-format=`<FORMAT>:
Specify the input message format (default=text). Possible values are "text",
Specify the input message format (default=text). Possible values are "text",
"html", and "markdown".
"html", and "markdown".
* `-T`, `--theme=`THEME:
`-T`, `--theme=`THEME:
Specify the default theme.
Specify the default theme.
* `-g`, `--tag=`TAG:
`-g`, `--tag=`TAG:
Specify one or more tags to filter which services to notify. Use multiple
Specify one or more tags to filter which services to notify. Use multiple
**--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`:
`-Da`, `--disable-async`:
Perform a trial run but only prints the notification services to-be
Send notifications synchronously (one after the other) instead of
triggered to **stdout**. Notifications are never sent using this mode.
all at once.
* `-v`, `--verbose`:
`-R`, `--recursion-depth`:
The more of these you specify, the more verbose the output is.
he number of recursive import entries that can be loaded from within
Apprise configuration. By default this is set to 1. If this is set to
zero, then import statements found in any configuration is ignored.
* `-Da`, `--disable-async`:
`-e`, `--interpret-escapes`
Send notifications synchronously (one after the other) instead of
Enable interpretation of backslash escapes. For example, this would convert
all at once.
sequences such as \n and \r to their respected ascii new-line and carriage
* `-R`, `--recursion-depth`:
`-d`, `--dry-run`:
he number of recursive import entries that can be loaded from within
Perform a trial run but only prints the notification services to-be
Apprise configuration. By default this is set to 1. If this is set to
triggered to **stdout**. Notifications are never sent using this mode.
zero, then import statements found in any configuration is ignored.
* `-D`, `--debug`:
return characters prior to the delivery of the notification.
A debug mode; useful for troubleshooting.
* `-V`, `--version`:
`-v`, `--verbose`:
Display the apprise version and exit.
The more of these you specify, the more verbose the output is. e.g: -vvvv
* `--help`:
`-D`, `--debug`:
Show this message and exit.
A debug mode; useful for troubleshooting.
## EXIT STATUS
`-V`, `--version`:
Display the apprise version and exit.
`-h`, `--help`:
Show this message and exit.
**apprise** exits with a status 0 if all notifications were sent successfully otherwise **apprise** returns a value of 1. **apprise** returns a value of 2 if
## EXIT STATUS
there was an error specified on the command line (such as not providing an valid
argument).
**apprise** exits with a status of 3 if there were no notifcations sent due (as a result of end user actions). This occurs in the case where you have assigned one or more tags to all of the Apprise URLs being notified and did not match any when actually executing the **apprise** tool. This can also occur if you specified a tag that has not been assigned to anything defined in your configuration.
**apprise** exits with a status of:
* **0** if all of the notifications were sent successfully.
* **1** if one or more notifications could not be sent.
* **2** if there was an error specified on the command line such as not
providing an valid argument.
* **3** if there was one or more Apprise Service URLs successfully
loaded but none could be notified due to user filtering (via tags).
## SERVICE URLS
## SERVICE URLS
@ -95,34 +103,70 @@ visit the [Apprise GitHub page][serviceurls] and see what's available.
Send a notification to as many servers as you want to specify as you can
Send a notification to as many servers as you want to specify as you can
Chris Caron
4 years ago