chiark - git - mdw - ircbot/blob - helpinfos

   1 ::wwwtitle      Blight (chiark IRC bot) help
   2 ::wwwaddress    chiark IRC operators &lt;ircop@chiark&gt;
   3
   4 :
   5 See http://www.chiark.greenend.org.uk/ucgi/~ijackson/blight-help
   6 or /msg me with `help !overview'.
   7
   8 :overview
   9 General commands:           Registration and user settings:
  10  !help [<cmd>|<opt>|<topic>]  !register [insecure|delete]
  11  !seen <nick>                 !set [<opt> [<value>]]      who [<nick>]
  12  !summon <username>           (See `help !identify', `help !blight-id')
  13  !invite [<chan>] <nick>...  Channel settings (see `help channel'):
  14  !op [<chan>]                 !channel [<chan>] <setting> [....]
  15 Options:                    Additional help topics:
  16  !timeformat ks|hms           !identify !identpass !invite !blight-id
  17 Send commands to me by /msg, or say them in channel with \! in front.
  18
  19 :help
  20 help             gives an overview and lists the topics &c
  21 help <command>   gives help on a command
  22 help <opt>       gives help on an option
  23 help <topic>     gives help on an additional topic
  24
  25 :seen
  26 seen <nick>
  27  Tells you or the channel when I last saw that nick in
  28  use.  When the nick is next used, I'll tell them you asked.
  29
  30 :summon
  31 summon <username>
  32  Invites a logged-on user onto IRC.  If the user is not logged on
  33  you'll be told.  Target users can change this (eg, to disable it)
  34  by reconfiguring the userv service `irc-summon'.  See ~ian/.userv.
  35
  36 :who
  37 who [<nick>]
  38  Gives information about who I think the nick is (or who I think you
  39  are), including whether the nick is registered, whether it is
  40  associated with a username and if so who, and whether the current
  41  user of the nick has identified themselves to me.
  42  See `help !register'.
  43
  44 #:convert
  45 #convert <number> <unit>
  46 # Converts the specified quantity into SI units.  Units that are
  47 # understood are any understood by units(1) and also
  48 #   kelvin celsius fahrenheit    (convert to celsius or kelvin)
  49 #(Not yet implemented.)
  50
  51 :op
  52 op [<channel>]     on channel
  53 op <channel>       (privately)
  54  I'll give you channel operator privilege, if you're a manager.
  55  See `help !manager'.
  56
  57 :channel
  58 channel [<chan>] [show]                       show settings
  59 channel [<chan>] !manager +|-|= <nick> ...     set manager list
  60 channel [<chan>] !autojoin yes|no              join at bot start ?
  61 channel [<chan>] !userinvite pub|here|all|none who can \!invite ?
  62 channel [<chan>] !mode *|+...-...              set modes when alone
  63 channel [<chan>] !topic leave | set <topic>    set topic when alone?
  64 channel [<chan>] !topic see|tell +|-|= <chan>|* ...
  65  See `help <setting>' (eg, `help manager') for more info.
  66
  67 :topic
  68 channel [<chan>] topic set <topic>    set topic when alone
  69 channel [<chan>] topic leave          don't (default)
  70  If set to `topic set <topic>' then whenever I'm alone in the channel
  71  I'll reset the topic; if se to `topic leave' I'll leave it alone.
  72 channel [<chan>] topic see|tell +|-|= <chan>|* ...
  73  I can inform one channel about topic changes in another.  Each
  74  channel has a `see list' and a `tell list' which may be empty or
  75  contain some channel names and/or a `*'.  I'll tell channel #spy
  76  whenever I see the topic change in #showoff if: #showoff or * is
  77  mentioned in #spy's see list, and #spy or * is mentioned in
  78  #showoff's tell list, and at least one those mentions is not a `*'.
  79  + adds items to the relevant list, - removes them, and = sets the
  80  list to exactly those items specified.  Both lists are empty by
  81  default, but a good permissive value is just `*' for both lists.
  82
  83 :autojoin
  84 !channel [<chan>] autojoin yes|no      (`yes' is the default.)
  85  Controls whether I'll join the channel when I'm (re)started.
  86
  87 :userinvite
  88 channel [<chan>] userinvite pub    users on chan can \!invite
  89 channel [<chan>] userinvite here   users on chan can \!invite and /msg
  90 channel [<chan>] userinvite all    anyone can \!invite and /msg
  91 channel [<chan>] userinvite none   \!invite and /msg are disabled
  92  Controls whether the `invite' command works for this channel, and
  93  who can use it (`help !invite').  `userinvite pub' is the default.
  94
  95 :mode
  96 !channel [<chan>] mode *|+...-...           (`mode *' is default.)
  97  If not set to `*' then whenever I'm alone in the channel I'll set
  98  and unset the channel modes specified.  Only the modes imnpst are
  99  supported.  Precede one or more mode letters with + to set, - to
 100  unset; any letters not mentioned will be left alone.
 101
 102 :manager
 103 !channel [<chan>] manager + <nick> <nick> ...  add managers
 104 !channel [<chan>] manager - <nick> <nick> ...  remove managers
 105 !channel [<chan>] manager = <nick> <nick> ...  set new manager list
 106  Managers are those who can use the `channel' command to change
 107  channel settings.  Manager status is only effective for secure
 108  nicks, after the manager has identified themselves.
 109  If you op me on an unmanaged channel you become the only manager,
 110  but you must use `!channel' to change a channel setting to make this
 111  permanent.  To make a channel unmanaged, make it have no managers.
 112
 113 :identify
 114 You must identify yourself to change your settings if your nick is
 115 secure, and to use channel management commands.  In ircII on chiark,
 116 just say `/!blight-id'.  For other clients, see `help !identpass'.
 117 Once you are identified you can then register new nicks, change
 118 settings, etc. - so long as you remain on a channel that I'm on too
 119 (see `help !invite').  See also `help !register'.
 120
 121 :blight-id
 122 /blight-id is a command available in ircII (and possibly other
 123 clients) on chiark.  It sets up a password if you don't already have
 124 one, and then uses it to identify you to Blight.  If you want to
 125 change your password, delete the file ~/.userv/irc-pass-md5.
 126 See `help !register' and `help !identpass'.
 127
 128 :identpass
 129 identpass <username> <password>
 130  Identifies you to Blight.  To set up your password, or be reminded
 131  of it, run the shell command `irc-blight-id' on chiark.
 132  (On ircII on chiark `/!blight-id' is easier, see `help !blight-id'.)
 133  See `help !identpass-internals' for technical details.
 134
 135 :identpass-internals
 136 Identification, for example with /!blight-id, is actually done with
 137 `!identpass', which feeds the md5sum of the password to `userv
 138 <username> irc-identpass <nick>'.  That must exit 0 if all is well.
 139 By default this checks the md5sum against ~/.userv/irc-pass-md5.
 140
 141 :invite
 142 invite <nick> ...             on channel
 143 invite <channel> <nick> ...   privately
 144  This command gets me to invite the specified people to the channel.
 145  This can be disabled for managed channels - see `help !userinvite'.
 146 To get me to join a channel, just invite me to it.
 147
 148 :register
 149 register            register your nick (or make it secure)
 150 register delete     delete your nick registration
 151 register insecure   register your nick insecurely
 152  I only store settings for registered nicks.  For `insecure' nicks
 153  anyone who currently holds that nick can change its settings (see
 154  `help !set', including securing it to their username.  `secure'
 155  nicks can only have their settings changed by the user to which they
 156  are registered, after identifying themselves (see `help !identify').
 157
 158 :set
 159 set                  show your current settings
 160 set <option>         show the current setting of <option>
 161 set <option> <value> set <option> to <value>
 162  See also `help !register' and `help !identify'.  See `help !overview'
 163  for the list of options, and `help <option>' for specific info.
 164
 165 :timeformat
 166 set timeformat ks   show times in seconds, kiloseconds, etc.
 167 set timeformat hms  use days, hours, minutes, seconds
 168
 169 #
 170 # Local variables:
 171 # fill-column: 69
 172 # End.