Projects/pushover-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fixup markdown.

Browse source
This commit is contained in:
Darren 'Tadgy' Austin 2023-11-02 14:49:03 +00:00
commit 988bd831b3
1 changed files with 62 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

124
README.md
View file

@ -39,7 +39,7 @@ If the `<config file>` is an absolute path, only that file is used as the basis
An unqualified or non-absolute `<config file>` is searched for in the following locations (in order): An unqualified or non-absolute `<config file>` is searched for in the following locations (in order):
1. Relative to the current directory. 1. Relative to the current directory.
2. Relative to the user's personal configuration directory at: `~/.pushover-client`. 2. Relative to the user's personal configuration directory at: `~/.pushover-client`.
3. Relative to the system wise configuration directory at: `/etc/pushover-client`. 3. Relative to the system wide configuration directory at: `/etc/pushover-client`.
If no `<config file>` is given on the command line, a `default` config file is searched for in and read from the following locations in order, even if all If no `<config file>` is given on the command line, a `default` config file is searched for in and read from the following locations in order, even if all
options are given on the command line: options are given on the command line:
@ -53,121 +53,121 @@ required on the command line.
Configuration options Configuration options
--------------------- ---------------------
`-a`, `--attachment <filename>` `-a`|`--attachment` `<filename>`
Config file: `ATTACHMENT=""`. Config file: `ATTACHMENT=""`.
* The picture to send with the alert. By default, no picture is sent. * The picture to send with the alert. By default, no picture is sent.
`-A`, `--api-url <url>` `-A`|`--api-url` `<url>`
Config file: `API_URL=""`. Config file: `API_URL=""`.
* The API URL to use for this submission. The Default is coded into the `pushover-client` script and should not need to be changed. * The API URL to use for this submission. The Default is coded into the `pushover-client` script and should not need to be changed.
Quote `<url>` if it contains shell special chars. Quote `<url>` if it contains shell special chars.
`-c`, `--callback <url>` `-c`|`--callback` `<url>`
Config file: `CALLBACK_URL=""`. Config file: `CALLBACK_URL=""`.
* A URL which is accessed by API server when the user acknowledges the alert. This option is only used in priority 2 alerts. * A URL which is accessed by API server when the user acknowledges the alert. This option is only used in priority 2 alerts.
Quote `<url>` if it contains shell special chars. Quote `<url>` if it contains shell special chars.
`-d`, `--devices <devices>` `-d`|`--devices` `<devices>`
Config file: `DEVICES=""`. Config file: `DEVICES=""`.
* A comma seperated list of the devices to receive the alert. The default is to send to all devices. * A comma seperated list of the devices to receive the alert. The default is to send to all devices.
`-e`, `--expiry <seconds>` `-e`|`--expiry` `<seconds>`
Config file: `EXPIRY=""`, Config file: `EXPIRY=""`,
* Set the expiration time for alerts sent with priority 2. The default is 3600 (1 hour). The maximum expiry time is 10800 (3 hours). * Set the expiration time for alerts sent with priority 2. The default is 3600 (1 hour). The maximum expiry time is 10800 (3 hours).
`-m`, `--message <text>` `-m`|`--message` `<text>`
Config file: `MESSAGE=""`. Config file: `MESSAGE=""`.
* The plain text message to send as the alert. * The plain text message to send as the alert.
Quote `<text>` if it contains spaces. Quote `<text>` if it contains spaces.
This option or `-M` (config file: `HTML_MESSAGE=""`) is required. This option or `-M` (config file: `HTML_MESSAGE=""`) is required.
`-M`, `--html-message <text>` `-M`|`--html-message` `<text>`
Config file: `HTML_MESSAGE=""`. Config file: `HTML_MESSAGE=""`.
* The HTML message to send as the alert. Only basic text formatting is supported. * The HTML message to send as the alert. Only basic text formatting is supported.
Quote `<text>` if it contains spaces. Quote `<text>` if it contains spaces.
This option or `-m` (config file: `MESSAGE=""`) is required. This option or `-m` (config file: `MESSAGE=""`) is required.
`--monospace` `--monospace`
Config file: `MONOSPACE=""`. Config file: `MONOSPACE=""`.
* Use a monospace font to display the message given with -m. The default is to use regular (variable width) font. * Use a monospace font to display the message given with -m. The default is to use regular (variable width) font.
This option cannot be used with `-M`. This option cannot be used with `-M`.
`-p`, `--priority <priority>` `-p`|`--priority` `<priority>`
Config file: `PRIORITY=""`. Config file: `PRIORITY=""`.
* Set the priority of the message: * Set the priority of the message:
`-2` * Lowest priority - no alert/notification will be generated on the device. However, the app badge or number will update on devices. `-2` Lowest priority - no alert/notification will be generated on the device. However, the app badge or number will update on devices.
`-1` * Low priority - no alert sound is emitted but a notification will appear. `-1` Low priority - no alert sound is emitted but a notification will appear.
During a user's configured quiet hours, priority -1 is used for messages. During a user's configured quiet hours, priority -1 is used for messages.
`0` * Normal priority (the default) - an alert sound and notification are generated. `0` Normal priority (the default) - an alert sound and notification are generated.
`1` * High priority - bypass the user's configured quiet hours and generate an audible alert and notification. `1` High priority - bypass the user's configured quiet hours and generate an audible alert and notification.
`2` * Emergency - as per priority 1, but the alert and notification is repeated (subject to the `-r` (config file: `RETRY=""`) and `-e` (config file: `2` Emergency - as per priority 1, but the alert and notification is repeated (subject to the `-r` (config file: `RETRY=""`) and `-e` (config file:
`EXPIRY=""`) options) until it is acknowledged by the recipient. `EXPIRY=""`) options) until it is acknowledged by the recipient.
`-q`, `--quiet` `-q`|`--quiet`
Config file: `QUIET=""`. Config file: `QUIET=""`.
* Do not print the API execution reply to stdout. * Do not print the API execution reply to stdout.
`-r`, `--retry <seconds>` `-r`|`--retry` `<seconds>`
Config file: `RETRY=""`. Config file: `RETRY=""`.
* Set the retry interval for alerts sent with priority 2. The default is 60 (1 minute). The minimum retry time is 30 seconds. * Set the retry interval for alerts sent with priority 2. The default is 60 (1 minute). The minimum retry time is 30 seconds.
`-s`, `--subject <text>` `-s`|`--subject` `<text>`
Config file: `SUBJECT=""`. Config file: `SUBJECT=""`.
* The subject/title of the message. If unset, the configured app name is used. * The subject/title of the message. If unset, the configured app name is used.
Quote `<text>` if it contains spaces. Quote `<text>` if it contains spaces.
`-S`, `--sound <sound>` `-S`|`--sound` `<sound>`
Config file: `SOUND=""`. Config file: `SOUND=""`.
* Set the alert sound to play with message: * Set the alert sound to play with message:
`none ` * None/silent. `none ` None/silent.
`vibrate` * Vibrate only. `vibrate` Vibrate only.
`pushover` * Pushover (short tone, the default). `pushover` Pushover (short tone, the default).
`bike` * Bike (short tone). `bike` Bike (short tone).
`bugle` * Bugle (short tone). `bugle` Bugle (short tone).
`cashregister` * Cash Register (short tone). `cashregister` Cash Register (short tone).
`classical` * Classical (short tone). `classical` Classical (short tone).
`cosmic` * Cosmic (short tone). `cosmic` Cosmic (short tone).
`falling` * Falling (short tone). `falling` Falling (short tone).
`gamelan` * Gamelan (short tone). `gamelan` Gamelan (short tone).
`incoming` * Incoming (short tone). `incoming` Incoming (short tone).
`intermission` * Intermission (short tone). `intermission` Intermission (short tone).
`magic` * Magic (short tone). `magic` Magic (short tone).
`mechanical` * Mechanical (short tone). `mechanical` Mechanical (short tone).
`pianobar` * Piano Bar (short tone). `pianobar` Piano Bar (short tone).
`siren` * Siren (short tone). `siren` Siren (short tone).
`spacealarm` * Space Alarm (short tone). `spacealarm` Space Alarm (short tone).
`tugboat` * Tug Boat (short tone). `tugboat` Tug Boat (short tone).
`alien` * Alien Alarm (long tone). `alien` Alien Alarm (long tone).
`climb` * Climb (long tone). `climb` Climb (long tone).
`persistent` * Persistent (long tone). `persistent` Persistent (long tone).
`echo` * Pushover Echo (long tone). `echo` Pushover Echo (long tone).
`updown` * Up Down (long tone). `updown` Up Down (long tone).
Or a sound uploaded to the user's account. Or a sound uploaded to the user's account.
`-t`, `--token <token>` `-t`|`--token` `<token>`
Config file: `TOKEN=""`. Config file: `TOKEN=""`.
* The pushover.net API token/key for the specific application. This option is required. * The pushover.net API token/key for the specific application. This option is required.
`-T`, `--ttl <seconds>` `-T`|`--ttl` `<seconds>`
Config file: `TTL=""`. Config file: `TTL=""`.
* The number of seconds the alert will live (or be displayed) on a users device before being automatically removed. The default is no ttl. * The number of seconds the alert will live (or be displayed) on a users device before being automatically removed. The default is no ttl.
This option is ignored when alerts are sent with priority (-p) 2. This option is ignored when alerts are sent with priority (-p) 2.
`--timestamp <seconds>` `--timestamp` `<seconds>`
Config file: `TIMESTAMP=""`. Config file: `TIMESTAMP=""`.
* The number of seconds since the unix epoch to use as the timestamp for the alert. The default timestamp is the time the API received the message. * The number of seconds since the unix epoch to use as the timestamp for the alert. The default timestamp is the time the API received the message.
`-u`, `--user <user_key>` `-u`|`--user` `<user_key>`
Config file: `USER_KEYS=""`. Config file: `USER_KEYS=""`.
* The pushover.net user key(s). If a single user key is specified, that account's configuration will be used for the alerts. If a comma separated list * The pushover.net user key(s). If a single user key is specified, that account's configuration will be used for the alerts. If a comma separated list
(maximum 50) of user keys is given, the alert is sent only to those users. This option is required. (maximum 50) of user keys is given, the alert is sent only to those users. This option is required.
`-U`, `--url <url>` `-U`|`--url` `<url>`
Config file: `URL=""`. Config file: `URL=""`.
* Set the URL to send with the alert. * Set the URL to send with the alert.
Quote `<url>` if it contains shell special chars. Quote `<url>` if it contains shell special chars.
`--url-title <text>` `--url-title` `<text>`
Config file: `URL_TITLE=""`. Config file: `URL_TITLE=""`.
* The title of the URL given with -U. Ignored if -U is not used also. * The title of the URL given with -U. Ignored if -U is not used also.
Quote `<text>` if it contains spaces. Quote `<text>` if it contains spaces.
@ -193,34 +193,34 @@ In the following examples, `<user key>` is the pushover.net user key(s), `<API t
file name. file name.
Command line examples: Command line examples:
* Send a plain text message to all devices, showing all required [options]. * Send a plain text message to all devices, showing all required [options].
`pushover-client -u <user key> -t <API token> -m "Test message"` `pushover-client -u <user key> -t <API token> -m "Test message"`
* Same as the above, but do not show any response from the API server (an appropriate error/return code is set). * Same as the above, but do not show any response from the API server (an appropriate error/return code is set).
`pushover-client -q -u <user key> -t <API token> -m "Test message"` `pushover-client -q -u <user key> -t <API token> -m "Test message"`
* Send a HTML message (which will be underlined) to all devices, showing all required [options]. * Send a HTML message (which will be underlined) to all devices, showing all required [options].
`pushover-client -u <user key> -t <API token> -M "<u>Test message</u>"` `pushover-client -u <user key> -t <API token> -M "<u>Test message</u>"`
* Send a plain text message to all devices, with the addition of a subject/title to the message. * Send a plain text message to all devices, with the addition of a subject/title to the message.
`pushover-client -u <user key> -t <API token> -s "Test subject" -m "..."` `pushover-client -u <user key> -t <API token> -s "Test subject" -m "..."`
* Send a message to all devices, including a picture attachment. * Send a message to all devices, including a picture attachment.
`pushover-client -u <user key> -t <API token> -a </path/to/image> -m "..."` `pushover-client -u <user key> -t <API token> -a </path/to/image> -m "..."`
* Send a message to all devices, including a supplimentary URL with a title. * Send a message to all devices, including a supplimentary URL with a title.
`pushover-client -u <user key> -t <API token> -U "https://afterdark.org.uk" --url-title "Afterdark" -m "Check out the included URL!"` `pushover-client -u <user key> -t <API token> -U "https://afterdark.org.uk" --url-title "Afterdark" -m "Check out the included URL!"`
* Send a message to all devices, selecting an alternative sound alert. * Send a message to all devices, selecting an alternative sound alert.
`pushover-client -u <user key> -t <API token> -s "magic" -m "..."` `pushover-client -u <user key> -t <API token> -s "magic" -m "..."`
* Send a message to a specific list of devices. * Send a message to a specific list of devices.
`pushover-client -u <user key> -t <API token> -d "iphone,ipad" -m "..."` `pushover-client -u <user key> -t <API token> -d "iphone,ipad" -m "..."`
* Send an emergency alert, repeated every minute for an 2 hours until it is acknowledged by the user. * Send an emergency alert, repeated every minute for an 2 hours until it is acknowledged by the user.
`pushover-client -u <user key> -t <API token> -p 2 -r 60 -e 7200 -m "..."` `pushover-client -u <user key> -t <API token> -p 2 -r 60 -e 7200 -m "..."`
Read all configuration from the given <config file> path and use that for sending the alert. Read all configuration from the given <config file> path and use that for sending the alert.
If this path does not exist, search for a file matching the <config file> name in the user's private pushover directory (~/.pushover) or the system wide If this path does not exist, search for a file matching the <config file> name in the user's private pushover directory (~/.pushover) or the system wide
pushover directory (/etc/pushover), in that order. pushover directory (/etc/pushover), in that order.
`pushover-client <config file>` `pushover-client <config file>`