chiark / gitweb /
Abortive stuff to avoid repeated from norecord
[ircbot] / helpinfos
CommitLineData
5e5be903
IJ
1::wwwtitle Blight (chiark IRC bot) help
2::wwwaddress chiark IRC operators <ircop@chiark>
3
4:
5See http://www.chiark.greenend.org.uk/ucgi/~ijackson/blight-help
6or /msg me with `help !overview'.
7
8:overview
e6cc22dc 9General commands: Registration and user settings:
5e5be903
IJ
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> [....]
ebbae0a9 15 !leave [<chan>] Additional help topics:
2f59550c 16 !ping [<stuff ...>] !identify !identpass !invite !blight-id
4f277ed6 17 !tell <nick> <message ...>
5e5be903 18Send commands to me by /msg, or say them in channel with \! in front.
904451e2 19To get me on a channel, invite me. To become channel manager, op me.
e6cc22dc 20
5e5be903 21:help
e6cc22dc
IJ
22help gives an overview and lists the topics &c
23help <command> gives help on a command
24help <opt> gives help on an option
25help <topic> gives help on an additional topic
26
4f277ed6
IJ
27:tell
28tell <nick> <message ...>
29 Leaves a message for someone, which will be delivered according to
63de196a 30 their `!set !tellme'. I will tell you about your undelivered tells
b2dcb948 31 whenever I see you arriving, or when you say `!ping'. See also
63de196a 32 `help !untell' and `help !delmsg'.
4f277ed6 33
63de196a 34:untell
b36ab2da
IJ
35!untell <nick> ...
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.
4f277ed6
IJ
40
41:tellme
d7eda3bc 42!tellme repeats any messages you have outstanding.
4f277ed6 43!set tellme configures how you receive messages sent with !tell:
26477e22 44 set tellme insecure When I see you.
82d3b72f 45 set tellme secure [<!interval>] Hide body (reminding) until ident.
4f277ed6
IJ
46 set tellme refuse Do not accept messages.
47 set tellme mailto <email-addr> By email. (Secure nicks only.)
26477e22
IJ
48Default: `secure 600'. For insecure nicks `secure' == `insecure'.
49To set when to consider messages delivered (see `help !untell'):
4f277ed6 50 set tellme unreliable Tell you once, then forget.
26477e22 51 set tellme remind [<every-interval> [<within-interval>]]
4f277ed6
IJ
52 Remind until you talk on channel within <within-interval>
53 of me having told you. (Default is remind 1h 30s.)
37a9f1ad 54 set tellme pester <interval> Remind until you say !delmsg
4f277ed6
IJ
55
56:delmsg
57delmsg [<nick> ...]
8c7d57b0 58 Forgets about !tell messages I've passed on: either all of them, or
63de196a
IJ
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.
4f277ed6 62
5e5be903 63:seen
e6cc22dc
IJ
64seen <nick>
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.
67
5e5be903 68:summon
e6cc22dc
IJ
69summon <username>
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.
73
5e5be903 74:who
a4a1f396
IJ
75who [<nick>]
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.
5e5be903
IJ
80 See `help !register'.
81
82#:convert
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.)
88
89:op
90op [<channel>] on channel
91op <channel> (privately)
20087363 92 I'll give you channel operator privilege, if you're a manager.
5e5be903
IJ
93 See `help !manager'.
94
cf6ea4de
IJ
95:leave
96leave [<channel>] on channel
97leave <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.
100
5e5be903
IJ
101:channel
102channel [<chan>] [show] show settings
103channel [<chan>] !manager +|-|= <nick> ... set manager list
104channel [<chan>] !autojoin yes|no join at bot start ?
904451e2 105channel [<chan>] !userinvite pub|here|all|none who can !invite ?
5e5be903 106channel [<chan>] !mode *|+...-... set modes when alone
281b5f05
IJ
107channel [<chan>] !topic leave | set <topic> set topic when alone?
108channel [<chan>] !topic see|tell +|-|= <chan>|* ...
20087363
IJ
109 See `help <setting>' (eg, `help manager') for more info.
110
281b5f05
IJ
111:topic
112channel [<chan>] topic set <topic> set topic when alone
113channel [<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.
116channel [<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.
126
5e5be903
IJ
127:autojoin
128!channel [<chan>] autojoin yes|no (`yes' is the default.)
20087363 129 Controls whether I'll join the channel when I'm (re)started.
20087363 130
5e5be903 131:userinvite
bdf495dc
IJ
132channel [<chan>] userinvite pub users on chan can \!invite
133channel [<chan>] userinvite here users on chan can \!invite and /msg
134channel [<chan>] userinvite all anyone can \!invite and /msg
135channel [<chan>] userinvite none \!invite and /msg are disabled
5e5be903
IJ
136 Controls whether the `invite' command works for this channel, and
137 who can use it (`help !invite'). `userinvite pub' is the default.
52a856ae 138 Channel managers can always use the `invite' command.
5e5be903
IJ
139
140:mode
93fe4099 141!channel [<chan>] mode *|+...-... (`mode *' is default.)
5e5be903
IJ
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.
146
147:manager
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
20087363
IJ
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,
5e5be903 155 but you must use `!channel' to change a channel setting to make this
20087363 156 permanent. To make a channel unmanaged, make it have no managers.
e6cc22dc 157
5e5be903
IJ
158:identify
159You must identify yourself to change your settings if your nick is
160secure, and to use channel management commands. In ircII on chiark,
161just say `/!blight-id'. For other clients, see `help !identpass'.
162Once you are identified you can then register new nicks, change
163settings, etc. - so long as you remain on a channel that I'm on too
164(see `help !invite'). See also `help !register'.
e6cc22dc 165
5e5be903 166:blight-id
d83fb8db
IJ
167/blight-id is a command available in ircII (and possibly other
168clients) on chiark. It sets up a password if you don't already have
169one, and then uses it to identify you to Blight. If you want to
170change your password, delete the file ~/.userv/irc-pass-md5.
5e5be903 171See `help !register' and `help !identpass'.
d83fb8db 172
5e5be903 173:identpass
e6cc22dc 174identpass <username> <password>
dde1d60c
IJ
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.
5e5be903
IJ
177 (On ircII on chiark `/!blight-id' is easier, see `help !blight-id'.)
178 See `help !identpass-internals' for technical details.
dde1d60c 179
5e5be903
IJ
180:identpass-internals
181Identification, for example with /!blight-id, is actually done with
182`!identpass', which feeds the md5sum of the password to `userv
86501c55
IJ
183<username> irc-identpass <nick>'. That must exit 0 if all is well.
184By default this checks the md5sum against ~/.userv/irc-pass-md5.
e6cc22dc 185
5e5be903
IJ
186:invite
187invite <nick> ... on channel
188invite <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'.
191To get me to join a channel, just invite me to it.
e6cc22dc 192
5e5be903 193:register
e6cc22dc
IJ
194register register your nick (or make it secure)
195register delete delete your nick registration
196register insecure register your nick insecurely
197 I only store settings for registered nicks. For `insecure' nicks
bdf495dc
IJ
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').
e6cc22dc 202
5e5be903 203:set
e6cc22dc
IJ
204set show your current settings
205set <option> show the current setting of <option>
206set <option> <value> set <option> to <value>
8c7d57b0
IJ
207 Options: !timeformat ks|hms !marktime off|once|<!interval>
208 !tellme ...
ebbae0a9 209 See also `help <option>', `help !register' and `help !identify'
e6cc22dc 210
5e5be903 211:timeformat
ebbae0a9 212!set timeformat ks show times in seconds, kiloseconds, etc.
e6cc22dc
IJ
213set timeformat hms use days, hours, minutes, seconds
214
ebbae0a9
IJ
215:ping
216ping [<string>]
217Replies with hopefully-useful information, including:
c8723e92 218* Current time, number of IRC and system users, and load averages.
ebbae0a9
IJ
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.
223I can tell you this automatically if you like - see `help !marktime'.
63de196a
IJ
224If you have undelivered messages sent with !tell by or to you, I'll
225let you know about those too (privately, if you ping on channel).
ebbae0a9
IJ
226
227:marktime
4f277ed6
IJ
228!set marktime off Only an explicit `!ping' command sends info.
229set marktime once Send ping info shortly after I first see you.
230set marktime <!interval> Also send info regularly (min. interval 5m).
231
232:interval
233Intervals in commands are <amount><unit>, where the unit is one of
234s for seconds, ks for kiloseconds, m for minutes, h for hours.
ebbae0a9 235
20087363
IJ
236# Local variables:
237# fill-column: 69
ebbae0a9 238# End: