summary refs log tree commit diff
path: root/extra
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2021-05-04 19:58:12 -0400
committerJune McEnroe <june@causal.agency>2021-05-04 19:58:12 -0400
commit4911085a851652e511082f6b0138c6e82c3d8198 (patch)
treeb65c695957710b97128f563cd95a2c2fa59cc976 /extra
parentClean up Makefiles, configure scripts (diff)
downloadpounce-4911085a851652e511082f6b0138c6e82c3d8198.tar.gz
pounce-4911085a851652e511082f6b0138c6e82c3d8198.zip
notify: Reword pounce-notify manual
Diffstat (limited to 'extra')
-rw-r--r--extra/notify/pounce-notify.157
1 files changed, 22 insertions, 35 deletions
diff --git a/extra/notify/pounce-notify.1 b/extra/notify/pounce-notify.1
index 205a4c0..74ee554 100644
--- a/extra/notify/pounce-notify.1
+++ b/extra/notify/pounce-notify.1
@@ -1,4 +1,4 @@
-.Dd April 30, 2021
+.Dd May  4, 2021
 .Dt POUNCE-NOTIFY 1
 .Os
 .
@@ -20,37 +20,33 @@
 .Sh DESCRIPTION
 The
 .Nm
-daemon provides
-a generic interface for notifications
-via the
+program connects to an instance of
 .Xr pounce 1
-IRC bouncer.
-For each IRC message
-that is either a private message
-or a message containing the user's nick
-.Po
-case-sensitive,
-surrounded by either whitespace or punctuation
-.Pc ,
-the
+at
+.Ar host
+and runs
 .Ar command
-is run
-with information about the message
-set in its environment.
+for each private message
+or message containing the user's nickname
+while the user is marked as away.
+The nickname is matched case-sensitively
+and must be surrounded by whitespace or punctuation.
+Information about the message
+is passed to the command
+through the environment.
 .
 .Pp
 The arguments are as follows:
 .Bl -tag -width Ds
 .It Fl c Ar cert
 Load the TLS client certificate from
-.Ar path .
-If the private key
-is in a separate file,
+.Ar cert .
+If the private key is in a separate file,
 it is loaded with
 .Fl k .
 .It Fl k Ar priv
 Load the TLS client private key from
-.Ar path .
+.Ar priv .
 .It Fl p Ar port
 Connect to
 .Ar port .
@@ -60,28 +56,19 @@ Set the username to
 .Ar user .
 The default username is
 .Dq pounce-notify .
-.It Fl v
-Log IRC protocol to standard error.
 .It Fl w Ar pass
 Log in with the server password
 .Ar pass .
-.It Ar host
-Connect to
-.Ar host .
-.It Ar command
-The command to run,
-interpreted by the shell.
 .El
 .
 .Sh ENVIRONMENT
-The
-.Ar command
-is run
-with the following variables
-set in its environment:
-.Bl -tag -width Ds
+The following variables
+are set in the environment of
+.Ar command :
+.Bl -tag -width "NOTIFY_MESSAGE" -compact
 .It Ev NOTIFY_CHANNEL
-The channel in which the message was sent.
+The name of the channel
+in which the message was sent.
 Unset if the message was private.
 .It Ev NOTIFY_HOST
 The hostname of the user who sent the message.
class='logmsg'> 2022-08-14Remove tweets text fileJune McEnroe Such link rot. 2022-08-09Fix all copyright noticesJune McEnroe 2022-08-04Add Conversations With FriendsJune McEnroe The better of the two, but largely the same. I feel like these books are a bit too autobiographical, but I don't know if I'm allowed to accuse an author of that. My real problem is that I read these books as largely uncritical of their characters. They behave in nonsense ways, are mostly uncritical of their own behaviour, and don't really have arcs of growth or change. I suppose this book had a bit of one, but only in the last two chapters. 2022-07-30Add Normal PeopleJune McEnroe Unbearably straight. Eyerolls and sighs per page off the charts. Shout out to Joanna, I guess. I kinda like the lack of quotation marks though to be honest. After half of the Ruth Ozeki novel and now this, I need to get back to some genre fiction. 2022-07-26Rewrite glitch from new pngoJune McEnroe 2022-07-26Update Care with time-to-ID and piercingsJune McEnroe 2022-07-26Add -w to upJune McEnroe 2022-07-13Set push.autoSetupRemoteJune McEnroe 2022-07-08Remove TOURJune McEnroe There is not that much distinct stuff here anymore. 2022-07-03Add The Bone Shard EmperorJune McEnroe Suffers a little bit from middle book but I really enjoyed it. Read it faster than the first one too, despite its length. 2022-06-25Bump xterm font size to 12June McEnroe 2022-06-10Handle subshells (and functions) inside substitutionsJune McEnroe 2022-06-10Switch to jorts Install scriptJune McEnroe 2022-06-08Indicate if still reading or no resultsJune McEnroe 2022-06-08Add Maiden, Mother, CroneJune McEnroe Mixed bag like most collections of short stories. Some of them are pretty good. The author of the worst written story also has the worst written bio. 2022-06-05FIRST SHOW IN 2.5 YEARS BABEY!!!June McEnroe 2022-06-03Set line number on File linesJune McEnroe 2022-06-03Stop polling stdin after EOFJune McEnroe 2022-06-02Set TABSIZE=4June McEnroe Absolutely indiscriminately. 2022-06-02Do basic match highlightingJune McEnroe 2022-06-02Clean up parsing a littleJune McEnroe 2022-06-02Don't duplicate path stringJune McEnroe 2022-06-02Use stderr instead of /dev/tty, realloc buffer if lines too longJune McEnroe For some reason I haven't been able to figure out, trying to poll /dev/tty returns POLLNVAL (and this was using 100% CPU looping), but using stderr instead works fine. 2022-06-02Add initial working version of qfJune McEnroe 2022-05-29Set prompt for okshJune McEnroe