/[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.2 - (show annotations) (download)
Thu Aug 5 18:12:04 2010 UTC (10 years, 2 months ago) by pseudo
Branch: MAIN
Changes since 1.1: +24 -6 lines
Added new, full IPv6 support to eggdrop.

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 my-hostname}%{+n}
32 ### %bset my-hostname%b <hostname>
33 Set this if Eggdrop has trouble detecting its hostname.
34 %{help=set vhost4}%{+n}
35 ### %bset vhost4%b <ipv4-address|hostname>
36 If you're using virtual hosting (your machine has more than 1 IP),
37 you may want to set this to a particular IP to bind to. You can
38 specify either by hostname or by IP. Note that this is not used for
39 listening. Use the listen-addr variable to specify the listening
40 address.
41 %{help=set vhost6}%{+n}
42 ### %bset vhost6%b <ipv6-address|hostname>
43 IPv6 vhost to bind to for outgoing IPv6 connections. You can set it
44 to any valid IPv6 address or hostname, resolving to an IPv6 address.
45 Note that this is not used for listening. Use the listen-addr
46 variable to specify the listening address.
47 %{help=set nat-ip}%{+n}
48 ### %bset nat-ip%b <ip-address>
49 If you have a NAT firewall (you box has an IP in one of the
50 following ranges: 192.168.0.0-192.168.255.255,
51 172.16.0.0-172.31.255.255, 10.0.0.0-10.255.255.255 and your
52 firewall transparently changes your address to a unique address
53 for your box) or you have IP masquerading between you and the
54 rest of the world, and /dcc chat, /ctcp chat or userfile sharing
55 aren't working, enter your outside IP here. This IP is used for
56 transfers only, and has nothing to do with the vhost4/6 or
57 listen-addr settings. You may still need to set them.
58 %{help=set listen-addr}%{+n}
59 ### %bset listen-addr%b <ip-address/hostname>
60 You can specify a particular IPv4/IPv6 address (or hostname)
61 to bind for listening, e.g. for the 'listen' tcl command or
62 for file sending.
63 %{help=set prefer-ipv6}%{+n}
64 ### %bset prefer-ipv6%b <0/1>
65 Prefer IPv6 over IPv4 for connections and dns resolution.
66 If the preferred protocol family is not supported, the other
67 one will be tried.
68 %{help=set dcc-sanitycheck}%{+n}
69 ### %bset dcc-sanitycheck%b <0/1>
70 This setting will make the bot ignore DCC chat requests which
71 appear to have bogus information on the grounds that the user may
72 have been trying to make the bot connect to somewhere that will
73 get it into trouble, or that the user has a broken client, in
74 which case the connect wouldn't work anyway.
75 %{help=set network}%{+n}
76 ### %bset network%b <net-name>
77 This setting is used only for info to share with others on your
78 botnet. Set this to the IRC network your bot is connected to.
79 %{help=set whois-fields}%{+n}
80 ### %bset whois-fields%b <field-list>
81 Enter all user-defined fields that should be displayed in a
82 '.whois'. This will only be shown if the user has one of these
83 extra fields. You might prefer to comment this out and use the
84 userinfo1.0.tcl script which provides commands for changing all
85 of these.
86 %{help=set username}%{+n}
87 ### %bset username%b <username>
88 This setting defines the username the bot uses on IRC. This setting
89 has no effect if an ident daemon is running on your bot's machine.
90 %{help=set version}%{+n}
91 ### %bset version%b
92 Current bot version - "1.1.2+pl1 1010201 pl1"; first item is the
93 text version, second item is a numerical version, and any following
94 items are the names of patches that have been added.
95 %{help=set firewall}%{+n}
96 ### %bset firewall%b <host:port>
97 Set this to your socks host if your Eggdrop sits behind a
98 firewall. If you use a Sun "telnet passthru" firewall, prefix
99 the host with a '!'.
100 %{help=set telnet-flood}%{+n}
101 ### %bset telnet-flood%b <times:seconds>
102 Define here how many telnet connection attempts in how many
103 seconds from the same host constitute a flood. The correct
104 format is Attempts:Seconds.
105 %{help=set paranoid-telnet-flood}%{+n}
106 ### %bset paranoid-telnet-flood%b <0/1>
107 If you want telnet-flood to apply even to +f users, set this
108 setting to 1.
109 %{help=set ignore-time}%{+n}
110 ### %bset ignore-time%b <time>
111 The time in minutes that temporary ignores should last.
112 %{help=set dcc-flood-thr}%{+n}
113 ### %bset dcc-flood-thr%b <number>
114 Specify here the number of lines to accept from a user on the
115 partyline within 1 second before they are considered to be
116 flooding and therefore get booted.
117 %{help=set hourly-updates}%{+n}
118 ### %bset hourly-updates%b <military time>
119 Define here what Eggdrop considers 'hourly'. All calls to it,
120 including such things as note notifying or userfile saving, are
121 affected by this.
122 %{help=set switch-logfiles-at}%{+n}
123 ### %bset switch-logfiles-at%b <military-time>
124 You can specify when Eggdrop should switch logfiles and start
125 fresh. You must use military time for this setting. 300 is the
126 default, and describes 03:00 (AM).
127 %{help=set connect-timeout}%{+n}
128 ### %bset connect-timeout%b <seconds>
129 This settings defines a time in seconds that the bot should
130 wait before a dcc chat, telnet, or relay connection times out.
131 %{help=set resolve-timeout}%{+n}
132 ### %bset resolve-timeout%b <seconds>
133 Set here the amount of seconds before giving up on hostname/address
134 lookup (you might want to increase this if you are on a slow network).
135 %{help=set dupwait-timeout}%{+n}
136 ### %bset dupwait-timeout%b <seconds>
137 If your Eggdrop rejects bots that actually have already
138 disconnected from another hub, but the disconnect information has
139 not yet spread over the botnet due to lag, use this setting. The
140 bot will wait dupwait-timeout seconds before it checks again and
141 then finally reject the bot.
142 %{help=set reserved-portrange}%{+n}
143 ### %bset reserved-portrange%b <lowport>:<highport>
144 If you want all dcc file transfers to use a particular portrange
145 either because you're behind a firewall, or for other security
146 reasons, set it here.
147 %{help=set require-p}%{+n}
148 ### %bset require-p%b <0/1>
149 Define here whether or not a +o user still needs the +p flag to
150 dcc the bot.
151 %{help=set keep-all-logs}%{+n}
152 ### %bset keep-all-logs%b <0/1>
153 If you want to keep your logfiles forever, turn this setting on.
154 All logfiles will get suffix
155 ".[2 digit day][3 letter month][4 digit year]". Note that your
156 quota/hard-disk might be filled by this, so check your logfiles
157 often and download them.
158 %{help=set open-telnets}%{+n}
159 ### %bset open-telnets%b <0/1>
160 If you want people allow to telnet in and type 'NEW' to become a
161 new user, set this to 1. This is similar to the 'hello' msg
162 command. The protect-telnet setting must be set to 0 to use this.
163 %{help=set stealth-telnets}%{+n}
164 ### %bset stealth-telnets%b <0/1>
165 If you don't want Eggdrop to identify itself as an eggdrop on a
166 telnet connection, set this setting to 1. Eggdrop will display
167 'Nickname' instead.
168 %{help=set use-telnet-banner}%{+n}
169 ### %bset use-telnet-banner%b <0/1>
170 If you want Eggdrop to display a banner when telneting in, set
171 this setting to 1. The telnet banner is set by 'set telnet-banner'.
172 %{help=set handlen}%{+n}
173 ### %bset handlen%b
174 This is the max length handles may be on the bot.
175 %{help=set console}%{+n}
176 ### %bset console%b <console-flags>
177 This is the default console mode. It uses the same event flags
178 as the log files do. The console channel is automatically set to
179 your "primary" channel, which is set in the modules section of
180 the config file. Masters can change their console channel and modes
181 with the '.console' command.
182 %{help=set default-flags}%{+n}
183 ### %bset default-flags%b <flags>
184 Enter the flags that all new users should get by default. See
185 '.help whois' on the partyline for a list of flags and their
186 descriptions.
187 %{help=set log-time}%{+n}
188 ### %bset log-time%b <0/1>
189 Use this feature to timestamp entries in the log file.
190 %{help=set timestamp-format}%{+n}
191 ### %bset timestamp-format%b <format>
192 Set the following to the timestamp for the logfile entries. Popular
193 times might be "[%H:%M]" (hour,min), or "[%H:%M:%S]" (hour, min, sec).
194 Read `man strftime' for more formatting options. Keep it below 32
195 chars.
196 %{help=set max-logsize}%{+n}
197 ### %bset max-logsize%b <filesize>
198 This is the maximum size of your logfiles. Set it to 0 to disable.
199 This value is in kilobytes, so '550' would mean cycle logs when it
200 reaches the size of 550 kilobytes. Note that this only works if you
201 have keep-all-logs 0 (OFF).
202 %{help=set quick-logs}%{+n}
203 ### %bset quick-logs%b <0/1>
204 This could be good if you have had problem with the logfile
205 filling your quota/hard disk or if you log +p and publish it to
206 the web and need more up-to-date info. Note that this setting
207 might increase the CPU usage of your bot (on the other hand it will
208 decrease your mem usage).
209 %{help=set logfile-suffix}%{+n}
210 ### %bset logfile-suffix%b <suffix>
211 If keep-all-logs is 1, this setting will define the suffix of the
212 logfiles. The default will result in a suffix like "04May2000".
213 "%Y%m%d" will produce the often used yyyymmdd format. Read the
214 strftime manpages for more options. NOTE: On systems which don't
215 support strftime, the default format will be used _always_.
216 %{help=set quiet-save}%{+n}
217 ### %bset quiet-save%b <0/1/2/3>
218 "Writing user file..." and "Writing channel file..." messages won't
219 be logged anymore if this option is enabled. If you set it to 2, the
220 "Backing up user file..." and "Backing up channel file..." messages
221 will also not be logged. In addition to this, you can disable the
222 "Switching logfiles..." and the new date message at midnight, by
223 setting this to 3.
224 %{help=set sort-users}%{+n}
225 ### %bset sort-users%b <0/1>
226 If you want your userfile to be sorted upon saving, enable this
227 setting. This causes the bot to use a bit more CPU when saving the
228 userfile.
229 %{help=set die-on-sighup}%{+n}
230 ### %bset die-on-sighup%b <0/1>
231 Enable this setting if you want your Eggdrop to die upon receiving
232 a SIGHUP kill signal. Otherwise, the Eggdrop will just save its
233 userfile and rehash.
234 %{help=set die-on-sigterm}%{+n}
235 ### %bset die-on-sigterm%b <0/1>
236 Enable this setting if you want your Eggdrop to die upon receiving
237 a SIGTERM kill signal. Otherwise, the Eggdrop will just save its
238 userfile and rehash.
239 %{help=set remote-boots}%{+n}
240 ### %bset remote-boots%b <0/1>
241 This setting defines whether or not people can boot users on the
242 Eggdrop from other bots in your botnet. Valid settings are:
243 0 - allow *no* outside boots
244 1 - allow boots from sharebots
245 2 - allow any boots
246 %{help=set max-socks}%{+n}
247 ### %bset max-socks%b <max dcc connections>
248 Set here the maximum number of socket connections you will allow. You can
249 increase this later, but never decrease it below current usage. If you're
250 using Tcl threads, this is a per-thread maximum.
251 %{help=set max-logs}%{+n}
252 ### %bset max-logs%b <max number of logs>
253 This is the maximum number of logfiles allowed. This setting
254 can be increased; however, don't decrease it.
255 %{help=set protect-telnet}%{+n}
256 ### %bset protect-telnet%b <0/1>
257 This setting will drop telnet connections not matching a known
258 host.
259 %{help=set ident-timeout}%{+n}
260 ### %bset ident-timeout%b <timeout>
261 This settings defines a time in seconds that the bot should wait
262 before a dcc chat, telnet, or relay connection times out.
263 %{help=set share-unlinks}%{+n}
264 ### %bset share-unlinks%b 0/1
265 This setting prohibits remote bots from telling your Eggdrop to
266 unlink from share bots.
267 %{help=set strict-host}%{+n}
268 ### %bset strict-host%b <0/1>
269 Specifies whether the bot should leave leading ~+-^= in users'
270 hostnames. If this is on, the bot will differentiate between
271 valid-ident usernames and invalid ones. This setting is currently
272 kept for compatibility, but will be removed from the next release.
273 Please leave it set to 1 for now to avoid problems with your user
274 files in the future.
275 %{help=set cidr-support}%{+n}
276 ### %bset cidr-support%b <0/1>
277 Enables cidr support for b/e/I modes if set to 1. This means the
278 bot will understand and match modes in cidr notation, and will
279 be able to put and enforce such bans or unban itself, if banned
280 with a cidr mask.
281 Warning: enabling this on servers which don't support cidr may
282 result in kick floods or other problems.
283 %{help=set allow-dk-cmds}%{+n}
284 ### %bset allow-dk-cmds%b <0/1>
285 Enable this setting if you want +d & +k users to use commands
286 bound as -|-.
287 %{help=set userfile-perm}%{+n}
288 ### %bset userfile-perm%b <octal value>
289 This specifies what permissions the user, channel, and notes
290 files should be set to. The octal values are the same as for
291 the chmod system command.

webmaster@eggheads.org
ViewVC Help
Powered by ViewVC 1.1.23