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 !kill <nick> [<reason>]
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
29 Tells you or the channel when I last saw that nick in
30 use. When the nick is next used, I'll tell them you asked.
34 Invites a logged-on user onto IRC. If the user is not logged on
35 you'll be told. Target users can change this (eg, to disable it)
36 by reconfiguring the userv service `irc-summon'. See ~ian/.userv.
40 Gives information about who I think the nick is (or who I think you
41 are), including whether the nick is registered, whether it is
42 associated with a username and if so who, and whether the current
43 user of the nick has identified themselves to me.
47 #convert <number> <unit>
48 # Converts the specified quantity into SI units. Units that are
49 # understood are any understood by units(1) and also
50 # kelvin celsius fahrenheit (convert to celsius or kelvin)
51 #(Not yet implemented.)
54 op [<channel>] on channel
55 op <channel> (privately)
56 I'll give you channel operator privilege, if you're a manager.
60 leave [<channel>] on channel
61 leave <channel> (privately)
62 I'll leave the channel, if you're a manager. For an unmanaged
63 channel, I'll leave when I'm the last one on the channel.
66 channel [<chan>] [show] show settings
67 channel [<chan>] !manager +|-|= <nick> ... set manager list
68 channel [<chan>] !autojoin yes|no join at bot start ?
69 channel [<chan>] !userinvite pub|here|all|none who can !invite ?
70 channel [<chan>] !mode *|+...-... set modes when alone
71 channel [<chan>] !topic leave | set <topic> set topic when alone?
72 channel [<chan>] !topic see|tell +|-|= <chan>|* ...
73 See `help <setting>' (eg, `help manager') for more info.
76 channel [<chan>] topic set <topic> set topic when alone
77 channel [<chan>] topic leave don't (default)
78 If set to `topic set <topic>' then whenever I'm alone in the channel
79 I'll reset the topic; if se to `topic leave' I'll leave it alone.
80 channel [<chan>] topic see|tell +|-|= <chan>|* ...
81 I can inform one channel about topic changes in another. Each
82 channel has a `see list' and a `tell list' which may be empty or
83 contain some channel names and/or a `*'. I'll tell channel #spy
84 whenever I see the topic change in #showoff if: #showoff or * is
85 mentioned in #spy's see list, and #spy or * is mentioned in
86 #showoff's tell list, and at least one those mentions is not a `*'.
87 + adds items to the relevant list, - removes them, and = sets the
88 list to exactly those items specified. Both lists are empty by
89 default, but a good permissive value is just `*' for both lists.
92 !channel [<chan>] autojoin yes|no (`yes' is the default.)
93 Controls whether I'll join the channel when I'm (re)started.
96 channel [<chan>] userinvite pub users on chan can \!invite
97 channel [<chan>] userinvite here users on chan can \!invite and /msg
98 channel [<chan>] userinvite all anyone can \!invite and /msg
99 channel [<chan>] userinvite none \!invite and /msg are disabled
100 Controls whether the `invite' command works for this channel, and
101 who can use it (`help !invite'). `userinvite pub' is the default.
102 Channel managers can always use the `invite' command.
105 !channel [<chan>] mode *|+...-... (`mode *' is default.)
106 If not set to `*' then whenever I'm alone in the channel I'll set
107 and unset the channel modes specified. Only the modes imnpst are
108 supported. Precede one or more mode letters with + to set, - to
109 unset; any letters not mentioned will be left alone.
112 !channel [<chan>] manager + <nick> <nick> ... add managers
113 !channel [<chan>] manager - <nick> <nick> ... remove managers
114 !channel [<chan>] manager = <nick> <nick> ... set new manager list
115 Managers are those who can use the `channel' command to change
116 channel settings. Manager status is only effective for secure
117 nicks, after the manager has identified themselves.
118 If you op me on an unmanaged channel you become the only manager,
119 but you must use `!channel' to change a channel setting to make this
120 permanent. To make a channel unmanaged, make it have no managers.
123 You must identify yourself to change your settings if your nick is
124 secure, and to use channel management commands. In ircII on chiark,
125 just say `/!blight-id'. For other clients, see `help !identpass'.
126 Once you are identified you can then register new nicks, change
127 settings, etc. - so long as you remain on a channel that I'm on too
128 (see `help !invite'). See also `help !register'.
131 /blight-id is a command available in ircII (and possibly other
132 clients) on chiark. It sets up a password if you don't already have
133 one, and then uses it to identify you to Blight. If you want to
134 change your password, delete the file ~/.userv/irc-pass-md5.
135 See `help !register' and `help !identpass'.
138 identpass <username> <password>
139 Identifies you to Blight. To set up your password, or be reminded
140 of it, run the shell command `irc-blight-id' on chiark.
141 (On ircII on chiark `/!blight-id' is easier, see `help !blight-id'.)
142 See `help !identpass-internals' for technical details.
145 Identification, for example with /!blight-id, is actually done with
146 `!identpass', which feeds the md5sum of the password to `userv
147 <username> irc-identpass <nick>'. That must exit 0 if all is well.
148 By default this checks the md5sum against ~/.userv/irc-pass-md5.
151 invite <nick> ... on channel
152 invite <channel> <nick> ... privately
153 This command gets me to invite the specified people to the channel.
154 This can be disabled for managed channels - see `help !userinvite'.
155 To get me to join a channel, just invite me to it.
158 kill <nick> [<reason>]
159 Asks me to throw that client off IRC completely, using my IRC
160 Operator privilege. You must have identified yourself as the user
161 to whom the nick is registered. (See `help !register'.)
164 register register your nick (or make it secure)
165 register delete delete your nick registration
166 register insecure register your nick insecurely
167 I only store settings for registered nicks. For `insecure' nicks
168 anyone who currently holds that nick can change its settings (see
169 `help !set', including securing it to their username. `secure'
170 nicks can only have their settings changed by the user to which they
171 are registered, after identifying themselves (see `help !identify').
174 set show your current settings
175 set <option> show the current setting of <option>
176 set <option> <value> set <option> to <value>
177 Options: !timeformat ks|hms|beat
178 !marktime off|once|<n>[k]s|<n>m|<n>h
179 See also `help <option>', `help !register' and `help !identify'
182 !set timeformat ks show times in seconds, kiloseconds, etc.
183 set timeformat hms use days, hours, minutes, seconds
184 set timeformat beat use beats (1000 B = 1 day)
188 Replies with hopefully-useful information, including:
189 * Current time, number of IRC and system users, and load averages.
190 * Most recent traffic on a relevant channel (if sent privately, any
191 channel we're both on, otherwise the channel in question.) Only
192 actual message traffic counts, and \!-commands don't count either.
193 * The specified string, if any.
194 I can tell you this automatically if you like - see `help !marktime'.
197 !set marktime off Only an explicit `!ping' command sends you info.
198 set marktime once Send ping info shortly after I first see you.
199 set marktime <n>s Also send info every <n> seconds (min 300s).
200 set marktime <n>ks Also send info every <n> kiloseconds (min 1ks).
201 set marktime <n>m Also send info every <n> minutes (min 5m).
202 set marktime <n>h Also send info every <n> hours (min 1h).
~mdw / ircbot / blob