From fe1dcfb6c2eeaa8258d1597e8f337d7e007f4d5c Mon Sep 17 00:00:00 2001 From: codemastr Date: Fri, 21 Mar 2003 17:23:55 +0000 Subject: [PATCH] Docs update --- Changes | 1 + doc/unreal32docs.html | 327 ++++++++++++++++++++++-------------------- 2 files changed, 170 insertions(+), 158 deletions(-) diff --git a/Changes b/Changes index ab631cd35..67a4876bc 100644 --- a/Changes +++ b/Changes @@ -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 diff --git a/doc/unreal32docs.html b/doc/unreal32docs.html index 0796ab0f5..96eb88661 100644 --- a/doc/unreal32docs.html +++ b/doc/unreal32docs.html @@ -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;} @@ -20,7 +21,7 @@ http://www.unrealircd.com
Version: 3.2
Current Version: 3.2 Beta15
- Last doc update: 2003-03-20 + Last doc update: 2003-03-21 Head Coders: Stskeeps / codemastr / Luke / McSkaf / Syzop
Contributors: Zogg / NiQuiL / assyrian / chasm / DrBin / llthangel / Griever / nighthawk
Documentation: CKnight^ / Syzop
@@ -82,7 +83,7 @@ ---4.26. Deny Channel Block -=- (chrestrict.conf)
---4.27. Allow Channel Block
---4.28. Vhost Block Block -=- (vhost.conf)
- ---4.29. Badwords Block -=- (badwords.conf)
+ ---4.29. Badword Block -=- (badwords.conf)
---4.30. Uline Block -=- (U:Line)
---4.31. Link Block -=- (C/N/H:Lines)
---4.32. Alias Block
@@ -93,7 +94,7 @@ 7. Frequently Asked Questions (FAQ)

1.0 –Introduction & Notes
-

+

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 FAQ for common problems. If that didn't help you can ask for support at irc.ircsystems.net (port 6667) channel #unreal-support (strict UnrealIRCd support, don't ask for help about services!). If you have a real bug (like a crash) then report it at - http://bugs.unrealircd.org.

+ http://bugs.unrealircd.org.

1.1 – Notes on upgrading/mixing 3.1.x -> 3.2

+

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!

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!

-

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.

+

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.

1.2 – Notes on upgrading between 3.2 versions
-

+

The recommended way to upgrade is:
Linux:
- - Rename your old UnrealIRCd directory (or otherwise you'll overwrite it in the next step)
- - Extract the new UnrealIRCd version and run ./Config and make(*NIX).
- - Copy your old configuration files to the new directory (unrealircd.conf, motd, rules, server.* [SSL certs], network file, etc)

+ Windows:
- - Copy all of your configuration files to a temporary location.
- - Run the uninstaller for any previous versions of Unreal you have installed.
- - Run the installer for the new version of Unreal.
- - Copy your old configuration files to the new folder.
+

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!.

+ If you notice any changes (or bugs) between version, BE SURE TO READ THOSE FILES FIRST before reporting it as a bug!.

-

2.0 - Installation
+

2.0 - Installation


Tested & Supported Operating Systems:
- *NIX versions:
- Linux 2.2.x
- Linux 2.4.x
- FreeBSD 4.6-STABLE
- FreeBSD 4.5-STABLE
- Solaris 2.x
-
- SunOS is NOT supported
-
- Windows version:
- WindowsXP Home
- WindowsXP Pro
- Windows 2000 Pro
- Windows 2000 Server
- Windows 2000 Advanced Server
- Windows 98
- Windows Me
+
If you have Unreal3.2 working correctly under other operating systems, please send the details to docs@unrealircd.com

Installation Instructions
Linux:
- 1. gunzip -d Unreal3.2-beta13.tar.gz
- 2. tar xvf Unreal3.2-beta13.tar
- 3. cd Unreal3.2
- DO NOT EDIT MAKEFILE
- 4. ./Config
- 5. Answer these questions to the best of your knowledge. Generally if your not - sure, the default will work just fine!
- 6. make
- 7. Now create your unrealircd.conf and other configuration files, see section 4.
+

    +
  1. gunzip -d Unreal3.2-beta13.tar.gz +
  2. tar xvf Unreal3.2-beta13.tar +
  3. cd Unreal3.2 +
  4. ./Config +
  5. Answer these questions to the best of your knowledge. Generally if your not + sure, the default will work just fine! +
  6. make +
  7. Now create your unrealircd.conf and other configuration files, see section 4. +

Windows:
- 1. Run the Unreal installer
- 2. Now create your unrealircd.conf and other configuration files, see section 4.
+

    +
  1. Run the Unreal installer +
  2. Now create your unrealircd.conf and other configuration files, see section 4. +

-

+

3.0 - Features -

+

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).

-

You can skip this section, however it's suggested to read it before/after installing.

+

You can skip this section, however it's suggested to read it before/after installing.

-

3.1 - Cloaking

+

3.1 - Cloaking

Cloaking is a way to hide the real hostname of users, for example if your real host is d5142341.cable.wanadoo.nl, it will be shown (in join, part, whois, etc) as rox-2DCA3201.cable.wanadoo.nl. This feature is useful to prevent users flooding each other since they can't see the real host/IP.

@@ -185,25 +196,25 @@ Windows:
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.

- -

3.2 - Modules

+
+

3.2 - Modules

UnrealIRCd supports modules (except under windows) which is nice because:
- You can decide not to load them (ex: not load the scanner module) and they won't use any memory/CPU
- 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.
- Other people can create modules as well with new commands or usermodes for example.
UnrealIRCd only comes with a few modules, take a look at www.unrealircd.com -> modules or use google to find 3rd party modules.

-

Note that you need to load at least the commands module!

+

Note that you need to load at least the commands module!

-

3.3 - Proxy scanner

+

3.3 - Proxy scanner

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.

This module is not required, but often useful. If you load them, you need a set::scan block.

You can also use a separate proxy scanner program like BOPM, - in that case you should disable UnrealIRCd's own proxy scanner.

+ in that case you should disable UnrealIRCd's own proxy scanner.

-

3.4 - Snomasks

+

3.4 - Snomasks

Snomasks are server notice masks, it's a special type of usermode that controls which server notices you will receive (mostly used by opers)

It can be set by: /mode yournick +s SNOMASK, for example: /mode yournick +s +cF
@@ -222,34 +233,34 @@ Windows:
q - deny nick (Q:line) rejection notices

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)

+ on oper (set::snomask-on-oper, set::oper::snomask)

-

3.5 - Aliases

+

3.5 - Aliases

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).

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.

+ a file with default aliases for most commonly used services.

-

3.6 - Helpop

+

3.6 - Helpop

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.
For example /helpop chmodes gives you a overview of all channel modes UnrealIRCd has.
Remember that if you are an ircop (helpop) you will have to prefix the keyword with a '?' character, so /helpop becomes /helpop ? and - /helpop chmodes becomes /helpop ?chmodes etc..

+ /helpop chmodes becomes /helpop ?chmodes etc..

-

3.7 - Oper access levels

+

3.7 - Oper access levels

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.

-

This is controlled by the oper flags in the oper block, see the oper block for more information.

+

This is controlled by the oper flags in the oper block, see the oper block for more information.

-

3.8 - Oper commands

+

3.8 - Oper commands

UnrealIRCd has a lot of powerful oper commands which are explained in section 6, - you probably want to read those after installing :).

+ you probably want to read those after installing :).

-

3.9 - SSL

+

3.9 - SSL

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.

@@ -268,31 +279,31 @@ Windows:
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).

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.

-

3.10 - IPv6

+ That's however way too off topic to explain here. Learn about SSL, don't ask us, it has nothing to do with UnrealIRCd.

+

3.10 - IPv6

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.

-

Although microsoft has an experimental IPv6 implementation for w2k/XP it is not (yet) supported by UnrealIRCd.

+

Although microsoft has an experimental IPv6 implementation for w2k/XP it is not (yet) supported by UnrealIRCd.

-

3.11 - Zip links

+

3.11 - Zip links

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.

-

To compile with zip links support, you need to answer Yes to the zlib question in ./Config and set it in link::options::zip

+

To compile with zip links support, you need to answer Yes to the zlib question in ./Config and set it in link::options::zip

-

3.12 - Other stuff

-

UnrealIRCd has a lot of features so not everything is covered here... You'll find that out by yourself.

+

3.12 - Other stuff

+

UnrealIRCd has a lot of features so not everything is covered here... You'll find that out by yourself.

4.0 - Configuring your unrealircd.conf -

+

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.

-

4.1 Configuration File Explained
+ and check the FAQ before asking for help/reporting a bug.

+

4.1 Configuration File Explained

The new system uses a block-based system. Each entry, or block, in the new format has a specific format. The format works like:

@@ -333,9 +344,9 @@ Windows:

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.

-

+

4.2 - Me Block - REQUIRED (Previously known as the M:Line) + REQUIRED (Previously known as the M:Line)

Syntax:

@@ -356,10 +367,10 @@ me {
 	info "FooNet Server";
 	numeric 1;
 };
-

+

4.3 - Admin Block - REQUIRED (Previously known as the A:Line) + REQUIRED (Previously known as the A:Line)

Syntax:

@@ -381,10 +392,10 @@ admin {
 	"bob";
 	"widely@used.name";
 };
-

+

4.4 - Class Block - REQUIRED (Previously known as the Y:Line) + REQUIRED (Previously known as the Y:Line)

Syntax:

@@ -423,9 +434,9 @@ class servers{
 	connfreq 100; /* How many seconds between each connection attempt */
 };

-

+

4.5 - Allow Block - REQUIRED (Previously known as the I:Line) + REQUIRED (Previously known as the I:Line)

Syntax:

@@ -485,10 +496,10 @@ allow {
 	password "f00Ness";
 	maxperip 1;
 };
-

+

 

4.6 - Listen Block - REQUIRED (Previously known as the P:Line) + REQUIRED (Previously known as the P:Line)

Syntax:

@@ -534,9 +545,9 @@ listen *:6601 {

Or if there are no options:

listen *:8067;
- listen *:6667;

+ listen *:6667;

4.7 - Oper Block - RECOMMENDED (Previously known as the O:Line) + RECOMMENDED (Previously known as the O:Line)

oper <name> {
@@ -873,9 +884,9 @@ oper bobsmith {
 	snomask frebWqFv;
 };

-

+

4.8 - DRpass Block - REQUIRED (Previously known as the X:Line) + REQUIRED (Previously known as the X:Line)

Syntax:

@@ -894,8 +905,8 @@ drpass {
 	die "die-you-stupid";
 };

-

-

4.9 - Include Directive +

+

4.9 - Include Directive

Syntax:
include <file-name>;

@@ -913,16 +924,19 @@ drpass { 
include aliases/ircservices.conf

Another example is to use it for including alias blocks, UnrealIRCd comes with some files which (should) contain the right aliases for most services:
- aliases/ircservices.conf (IRCServices, Daylight)
- aliases/epona.conf (Epona)
- aliases/auspice.conf (Auspice)
- aliases/generic.conf (Magick, Sirius, Wrecked)
- aliases/operstats.conf (OperStats)
- aliases/genericstats.conf (GeoStats, NeoStats)
+

-

+

4.10 - LoadModule Directive - REQUIRED + REQUIRED

Syntax:
loadmodule <file-name>;

@@ -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"; - +

4.11 - Log Block - OPTIONAL + OPTIONAL

Syntax:

@@ -984,9 +998,9 @@ log ircd.log {
 	};
 };

-

+

4.12 - TLD Block - OPTIONAL (Previously known as the T:Line) + OPTIONAL (Previously known as the T:Line)

Syntax:

@@ -1010,9 +1024,9 @@ tld {
 	motd "ircd.motd.fr";
 	rules "ircd.rules.fr";
 };

-

+

4.13 - Ban Nick Block - OPTIONAL (Previously known as the Q:Line) + OPTIONAL (Previously known as the Q:Line)

Syntax:

@@ -1030,9 +1044,9 @@ ban nick {
 	mask "*C*h*a*n*S*e*r*v*";
 	reason "Reserved for Services";
 };

-

+

4.14 - Ban User Block - OPTIONAL (Previously known as the K:Line) + OPTIONAL (Previously known as the K:Line)

Syntax:

@@ -1050,9 +1064,9 @@ ban user {
 	mask *tirc@*.saturn.bbn.com;
 	reason "Idiot";
 };

-

+

4.15 - Ban IP Block - OPTIONAL (Previously known as the Z:Line) + OPTIONAL (Previously known as the Z:Line)

Syntax:

@@ -1070,9 +1084,9 @@ ban ip {
 	mask 192.168.1.*;
 	reason "Get a real ip u lamer!";
 };

-

+

4.16 - Ban Server Block - OPTIONAL (Previously known as the q:Line) + OPTIONAL (Previously known as the q:Line)

Syntax:

@@ -1089,9 +1103,9 @@ ban server {
 	mask broken.server.my.network.com;
 	reason "Its broken!";
 };

-

+

4.17 - Ban RealName Block - OPTIONAL (Previously known as the n:Line) + OPTIONAL (Previously known as the n:Line)

Syntax:

@@ -1110,9 +1124,9 @@ ban realname {
 	mask "Bob*";
 	reason "Bob sucks!";
 };

-

+

4.18 - Ban Version Block - OPTIONAL + OPTIONAL

Syntax:

@@ -1130,9 +1144,9 @@ ban version {
 	mask "*SomeLameScript*";
 	reason "SomeLameScript contains backdoors";
 };

-

+

4.19 - Ban Exceptions Block - OPTIONAL (Previously known as the E:Line) + OPTIONAL (Previously known as the E:Line)

Syntax:

@@ -1148,9 +1162,9 @@ except ban {
 except ban {
 	mask myident@my.isp.com;
 };

-

+

4.20 - TKL Exceptions Block - OPTIONAL + OPTIONAL

Syntax:

@@ -1171,9 +1185,9 @@ except tkl {
 	mask myident@my.isp.com;
 	type gline;
 };

-

+

4.21 - Scan Exceptions Block - OPTIONAL (Previously known as the e:Line) + OPTIONAL (Previously known as the e:Line)

Syntax:

@@ -1189,10 +1203,10 @@ except scan {
 except scan {
 	mask 192.168.1.*;
 };

-

+

4.22 - Throttle Exceptions Block OPTIONAL -

+

Syntax:

 except throttle {
@@ -1206,10 +1220,10 @@ except throttle {
 except throtte {
 	mask 192.168.1.*;
 };

-

+

4.23 - Deny DCC Block OPTIONAL (Previously known as dccdeny.conf) -

+

Syntax:

 deny dcc {
@@ -1226,10 +1240,10 @@ deny dcc {
 deny dcc {
 	filename virus.exe;
 	reason "This is a GD Virus";
-};

+};

4.24 - Deny Version Block - OPTIONAL (Previously known as the V:Line) + OPTIONAL (Previously known as the V:Line)

Syntax:

@@ -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.

-

+

4.25 - Deny Link Block - OPTIONAL (Previously known as the D/d:Line) + OPTIONAL (Previously known as the D/d:Line)

Syntax:

@@ -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).

-

+

4.26 - Deny Channel Block OPTIONAL (Previously known as chrestrict.conf) -

+

Syntax:

 deny channel {
@@ -1302,10 +1316,10 @@ deny channel {
 	channel "#unrealsucks";
 	reason "No it don't!";
 };

-

+

4.27 - Allow Channel Block OPTIONAL -

+

Syntax:

 allow channel {
@@ -1319,10 +1333,10 @@ allow channel {
 allow channel {
 	channel "#something";
 };

-

+

4.28 - Vhost Block OPTIONAL (Previously known as vhosts.conf) -

+

Syntax:

 vhost {
@@ -1358,10 +1372,10 @@ vhost {
 	password mypassword;
 	swhois "Im Special";
 };

-

-

4.29 - Bad Word Block +

+

4.29 - Badword Block OPTIONAL (Previously known as badwords.*.conf) -

+

Syntax:

 badword <type> {
@@ -1381,9 +1395,9 @@ badword channel {
 	word shit;
 	replace shoot;
 };

-

+

4.30 - ULines Block - OPTIONAL (Previously known as the U:Line) + OPTIONAL (Previously known as the U:Line)

Syntax:

@@ -1402,10 +1416,10 @@ ulines {
 	services.mynetwork.com;
 	stats.mynetwork.com;
 };

-

+

4.31 - Link Block OPTIONAL (Previously known as C/N/H:Lines) -

+

Syntax:

 link <server-name> {
@@ -1500,11 +1514,10 @@ link hub.mynet.com {
 		zip;
 	};
 };

-

-

+

4.32 - Alias Block OPTIONAL -

+

Syntax [standard alias]:

 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.

-

+

4.33 - Help Block OPTIONAL -

+

Syntax:

 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.

-

+

4.34 - Set Block REQUIRED (Previously known as unrealircd.conf/networks file) -

+

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 {

set::anti-flood::unknown-flood-amount {amount}
Specifies the amount of data (in KiloBytes) that the unknown connection must send in order for the user to be killed.

-

+

5 – User & Channel Modes -

+

@@ -1804,7 +1817,7 @@ Set { - @@ -2006,8 +2019,8 @@ Set {
Mode
G
Makes channel G rated. Checks for words listed in the Bad Word Blocks, + Makes channel G rated. Checks for words listed in the Badword Blocks, and replaces them with the words specified
Lets you see when people do a /whois on you (IRCops Only)
-

 

-

6 – User & Oper Commands Table

+

+

6 – User & Oper Commands Table

NOTE: the /helpop documentation is more up to date, use /helpop command (or /helpop ?command if you are oper) to get more information on a command.

@@ -2518,15 +2531,13 @@ to get more information on a command.

module
Lists all loaded modules - IRCop/All + Admin -

 

+

7 – Frequently Asked Questions (FAQ)

-

The FAQ is available online here

- -

 

-

 

+

The FAQ is available online here

+