/[cvs]/eggdrop1.8/help/set/cmds1.help
ViewVC logotype

Contents of /eggdrop1.8/help/set/cmds1.help

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.3 - (show annotations) (download)
Tue Oct 19 12:13:32 2010 UTC (10 years ago) by pseudo
Branch: MAIN
Changes since 1.2: +75 -3 lines
Added full SSL support including Tcl commands.
Added support for certificate authentication.
Added support for botnet and partyline encryption using ssl.
Documented the new features and commands.
Fixed add_server() problems with IPv6 addresses in the server list.

1 %{help=set botnet-nick}%{+n}
2 ### %bset botnet-nick%b <nickname>
3 If you want to use a different nickname on the botnet than you
4 use on IRC (i.e. if you're on an un-trusted botnet), set this
5 setting to the nick you would like to use.
6 %{help=set userfile}%{+n}
7 ### %bset userfile%b <filename>
8 Specify here the filename your userfile should be saved as.
9 %{help=set motd}%{+n}
10 ### %bset motd%b <filename>
11 The MOTD (Message Of The day) is displayed when people dcc chat or
12 telnet to the bot. Look at doc/TEXT-SUBSTITUTIONS for options.
13 %{help=set telnet-banner}%{+n}
14 ### %bset telnet-banner%b <filename>
15 This banner will be displayed on telnet connections. Look at
16 doc/TEXT-SUBSTITUTIONS for options.
17 %{help=set admin}%{+n}
18 ### %bset admin%b <admin-info>
19 This setting defines which contact person should be shown in
20 .status, /msg help, and other places. You really should include
21 this information.
22 %{help=set temp-path}%{+n}
23 ### %bset temp-path%b <path>
24 Set here a place to store temporary files.
25 %{help=set notify-newusers}%{+n}
26 ### %bset notify-newusers%b <nickname-list>
27 Who should a note be sent to when new users are learned?
28 %{help=set owner}%{+n}
29 ### %bset owner%b <nickname-list>
30 This is a list of owners of the bot.
31 %{help=set vhost4}%{+n}
32 ### %bset vhost4%b <ipv4-address|hostname>
33 If you're using virtual hosting (your machine has more than 1 IP),
34 you may want to set this to a particular IP to bind to. You can
35 specify either by hostname or by IP. Note that this is not used for
36 listening. Use the listen-addr variable to specify the listening
37 address.
38 %{help=set vhost6}%{+n}
39 ### %bset vhost6%b <ipv6-address|hostname>
40 IPv6 vhost to bind to for outgoing IPv6 connections. You can set it
41 to any valid IPv6 address or hostname, resolving to an IPv6 address.
42 Note that this is not used for listening. Use the listen-addr
43 variable to specify the listening address.
44 %{help=set nat-ip}%{+n}
45 ### %bset nat-ip%b <ip-address>
46 If you have a NAT firewall (you box has an IP in one of the
47 following ranges: 192.168.0.0-192.168.255.255,
48 172.16.0.0-172.31.255.255, 10.0.0.0-10.255.255.255 and your
49 firewall transparently changes your address to a unique address
50 for your box) or you have IP masquerading between you and the
51 rest of the world, and /dcc chat, /ctcp chat or userfile sharing
52 aren't working, enter your outside IP here. This IP is used for
53 transfers only, and has nothing to do with the vhost4/6 or
54 listen-addr settings. You may still need to set them.
55 %{help=set listen-addr}%{+n}
56 ### %bset listen-addr%b <ip-address/hostname>
57 You can specify a particular IPv4/IPv6 address (or hostname)
58 to bind for listening, e.g. for the 'listen' tcl command or
59 for file sending.
60 %{help=set prefer-ipv6}%{+n}
61 ### %bset prefer-ipv6%b <0/1>
62 Prefer IPv6 over IPv4 for connections and dns resolution.
63 If the preferred protocol family is not supported, the other
64 one will be tried.
65 %{help=set dcc-sanitycheck}%{+n}
66 ### %bset dcc-sanitycheck%b <0/1>
67 This setting will make the bot ignore DCC chat requests which
68 appear to have bogus information on the grounds that the user may
69 have been trying to make the bot connect to somewhere that will
70 get it into trouble, or that the user has a broken client, in
71 which case the connect wouldn't work anyway.
72 %{help=set network}%{+n}
73 ### %bset network%b <net-name>
74 This setting is used only for info to share with others on your
75 botnet. Set this to the IRC network your bot is connected to.
76 %{help=set whois-fields}%{+n}
77 ### %bset whois-fields%b <field-list>
78 Enter all user-defined fields that should be displayed in a
79 '.whois'. This will only be shown if the user has one of these
80 extra fields. You might prefer to comment this out and use the
81 userinfo1.0.tcl script which provides commands for changing all
82 of these.
83 %{help=set username}%{+n}
84 ### %bset username%b <username>
85 This setting defines the username the bot uses on IRC. This setting
86 has no effect if an ident daemon is running on your bot's machine.
87 %{help=set version}%{+n}
88 ### %bset version%b
89 Current bot version - "1.1.2+pl1 1010201 pl1"; first item is the
90 text version, second item is a numerical version, and any following
91 items are the names of patches that have been added.
92 %{help=set firewall}%{+n}
93 ### %bset firewall%b <host:port>
94 Set this to your socks host if your Eggdrop sits behind a
95 firewall. If you use a Sun "telnet passthru" firewall, prefix
96 the host with a '!'.
97 %{help=set telnet-flood}%{+n}
98 ### %bset telnet-flood%b <times:seconds>
99 Define here how many telnet connection attempts in how many
100 seconds from the same host constitute a flood. The correct
101 format is Attempts:Seconds.
102 %{help=set paranoid-telnet-flood}%{+n}
103 ### %bset paranoid-telnet-flood%b <0/1>
104 If you want telnet-flood to apply even to +f users, set this
105 setting to 1.
106 %{help=set ignore-time}%{+n}
107 ### %bset ignore-time%b <time>
108 The time in minutes that temporary ignores should last.
109 %{help=set dcc-flood-thr}%{+n}
110 ### %bset dcc-flood-thr%b <number>
111 Specify here the number of lines to accept from a user on the
112 partyline within 1 second before they are considered to be
113 flooding and therefore get booted.
114 %{help=set hourly-updates}%{+n}
115 ### %bset hourly-updates%b <military time>
116 Define here what Eggdrop considers 'hourly'. All calls to it,
117 including such things as note notifying or userfile saving, are
118 affected by this.
119 %{help=set switch-logfiles-at}%{+n}
120 ### %bset switch-logfiles-at%b <military-time>
121 You can specify when Eggdrop should switch logfiles and start
122 fresh. You must use military time for this setting. 300 is the
123 default, and describes 03:00 (AM).
124 %{help=set connect-timeout}%{+n}
125 ### %bset connect-timeout%b <seconds>
126 This settings defines a time in seconds that the bot should
127 wait before a dcc chat, telnet, or relay connection times out.
128 %{help=set resolve-timeout}%{+n}
129 ### %bset resolve-timeout%b <seconds>
130 Set here the amount of seconds before giving up on hostname/address
131 lookup (you might want to increase this if you are on a slow network).
132 %{help=set dupwait-timeout}%{+n}
133 ### %bset dupwait-timeout%b <seconds>
134 If your Eggdrop rejects bots that actually have already
135 disconnected from another hub, but the disconnect information has
136 not yet spread over the botnet due to lag, use this setting. The
137 bot will wait dupwait-timeout seconds before it checks again and
138 then finally reject the bot.
139 %{help=set reserved-portrange}%{+n}
140 ### %bset reserved-portrange%b <lowport>:<highport>
141 If you want all dcc file transfers to use a particular portrange
142 either because you're behind a firewall, or for other security
143 reasons, set it here.
144 %{help=set require-p}%{+n}
145 ### %bset require-p%b <0/1>
146 Define here whether or not a +o user still needs the +p flag to
147 dcc the bot.
148 %{help=set keep-all-logs}%{+n}
149 ### %bset keep-all-logs%b <0/1>
150 If you want to keep your logfiles forever, turn this setting on.
151 All logfiles will get suffix
152 ".[2 digit day][3 letter month][4 digit year]". Note that your
153 quota/hard-disk might be filled by this, so check your logfiles
154 often and download them.
155 %{help=set open-telnets}%{+n}
156 ### %bset open-telnets%b <0/1>
157 If you want people allow to telnet in and type 'NEW' to become a
158 new user, set this to 1. This is similar to the 'hello' msg
159 command. The protect-telnet setting must be set to 0 to use this.
160 %{help=set stealth-telnets}%{+n}
161 ### %bset stealth-telnets%b <0/1>
162 If you don't want Eggdrop to identify itself as an eggdrop on a
163 telnet connection, set this setting to 1. Eggdrop will display
164 'Nickname' instead.
165 %{help=set use-telnet-banner}%{+n}
166 ### %bset use-telnet-banner%b <0/1>
167 If you want Eggdrop to display a banner when telneting in, set
168 this setting to 1. The telnet banner is set by 'set telnet-banner'.
169 %{help=set handlen}%{+n}
170 ### %bset handlen%b
171 This is the max length handles may be on the bot.
172 %{help=set console}%{+n}
173 ### %bset console%b <console-flags>
174 This is the default console mode. It uses the same event flags
175 as the log files do. The console channel is automatically set to
176 your "primary" channel, which is set in the modules section of
177 the config file. Masters can change their console channel and modes
178 with the '.console' command.
179 %{help=set default-flags}%{+n}
180 ### %bset default-flags%b <flags>
181 Enter the flags that all new users should get by default. See
182 '.help whois' on the partyline for a list of flags and their
183 descriptions.
184 %{help=set log-time}%{+n}
185 ### %bset log-time%b <0/1>
186 Use this feature to timestamp entries in the log file.
187 %{help=set timestamp-format}%{+n}
188 ### %bset timestamp-format%b <format>
189 Set the following to the timestamp for the logfile entries. Popular
190 times might be "[%H:%M]" (hour,min), or "[%H:%M:%S]" (hour, min, sec).
191 Read `man strftime' for more formatting options. Keep it below 32
192 chars.
193 %{help=set max-logsize}%{+n}
194 ### %bset max-logsize%b <filesize>
195 This is the maximum size of your logfiles. Set it to 0 to disable.
196 This value is in kilobytes, so '550' would mean cycle logs when it
197 reaches the size of 550 kilobytes. Note that this only works if you
198 have keep-all-logs 0 (OFF).
199 %{help=set quick-logs}%{+n}
200 ### %bset quick-logs%b <0/1>
201 This could be good if you have had problem with the logfile
202 filling your quota/hard disk or if you log +p and publish it to
203 the web and need more up-to-date info. Note that this setting
204 might increase the CPU usage of your bot (on the other hand it will
205 decrease your mem usage).
206 %{help=set logfile-suffix}%{+n}
207 ### %bset logfile-suffix%b <suffix>
208 If keep-all-logs is 1, this setting will define the suffix of the
209 logfiles. The default will result in a suffix like "04May2000".
210 "%Y%m%d" will produce the often used yyyymmdd format. Read the
211 strftime manpages for more options. NOTE: On systems which don't
212 support strftime, the default format will be used _always_.
213 %{help=set quiet-save}%{+n}
214 ### %bset quiet-save%b <0/1/2/3>
215 "Writing user file..." and "Writing channel file..." messages won't
216 be logged anymore if this option is enabled. If you set it to 2, the
217 "Backing up user file..." and "Backing up channel file..." messages
218 will also not be logged. In addition to this, you can disable the
219 "Switching logfiles..." and the new date message at midnight, by
220 setting this to 3.
221 %{help=set sort-users}%{+n}
222 ### %bset sort-users%b <0/1>
223 If you want your userfile to be sorted upon saving, enable this
224 setting. This causes the bot to use a bit more CPU when saving the
225 userfile.
226 %{help=set die-on-sighup}%{+n}
227 ### %bset die-on-sighup%b <0/1>
228 Enable this setting if you want your Eggdrop to die upon receiving
229 a SIGHUP kill signal. Otherwise, the Eggdrop will just save its
230 userfile and rehash.
231 %{help=set die-on-sigterm}%{+n}
232 ### %bset die-on-sigterm%b <0/1>
233 Enable this setting if you want your Eggdrop to die upon receiving
234 a SIGTERM kill signal. Otherwise, the Eggdrop will just save its
235 userfile and rehash.
236 %{help=set remote-boots}%{+n}
237 ### %bset remote-boots%b <0/1>
238 This setting defines whether or not people can boot users on the
239 Eggdrop from other bots in your botnet. Valid settings are:
240 0 - allow *no* outside boots
241 1 - allow boots from sharebots
242 2 - allow any boots
243 %{help=set max-socks}%{+n}
244 ### %bset max-socks%b <max dcc connections>
245 Set here the maximum number of socket connections you will allow. You can
246 increase this later, but never decrease it below current usage. If you're
247 using Tcl threads, this is a per-thread maximum.
248 %{help=set max-logs}%{+n}
249 ### %bset max-logs%b <max number of logs>
250 This is the maximum number of logfiles allowed. This setting
251 can be increased; however, don't decrease it.
252 %{help=set protect-telnet}%{+n}
253 ### %bset protect-telnet%b <0/1>
254 This setting will drop telnet connections not matching a known
255 host.
256 %{help=set ident-timeout}%{+n}
257 ### %bset ident-timeout%b <timeout>
258 This settings defines a time in seconds that the bot should wait
259 before a dcc chat, telnet, or relay connection times out.
260 %{help=set share-unlinks}%{+n}
261 ### %bset share-unlinks%b 0/1
262 This setting prohibits remote bots from telling your Eggdrop to
263 unlink from share bots.
264 %{help=set strict-host}%{+n}
265 ### %bset strict-host%b <0/1>
266 Specifies whether the bot should leave leading ~+-^= in users'
267 hostnames. If this is on, the bot will differentiate between
268 valid-ident usernames and invalid ones. This setting is currently
269 kept for compatibility, but will be removed from the next release.
270 Please leave it set to 1 for now to avoid problems with your user
271 files in the future.
272 %{help=set cidr-support}%{+n}
273 ### %bset cidr-support%b <0/1>
274 Enables cidr support for b/e/I modes if set to 1. This means the
275 bot will understand and match modes in cidr notation, and will
276 be able to put and enforce such bans or unban itself, if banned
277 with a cidr mask.
278 Warning: enabling this on servers which don't support cidr may
279 result in kick floods or other problems.
280 %{help=set allow-dk-cmds}%{+n}
281 ### %bset allow-dk-cmds%b <0/1>
282 Enable this setting if you want +d & +k users to use commands
283 bound as -|-.
284 %{help=set userfile-perm}%{+n}
285 ### %bset userfile-perm%b <octal value>
286 This specifies what permissions the user, channel, and notes
287 files should be set to. The octal values are the same as for
288 the chmod system command.
289 %{help=set ssl-certificate}%{+n}
290 ### %bset ssl-certificate%b <filename>
291 Specify the filename where your SSL certificate is located. If
292 you don't set this, eggdrop will not be able to act as a server
293 in SSL connections, as with most ciphers a certificate and a
294 private key are required on the server side. Must be in PEM
295 format.
296 %{help=set ssl-privatekey}%{+n}
297 ### %bset ssl-privatekey%b <filename>
298 File containing your private RSA key used for SSL connections.
299 %{help=set ssl-verify-depth}%{+n}
300 ### %bset ssl-verify-depth%b <depth>
301 Sets the maximum depth for the certificate chain verification
302 that will be allowed for ssl. When certificate verification is
303 enabled, any chain exceeding this depth will fail verification.
304 %{help=set ssl-capath}%{+n}
305 ### %bset ssl-capath%b <directory>
306 Specify the location where CA certificates for verification
307 purposes are located. These certificates are trusted. If you
308 don't set this or ssl-cafile, certificate verification will not
309 work.
310
311 See also: ssl-cafile
312 %{help=set ssl-cafile}%{+n}
313 ### %bset ssl-cafile%b <filename>
314 Specify a file which contains CA certificates for verification
315 purposes. These certificates are trusted. If you don't set this
316 or ssl-capath, certificate verification will not work.
317
318 See also: set ssl-capath
319 %{help=set ssl-ciphers}%{+n}
320 ### %bset ssl-ciphers%b <cipher list>
321 Specify the list of ciphers (in order of preference) allowed for
322 use with ssl. The cipher list is one or more cipher strings
323 separated by colons, commas or spaces. Unavailable ciphers are
324 silently ignored unless no useable cipher could be found. For the
325 list of possible cipher strings and their meanings, please refer
326 to the ciphers(1) manual.
327 If you set this, the value replaces any ciphers OpenSSL might use
328 by default. To include the default ciphers, you can put DEFAULT
329 as a cipher string in the list.
330 %{help=set ssl-cert-auth}%{+n}
331 ### %bset ssl-cert-auth%b <0/1/2>
332 Enable certificate authorization. Set to 1 to allow users and bots
333 to identify automatically by their certificate fingerprints. Setting
334 it to 2 to will force fingerprint logins. With a value of 2, users
335 without a fingerprint set or with a certificate UID not matching
336 their handle won't be allowed to login on SSL enabled telnet ports.
337 Fingerprints must be set in advance with the .fprint and .chfinger
338 commands.
339 NOTE: this setting has no effect on plain-text ports.
340 %{help=set ssl-verify-dcc}%{+n}
341 ### %bset ssl-verify-dcc%b <#>
342 Control certificate verification for DCC chats (/dcc chat botnick)
343
344 See also: set ssl-verify-clients
345 %{help=set ssl-verify-bots}%{+n}
346 ### %bset ssl-verify-bots%b <#>
347 Control certificate verification for linking to hubs
348
349 See also: set ssl-verify-clients
350 %{help=set ssl-verify-clients}%{+n}
351 ### %bset ssl-verify-clients%b <#>
352 Control cerfificate verification for SSL listening ports. This includes
353 leaf bots connecting to us, users telneting in and /ctcp bot chat.
354 You can set this by adding together the numbers for all exceptions you
355 want to enable. By default certificate verification is disabled and all
356 certificates are assumed to be valid.
357 There are the following exceptions with their corresponding numbers:
358 1 enable certificate verification
359 2 allow self-signed certificates
360 4 don't check peer common or alt names
361 8 allow expired certificates
362 16 allow certificates which are not valid yet
363 32 allow revoked certificates

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23