Document ping in overview.

[ircbot] / helpinfos

diff --git a/helpinfos b/helpinfos
index 4a55aa42bbc4d49c2488acd8f7dca50ed1567f3d..5b2f939b1324fcbde26fec63c49ab4ea4b2da542 100644 (file)
--- a/helpinfos
+++ b/helpinfos
@@ -12,9 +12,10 @@ General commands:           Registration and user settings:
  !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
+ !leave [<chan>]             Additional help topics:
+ !ping [<stuff ...>]          !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
@@ -54,11 +55,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>|* ...
@@ -159,14 +166,31 @@ 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   !marktime off|once|<n>[k]s|<n>m|<n>h
+ See also `help <option>', `help !register' and `help !identify'
 
 :timeformat
-set timeformat ks   show times in seconds, kiloseconds, etc.
+!set timeformat ks   show times in seconds, kiloseconds, etc.
 set timeformat hms  use days, hours, minutes, seconds
 
-#
+:ping
+ping [<string>]
+Replies with hopefully-useful information, including:
+* Current time, number of users on the system, and load average.
+* 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'.
+
+: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).
+
 # Local variables:
 # fill-column: 69
-# End.
+# End: