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