chiark / gitweb /
marktime and ping.
[ircbot] / helpinfos
... / ...
CommitLineData
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
9General 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 !identify !identpass !invite !blight-id
17Send commands to me by /msg, or say them in channel with \! in front.
18
19:help
20help gives an overview and lists the topics &c
21help <command> gives help on a command
22help <opt> gives help on an option
23help <topic> gives help on an additional topic
24
25:seen
26seen <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
31summon <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
37who [<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
52op [<channel>] on channel
53op <channel> (privately)
54 I'll give you channel operator privilege, if you're a manager.
55 See `help !manager'.
56
57:leave
58leave [<channel>] on channel
59leave <channel> (privately)
60 I'll leave the channel, if you're a manager. For an unmanaged
61 channel, I'll leave when I'm the last one on the channel.
62
63:channel
64channel [<chan>] [show] show settings
65channel [<chan>] !manager +|-|= <nick> ... set manager list
66channel [<chan>] !autojoin yes|no join at bot start ?
67channel [<chan>] !userinvite pub|here|all|none who can \!invite ?
68channel [<chan>] !mode *|+...-... set modes when alone
69channel [<chan>] !topic leave | set <topic> set topic when alone?
70channel [<chan>] !topic see|tell +|-|= <chan>|* ...
71 See `help <setting>' (eg, `help manager') for more info.
72
73:topic
74channel [<chan>] topic set <topic> set topic when alone
75channel [<chan>] topic leave don't (default)
76 If set to `topic set <topic>' then whenever I'm alone in the channel
77 I'll reset the topic; if se to `topic leave' I'll leave it alone.
78channel [<chan>] topic see|tell +|-|= <chan>|* ...
79 I can inform one channel about topic changes in another. Each
80 channel has a `see list' and a `tell list' which may be empty or
81 contain some channel names and/or a `*'. I'll tell channel #spy
82 whenever I see the topic change in #showoff if: #showoff or * is
83 mentioned in #spy's see list, and #spy or * is mentioned in
84 #showoff's tell list, and at least one those mentions is not a `*'.
85 + adds items to the relevant list, - removes them, and = sets the
86 list to exactly those items specified. Both lists are empty by
87 default, but a good permissive value is just `*' for both lists.
88
89:autojoin
90!channel [<chan>] autojoin yes|no (`yes' is the default.)
91 Controls whether I'll join the channel when I'm (re)started.
92
93:userinvite
94channel [<chan>] userinvite pub users on chan can \!invite
95channel [<chan>] userinvite here users on chan can \!invite and /msg
96channel [<chan>] userinvite all anyone can \!invite and /msg
97channel [<chan>] userinvite none \!invite and /msg are disabled
98 Controls whether the `invite' command works for this channel, and
99 who can use it (`help !invite'). `userinvite pub' is the default.
100
101:mode
102!channel [<chan>] mode *|+...-... (`mode *' is default.)
103 If not set to `*' then whenever I'm alone in the channel I'll set
104 and unset the channel modes specified. Only the modes imnpst are
105 supported. Precede one or more mode letters with + to set, - to
106 unset; any letters not mentioned will be left alone.
107
108:manager
109!channel [<chan>] manager + <nick> <nick> ... add managers
110!channel [<chan>] manager - <nick> <nick> ... remove managers
111!channel [<chan>] manager = <nick> <nick> ... set new manager list
112 Managers are those who can use the `channel' command to change
113 channel settings. Manager status is only effective for secure
114 nicks, after the manager has identified themselves.
115 If you op me on an unmanaged channel you become the only manager,
116 but you must use `!channel' to change a channel setting to make this
117 permanent. To make a channel unmanaged, make it have no managers.
118
119:identify
120You must identify yourself to change your settings if your nick is
121secure, and to use channel management commands. In ircII on chiark,
122just say `/!blight-id'. For other clients, see `help !identpass'.
123Once you are identified you can then register new nicks, change
124settings, etc. - so long as you remain on a channel that I'm on too
125(see `help !invite'). See also `help !register'.
126
127:blight-id
128/blight-id is a command available in ircII (and possibly other
129clients) on chiark. It sets up a password if you don't already have
130one, and then uses it to identify you to Blight. If you want to
131change your password, delete the file ~/.userv/irc-pass-md5.
132See `help !register' and `help !identpass'.
133
134:identpass
135identpass <username> <password>
136 Identifies you to Blight. To set up your password, or be reminded
137 of it, run the shell command `irc-blight-id' on chiark.
138 (On ircII on chiark `/!blight-id' is easier, see `help !blight-id'.)
139 See `help !identpass-internals' for technical details.
140
141:identpass-internals
142Identification, for example with /!blight-id, is actually done with
143`!identpass', which feeds the md5sum of the password to `userv
144<username> irc-identpass <nick>'. That must exit 0 if all is well.
145By default this checks the md5sum against ~/.userv/irc-pass-md5.
146
147:invite
148invite <nick> ... on channel
149invite <channel> <nick> ... privately
150 This command gets me to invite the specified people to the channel.
151 This can be disabled for managed channels - see `help !userinvite'.
152To get me to join a channel, just invite me to it.
153
154:register
155register register your nick (or make it secure)
156register delete delete your nick registration
157register insecure register your nick insecurely
158 I only store settings for registered nicks. For `insecure' nicks
159 anyone who currently holds that nick can change its settings (see
160 `help !set', including securing it to their username. `secure'
161 nicks can only have their settings changed by the user to which they
162 are registered, after identifying themselves (see `help !identify').
163
164:set
165set show your current settings
166set <option> show the current setting of <option>
167set <option> <value> set <option> to <value>
168 Options: !timeformat ks|hms !marktime off|once|<n>[k]s|<n>m|<n>h
169 See also `help <option>', `help !register' and `help !identify'
170
171:timeformat
172!set timeformat ks show times in seconds, kiloseconds, etc.
173set timeformat hms use days, hours, minutes, seconds
174
175:ping
176ping [<string>]
177Replies with hopefully-useful information, including:
178* Current time, number of users on the system, and load average.
179* Most recent traffic on a relevant channel (if sent privately, any
180 channel we're both on, otherwise the channel in question.) Only
181 actual message traffic counts, and \!-commands don't count either.
182* The specified string, if any.
183I can tell you this automatically if you like - see `help !marktime'.
184
185:marktime
186!set marktime off Only an explicit `!ping' command sends you info.
187set marktime once Send ping info shortly after I first see you.
188set marktime <n>s Also send info every <n> seconds (min 300s).
189set marktime <n>ks Also send info every <n> kiloseconds (min 1ks).
190set marktime <n>m Also send info every <n> minutes (min 5m).
191set marktime <n>h Also send info every <n> hours (min 1h).
192
193# Local variables:
194# fill-column: 69
195# End: