From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Mon, 8 Nov 2004 11:45:43 +0000 (+0000)
Subject: better docs for !summon
X-Git-Url: https://git.distorted.org.uk/~mdw/ircbot/commitdiff_plain/b2b22b5c1857ff5a51fc171f26c5ee645d151d24?ds=sidebyside

better docs for !summon
---

diff --git a/helpinfos b/helpinfos
index 857c1d8..4ba336b 100644
--- a/helpinfos
+++ b/helpinfos
@@ -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, similar to a talk
+ request, will written to their terminal; if the user is not logged
+ on to the system 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 time_t).
 
 :who
 who [<nick>]