1 ::wwwtitle Blight (chiark IRC bot) help
2 ::wwwaddress chiark IRC operators <ircop@chiark>
5 See http://www.chiark.greenend.org.uk/ucgi/~ijackson/blight-help
6 or /msg me with `help !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 !leave [<chan>] Additional help topics:
16 !ping [<stuff ...>] !identify !identpass !invite !blight-id
17 !tell <nick> <message ...>
18 Send commands to me by /msg, or say them in channel with \! in front.
19 To get me on a channel, invite me. To become channel manager, op me.
22 help gives an overview and lists the topics &c
23 help <command> gives help on a command
24 help <opt> gives help on an option
25 help <topic> gives help on an additional topic
28 tell <nick> <message ...>
29 Leaves a message for someone, which will be delivered according to
30 their `!set !tellme'. I will tell you about your undelivered tells
31 whenever I see you arriving, or when you say `!ping'. See also
32 `help !untell' and `help !delmsg'.
36 Forgets about all message(s) you've sent with !tell to particular
37 nick(s). Use !delmsg to delete messages sent *to* you. There is no
38 way to untell individual messages to the same nick. If your nick is
39 secure, you must !identify yourself to use untell.
42 !tellme repeats any messages you have outstanding.
43 !set tellme configures how you receive messages sent with !tell:
44 set tellme insecure When I see you.
45 set tellme secure [<!interval>] Hide body (reminding) until ident.
46 set tellme refuse Do not accept messages.
47 set tellme mailto <email-addr> By email. (Secure nicks only.)
48 Default: `secure 600'. For insecure nicks `secure' == `insecure'.
49 To set when to consider messages delivered (see `help !untell'):
50 set tellme unreliable Tell you once, then forget.
51 set tellme remind [<every-interval> [<within-interval>]]
52 Remind until you talk on channel within <within-interval>
53 of me having told you. (Default is remind 1h 30s.)
54 set tellme pester <interval> Remind until you say !delmsg
58 Forgets about !tell messages I've passed on: either all of them, or
59 only those from certain nicks. Necessary if you !set !tellme pester
60 or reliable, and also works with remind, but not with unreliable.
61 Use !untell to delete messages you've sent, rather than received.
65 Tells you or the channel when I last saw that nick in
66 use. When the nick is next used, I'll tell them you asked.
70 Invites a logged-on user onto IRC. If the user is not logged on
71 you'll be told. Target users can change this (eg, to disable it)
72 by reconfiguring the userv service `irc-summon'. See ~ian/.userv.
76 Gives information about who I think the nick is (or who I think you
77 are), including whether the nick is registered, whether it is
78 associated with a username and if so who, and whether the current
79 user of the nick has identified themselves to me.
83 #convert <number> <unit>
84 # Converts the specified quantity into SI units. Units that are
85 # understood are any understood by units(1) and also
86 # kelvin celsius fahrenheit (convert to celsius or kelvin)
87 #(Not yet implemented.)
90 op [<channel>] on channel
91 op <channel> (privately)
92 I'll give you channel operator privilege, if you're a manager.
96 leave [<channel>] on channel
97 leave <channel> (privately)
98 I'll leave the channel, if you're a manager. For an unmanaged
99 channel, I'll leave when I'm the last one on the channel.
102 channel [<chan>] [show] show settings
103 channel [<chan>] !manager +|-|= <nick> ... set manager list
104 channel [<chan>] !autojoin yes|no join at bot start ?
105 channel [<chan>] !userinvite pub|here|all|none who can !invite ?
106 channel [<chan>] !mode *|+...-... set modes when alone
107 channel [<chan>] !topic leave | set <topic> set topic when alone?
108 channel [<chan>] !topic see|tell +|-|= <chan>|* ...
109 See `help <setting>' (eg, `help manager') for more info.
112 channel [<chan>] topic set <topic> set topic when alone
113 channel [<chan>] topic leave don't (default)
114 If set to `topic set <topic>' then whenever I'm alone in the channel
115 I'll reset the topic; if se to `topic leave' I'll leave it alone.
116 channel [<chan>] topic see|tell +|-|= <chan>|* ...
117 I can inform one channel about topic changes in another. Each
118 channel has a `see list' and a `tell list' which may be empty or
119 contain some channel names and/or a `*'. I'll tell channel #spy
120 whenever I see the topic change in #showoff if: #showoff or * is
121 mentioned in #spy's see list, and #spy or * is mentioned in
122 #showoff's tell list, and at least one those mentions is not a `*'.
123 + adds items to the relevant list, - removes them, and = sets the
124 list to exactly those items specified. Both lists are empty by
125 default, but a good permissive value is just `*' for both lists.
128 !channel [<chan>] autojoin yes|no (`yes' is the default.)
129 Controls whether I'll join the channel when I'm (re)started.
132 channel [<chan>] userinvite pub users on chan can \!invite
133 channel [<chan>] userinvite here users on chan can \!invite and /msg
134 channel [<chan>] userinvite all anyone can \!invite and /msg
135 channel [<chan>] userinvite none \!invite and /msg are disabled
136 Controls whether the `invite' command works for this channel, and
137 who can use it (`help !invite'). `userinvite pub' is the default.
138 Channel managers can always use the `invite' command.
141 !channel [<chan>] mode *|+...-... (`mode *' is default.)
142 If not set to `*' then whenever I'm alone in the channel I'll set
143 and unset the channel modes specified. Only the modes imnpst are
144 supported. Precede one or more mode letters with + to set, - to
145 unset; any letters not mentioned will be left alone.
148 !channel [<chan>] manager + <nick> <nick> ... add managers
149 !channel [<chan>] manager - <nick> <nick> ... remove managers
150 !channel [<chan>] manager = <nick> <nick> ... set new manager list
151 Managers are those who can use the `channel' command to change
152 channel settings. Manager status is only effective for secure
153 nicks, after the manager has identified themselves.
154 If you op me on an unmanaged channel you become the only manager,
155 but you must use `!channel' to change a channel setting to make this
156 permanent. To make a channel unmanaged, make it have no managers.
159 You must identify yourself to change your settings if your nick is
160 secure, and to use channel management commands. In ircII on chiark,
161 just say `/!blight-id'. For other clients, see `help !identpass'.
162 Once you are identified you can then register new nicks, change
163 settings, etc. - so long as you remain on a channel that I'm on too
164 (see `help !invite'). See also `help !register'.
167 /blight-id is a command available in ircII (and possibly other
168 clients) on chiark. It sets up a password if you don't already have
169 one, and then uses it to identify you to Blight. If you want to
170 change your password, delete the file ~/.userv/irc-pass-md5.
171 See `help !register' and `help !identpass'.
174 identpass <username> <password>
175 Identifies you to Blight. To set up your password, or be reminded
176 of it, run the shell command `irc-blight-id' on chiark.
177 (On ircII on chiark `/!blight-id' is easier, see `help !blight-id'.)
178 See `help !identpass-internals' for technical details.
181 Identification, for example with /!blight-id, is actually done with
182 `!identpass', which feeds the md5sum of the password to `userv
183 <username> irc-identpass <nick>'. That must exit 0 if all is well.
184 By default this checks the md5sum against ~/.userv/irc-pass-md5.
187 invite <nick> ... on channel
188 invite <channel> <nick> ... privately
189 This command gets me to invite the specified people to the channel.
190 This can be disabled for managed channels - see `help !userinvite'.
191 To get me to join a channel, just invite me to it.
194 register register your nick (or make it secure)
195 register delete delete your nick registration
196 register insecure register your nick insecurely
197 I only store settings for registered nicks. For `insecure' nicks
198 anyone who currently holds that nick can change its settings (see
199 `help !set', including securing it to their username. `secure'
200 nicks can only have their settings changed by the user to which they
201 are registered, after identifying themselves (see `help !identify').
204 set show your current settings
205 set <option> show the current setting of <option>
206 set <option> <value> set <option> to <value>
207 Options: !timeformat ks|hms !marktime off|once|<!interval>
209 See also `help <option>', `help !register' and `help !identify'
212 !set timeformat ks show times in seconds, kiloseconds, etc.
213 set timeformat hms use days, hours, minutes, seconds
217 Replies with hopefully-useful information, including:
218 * Current time, number of IRC and system users, and load averages.
219 * Most recent traffic on a relevant channel (if sent privately, any
220 channel we're both on, otherwise the channel in question.) Only
221 actual message traffic counts, and \!-commands don't count either.
222 * The specified string, if any.
223 I can tell you this automatically if you like - see `help !marktime'.
224 If you have undelivered messages sent with !tell by or to you, I'll
225 let you know about those too (privately, if you ping on channel).
228 !set marktime off Only an explicit `!ping' command sends info.
229 set marktime once Send ping info shortly after I first see you.
230 set marktime <!interval> Also send info regularly (min. interval 5m).
233 Intervals in commands are <amount><unit>, where the unit is one of
234 s for seconds, ks for kiloseconds, m for minutes, h for hours.
~mdw / ircbot / blob