-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Just maintain one manpage written in mdoc
- Loading branch information
Showing
2 changed files
with
73 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,52 +1,75 @@ | ||
.TH POVER 1 | ||
.SH NAME | ||
pover \- push a notification to Pushover | ||
.SH SYNOPSIS | ||
.B pover | ||
[ | ||
.B -d | ||
] | ||
[ | ||
.B -f | ||
.I file | ||
] | ||
.SH DESCRIPTION | ||
.I Pover | ||
pushes a notification to Pushover using text read from standard input as the message body. | ||
The | ||
.B -d | ||
flag enables debugging output. | ||
The | ||
.B -f | ||
flag sets credentials to be read from | ||
.IR file . | ||
.PP | ||
Credentials must be present in a credentials file. | ||
A credentials file is a newline-delimited text file. | ||
Lines beginning with "#" are treated as comments and ignored. | ||
.Dd $Mdocdate$ | ||
.Dt pover 1 | ||
.Os | ||
.Sh NAME | ||
.Nm pover | ||
.Nd send a notification to Pushover | ||
.Sh SYNOPSIS | ||
.Nm | ||
.Op Fl d | ||
.Op Fl f Ar file | ||
.Op Fl t Ar title | ||
.Sh DESCRIPTION | ||
.Nm | ||
sends a notification to Pushover using text read from standard input as the message body. | ||
.Pp | ||
The options are: | ||
.Bl -tag -width Ds | ||
.It Fl d | ||
Write debugging output to standard error. | ||
.It Fl f Ar file | ||
Sets configuration to be read from | ||
.Ar file . | ||
.It Fl t Ar title | ||
Sets the message title to | ||
.Ar title . | ||
By default there is no title. | ||
.El | ||
.Pp | ||
Credentials must be present in a configuration file. | ||
A configuration file is a newline-delimited text file. | ||
Lines beginning with | ||
.Dq # | ||
are treated as comments and ignored. | ||
Configuration is a series of key-value pairs separated by whitespace, | ||
one per line. | ||
The recognised keys in the credentials file are: | ||
.TP | ||
.B user | ||
Pushover account User key. | ||
.TP | ||
.B token | ||
.Bl -tag -width Ds | ||
.It user | ||
Pushover account user key. | ||
.It token | ||
API token. | ||
.SH EXAMPLES | ||
An example credentials file | ||
.EX | ||
# for pushover application "shell" | ||
user abcd12345 | ||
token zxcvbnm98765 | ||
.EE | ||
.PP | ||
Send a message "Hello world", | ||
reading credentials from a non-default path | ||
.EX | ||
echo "Hello world" | pover -f /tmp/creds | ||
.EE | ||
.SH FILES | ||
.B $HOME/.config/pover | ||
.TP | ||
default credentials file | ||
.SH SOURCE | ||
.B github.com/ollytom/pover | ||
.El | ||
.Sh EXIT STATUS | ||
.Ex | ||
.Sh EXAMPLES | ||
An example configuration file: | ||
.Pp | ||
.Bd -literal -offset indent -compact | ||
# for pushover application "shell" | ||
user abcd12345 | ||
token zxcvbnm98765 | ||
.Ed | ||
.Pp | ||
Send the current date as a notification: | ||
.Pp | ||
.Dl date | pover | ||
.Pp | ||
Send a hello world notification, reading configuration from | ||
.Pa /etc/pover : | ||
.Pp | ||
.Dl echo 'hello world' | pover -f /etc/pover | ||
.Sh FILES | ||
The default configuration file location is as returned from Go's os.UserConfigDir(). | ||
.Bl -tag -width Ds | ||
.It Pa $HOME/.config/pover | ||
On Unix. | ||
.It Pa $HOME/Library/Application\ Support/pover | ||
On Darwin. | ||
.It Pa %AppData%\\\pover | ||
On Windows. | ||
.It Pa $home/lib/pover | ||
On Plan 9. | ||
.El | ||
.Sh SEE ALSO | ||
.Lk "Pushover Message API documentation" https://pushover.net/api |
This file was deleted.
Oops, something went wrong.