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