chiark / gitweb /
Improvements.
[ircbot] / helpinfos
index 4a55aa42bbc4d49c2488acd8f7dca50ed1567f3d..9d920d2d114c2033d4811a139dec1f35cd58d2a7 100644 (file)
--- a/helpinfos
+++ b/helpinfos
@@ -10,11 +10,13 @@ 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> [....]
-Options:                    Additional help topics:
- !timeformat ks|hms           !identify !identpass !invite !blight-id
+ !invite [<chan>] <nick>...  For channel managers (see `help channel'):
+ !leave [<chan>]              !channel [<chan>] <setting> [....]
+ !ping [<stuff ...>]          !op [<chan>]                          
+ !tell <nick> <message ...>  Additional help topics:                 
+ !kill <nick> [<reason>]      !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.
 
 :help
 help             gives an overview and lists the topics &c
@@ -22,6 +24,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 refuse                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
@@ -54,11 +92,17 @@ op <channel>       (privately)
  I'll give you channel operator privilege, if you're a manager.
  See `help !manager'.
 
+:leave
+leave [<channel>]     on channel
+leave <channel>       (privately)
+ I'll leave the channel, if you're a manager.  For an unmanaged
+ channel, I'll leave when I'm the last one on the channel.
+
 :channel
 channel [<chan>] [show]                       show settings
 channel [<chan>] !manager +|-|= <nick> ...     set manager list
 channel [<chan>] !autojoin yes|no              join at bot start ?
-channel [<chan>] !userinvite pub|here|all|none who can \!invite ?
+channel [<chan>] !userinvite pub|here|all|none who can !invite ?
 channel [<chan>] !mode *|+...-...              set modes when alone
 channel [<chan>] !topic leave | set <topic>    set topic when alone?
 channel [<chan>] !topic see|tell +|-|= <chan>|* ...
@@ -91,6 +135,7 @@ channel [<chan>] userinvite all    anyone can \!invite and /msg
 channel [<chan>] userinvite none   \!invite and /msg are disabled
  Controls whether the `invite' command works for this channel, and
  who can use it (`help !invite').  `userinvite pub' is the default.
+ Channel managers can always use the `invite' command.
 
 :mode
 !channel [<chan>] mode *|+...-...           (`mode *' is default.)
@@ -145,6 +190,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
@@ -159,14 +210,37 @@ register insecure   register your nick insecurely
 set                  show your current settings
 set <option>         show the current setting of <option>
 set <option> <value> set <option> to <value>
- See also `help !register' and `help !identify'.  See `help !overview'
- for the list of options, and `help <option>' for specific info.
+ 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
-set timeformat ks   show times in seconds, kiloseconds, etc.
-set timeformat hms  use days, hours, minutes, seconds
+!set timeformat ks    show times in seconds, kiloseconds, etc.
+set timeformat hms   use days, hours, minutes, seconds
+set timeformat beat  use beats (1000 B = 1 day)
+
+:ping
+ping [<string>]
+Replies with hopefully-useful information, including:
+* Current time, number of IRC and system users, and load averages.
+* Most recent traffic on a relevant channel (if sent privately, any
+  channel we're both on, otherwise the channel in question.)  Only
+  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 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.
 
-#
 # Local variables:
 # fill-column: 69
-# End.
+# End: