helpinfos: Missing cross-reference.

[ircbot] / helpinfos

diff --git a/helpinfos b/helpinfos
index f4181809a4a26b0a08d03493a12322472c58a1fe..4f1030887543c25f0a4f1229f90eb6685a05fc48 100644 (file)
--- a/helpinfos
+++ b/helpinfos
@@ -1,14 +1,14 @@
 ::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
 General commands:           Registration and user settings:
  !help [<cmd>|<opt>|<topic>]  !register [insecure|delete]
- !seen <nick>                 !set [<opt> [<value>]]      who [<nick>]
+ !seen <nick>                 !set [<opt> [<value>]]      !who [<nick>]
  !summon <username>           (See `help !identify', `help !blight-id')
  !invite [<chan>] <nick>...  For channel managers (`help !channel'):
  !ping [<stuff ...>]          !op [<chan>]
@@ -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>]
@@ -188,8 +202,9 @@ By default this checks the md5sum against ~/.userv/irc-pass-md5.
 invite <nick> ...             on channel
 invite <channel> <nick> ...   privately
  This command gets me to invite the specified people to the channel.
+ This is useful because only IRC channel operators can use /invite.
  This can be disabled for managed channels - see `help !userinvite'.
-To get me to join a channel, just invite me to it.
+To get me to join a channel, a channel operator should /invite me.
 
 :kill
 kill <nick> [<reason>]