-!
+::wwwtitle Blight (chiark IRC bot) help
+::wwwaddress chiark IRC operators <ircop@chiark>
+
+:
+See http://www.chiark.greenend.org.uk/ucgi/~ijackson/blight-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>]]
- summon <username> (See `help identify'.)
- convert <number> <unit> Channel settings:
- ops oplist [<chan>] [+|-|= [?]<nick> ...]
+ !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
-Send commands to me by /msg, or say them in channel with ! in front.
+ timeformat ks|hms !identify !identpass !invite !blight-id
+Send commands to me by /msg, or say them in channel with \! in front.
-!help
+:help
help gives an overview and lists the topics &c
help <command> gives help on a command
help <opt> gives help on an option
help <topic> gives help on an additional topic
-!seen
+:seen
seen <nick>
Tells you or the channel when I last saw that nick in
use. When the nick is next used, I'll tell them you asked.
-!summon
+: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.
-!convert
-convert <number> <unit>
- Converts the specified quantity into SI units. Units that are
- understood are any understood by units(1) and also
- kelvin celsius fahrenheit (convert to celsius or kelvin)
-
-!ops
-ops on channel
-ops <channel> (privately)
- Asks me to give you channel operator privilege. You must have
- identified yourself (see `help identification').
-
-!oplist
-oplist [<chan>] show chop list
-oplist [<chan>] + <nick> <nick> ... add nicks to chop list
-oplist [<chan>] - <nick> <nick> ... remove nicks from chop list
-oplist [<chan>] = <nick> <nick> ... set chop list
- Configures the list of who may use the `ops' command. You must be
- on the oplist yourself to do this. If you op me on a channel I'll
- automatically add you to the oplist if you have identified yourself.
-
-!identify
-You must identify yourself to change your settings and to use channel
-management commands. In ircII on chiark, just say `/blight-id'. For
-other clients, see `help identpass'. Once you are identified you can
-then register new nicks, change settings, etc. - so long as you
-remain on a channel that I'm on too. (See also `help invite'.)
-
-!identpass
+:who
+who [<nick>]
+ Gives information about who I think the nick is (or who I think you
+ are), including whether the nick is registered, whether it is
+ associated with a username and if so who, and whether the current
+ user of the nick has identified themselves to me.
+ See `help !register'.
+
+#:convert
+#convert <number> <unit>
+# Converts the specified quantity into SI units. Units that are
+# understood are any understood by units(1) and also
+# kelvin celsius fahrenheit (convert to celsius or kelvin)
+#(Not yet implemented.)
+
+:op
+op [<channel>] on channel
+op <channel> (privately)
+ I'll give you channel operator privilege, if you're a manager.
+ See `help !manager'.
+
+: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>] !mode *|+...-... set modes when alone
+ See `help <setting>' (eg, `help manager') for more info.
+
+:autojoin
+!channel [<chan>] autojoin yes|no (`yes' is the default.)
+ Controls whether I'll join the channel when I'm (re)started.
+
+:userinvite
+ \!invite /msg ... invite ...
+channel [<chan>] userinvite pub allowed refused
+channel [<chan>] userinvite here allowed only if user on chan
+channel [<chan>] userinvite all allowed any user can invite
+channel [<chan>] userinvite none refused refused
+ Controls whether the `invite' command works for this channel, and
+ who can use it (`help !invite'). `userinvite pub' is the default.
+
+:mode
+!channel [<chan>] mode *+...-...| (`mode *' is default.)
+ If not set to `*' then whenever I'm alone in the channel I'll set
+ and unset the channel modes specified. Only the modes imnpst are
+ supported. Precede one or more mode letters with + to set, - to
+ unset; any letters not mentioned will be left alone.
+
+:manager
+!channel [<chan>] manager + <nick> <nick> ... add managers
+!channel [<chan>] manager - <nick> <nick> ... remove managers
+!channel [<chan>] manager = <nick> <nick> ... set new manager list
+ Managers are those who can use the `channel' command to change
+ channel settings. Manager status is only effective for secure
+ nicks, after the manager has identified themselves.
+ If you op me on an unmanaged channel you become the only manager,
+ but you must use `!channel' to change a channel setting to make this
+ permanent. To make a channel unmanaged, make it have no managers.
+
+:identify
+You must identify yourself to change your settings if your nick is
+secure, and to use channel management commands. In ircII on chiark,
+just say `/!blight-id'. For other clients, see `help !identpass'.
+Once you are identified you can then register new nicks, change
+settings, etc. - so long as you remain on a channel that I'm on too
+(see `help !invite'). See also `help !register'.
+
+:blight-id
+/blight-id is a command available in ircII (and possibly other
+clients) on chiark. It sets up a password if you don't already have
+one, and then uses it to identify you to Blight. If you want to
+change your password, delete the file ~/.userv/irc-pass-md5.
+See `help !register' and `help !identpass'.
+
+:identpass
identpass <username> <password>
- Identification, for example with /blight-id, is actually done with
- `identpass', which passes the md5sum of the password to `userv
- <username> irc-identpass <nick>'. That must exit 0 if all is well.
+ Identifies you to Blight. To set up your password, or be reminded
+ of it, run the shell command `irc-blight-id' on chiark.
+ (On ircII on chiark `/!blight-id' is easier, see `help !blight-id'.)
+ See `help !identpass-internals' for technical details.
+
+:identpass-internals
+Identification, for example with /!blight-id, is actually done with
+`!identpass', which feeds the md5sum of the password to `userv
+<username> irc-identpass <nick>'. That must exit 0 if all is well.
+By default this checks the md5sum against ~/.userv/irc-pass-md5.
-!invite
-If you invite me to a channel I'll join it.
+:invite
+invite <nick> ... on channel
+invite <channel> <nick> ... privately
+ This command gets me to invite the specified people to the channel.
+ This can be disabled for managed channels - see `help !userinvite'.
+To get me to join a channel, just invite me to it.
-!register
+:register
register register your nick (or make it secure)
register delete delete your nick registration
register insecure register your nick insecurely
anyone who currently holds that nick can change its settings,
including securing it to their username. `secure' nicks can only
have their settings changed by the user to which they are
- registered, after identifying themselves (see `help identify').
+ registered, after identifying themselves (see `help !identify').
-!set
+:set
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 ident'. See just `help' for the
- list of options, and `help <option>' for info about that option.
+ See also `help !register' and `help !identify'. See `help !overview'
+ for the list of options, and `help <option>' for specific info.
-!timeformat
+:timeformat
set timeformat ks show times in seconds, kiloseconds, etc.
set timeformat hms use days, hours, minutes, seconds
#
+# Local variables:
+# fill-column: 69
+# End.
~mdw / ircbot / blobdiff