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