Say "you"

[ircbot.git] / helpinfos

diff --git a/helpinfos b/helpinfos
index d19544cfbeb25648053ee07010ffa7bf4849c7be..f4181809a4a26b0a08d03493a12322472c58a1fe 100644 (file)
--- a/helpinfos
+++ b/helpinfos
@@ -10,10 +10,12 @@ General commands:           Registration and user settings:
  !help [<cmd>|<opt>|<topic>]  !register [insecure|delete]
  !seen <nick>                 !set [<opt> [<value>]]      who [<nick>]
  !summon <username>           (See `help !identify', `help !blight-id')
- !invite [<chan>] <nick>...  Channel settings (see `help channel'):
- !op [<chan>]                 !channel [<chan>] <setting> [....]
- !leave [<chan>]             Additional help topics:
- !ping [<stuff ...>]          !identify !identpass !invite !blight-id
+ !invite [<chan>] <nick>...  For channel managers (`help !channel'):
+ !ping [<stuff ...>]          !op [<chan>]
+ !kill <nick> [<reason>]      !leave [<chan>]
+ !tell <nick> <message ...>   !channel [<chan>] <setting> [....]
+Additional help topics:
+ !tutorial (long\!)  !identify !identpass !invite !blight-id
 Send commands to me by /msg, or say them in channel with \! in front.
 To get me on a channel, invite me.  To become channel manager, op me.
 
@@ -23,6 +25,42 @@ help <command>   gives help on a command
 help <opt>       gives help on an option
 help <topic>     gives help on an additional topic
 
+:tell
+tell <nick> <message ...>
+ Leaves a message for someone, which will be delivered according to
+ their `!set !tellme'.  I will tell you about your undelivered tells
+ whenever I see you arriving, or when you say `!ping'.  See also
+ `help !untell' and `help !delmsg'.
+
+:untell
+!untell <nick> ...
+ Forgets about all message(s) you've sent with !tell to particular
+ nick(s).  Use !delmsg to delete messages sent *to* you.  There is no
+ way to untell individual messages to the same nick.  If your nick is
+ secure, you must !identify yourself to use untell.
+
+:tellme
+The !tellme command repeats any messages you have outstanding.
+!set tellme configures how you receive messages sent with !tell:
+ set tellme insecure              When I see you.
+ set tellme secure [<!interval>]   Hide body (reminding) until ident.
+ set tellme reject                Do not accept messages.
+ set tellme mailto <email-addr>   By email.  (Secure nicks only.)
+Default: `secure 600'.  For insecure nicks `secure' == `insecure'.
+To set when to consider messages delivered (see `help !untell'):
+ set tellme unreliable            Tell you once, then forget.
+ set tellme remind [<every-interval> [<within-interval>]]
+    Remind until you talk on channel within <within-interval>
+    of me having told you.  (Default is remind 1h 30s.)
+ set tellme pester <interval>     Remind until you say !delmsg
+
+:delmsg
+delmsg [<nick> ...]
+ Forgets about !tell messages I've passed on: either all of them, or
+ only those from certain nicks.  Necessary if you !set !tellme pester
+ or reliable, and also works with remind, but not with unreliable.
+ Use !untell to delete messages you've sent, rather than received.
+
 :seen
 seen <nick>
  Tells you or the channel when I last saw that nick in
@@ -153,6 +191,12 @@ invite <channel> <nick> ...   privately
  This can be disabled for managed channels - see `help !userinvite'.
 To get me to join a channel, just invite me to it.
 
+:kill
+kill <nick> [<reason>]
+ Asks me to throw that client off IRC completely, using my IRC
+ Operator privilege.  You must have identified yourself as the user
+ to whom the nick is registered.  (See `help !register'.)
+
 :register
 register            register your nick (or make it secure)
 register delete     delete your nick registration
@@ -169,6 +213,7 @@ set <option>         show the current setting of <option>
 set <option> <value> set <option> to <value>
  Options:  !timeformat ks|hms|beat
            !marktime off|once|<n>[k]s|<n>m|<n>h
+           !tellme ...
  See also `help <option>', `help !register' and `help !identify'
 
 :timeformat
@@ -185,14 +230,21 @@ Replies with hopefully-useful information, including:
   actual message traffic counts, and \!-commands don't count either.
 * The specified string, if any.
 I can tell you this automatically if you like - see `help !marktime'.
+If you have undelivered messages sent with !tell by or to you, I'll
+let you know about those too (privately, if you ping on channel).
 
 :marktime
-!set marktime off    Only an explicit `!ping' command sends you info.
-set marktime once   Send ping info shortly after I first see you.
-set marktime <n>s   Also send info every <n> seconds (min 300s).
-set marktime <n>ks  Also send info every <n> kiloseconds (min 1ks).
-set marktime <n>m   Also send info every <n> minutes (min 5m).
-set marktime <n>h   Also send info every <n> hours (min 1h).
+!set marktime off        Only an explicit `!ping' command sends info.
+set marktime once       Send ping info shortly after I first see you.
+set marktime <!interval> Also send info regularly (min. interval 5m).
+
+:interval
+Intervals in commands are <amount><unit>, where the unit is one of
+s for seconds, ks for kiloseconds, m for minutes, h for hours.
+
+:tutorial
+Sorry, there is no tutorial.  If you would like to contribute by
+writing one, please email ijackson@chiark.greenend.org.uk.
 
 # Local variables:
 # fill-column: 69