mirror of
https://github.com/unrealircd/unrealircd.git
synced 2026-07-03 06:53:13 +02:00
Docs update
This commit is contained in:
@@ -1991,3 +1991,4 @@ seen. gmtime warning still there
|
||||
- Updated some documentation
|
||||
- (Hopefully) fixed some Ziplinks problems
|
||||
- Added missing except tkl {} documentation
|
||||
- Documentation update and cleanup
|
||||
|
||||
+169
-158
@@ -11,6 +11,7 @@
|
||||
.block_optional { color: blue; font-weight: bold; }
|
||||
.block_old { font-size: 14; }
|
||||
.set { font-weight: bold; }
|
||||
.desc { margin-left: 15px; }
|
||||
pre { font: "times new roman"; font-style: normal;}
|
||||
</style>
|
||||
</head>
|
||||
@@ -20,7 +21,7 @@
|
||||
<font size="4"><a href="http://www.unrealircd.com">http://www.unrealircd.com</a></font><br>
|
||||
<font size="4">Version: 3.2</font><br>
|
||||
<b>Current Version:</b> 3.2 Beta15<br>
|
||||
<b>Last doc update:</b> 2003-03-20 </div>
|
||||
<b>Last doc update:</b> 2003-03-21 </div>
|
||||
<b>Head Coders:</b> Stskeeps / codemastr / Luke / McSkaf / Syzop<br>
|
||||
<b>Contributors:</b> Zogg / NiQuiL / assyrian / chasm / DrBin / llthangel / Griever / nighthawk<br>
|
||||
<b>Documentation:</b> CKnight^ / Syzop<br>
|
||||
@@ -82,7 +83,7 @@
|
||||
---4.26. <a href="#denychannelblock">Deny Channel Block -=- (chrestrict.conf)</a><br>
|
||||
---4.27. <a href="#allowchannelblock">Allow Channel Block</a><br>
|
||||
---4.28. <a href="#vhostblock">Vhost Block Block -=- (vhost.conf)</a><br>
|
||||
---4.29. <a href="#badwordsblock">Badwords Block -=- (badwords.conf)</a><br>
|
||||
---4.29. <a href="#badwordsblock">Badword Block -=- (badwords.conf)</a><br>
|
||||
---4.30. <a href="#ulinesblock">Uline Block -=- (U:Line)</a><br>
|
||||
---4.31. <a href="#linkblock">Link Block -=- (C/N/H:Lines)</a><br>
|
||||
---4.32. <a href="#aliasblock">Alias Block</a><br>
|
||||
@@ -93,7 +94,7 @@
|
||||
7. <a href="#faq">Frequently Asked Questions (FAQ)</a><br>
|
||||
</p>
|
||||
<p><b><font size="+2">1.0 –Introduction & Notes <a name="IntroductionNotes"></a></font></b><br>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>This document was written for exclusive use with UnrealIRCd. Use of this
|
||||
document with another software package, or distribution of this document with
|
||||
another software package is strictly prohibited without the written permission
|
||||
@@ -104,78 +105,88 @@
|
||||
at the <a href="#faq">FAQ</a> for common problems. If that didn't help you can
|
||||
ask for support at <a href="irc://irc.ircsystems.net/unreal-support">irc.ircsystems.net (port 6667) channel #unreal-support</a> (strict UnrealIRCd support, don't
|
||||
ask for help about services!). If you have a real bug (like a crash) then report it at
|
||||
<a href="http://bugs.unrealircd.org" TARGET="_blank">http://bugs.unrealircd.org</a>.</p>
|
||||
<a href="http://bugs.unrealircd.org" TARGET="_blank">http://bugs.unrealircd.org</a>.</p></div>
|
||||
|
||||
<p><font size="+2"><b>1.1 – Notes on upgrading/mixing 3.1.x -> 3.2 </b></font><a name="notesonolder"></a><br>
|
||||
</p>
|
||||
<div class="desc">
|
||||
<p>In case you are upgrading from Unreal3.1.x to Unreal3.2 you'll notice the whole config file has changed,
|
||||
you may find it hard at first, but once you've switched you'll find it much better!</p>
|
||||
<p>Also don't forget to read section 3 about features, altough you know already some of them which are in 3.1.x there are several new features too!</p>
|
||||
<p>It's best not to mix/link 3.1.x with 3.2, but if you really want to, you need at least 3.1.4, but 3.1.5.1 is strongly recommended.</p>
|
||||
<p>It's best not to mix/link 3.1.x with 3.2, but if you really want to, you need at least 3.1.4, but 3.1.5.1 is strongly recommended.</p></div>
|
||||
|
||||
<p><font size="+2"><b>1.2 – Notes on upgrading between 3.2 versions</b></font><a name="notesonupgrade"></a><br>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>The recommended way to upgrade is:<br>
|
||||
Linux:<br>
|
||||
- Rename your old UnrealIRCd directory (or otherwise you'll overwrite it in the next step)<br>
|
||||
- Extract the new UnrealIRCd version and run ./Config and make(*NIX).<br>
|
||||
- Copy your old configuration files to the new directory (unrealircd.conf, motd, rules, server.* [SSL certs], network file, etc)<br></p>
|
||||
<ul>
|
||||
<li>Rename your old UnrealIRCd directory (or otherwise you'll overwrite it in the next step)
|
||||
<li>Extract the new UnrealIRCd version and run ./Config and make(*NIX).
|
||||
<li>Copy your old configuration files to the new directory (unrealircd.conf, motd, rules, server.* [SSL certs], network file, etc)</p></ul>
|
||||
Windows:<br>
|
||||
- Copy all of your configuration files to a temporary location.<br>
|
||||
- Run the uninstaller for any previous versions of Unreal you have installed.<br>
|
||||
- Run the installer for the new version of Unreal.<br>
|
||||
- Copy your old configuration files to the new folder.<br>
|
||||
<ul>
|
||||
<li>Copy all of your configuration files to a temporary location.
|
||||
<li>Run the uninstaller for any previous versions of Unreal you have installed.
|
||||
<li>Run the installer for the new version of Unreal.
|
||||
<li>Copy your old configuration files to the new folder.
|
||||
</ul>
|
||||
<p>Please also check .RELEASE.NOTES and maybe even Changes to see what has been changed.
|
||||
If you notice any changes (or bugs) between version, BE SURE TO READ THOSE FILES FIRST before reporting it as a bug!.</p>
|
||||
If you notice any changes (or bugs) between version, BE SURE TO READ THOSE FILES FIRST before reporting it as a bug!.</p></div>
|
||||
|
||||
<p><font size="+2"><b>2.0 - Installation</b></font><a name="installation" id="installation"></a><br>
|
||||
<p><font size="+2"><b>2.0 - Installation</b></font><a name="installation" id="installation"></a><br><div class="desc">
|
||||
<br>
|
||||
<b>Tested & Supported Operating Systems:</b><br>
|
||||
*NIX versions:<br>
|
||||
Linux 2.2.x<br>
|
||||
Linux 2.4.x<br>
|
||||
FreeBSD 4.6-STABLE<br>
|
||||
FreeBSD 4.5-STABLE<br>
|
||||
Solaris 2.x<br>
|
||||
<br>
|
||||
SunOS is NOT supported<br>
|
||||
<br>
|
||||
<b>Windows version:</b><br>
|
||||
WindowsXP Home<br>
|
||||
WindowsXP Pro<br>
|
||||
Windows 2000 Pro<br>
|
||||
Windows 2000 Server<br>
|
||||
Windows 2000 Advanced Server<br>
|
||||
Windows 98<br>
|
||||
Windows Me<br>
|
||||
<ul>
|
||||
<li><b>*NIX versions:</b>
|
||||
<ul>
|
||||
<li>Linux 2.2.x
|
||||
<li>Linux 2.4.x
|
||||
<li>FreeBSD 4.6-STABLE
|
||||
<li>FreeBSD 4.5-STABLE
|
||||
<li>Solaris 2.x
|
||||
</ul>
|
||||
<li><b>Windows version:</b>
|
||||
<ul>
|
||||
<li>WindowsXP Home
|
||||
<li>WindowsXP Pro
|
||||
<li>Windows 2000 Pro
|
||||
<li>Windows 2000 Server
|
||||
<li>Windows 2000 Advanced Server
|
||||
<li>Windows 98
|
||||
<li>Windows Me
|
||||
</ul>
|
||||
</ul>
|
||||
<br>
|
||||
If you have Unreal3.2 working correctly under other operating systems, please
|
||||
send the details to <a href="mailto://docs@unrealircd.com">docs@unrealircd.com<br>
|
||||
</a> </p>
|
||||
<p><b>Installation Instructions</b><br>
|
||||
Linux:<br>
|
||||
1. gunzip -d Unreal3.2-beta13.tar.gz<br>
|
||||
2. tar xvf Unreal3.2-beta13.tar <br>
|
||||
3. cd Unreal3.2 <br>
|
||||
DO NOT EDIT MAKEFILE <br>
|
||||
4. ./Config<br>
|
||||
5. Answer these questions to the best of your knowledge. Generally if your not
|
||||
sure, the default will work just fine! <br>
|
||||
6. make<BR>
|
||||
7. Now create your unrealircd.conf and other configuration files, see section 4.<br>
|
||||
<ol>
|
||||
<li>gunzip -d Unreal3.2-beta13.tar.gz
|
||||
<li>tar xvf Unreal3.2-beta13.tar
|
||||
<li>cd Unreal3.2
|
||||
<li>./Config
|
||||
<li>Answer these questions to the best of your knowledge. Generally if your not
|
||||
sure, the default will work just fine!
|
||||
<li>make
|
||||
<li>Now create your unrealircd.conf and other configuration files, see section 4.
|
||||
</ol>
|
||||
<p>
|
||||
Windows:<br>
|
||||
1. Run the Unreal installer<br>
|
||||
2. Now create your unrealircd.conf and other configuration files, see section 4.<br>
|
||||
<ol>
|
||||
<li>Run the Unreal installer
|
||||
<li>Now create your unrealircd.conf and other configuration files, see section 4.
|
||||
</ol>
|
||||
</p>
|
||||
<p> </p>
|
||||
<p> </p></div>
|
||||
<p><font size="+2"><b>3.0 - Features</b></font>
|
||||
<a name="features"></a> </p>
|
||||
<a name="features"></a></p><div class="desc">
|
||||
<p>Some major/nice features are explained in this section. It provides a general overview,
|
||||
and sometimes refers to the config file (something which you might know nothing about yet).</p>
|
||||
<p>You can skip this section, however it's suggested to read it before/after installing.</p>
|
||||
<p>You can skip this section, however it's suggested to read it before/after installing.</p></div>
|
||||
|
||||
<p><font size="+2"><b>3.1 - Cloaking</b></font><a name="feature_cloaking"></a></p>
|
||||
<p><font size="+2"><b>3.1 - Cloaking</b></font><a name="feature_cloaking"></a></p><div class="desc">
|
||||
<p>Cloaking is a way to hide the real hostname of users, for example if your real host is <i>d5142341.cable.wanadoo.nl</i>,
|
||||
it will be shown (in join, part, whois, etc) as <i>rox-2DCA3201.cable.wanadoo.nl</i>.
|
||||
This feature is useful to prevent users flooding each other since they can't see the real host/IP.</p>
|
||||
@@ -185,25 +196,25 @@ Windows:<br>
|
||||
to set those 3 keys in your config file, they should be 3 random numbers between 10,000 and 4,294,967,295.
|
||||
If someone else knows these keys they can decode the cloaked host and discover the real one, that's why you
|
||||
have to keep them secret. The cloak keys must be the same on all servers on the network.</p>
|
||||
|
||||
<p><font size="+2"><b>3.2 - Modules</b></font><a name="feature_modules"></a></p>
|
||||
</div>
|
||||
<p><font size="+2"><b>3.2 - Modules</b></font><a name="feature_modules"></a></p><div class="desc">
|
||||
<p>UnrealIRCd supports modules (except under windows) which is nice because:<br>
|
||||
- You can decide not to load them (ex: not load the scanner module) and they won't use any memory/CPU<br>
|
||||
- You can load/reload/unload them while the ircd is running (by /rehash). This allows some bugs to be fixed or new features to be added without requiring a restart.<br>
|
||||
- Other people can create modules as well with new commands or usermodes for example.<br>
|
||||
UnrealIRCd only comes with a few modules, take a look at www.unrealircd.com -> modules
|
||||
or use google to find 3rd party modules.</p>
|
||||
<p>Note that you need to load at least the commands module!</p>
|
||||
<p>Note that you need to load at least the commands module!</p></div>
|
||||
|
||||
<p><font size="+2"><b>3.3 - Proxy scanner</b></font><a name="feature_scanner"></a></p>
|
||||
<p><font size="+2"><b>3.3 - Proxy scanner</b></font><a name="feature_scanner"></a></p><div class="desc">
|
||||
<p>UnrealIRCd comes with proxy scanner modules: if a user connects it will check on some ports to see
|
||||
if the user is using an anonymous proxy. There's 1 main scanner module (scan.so) and two
|
||||
modules which do the actual scanning: scan_socks and scan_http.</p>
|
||||
<p>This module is not required, but often useful. If you load them, you need a set::scan block.</p>
|
||||
<p>You can also use a separate proxy scanner program like <A HREF="http://www.blitzed.org/bopm/" TARGET="_blank">BOPM</A>,
|
||||
in that case you should disable UnrealIRCd's own proxy scanner.</p>
|
||||
in that case you should disable UnrealIRCd's own proxy scanner.</p></div>
|
||||
|
||||
<p><font size="+2"><b>3.4 - Snomasks</b></font><a name="feature_snomasks"></a></p>
|
||||
<p><font size="+2"><b>3.4 - Snomasks</b></font><a name="feature_snomasks"></a></p><div class="desc">
|
||||
<p>Snomasks are server notice masks, it's a special type of usermode that controls which
|
||||
server notices you will receive (mostly used by opers)</p>
|
||||
<p>It can be set by: /mode yournick +s SNOMASK, for example: /mode yournick +s +cF<br>
|
||||
@@ -222,34 +233,34 @@ Windows:<br>
|
||||
q - deny nick (Q:line) rejection notices<br>
|
||||
</p>
|
||||
<p>You can control which snomasks you automatically get (set::snomask-on-connect) and which you get
|
||||
on oper (set::snomask-on-oper, set::oper::snomask)</p>
|
||||
on oper (set::snomask-on-oper, set::oper::snomask)</p></div>
|
||||
|
||||
<p><font size="+2"><b>3.5 - Aliases</b></font><a name="feature_aliases"></a></p>
|
||||
<p><font size="+2"><b>3.5 - Aliases</b></font><a name="feature_aliases"></a></p><div class="desc">
|
||||
<p>With aliases you can configure serverside alias commands.
|
||||
You can for example let "/ns identify blah" be forwarded to nickserv (it will be
|
||||
translated to: privmsg nickserv identify blah).</p>
|
||||
<p>Aliases are configured by alias blocks in the configuration file, and you can also include
|
||||
a file with default aliases for most commonly used services.</p>
|
||||
a file with default aliases for most commonly used services.</p></div>
|
||||
|
||||
<p><font size="+2"><b>3.6 - Helpop</b></font><a name="feature_helpop"></a></p>
|
||||
<p><font size="+2"><b>3.6 - Helpop</b></font><a name="feature_helpop"></a></p><div class="desc">
|
||||
<p>UnrealIRCd has a built-in help system accessable by /helpop. The /helpop command is completely user configurable via
|
||||
the help block in the configuration file. Additionally, a help.conf is included which contains some basic help for
|
||||
all commands.<br>
|
||||
For example <i>/helpop chmodes</i> gives you a overview of all channel modes UnrealIRCd has.<br>
|
||||
Remember that if you are an ircop (helpop) you will have to prefix the keyword with a '?' character,
|
||||
so <i>/helpop</i> becomes <i>/helpop ?</i> and
|
||||
<i>/helpop chmodes</i> becomes <i>/helpop ?chmodes</i> etc..</p>
|
||||
<i>/helpop chmodes</i> becomes <i>/helpop ?chmodes</i> etc..</p></div>
|
||||
|
||||
<p><font size="+2"><b>3.7 - Oper access levels</b></font><a name="feature_operaccesslevels"></a></p>
|
||||
<p><font size="+2"><b>3.7 - Oper access levels</b></font><a name="feature_operaccesslevels"></a></p><div class="desc">
|
||||
<p>There are several oper levels in UnrealIRCd and you can add additional rights (like to use /gline) to
|
||||
each of them, that way you can give each oper the privileges they need.</p>
|
||||
<p>This is controlled by the oper flags in the oper block, see the oper block for more information.</p>
|
||||
<p>This is controlled by the oper flags in the oper block, see the oper block for more information.</p></div>
|
||||
|
||||
<p><font size="+2"><b>3.8 - Oper commands</b></font><a name="feature_opercmds"></a></p>
|
||||
<p><font size="+2"><b>3.8 - Oper commands</b></font><a name="feature_opercmds"></a></p><div class="desc">
|
||||
<p>UnrealIRCd has a lot of powerful oper commands which are explained in section 6,
|
||||
you probably want to read those after installing :).</p>
|
||||
you probably want to read those after installing :).</p></div>
|
||||
|
||||
<p><font size="+2"><b>3.9 - SSL</b></font><a name="feature_ssl"></a></p>
|
||||
<p><font size="+2"><b>3.9 - SSL</b></font><a name="feature_ssl"></a></p><div class="desc">
|
||||
<p>SSL stands for Secure Socket Layer, with SSL you can make secure encrypted connections.
|
||||
It can be used to encrypt server<->server traffic, but client<->server traffic can also be encrypted.
|
||||
You usually use SSL to protect against sniffing and for authentication.</p>
|
||||
@@ -268,31 +279,31 @@ Windows:<br>
|
||||
If you then connect to 127.0.0.1 port 6667, your traffic will be encrypted and forwarded to irc.myserv.com
|
||||
port 6900 (an SSL port).</p>
|
||||
<p>If you are really concerned about security/sniffing then you also need to validate certificates on the client end.
|
||||
That's however way too off topic to explain here. Learn about SSL, don't ask us, it has nothing to do with UnrealIRCd.</p>
|
||||
<p><font size="+2"><b>3.10 - IPv6</b></font><a name="feature_ipv6"></a></p>
|
||||
That's however way too off topic to explain here. Learn about SSL, don't ask us, it has nothing to do with UnrealIRCd.</p></div>
|
||||
<p><font size="+2"><b>3.10 - IPv6</b></font><a name="feature_ipv6"></a></p><div class="desc">
|
||||
<p>UnrealIRCd supports IPv6, since beta15 it seems to work well although there might be some
|
||||
bugs in it. You need to compile with IPv6 support (answer yes to the ./Config question), ofcourse your
|
||||
OS needs to have IPv6 support enabled too.</p>
|
||||
<p>Although microsoft has an experimental IPv6 implementation for w2k/XP it is not (yet) supported by UnrealIRCd.</p>
|
||||
<p>Although microsoft has an experimental IPv6 implementation for w2k/XP it is not (yet) supported by UnrealIRCd.</p></div>
|
||||
|
||||
<p><font size="+2"><b>3.11 - Zip links</b></font><a name="feature_ziplinks"></a></p>
|
||||
<p><font size="+2"><b>3.11 - Zip links</b></font><a name="feature_ziplinks"></a></p><div class="desc">
|
||||
<p>Zip links can be turned on for server<->server links, it compresses the data by using zlib.
|
||||
It can save 60-80% bandwidth... So it's quite useful for low-bandwidth links or links with
|
||||
many users, it can help a lot when you are linking since a lot of data is sent about every user/channel/etc.</p>
|
||||
<p>To compile with zip links support, you need to answer Yes to the zlib question in ./Config and set it in link::options::zip</p>
|
||||
<p>To compile with zip links support, you need to answer Yes to the zlib question in ./Config and set it in link::options::zip</p></div>
|
||||
|
||||
<p><font size="+2"><b>3.12 - Other stuff</b></font><a name="feature_other"></a></p>
|
||||
<p>UnrealIRCd has a lot of features so not everything is covered here... You'll find that out by yourself.</p>
|
||||
<p><font size="+2"><b>3.12 - Other stuff</b></font><a name="feature_other"></a></p><div class="desc">
|
||||
<p>UnrealIRCd has a lot of features so not everything is covered here... You'll find that out by yourself.</p></div>
|
||||
|
||||
<p> </p>
|
||||
<p><font size="+2"><b>4.0 - Configuring your unrealircd.conf</b></font>
|
||||
<a name="configuringyourunrealircdconf"></a> </p>
|
||||
<a name="configuringyourunrealircdconf"></a></p><div class="desc">
|
||||
<p>First of all, creating a good unrealircd.conf will take some time, probably
|
||||
something like 10 - 60m. You can try to get it booted up as quickly as you can and
|
||||
tweak later, or you can learn the major sections directly step-by-step which is
|
||||
the recommended method ;P. If you have any problems, check your syntax, check the manual
|
||||
and check the FAQ before asking for help/reporting a bug.</p>
|
||||
<p><b><font size="+2">4.1 Configuration File Explained</font></b><a name="configurationfileexplained"></a><br>
|
||||
and check the FAQ before asking for help/reporting a bug.</p></div>
|
||||
<p><b><font size="+2">4.1 Configuration File Explained</font></b><a name="configurationfileexplained"></a><br><div class="desc">
|
||||
</p>
|
||||
<p>The new system uses a block-based system. Each entry, or block, in the new
|
||||
format has a specific format. The format works like:</p>
|
||||
@@ -333,9 +344,9 @@ Windows:<br>
|
||||
<p>Now that you know how it works, create your unrealircd.conf from scratch or
|
||||
copy doc/example.conf and start editting. It's recommended to walk step by step
|
||||
trough all block types and use this manual as a reference.</p>
|
||||
<p> </p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.2 - </font><font class="block_name">Me Block</font>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the M:Line)</font><a name="meblock"></a>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the M:Line)</font><a name="meblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -356,10 +367,10 @@ me {
|
||||
info "FooNet Server";
|
||||
numeric 1;
|
||||
};
|
||||
</pre></p>
|
||||
</pre></p></div>
|
||||
<p></p>
|
||||
<p><font class="block_section">4.3 - </font><font class="block_name">Admin Block</font>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the A:Line)</font><a name="adminblock"></a>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the A:Line)</font><a name="adminblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -381,10 +392,10 @@ admin {
|
||||
"bob";
|
||||
"widely@used.name";
|
||||
};
|
||||
</pre></p>
|
||||
</pre></p></div>
|
||||
<p></p>
|
||||
<p><font class="block_section">4.4 - </font><font class="block_name">Class Block</font>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the Y:Line)</font><a name="classblock"></a>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the Y:Line)</font><a name="classblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -423,9 +434,9 @@ class servers{
|
||||
connfreq 100; /* How many seconds between each connection attempt */
|
||||
};
|
||||
</pre></p>
|
||||
<p> </p>
|
||||
<p> </p></div>
|
||||
<p><font class="block_section">4.5 - </font><font class="block_name">Allow Block</font>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the I:Line)</font><a name="allowblock"></a>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the I:Line)</font><a name="allowblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -485,10 +496,10 @@ allow {
|
||||
password "f00Ness";
|
||||
maxperip 1;
|
||||
};
|
||||
</pre></p>
|
||||
</pre></p></div>
|
||||
<p> </p>
|
||||
<p><font class="block_section">4.6 - </font><font class="block_name">Listen Block</font>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the P:Line)</font><a name="listenblock"></a>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the P:Line)</font><a name="listenblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -534,9 +545,9 @@ listen *:6601 {
|
||||
</pre></p>
|
||||
<p>Or if there are no options:</p>
|
||||
<p>listen *:8067;<br>
|
||||
listen *:6667;</p>
|
||||
listen *:6667;</p></div>
|
||||
<p><font class="block_section">4.7 - </font><font class="block_name">Oper Block</font>
|
||||
<font class="block_recommended">RECOMMENDED</font> <font class="block_old">(Previously known as the O:Line)</font><a name="operblock"></a>
|
||||
<font class="block_recommended">RECOMMENDED</font> <font class="block_old">(Previously known as the O:Line)</font><a name="operblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>
|
||||
<pre>oper <name> {
|
||||
@@ -873,9 +884,9 @@ oper bobsmith {
|
||||
snomask frebWqFv;
|
||||
};
|
||||
</pre></p>
|
||||
<p> </p>
|
||||
<p> </p></div>
|
||||
<p><font class="block_section">4.8 - </font><font class="block_name">DRpass Block</font>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the X:Line)</font><a name="drpassblock"></a>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as the X:Line)</font><a name="drpassblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -894,8 +905,8 @@ drpass {
|
||||
die "die-you-stupid";
|
||||
};
|
||||
</pre></p>
|
||||
<p> </p>
|
||||
<p><font class="block_section">4.9 - </font><font class="block_name">Include Directive</font><a name="includedirective"></a>
|
||||
<p> </p></div>
|
||||
<p><font class="block_section">4.9 - </font><font class="block_name">Include Directive</font><a name="includedirective"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
include <file-name>;</p>
|
||||
@@ -913,16 +924,19 @@ drpass {
|
||||
<pre>include aliases/ircservices.conf</pre></p>
|
||||
<p>Another example is to use it for including alias blocks, UnrealIRCd comes with
|
||||
some files which (should) contain the right aliases for most services:<br>
|
||||
aliases/ircservices.conf (IRCServices, Daylight)<br>
|
||||
aliases/epona.conf (Epona)<br>
|
||||
aliases/auspice.conf (Auspice)<Br>
|
||||
aliases/generic.conf (Magick, Sirius, Wrecked)<br>
|
||||
aliases/operstats.conf (OperStats)<br>
|
||||
aliases/genericstats.conf (GeoStats, NeoStats)<br>
|
||||
<ul>
|
||||
<li>aliases/ircservices.conf (IRCServices, Daylight)
|
||||
<li>aliases/epona.conf (Epona)
|
||||
<li>aliases/auspice.conf (Auspice)
|
||||
<li>aliases/generic.conf (Magick, Sirius, Wrecked)
|
||||
<li>aliases/cygnus.conf (Cygnus)
|
||||
<li>aliases/operstats.conf (OperStats)
|
||||
<li>aliases/genericstats.conf (GeoStats, NeoStats)
|
||||
</ul>
|
||||
</p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.10 - </font><font class="block_name">LoadModule Directive</font>
|
||||
<font class="block_required">REQUIRED</font><a name="loadmoduledirective"></a>
|
||||
<font class="block_required">REQUIRED</font><a name="loadmoduledirective"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
loadmodule <file-name>;</p>
|
||||
@@ -939,9 +953,9 @@ loadmodule "src/modules/commands.so";
|
||||
loadmodule "src/modules/scan.so";
|
||||
loadmodule "src/modules/scan_socks.so";
|
||||
loadmodule "src/modules/scan_http.so";
|
||||
</pre>
|
||||
</pre></div>
|
||||
<p><font class="block_section">4.11 - </font><font class="block_name">Log Block</font>
|
||||
<font class="block_optional">OPTIONAL</font><a name="logblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font><a name="logblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -984,9 +998,9 @@ log ircd.log {
|
||||
};
|
||||
};
|
||||
</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.12 - </font><font class="block_name">TLD Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the T:Line)</font><a name="tldblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the T:Line)</font><a name="tldblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1010,9 +1024,9 @@ tld {
|
||||
motd "ircd.motd.fr";
|
||||
rules "ircd.rules.fr";
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.13 - </font><font class="block_name">Ban Nick Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the Q:Line)</font><a name="bannickblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the Q:Line)</font><a name="bannickblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1030,9 +1044,9 @@ ban nick {
|
||||
mask "*C*h*a*n*S*e*r*v*";
|
||||
reason "Reserved for Services";
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.14 - </font><font class="block_name">Ban User Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the K:Line)</font><a name="banuserblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the K:Line)</font><a name="banuserblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1050,9 +1064,9 @@ ban user {
|
||||
mask *tirc@*.saturn.bbn.com;
|
||||
reason "Idiot";
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.15 - </font><font class="block_name">Ban IP Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the Z:Line)</font><a name="banipblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the Z:Line)</font><a name="banipblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1070,9 +1084,9 @@ ban ip {
|
||||
mask 192.168.1.*;
|
||||
reason "Get a real ip u lamer!";
|
||||
};</pre></p>
|
||||
<p> </p>
|
||||
<p> </p></div>
|
||||
<p><font class="block_section">4.16 - </font><font class="block_name">Ban Server Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the q:Line)</font><a name="banserverblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the q:Line)</font><a name="banserverblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1089,9 +1103,9 @@ ban server {
|
||||
mask broken.server.my.network.com;
|
||||
reason "Its broken!";
|
||||
};</pre></p>
|
||||
<p> </p>
|
||||
<p> </p></div>
|
||||
<p><font class="block_section">4.17 - </font><font class="block_name">Ban RealName Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the n:Line)</font><a name="banrealnameblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the n:Line)</font><a name="banrealnameblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1110,9 +1124,9 @@ ban realname {
|
||||
mask "Bob*";
|
||||
reason "Bob sucks!";
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.18 - </font><font class="block_name">Ban Version Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <a name="banversionblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <a name="banversionblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1130,9 +1144,9 @@ ban version {
|
||||
mask "*SomeLameScript*";
|
||||
reason "SomeLameScript contains backdoors";
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.19 - </font><font class="block_name">Ban Exceptions Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the E:Line)</font><a name="banexceptionblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the E:Line)</font><a name="banexceptionblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1148,9 +1162,9 @@ except ban {
|
||||
except ban {
|
||||
mask myident@my.isp.com;
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.20 - </font><font class="block_name">TKL Exceptions Block</font>
|
||||
<font class="block_optional">OPTIONAL</font><a name="tklexceptionblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font><a name="tklexceptionblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1171,9 +1185,9 @@ except tkl {
|
||||
mask myident@my.isp.com;
|
||||
type gline;
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.21 - </font><font class="block_name">Scan Exceptions Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the e:Line)</font><a name="scanexceptionblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the e:Line)</font><a name="scanexceptionblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1189,10 +1203,10 @@ except scan {
|
||||
except scan {
|
||||
mask 192.168.1.*;
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.22 - </font><font class="block_name">Throttle Exceptions Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <a name="throttleexceptionblock"></a>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
except throttle {
|
||||
@@ -1206,10 +1220,10 @@ except throttle {
|
||||
except throtte {
|
||||
mask 192.168.1.*;
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.23 - </font><font class="block_name">Deny DCC Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as dccdeny.conf)</font><a name="denydccblock"></a>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
deny dcc {
|
||||
@@ -1226,10 +1240,10 @@ deny dcc {
|
||||
deny dcc {
|
||||
filename virus.exe;
|
||||
reason "This is a GD Virus";
|
||||
};</pre></p>
|
||||
};</pre></p></div>
|
||||
<p></p>
|
||||
<p><font class="block_section">4.24 - </font><font class="block_name">Deny Version Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the V:Line)</font><a name="denyversionblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the V:Line)</font><a name="denyversionblock"></a><div class="desc">
|
||||
</p>
|
||||
<p> Syntax:<br>
|
||||
<pre>
|
||||
@@ -1254,9 +1268,9 @@ deny version {
|
||||
if a character is prefixed by a ! then it means the server may not have this
|
||||
flag compiled into it, if it does not have a ! prefix, then it means the server
|
||||
must have this flag compiled.</p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.25 - </font><font class="block_name">Deny Link Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the D/d:Line)</font><a name="denylinkblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the D/d:Line)</font><a name="denylinkblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1281,10 +1295,10 @@ deny link {
|
||||
to true, then the link is denied. The deny::type allows two different values,
|
||||
auto (only applies to autoconnects, /connect will still work), and all (applies
|
||||
to all connection attempts).</p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.26 - </font><font class="block_name">Deny Channel Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as chrestrict.conf)</font><a name="denychannelblock"></a>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
deny channel {
|
||||
@@ -1302,10 +1316,10 @@ deny channel {
|
||||
channel "#unrealsucks";
|
||||
reason "No it don't!";
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.27 - </font><font class="block_name">Allow Channel Block</font>
|
||||
<font class="block_optional">OPTIONAL</font><a name="allowchannelblock"></a>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
allow channel {
|
||||
@@ -1319,10 +1333,10 @@ allow channel {
|
||||
allow channel {
|
||||
channel "#something";
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.28 - </font><font class="block_name">Vhost Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as vhosts.conf)</font><a name="vhostblock"></a>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
vhost {
|
||||
@@ -1358,10 +1372,10 @@ vhost {
|
||||
password mypassword;
|
||||
swhois "Im Special";
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p><font class="block_section">4.29 - </font><font class="block_name">Bad Word Block</font>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.29 - </font><font class="block_name">Badword Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as badwords.*.conf)</font><a name="badwordsblock"></a>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
badword <type> {
|
||||
@@ -1381,9 +1395,9 @@ badword channel {
|
||||
word shit;
|
||||
replace shoot;
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.30 - </font><font class="block_name">ULines Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the U:Line)</font><a name="ulinesblock"></a>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as the U:Line)</font><a name="ulinesblock"></a><div class="desc">
|
||||
</p>
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
@@ -1402,10 +1416,10 @@ ulines {
|
||||
services.mynetwork.com;
|
||||
stats.mynetwork.com;
|
||||
};</pre></p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.31 - </font><font class="block_name">Link Block</font>
|
||||
<font class="block_optional">OPTIONAL</font> <font class="block_old">(Previously known as C/N/H:Lines)</font><a name="linkblock"></a>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
link <server-name> {
|
||||
@@ -1500,11 +1514,10 @@ link hub.mynet.com {
|
||||
zip;
|
||||
};
|
||||
};</pre></p>
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
<p> </p></div>
|
||||
<p><font class="block_section">4.32 - </font><font class="block_name">Alias Block</font>
|
||||
<font class="block_optional">OPTIONAL</font><a name="aliasblock"></a>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>Syntax [standard alias]:<br>
|
||||
<pre>
|
||||
alias <name> {
|
||||
@@ -1548,10 +1561,10 @@ alias <name> {
|
||||
do % followed by the number and a -, for example %2- returns all parameters
|
||||
from the second till the last. For examples of using the alias block in the
|
||||
command format, consult doc/example.conf.</p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.33 - </font><font class="block_name">Help Block</font>
|
||||
<font class="block_optional">OPTIONAL</font><a name="helpblock"></a>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>Syntax:<br>
|
||||
<pre>
|
||||
help <name> {
|
||||
@@ -1565,10 +1578,10 @@ help <name> {
|
||||
left out, then it will be used when no parameter is passed to /helpop. The entries
|
||||
for the help block are the text that will be displayed to the user when requesting
|
||||
the /helpop.</p>
|
||||
<p></p>
|
||||
<p></p></div>
|
||||
<p><font class="block_section">4.34 - </font><font class="block_name">Set Block</font>
|
||||
<font class="block_required">REQUIRED</font> <font class="block_old">(Previously known as unrealircd.conf/networks file)</font><a name="setblock"></a>
|
||||
</p>
|
||||
</p><div class="desc">
|
||||
<p>The set file is what use to be our networks/unrealircd.conf and our networks
|
||||
file. On single server networks, rather than have 3 files, on single server
|
||||
networks, you can just include the set statements in the unrealircd.conf, on
|
||||
@@ -1760,9 +1773,9 @@ Set {
|
||||
<p><font class="set">set::anti-flood::unknown-flood-amount {amount}</font><br>
|
||||
Specifies the amount of data (in KiloBytes) that the unknown connection must send
|
||||
in order for the user to be killed.</p>
|
||||
<p></p>
|
||||
<p></p> </div>
|
||||
<p><b><font size="+2">5 – User & Channel Modes<a name="userchannelmodes"></a>
|
||||
</font></b></p>
|
||||
</font></b></p><div class="desc">
|
||||
<table width="83%" border="1">
|
||||
<tr>
|
||||
<td><div align="center"><b>Mode</b></div></td>
|
||||
@@ -1804,7 +1817,7 @@ Set {
|
||||
</tr>
|
||||
<tr>
|
||||
<td><div align="center">G</div></td>
|
||||
<td>Makes channel G rated. Checks for words listed in the Bad Word Blocks,
|
||||
<td>Makes channel G rated. Checks for words listed in the Badword Blocks,
|
||||
and replaces them with the words specified</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -2006,8 +2019,8 @@ Set {
|
||||
<td>Lets you see when people do a /whois on you (IRCops Only)</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p> </p>
|
||||
<p><font size="+2"><b>6 – User & Oper Commands Table<a name="useropercommands" id="useropercommands"></a></b></font></p>
|
||||
<p></p></div>
|
||||
<p><font size="+2"><b>6 – User & Oper Commands Table<a name="useropercommands" id="useropercommands"></a></b></font></p><div class="desc">
|
||||
<p>NOTE: the /helpop documentation is more up to date, use <i>/helpop command</i> (or <i>/helpop ?command</i> if you are oper)
|
||||
to get more information on a command.</p>
|
||||
|
||||
@@ -2518,15 +2531,13 @@ to get more information on a command.</p>
|
||||
<td height="36">module<br></td>
|
||||
<td>
|
||||
Lists all loaded modules
|
||||
<td>IRCop/All</td>
|
||||
<td>Admin</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p> </p>
|
||||
<p></p></div>
|
||||
<p><font size="+2"><b>7 – Frequently Asked Questions (FAQ)<a name="faq"></a></b></font></p>
|
||||
<p>The FAQ is available online <a href="http://www.vulnscan.org/UnrealIrcd/faq/" TARGET="_blank">here</a></p>
|
||||
|
||||
<p> </p>
|
||||
<p> </p>
|
||||
<div class="desc"><p>The FAQ is available online <a href="http://www.vulnscan.org/UnrealIrcd/faq/" TARGET="_blank">here</a></p></div>
|
||||
<p></p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user