chiark / gitweb /
userinvite is in channel show
[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> [....]
15Options: Additional help topics:
16 timeformat ks|hms !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:channel
58channel [<chan>] [show] show settings
59channel [<chan>] !manager +|-|= <nick> ... set manager list
60channel [<chan>] !autojoin yes|no join at bot start ?
61channel [<chan>] !userinvite pub|here|all|none who can \!invite ?
62channel [<chan>] !mode *|+...-... set modes when alone
63 See `help <setting>' (eg, `help manager') for more info.
64
65:autojoin
66!channel [<chan>] autojoin yes|no (`yes' is the default.)
67 Controls whether I'll join the channel when I'm (re)started.
68
69:userinvite
70 \!invite /msg ... invite ...
71channel [<chan>] userinvite pub allowed refused
72channel [<chan>] userinvite here allowed only if user on chan
73channel [<chan>] userinvite all allowed any user can invite
74channel [<chan>] userinvite none refused refused
75 Controls whether the `invite' command works for this channel, and
76 who can use it (`help !invite'). `userinvite pub' is the default.
77
78:mode
79!channel [<chan>] mode *+...-...| (`mode *' is default.)
80 If not set to `*' then whenever I'm alone in the channel I'll set
81 and unset the channel modes specified. Only the modes imnpst are
82 supported. Precede one or more mode letters with + to set, - to
83 unset; any letters not mentioned will be left alone.
84
85:manager
86!channel [<chan>] manager + <nick> <nick> ... add managers
87!channel [<chan>] manager - <nick> <nick> ... remove managers
88!channel [<chan>] manager = <nick> <nick> ... set new manager list
89 Managers are those who can use the `channel' command to change
90 channel settings. Manager status is only effective for secure
91 nicks, after the manager has identified themselves.
92 If you op me on an unmanaged channel you become the only manager,
93 but you must use `!channel' to change a channel setting to make this
94 permanent. To make a channel unmanaged, make it have no managers.
95
96:identify
97You must identify yourself to change your settings if your nick is
98secure, and to use channel management commands. In ircII on chiark,
99just say `/!blight-id'. For other clients, see `help !identpass'.
100Once you are identified you can then register new nicks, change
101settings, etc. - so long as you remain on a channel that I'm on too
102(see `help !invite'). See also `help !register'.
103
104:blight-id
105/blight-id is a command available in ircII (and possibly other
106clients) on chiark. It sets up a password if you don't already have
107one, and then uses it to identify you to Blight. If you want to
108change your password, delete the file ~/.userv/irc-pass-md5.
109See `help !register' and `help !identpass'.
110
111:identpass
112identpass <username> <password>
113 Identifies you to Blight. To set up your password, or be reminded
114 of it, run the shell command `irc-blight-id' on chiark.
115 (On ircII on chiark `/!blight-id' is easier, see `help !blight-id'.)
116 See `help !identpass-internals' for technical details.
117
118:identpass-internals
119Identification, for example with /!blight-id, is actually done with
120`!identpass', which feeds the md5sum of the password to `userv
121<username> irc-identpass <nick>'. That must exit 0 if all is well.
122By default this checks the md5sum against ~/.userv/irc-pass-md5.
123
124:invite
125invite <nick> ... on channel
126invite <channel> <nick> ... privately
127 This command gets me to invite the specified people to the channel.
128 This can be disabled for managed channels - see `help !userinvite'.
129To get me to join a channel, just invite me to it.
130
131:register
132register register your nick (or make it secure)
133register delete delete your nick registration
134register insecure register your nick insecurely
135 I only store settings for registered nicks. For `insecure' nicks
136 anyone who currently holds that nick can change its settings,
137 including securing it to their username. `secure' nicks can only
138 have their settings changed by the user to which they are
139 registered, after identifying themselves (see `help !identify').
140
141:set
142set show your current settings
143set <option> show the current setting of <option>
144set <option> <value> set <option> to <value>
145 See also `help !register' and `help !identify'. See `help !overview'
146 for the list of options, and `help <option>' for specific info.
147
148:timeformat
149set timeformat ks show times in seconds, kiloseconds, etc.
150set timeformat hms use days, hours, minutes, seconds
151
152#
153# Local variables:
154# fill-column: 69
155# End.