Skip to content

Commit

Permalink
Update man
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaime Piña committed Sep 6, 2020
1 parent 5fe3cc1 commit 24b8f01
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions docs/man/noti.yaml.5
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 2.7.3
.\" Automatically generated by Pandoc 2.10.1
.\"
.TH "NOTI.YAML" "5" "2018/03/25" "noti 3.4.0" "Noti Configuration File Format"
.hy
Expand All @@ -23,101 +23,101 @@ If $XDG_CONFIG_HOME is empty, then $HOME/.config will be used as its
default value and noti will check $HOME/.config/noti/noti.yaml.
.SH NSUSER
.TP
.B soundName
soundName
Banner success sound.
Default is Ping.
Possible options are Basso, Blow, Bottle, Frog, Funk, Glass, Hero,
Morse, Ping, Pop, Purr, Sosumi, Submarine, Tink.
See /System/Library/Sounds for available sounds.
.TP
.B soundNameFail
soundNameFail
Banner failure sound.
Default is Basso.
Possible options are Basso, Blow, Bottle, Frog, Funk, Glass, Hero,
Morse, Ping, Pop, Purr, Sosumi, Submarine, Tink.
See /System/Library/Sounds for available sounds.
.SH SAY
.TP
.B voice
voice
Name of voice used for speech notifications.
.SH ESPEAK
.TP
.B voiceName
voiceName
Name of voice used for speech notifications.
.SH SPEECHSYNTHESIZER
.TP
.B voice
voice
Name of voice used for speech notifications.
.SH BEARYCHAT
.TP
.B incomingHookURI
incomingHookURI
BearyChat incoming URI.
.SH KEYBASE
.TP
.B conversation
conversation
Keybase message destination.
Can be either users (comma-separated) or team.
.TP
.B channel
channel
Keybase team\[cq]s chat channel to send to.
Conversation must be a team.
If empty, the team\[cq]s default channel will be used (typically
\[lq]general\[rq]).
.TP
.B explodingLifetime
explodingLifetime
Keybase self-destructing message, after the specified time.
Times are written like \f[C]30s\f[R] (30 seconds), \f[C]15m\f[R] (15
minutes), \f[C]24h\f[R] (24 hours).
.TP
.B public
public
Enables broadcasting a message to everyone (when \f[C]conversation\f[R]
is your username), or to teams (when \f[C]conversation\f[R] is your team
name).
.SH PUSHBULLET
.TP
.B accessToken
accessToken
Pushbullet access token.
Log into your Pushbullet account and retrieve a token from the Account
Settings page.
.TP
.B deviceIden
deviceIden
Pushbullet device iden of the target device, if sending to a single
device.
.SH PUSHOVER
.TP
.B apiToken
apiToken
Pushover access token.
Log into your Pushover account and create a token from the Create New
Application/Plugin page.
.TP
.B userKey
userKey
Pushover message destination.
Should be your User Key.
.SH PUSHSAFER
.TP
.B key
key
Pushsafer private or alias key.
Log into your Pushsafer account and note your private or alias key.
.SH SIMPLEPUSH
.TP
.B key
key
Simplepush key.
Install the Simplepush app and retrieve your key there.
.TP
.B event
event
Customize ringtone and vibration.
.SH SLACK
.TP
.B token
token
Slack access token.
Log into your Slack account and retrieve a token from the Slack Web API
page.
.TP
.B channel
channel
Slack message destination.
Can be either a #channel or a \[at]username.
.TP
.B username
username
Noti bot username.
.SH EXAMPLES
.IP
Expand Down

0 comments on commit 24b8f01

Please sign in to comment.