helpinfos: Customize for local installation.

[ircbot] / helpinfos

diff --git a/helpinfos b/helpinfos
index 857c1d8ddd43df3f2f97d04ff89249797a1c9d38..8b7fa6dc30ee828e8524b97017236905152d80da 100644 (file)
--- a/helpinfos
+++ b/helpinfos
@@ -1,8 +1,8 @@
 ::wwwtitle     Blight (chiark IRC bot) help
-::wwwaddress   chiark IRC operators <ircop@chiark>
+::wwwaddress   distorted.org.uk IRC operators <irc@distorted.org.uk>
 
 :
-See http://www.chiark.greenend.org.uk/ucgi/~ijackson/blight-help
+See http://irc.distorted.org.uk/ucgi/~ircbot/help
 or /msg me with `help !overview'.
 
 :overview
@@ -68,9 +68,23 @@ seen <nick>
 
 :summon
 summon <username>
- Invites a logged-on user onto IRC.  If the user is not logged on
- you'll be told.  Target users can change this (eg, to disable it)
- by reconfiguring the userv service `irc-summon'.  See ~ian/.userv.
+ Invites a user onto IRC.  By default a message (like a talk request)
+ will be written to their terminal; if they're not logged on to the
+ machine running Blight, or are `mesg n', you'll be told.  A user can
+ change the way they are summoned (eg, to disable it) by reconfiguring
+ the userv service `irc-summon'.  See `help !irc-summon'.
+
+:irc-summon
+userv <user> irc-summon <callingnick> <callingpath> <channel>
+ This userv invocation is invoked by Blight when `!summon' is used.
+ For examples of how to (re)configure it, see
+  ~ian/.userv/services.d/irc-summon
+  /etc/userv/services.d/irc-summon
+ The service should immediately print one of these, and exit:
+  problem <description>   =>  The user `<user>' <description>.
+  ok <tty> <lastactivity> =>..invites <user> (<tty>, idle for ..)..
+ and Blight will respond as shown.  <tty> need not be an actual
+ terminal name; <lastactivity> must be a decimal absolute time_t).
 
 :who
 who [<nick>]