From f6aa7cdcf60e61a2b950da871942c656150c3e98 Mon Sep 17 00:00:00 2001 From: cknight Date: Sun, 18 Aug 2002 21:33:45 +0000 Subject: [PATCH] - Removed ./Setup - No longer supported (read the docs!) - Removed .NEW_CONFIG - No longer needed - Removed INSTALL - Refer to NEW docs Unreal32docs.html - Removed doc/commands.txt - Refer to NEW docs Unreal32docs.html - Removed doc/faq - Refer to NEW docs Unreal32docs.html - Removed doc/conf.doc - Refer to NEW Docs Unreal32docs.html - Removed doc/unrealircd.doc - Refer to NEW docs Unreal32docs.html - Removed doc/Elite.Changes - Out Dated - Removed doc/services-install-guide - Refer to NEW docs Unreal32docs.html - Modfied Unreal.nfo to include ref. to new docs --- .NEW_CONFIG | 8 - Changes | 10 + INSTALL | 106 ---- Setup | 35 -- Unreal.nfo | 9 +- doc/Elite.Changes | 129 ----- doc/commands.txt | 334 ----------- doc/conf.doc | 1044 ---------------------------------- doc/services-install-guide | 82 --- doc/unrealircd.doc | 1105 ------------------------------------ 10 files changed, 17 insertions(+), 2845 deletions(-) delete mode 100644 .NEW_CONFIG delete mode 100644 INSTALL delete mode 100755 Setup delete mode 100644 doc/Elite.Changes delete mode 100644 doc/commands.txt delete mode 100644 doc/conf.doc delete mode 100644 doc/services-install-guide delete mode 100644 doc/unrealircd.doc diff --git a/.NEW_CONFIG b/.NEW_CONFIG deleted file mode 100644 index 84dfeb980..000000000 --- a/.NEW_CONFIG +++ /dev/null @@ -1,8 +0,0 @@ -|=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=| -| UnrealIRCD Custom Create Network Configuration| -|=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=| -| | -| This will not be too hard, just follow the | -| instructions, and answer the questions... | -| | -|=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=| diff --git a/Changes b/Changes index 3f72a617a..562971325 100644 --- a/Changes +++ b/Changes @@ -1486,3 +1486,13 @@ seen. gmtime warning still there - Added set::ssl::egd for Entropy Gathering Daemon support see doc/conf.doc or doc/example.conf for more information. - Updated credits +- Removed ./Setup - No longer supported (read the docs!) +- Removed .NEW_CONFIG - No longer needed +- Removed INSTALL - Refer to NEW docs Unreal32docs.html +- Removed doc/commands.txt - Refer to NEW docs Unreal32docs.html +- Removed doc/faq - Refer to NEW docs Unreal32docs.html +- Removed doc/conf.doc - Refer to NEW Docs Unreal32docs.html +- Removed doc/unrealircd.doc - Refer to NEW docs Unreal32docs.html +- Removed doc/Elite.Changes - Out Dated +- Removed doc/services-install-guide - Refer to NEW docs Unreal32docs.html +- Modfied Unreal.nfo to include ref. to new docs diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 3d4585ee8..000000000 --- a/INSTALL +++ /dev/null @@ -1,106 +0,0 @@ -############################################################################### -#### Unreal IRC Unix Daemon Installation Guide #### -#### UnrealIRCD ver 3.2 #### -#### coders@lists.unrealircd.org #### -#### http://www.unrealircd.com/ #### -############################################################################### -#### Unpackaging the IRCD #### -#### #### -#### 1) gzip -d Unreal3..tar.gz #### -#### #### -#### 2) tar xvf Unreal3..tar #### -#### #### -#### 3) cd Unreal3./ #### -############################################################################### -#### Compiling the IRCD #### -#### #### -#### 1) Supported Operating Systems #### -#### #### -#### OS and Version Compiler and Version Comments #### -#### --------------- ------------------------ ------------------------ #### -#### NetBSD 1.2B gcc 2.7.2 #### -#### FreeBSD 4.5-R gcc 2.95.3 #### -#### SunOS 4.1.4 gcc 2.7-96q1 (Cygnus) #### -#### Solaris 2.4 gcc 2.7-96q1 (Cygnus) (SunOS 5.4) #### -#### Solaris 2.5 SunWorks Pro C (SunOS 5.5.1) #### -#### cc: SC4.0 18 Oct 1995 C 4.0 #### -#### Digital Unix 3.2 gcc 2.7-96q3 (Cygnus) #### -#### Linux 2.0.24 gcc 2.7.2.1 #### -#### PUX 9.01 gcc 2.6.3 #### -#### HPUX 10.01 gcc 2.7-96q3 (Cygnus) #### -#### Linux PPC (iMac) #### -#### AmigaOS 3.0 GCC egcs-2.91.66 (compile with -D_AMIGA) #### -#### Windows NT/95 MSVC++ 4.0 #### -#### Linux Mandrake Read FAQ #### -#### Linux 2.3.x gcc 2.95.2 glibc 2.1.3 #### -#### #### -#### 2) DO NOT edit the MakeFile or any of the files to configure your #### -#### IRCd. The newest releases of Unreal only require you to run: #### -#### #### -#### ./Config #### -#### #### -#### #### -#### 3) When in ./Config put in the best answers to your knowledge. #### -#### This is all pretty self explanatory. We suggest, to avoid #### -#### problems later on, put the DPATH and SPATH as the default. #### -#### (When it asks where the config files and binarys will be). #### -#### Also, when it asks for max file connections, the default is #### -#### 1024, but above it you will see what your true limit is. #### -#### Please put the maxfd number in or else your IRCD will not #### -#### start at all and you will have to re-compile. #### -#### #### -#### 4) make #### -#### This will compile your server based on you settings chosen in #### -#### ./Config #### -#### #### -#### 4a) Hopefully, the server will compile without incident. If it #### -#### does not, and you are not able to determine the error, please #### -#### email supporters@lists.unrealircd.org and hopefully someone #### -#### will be able to help you. Another suggestion is going on IRC #### -#### /server irc.ircsystems.net #Unreal-support #### -#### #### -#### 4b) make install #### -#### #### -############################################################################### -#### Configuring the Server #### -#### #### -#### 1) ./makeconf #### -#### This will help you create an unrealircd.conf file for your ircd. #### -#### It walks you through the steps and makes the file for you. Note: #### -#### If you want to edit your unrealircd.conf you should only need #### -#### to: edit unrealircd.conf. If you ./makeconf again it will delete #### -#### the old unrealircd.conf and re-write a new one. #### -#### #### -#### 2) ./networks/makenet #### -#### This will guide you through the process of creating a network #### -#### file for use with your ircd. It will also give you the option of #### -#### submitting your network file so it will be automatically #### -#### included in future releases. Please only submit the file once #### -#### per network. #### -#### #### -#### 3) Review doc/example.conf and doc/conf.doc on other configuration #### -#### options you may want to set. Also review the others docs in this #### -#### folder as they may help you get your IRCd going. #### -#### #### -############################################################################### -#### Starting the Server #### -#### #### -#### 1) Make sure you're in the top level Unreal3.2 directory.. #### -#### #### -#### 2) ./unreal start #### -#### #### -#### 3) If you get the error screen, please go through and check each #### -#### point presented, if you have no luck, go on IRC #### -#### /server irc.ircsystems.net #Unreal-support #### -#### #### -#### 4) /server yourserverip or domainname #### -#### #### -############################################################################### -#### Updating the IRCD #### -#### #### -#### 1) ./update #### -#### Newer releases of Unreal allow the use of ./update which logs #### -#### into the Unreal server and allows you to pick a new version to #### -#### to upgrade to. #### -#### #### -############################################################################### diff --git a/Setup b/Setup deleted file mode 100755 index 7b3733a55..000000000 --- a/Setup +++ /dev/null @@ -1,35 +0,0 @@ -#!/bin/sh -clear -echo "Starting up UnrealIRCd Setup" -echo "" -echo "Press enter to proceed to setup..." -read cc -more -d Unreal.nfo -echo "Press enter to proceed to FAQ..." -read cc -more -d doc/faq -echo "Press enter to proceed to configuration..." -read cc -if [ "$1" != "-noconfig" ] ; then - ./Config -fi - -echo "Press enter to proceed to compiling..." -read cc -make -echo "Press enter to proceed to unrealircd.conf making..." -read cc -./makeconf -echo "Press enter to proceed to network configuration..." -read cc -clear -echo "Do you want to use one of these network files, or make your own?" -cd networks -ls *.network -echo "[Type "no" if you want to make your own]" -read cc -if [ "$cc" == "no" ] ; then - ./makenet -fi -echo "Now just edit your unrealircd.conf and you should be ready to run" -echo "UnrealIRCd with ./unreal start" diff --git a/Unreal.nfo b/Unreal.nfo index 33d4d2801..6f4ed9508 100644 --- a/Unreal.nfo +++ b/Unreal.nfo @@ -22,6 +22,10 @@ * DrBin * llthangel + Documentation: + ============== + * CKnight^ + Precenses on the Internet: * http://www.unrealircd.com @@ -49,7 +53,8 @@ latest devel: base so we are volunteeringly helping you, but we are humans like you, and we got to have peace at times as well.] * Mailing list: supporters@lists.unrealircd.org (for support) - * READ doc/faq BEFORE ASKING QUESTIONS! + * READ THE DOCS BEFORE ASKING QUESTIONS! doc/unreal32docs.html + or on the web http://www.unrealircd.com/unreal32docs.html * READ http://support.unrealircd.org * Want to discuss, chat, etc? @@ -60,4 +65,4 @@ latest devel: ============================================== http://bugs.unrealircd.org -y \ No newline at end of file +y diff --git a/doc/Elite.Changes b/doc/Elite.Changes deleted file mode 100644 index 00889a143..000000000 --- a/doc/Elite.Changes +++ /dev/null @@ -1,129 +0,0 @@ -[ $Id$ ] -Take this with a grain of salt.. it's heaps old and this isn't Elite anymore - - ---------------------------- -Version Elite2.0 ========== -=========================== -- Since +x was rewritten, the ban bug is 100% fixed. :) -- Rewrote +x hidden host function completely. -- Fixed FUNNY bug with hiddenhost and /who (Reported by Prod|gy) -- Added/Removed irc networks -- Fixed bug in /watch (Reported/Fixed by Despise) -- Added nick-change flood protection. -- Added an awesome manual... ./manual to run -- Removed /who notice for opers. -- Added protection of /akill *@* :) -- Removed java stuff completely. (Java clients are like normal IRC clients...right?) -- Added new +a mode. This mode can only be set by +q channel owners. When you are +a in a - channel, you cannot be deopped or kicked. (Syntax: /mode #chan +a ) -- Added new +q channel mode. ChanServ must set the channel founder +q so they are also - known as channel owners via the ircd. Channel owners are protected and may set - other users +a which they will also be protected (but not chan owners). - (Syntax: /mode #chan +q ) -- Re-coded /MAP -- Changed GLINE notices from sendto_ops to send to all opers with +e flag on. -- Added (addnet) script, you can run this to add your net settings to the next release. -- Changed to in whois "Blah is an oper on " -- Added new +L channel mode. If a #chat has a limit (+l) of 10 users, and +L set to channel - #chat2, when a user trys to join #chat, they won't get "#chat is full", they will be - auto-joined to #chat2 - (Linked channels in other words). - (Syntax: /mode #chan +L ) -- Changes user@shadow-33.com to user@user-33.one.com (noone will know one.com is the realhost) -- Changed +x for IP's from (x.x.x.***) to (x.x.x.network-#) -- In oline flags * will introduce +e on oper up. (before: required +e in oline flag) -- Removed +t usermode (UMODE_ALL) - wasn't used. -- Made 'create your own network setting' feature more stable. -- Added new channel mode (+x) to disable colored text in channel. -- Added +C (Co Administrator) -- Added +T (Technical Administrator) -- Changed /map to numerics... -- Made startup message when booting more stable. - -Version Elite1.3 (02/23/99) -============================ -- Cleaned up version.c.SH -- Added new net settings (netdomain & helpchan) -- Added new net config creator in ./Config -- Made ./Config more easier... -- Created new usermode +j (Java user) -- New hostname (java.shadownet.org) for java users. -- Removed RUN_SERVICES code from entire ircd. - -Version Elite1.2.4 (02/14/99) -============================ -- Fixed the nick crash bug! (damn m_kill small error) -- New network(s) added. -- Changed one thing in m_gline (nothing big) - -Version Elite1.2.3 (02/10/99) -============================ -- Removed SOCKS checking. (possibly cause of crashing) -- Added new networks - -Version Elite1.2.2 (02/02/99) -============================ -- Fixed the crashing bug. (Changing nicks with linked servers) -- Modified AceStar net settings. -- Q-line notices are back (except for ULined clients). -- Fixed /kill bug with services. - -Version Elite1.2.1 (01/29/99) -============================ -- Fixed multiple notices from +N / -N -- Added some text to s_err.c -- Possibly fixed the odd crashing... ? - -Version Elite1.2 (01/24/99) -============================ -- Netadmin can be used via +N in the oline slot now. -- When +N is executed, net-wide oper msg's are sent about it. -- Completely removed the freeze function (it's a toy unlike a command) -- Changed abit of the GLINE adding notice. -- Added logging to a file for glines (gline.log) -- Implemented SOCKS checking (thx Rhom). -- Changed channel lists only when 2 ppl in chan to 1. -- Changed sendto_ops function in many places in s_user.c/s_serv.c to - sendto_locfailops. -- Changed GNOTICE in s_user.c/s_serv.c to GLOBOPS -- Fixed hiddenhost bug with /kill (+w could see real host of oper) -- Fixed hiddenhost bug with /oper (+s could see real host of oper) - -[Special thanks goes out to Rhom for reporting/help patch bugs] - -Version Elite1.1.1 (12/12/98) -============================= -- Fixed /whois bug (had problems with mIRC clients *sigh*) -- Fixed /topic bug (didn't allow topic changes at all.) - -Version Elite1.1 (12/6/98) -============================ -- Fixed ./Config script (Net select) -- Fixed /remgline bug. -- If ULined clients, channels are not shown which they are in. -- Fixed +e / +t / +b (non-opers could get +et before) -- Fixed OperMode notice. -- Fixed Gline sending extra Global on expire. -- Fixed /whowas wrong hostname bug (by Thiago) -- Fixed chkconf ZLINE error (by matt) -- Added PhazeNet configuration -- Added option for auto +x in ./Config -- Freeze was disabled in this version (It will be back in 1.2) - -Version Elite1.0 (09/20/98) -============================ -- Changed Shadow3.9 to Elite1.0 (Starting a new IRCD) -- Changed some numeric's around in src/s_err.c -- Auto +x on Oper up. -- Fixed small error in ./ircd script. -- Made ./Config more Linux-redhat friendly. -- Added RelicNet to the ircd. -- include/config.h is much more compatible with all IRC nets. -- Added /gline (works 100%) [/gline ]. -- Fixed up /map. -- Added UMODE's +e & +t - * e: EYES [Can see ppl who /whois, and other notices.] - * t: ALL [See's all net notices ie: See's all Client connectings...] -- Fixed the hiddenhost bug with IP's... -- Fixed major bug with hiddenhost which caused coredump. -- Made a new script (makeconf) -- generates the ircd.conf file. diff --git a/doc/commands.txt b/doc/commands.txt deleted file mode 100644 index b4d68cfd6..000000000 --- a/doc/commands.txt +++ /dev/null @@ -1,334 +0,0 @@ -Written by ^MrMike^ (mike@sector001.org) for the UnrealIRCd -Modified by codemastr to include a few other commands -(note, this file will be updated in CVS asap) - -PRIVMSG - - Used to send a message to a person or a channel - Syntax: MSG ,,, - Example: PRIVMSG Stskeeps :Hello. Unreal is a very good ircd. - Example: PRIVMSG Stskeeps,codemastr,DrBin :Hello Unreal Coding Team - -NOTICE - - Mainly used for one-time communication or for the results of a command. - Syntax: NOTICE ,,, - Example: NOTICE codemastr :Hi. How are you? - Example: NOTICE codemastr,Stskeeps :Hi codemastr and Stskeeps. - -MODE - - Used to change the mode of a channel or a user. You can only change modes for channel you are an Operator or Half-Op on. Also, you can only changes user modes for yourself. - Syntax: MODE - Example: MODE #UnrealIRCD +tn - Example: MODE #UnrealIRCD +ootn codemastr Stskeeps - -NICK - - Changes your "online identity" on a server. All those in the channel you are in will be alerted of your nickname change. - Syntax: NICK - Example: NICK |codemastr| - -JOIN - - Used to enter one or more channels on an IRC server. All occupants of the channel will be notified of your arrival. - Syntax: JOIN ,, - Example: JOIN #UnrealIRCD - Example: JOIN #UnrealIRCD,#OperHelp - -PING - - Determines the amount of lag (time it takes for a response to reach a person and come back) between yourself and someone else. - Syntax: PING - Example: PING Stskeeps - -WHOIS - - Shows information about the user in question, such as their "name", channels they are currently in, their hostmask, etc. - Syntax: WHOIS - Example: WHOIS DrBin - -ISON - - Used to determine of a certain user or users are currently on the IRC server based upon their nickname. - Syntax: ISON - Example: ISON Stskeeps DrBin codemastr NickServ ChanServ OperServ MemoServ - -USER - - Used during registration to server (i.e. during inital connection sequence.) - -PART - - Used to part (or leave) a channel you currently occupy. All those in the channel will be notified of your departure. - Syntax: PART ,,, - Example: PART #UnrealIRCD - Example: PART #UnrealIRCD,#OperHelp - -QUIT - - Disconnects you from the IRC server. Those in the channels you occupy will be notified of your departure. If you do not specify a reason, your nickname becomes the reason. - Syntax: QUIT - Example: QUIT Leaving! - -USERHOST - - Returns the userhost of the user in question. Usually used by scripts or bots to retrieve userhost information. - Syntax: USERHOST - Example: USERHOST codemastr - -SVSNICK - - Can only be used by a U:Lined server (i.e. services). Changes the nickname of the user in question. - Syntax: SVSNICK : - Example: SVSNICK Stskeeps Techie :963086432 - -SVSMODE - - Can only be used by a U:Lined server (i.e. services). Changes the mode of the channel or user in question. - Syntax: SVSMODE : - Example: SVSMODE #UnrealIRCD :+o Stskeeps - Example: SVSMODE codemastr :+i - -LUSERS - - Provides local and global user information (such as current and maximum user count). - Syntax: LUSERS - -CHANSERV - - Will send a secure message to ChanServ. Similar to /msg ChanServ, but more secure. May not work if server is configured improperly. - -TOPIC - - Sets/Changes the topic of the channel in question, or just display the current topic. - Syntax: TOPIC - Syntax: TOPIC - Example: TOPIC #operhelp - Example: TOPIC #UnrealIRCD Welcome to the Unreal IRCD Home Channel. - -INVITE - - Sends a user an invitation to join a perticular channel. You must be an operator on the channel in order to invite a user into it. - Syntax: INVITE - Example: INVITE codemastr #OperHelp - -KICK - - Removes a user from a channel. Can only be used by Operators or Half-Ops. If no reason is specified, your nickname becomes the reason. - Syntax: KICK - -WALLOPS - - Sends a "message" to all those with the umode +w. Only IRCops can send wallops, while anyone can view them. - Syntax: WALLOPS - -KILL - - Forcefully disconnects a user from an IRC Sever. Can only be used by IRCops. - Syntax: KILL - Example: KILL Clone5 Cloning is not allowed - -AWAY - - Sets your online status to "away". - Syntax: AWAY (AWAY without a reason will unset you away) - Example: AWAY Walking the dog... - -SQUIT - - Disconnects an IRC Server from the network - Syntax: SQUIT - Example: SQUIT leaf.* - -WHO - - Searches user information (-i users only) for supplied information. IRCops are a ble to search +i users. - Syntax: WHO - Example: WHO *.aol.com - -WHOWAS - - Retrieves previous 'WHOIS' information for users no longer connected to the server. - Syntax: WHOWAS - Example: WHOWAS Stskeeps - -LIST - - Provides a complete listing of all channels on the network. If a search string is specified, it will only show those matching the search string. - Syntax: LIST - Example: LIST - Example: LIST *ircd* - -NAMES - - Provides a list of users on the specified channel. - Syntax: NAMES - Example: NAMES #help - -OPER - - Attempts to give a user IRCop status. - Syntax: OPER - Example: OPER codemastr codeit - -CONNECT - - Links another IRC server to the one you are currently on. Remote connections are also possible. - Syntax: CONNECT - Syntax: - Example: CONNECT leaf.* - Example: CONNECT hub.* 6667 leaf.* - -VERSION - - Provides version information of the IRCD software in usage. - Syntax: VERSION - -STATS - - Provides certain statistical information about the server (for example, u will provide uptime information). - Syntax: STATS - Example: STATS u - -LINKS - - Lists all of the servers currently linked to the network. - Syntax: LINKS - -ADMIN - - Provides administrative information regarding the server. - Syntax: ADMIN - -SAMODE - - Allowed a services administrator to change the mode on a channel, without having operator status. - Syntax: SAMODE - Example: SAMODE #UnrealIRCD +m - -SVSKILL - - Can only be used by a U:Lined server. Forcefully disconnects a user from the network. - Syntax: SVSKILL - Example: SVSKILL codemastr Goodbye - -SVSNOOP - - Can only be used by a U:Lined server. Enabled or disables whether Global IRCop functions exist on the server in question or not. - Syntax: SVSNOOP <+/-> - Example: SVSNOOP leaf.* - - -MOTD - - Displays the Message of the Day. - Syntax: MOTD - Syntax: MOTD - -KLINE - - "Bans" a hostmask from connection to the IRC server. - Syntax: KLINE - Example: KLINE *@*.aol.com Abuse - -UNKLINE - - Removes a k:line from the server. - Syntax: UNKLINE - Example: UNKLINE *@*.aol.com - -ZLINE - - Disables all access to the IRC server from a specified IP. - Syntax: ZLINE - Example: ZLINE 127.0.0.1 - -UNZLINE - - Removes a currently active z:Line. - Syntax: UNZLINE - Example: ZLINE 127.0.0.1 - -GLOBOPS - - Sends a global "message" to all IRCops. Only viewable by IRCops (unlike WallOps, which can be viewed by normal users). - Syntax: GLOBOPS - Example: GLOBOPS Going to be akilling those clones... - -CHATOPS - - GLOBOPS is usually reserved for important network information. Therefore, for Oper Chat, CHATOPS was invented. IRCops with the +c flag enabled will be able to send/receive CHATOPS messages. - Syntax: CHATOPS - Example: CHATOPS How's everyone doing today? - -LOCOPS - - Similar to GLOBOPS, except only received by those IRCops local to your server. - Syntax: LOCOPS - Example: LOCOPS Going to be adding a temp k:line for that user... - -REHASH - - Prompts the server to reread its configuration file (ircd.conf). Will also remove any temporarly lines (i.e. k:line). - Syntax: REHASH - -RESTART - - Kills and restarts the irc daemon, disconnecting all users currently on that server. - Syntax: RESTART - Syntax: RESTART - -DIE - - Kills the irc daemon, disconnecting all users currently on that server. - Syntax: DIE - Syntax: DIE - -RULES - - Reads the rules.conf file and sends the contents to the user. - Syntax: RULES - -MAP - - Provides a "network map" of the IRC network. Mainly used for routing purposes. - Syntax: MAP - -DALINFO - - Original DALnet ircd credits. - Syntax: DALINFO - -MKPASSWD - - Used for generating an encrypted password. Mainly used for encrypted O:Line passwords. - Syntax: MKPASSWD - Example: MKPASSWD codeit - -ADDLINE - - Adds a line to the server's ircd.conf file. After added, you must REHASH the server for it to take affect. - Syntax: ADDLINE - Example: ADDLINE C:127.0.0.1:server.dal.net:linking:7325:50 - -TECHAT - - Similar to CHATOPS, but only Technical Admins are able to send/receive messages on this "channel". - Syntax: TECHAT - Example: TECHAT What do you think of the new routing map? - -NACHAT - - Similar to CHATOPS (and TECHAT), but only Network Admins are able to send/recieve messages. - Syntax: NACHAT - Example: NACHAT Linking a new server in a couple minutes... - -KNOCK - - For channels which are invite only, you can "knock" on the channel to request an invite. - Syntax: KNOCK - Example: KNOCK #secret_chan I'm an op, let me in! - -CREDITS - - Credits for Unreal IRCD. - Syntax: CREDITS - -LICENSE - - GPL information. - Syntax: LICENSE - -SVSJOIN - - Forces a user to join a channel. Can only be used by a U:Lined server. - Syntax: SVSJOIN - Example: SVSJOIN codemastr #jail - -SAJOIN - - Forces a user to join a channel. Can only be used by a Services Admin. - Syntax: SAJOIN - Example: SAJOIN Stskeeps #OperHelp - -SVSPART - - Forces a user to leave a channel. Can only be used by a U:Lined server. - Syntax: SVSPART - Example: SVSPART codemastr #jail - -SAPART - - Forces a user to leave a channel. Can only be used by a Services Admin. - Syntax: SAPART - Example: SAPART Stskeeps #OperHelp - -SETHOST - - Changes the hostname of yourself. Only available to IRCops. - Syntax: SETHOST - Example: SETHOST coder.tspre.org - -SETIDENT - - Changes the ident of yourself. Only available to IRCops. - Syntax: SETIDENT - Example: SETIDENT coder - -SETNAME - - Changes the "IRC Name" (or "Real Name") of yourself. Available to everyone. - Syntax: SETNAME - Example: SETNAME Unreal Coding Team Member - -CHGHOST - - Changes the hostname of a user currently on the IRC network. Only available to IRCops. - Syntax: CHGHOST - Example: CHGHOST codemastr coder.tspre.org - -CHGIDENT - - Changes the ident of a user currently on the IRC network. Only available to IRCops. - Syntax: CHGIDENT - Example: CHGIDENT codemastr coder - -CHGNAME - - Changes the "IRC Name" (or "Real Name") of a user currently on the IRC network. Only available to IRCops. - Syntax: CHGNAME - Example: CHGNAME codemastr Unreal Coding Team Member - diff --git a/doc/conf.doc b/doc/conf.doc deleted file mode 100644 index 57dc34b6d..000000000 --- a/doc/conf.doc +++ /dev/null @@ -1,1044 +0,0 @@ -UnrealIRCd Configuration Documentation v3.2-beta5 - -Table of Contents - 1.0 Abstract - 1.1 Introduction - 2.0 Me block (M:line) - 3.0 Admin block (A:line) - 4.0 Class block (Y:line) - 5.0 Allow block (I:line) - 6.0 Listen block (P:line) - 7.0 Oper block (O:line) - 8.0 Drpass block (X:line) - 9.0 Include directive (N/A) -10.0 Loadmodule directive (N/A) -11.0 Log block (N/A) -12.0 Tld block (T:line) -13.0 Ban nick block (Q:line) -13.1 Ban user block (K:line) -13.2 Ban ip block (Z:line) -13.3 Ban realname block (n:line) -13.4 Ban server block (q:line) -14.0 Except ban block (E:line) -14.1 Except scan block (e:line) -14.2 Except tkl block (N/A) -15.0 Deny dcc block (dccdeny.conf) -15.1 Deny version block (V:line) -15.2 Deny link block (D:line and d:line) -15.3 Deny channel block (chrestrict.conf) -16.0 Allow channel block (N/A) -17.0 Vhost block block (vhost.conf) -18.0 Badword block (badwords.*.conf) -19.0 Ulines block (U:line) -20.0 Link block (C:line, N:line, H:line, L:line) -21.0 Alias block (N/A) -22.0 Help block (N/A) -23.0 Set block (networks/unrealircd.conf and networks/*.network) -24.0 Conclusion - -1.0 Abstract -Welcome to the new Unreal configuration format. This format may seem very confusing at first, -but hopefully this document will clear up any confusion. This file will show you the new config -file directives as well as tell you the old format equivilent (where one exists) to help you get -a feel for the new file. - -1.1 Introduction -Each entry, or block, in the new format has a specific format. The format works like: - - { - ; -}; - - is the type of block, such as me, or admin. sometimes specifys a -value, such as /oper login, but other times it will be a sub-type such as in ban user. - is an individual variable specific to the block, and is the -associated value. Directives and their values do not have to be seperated by an equal sign, but -they maybe if you choose to do so. If contains spaces, or characters that -represent a comment it must be contained in double quotes. If you want to use a quote character -inside a quoted string use \" and it will be understood as a quote character. A - can have directives within it, if thats the case it will have it's own set of -curly braces surrounding it. Some blocks do not have directives and are specified just by -, such as include. Also note that there is no set format, meaning the whole block -can appear on one line or over multiple lines. The format above is what is normally used (and -what will be used in this file) because it is easy to read. Note: the configuration file is -currently case sensitive so BLOCK-NAME is not the same as block-name. There is a special -notation used to talk about entries in the config file. For example, to talk about - in the example above, you'd say ::, and if that -directive has a sub-block you want to reference, you would add another :: and the name of the -sub directive. To talk about an unnamed directive you would do :: which would in -this case mean , or it could be an entry in a sub block that has no name. - -Comments are supported in three formats, both multi-line and single-line comments are supported. -To comment a single line there are two options, a shell style comment, or a C++ style comment. -A shell style comment begins with a # and a C++ style begins with a //. These comments can -appear anywhere in a line and comment anything until the end of the line. For multi-line -comments, a C style comment is supported. To start the comment you enter /* and anything from -there until the */ is commented. - -Time values (listed as in the samples) are entries that specify periods of -time. The config format supports a very lenient method of entry. You can use the old -fashioned method of specifying the time in seconds, or you can specify them in a much -easier sense, for example 86400 is equivilent to writing 1day. You can use the constants -second, minute, hour, day, and week. You may pluralize the constants as necessary but -internally it makes no difference. The constants can be abbreviated to their first -letter as well, for example day and d are the same thing. Constants are case -insensitive. Spaces can also be used for easy readability but if you use spaces be sure to -enclose the value in double quotes. - -Size values (listed as in the samples) are very similar to time values except -they define a size rather than time. The size referred to is storage size. You can you the -traditional method of entering the number of bytes in the size, or you can use the new -method of using constants to make it more easily readable and easier to enter. For example -instead of writing 1024, you can simply write 1kilobyte. The included constants are byte, -kilobyte, megabyte, and gigabyte. You can abbreviate them to either their first letter or -you can for example enter kb to mean kilobyte. Just like time values, size value constants -are case insensitive. Spaces can also be used in the size value to seperate and add -readability, but if you use spaces be sure to enclose the value in double quotes. - -Negative and affirmative values are used to either enable or disable an option. Negative -values include no, off, false, 0. Affirmative values include yes, on, true, 1. - -2.0 Me block (M:line) - -Syntax: -me { - name ; - info ; - numeric ; -}; - -Example: -me { - name irc.unrealircd.com; - info "UnrealIRCd Development Server"; - numeric 21; -}; - -These values are pretty obvious. The me::name specifies the name of the server, me::info -specifies the server's info line, me::numeric specifies a numeric to identify the server. This -must be a value between 1 and 255 that is unique to the server meaning no other servers on the -network may have the same numeric. - -3.0 Admin block (A:line) - -Syntax: -admin { - ; - ; - ... -}; - -Example: -admin { - "codemastr"; - "codemastr@unrealircd.com"; -}; - -The admin block defines the text displayed in a /admin request. You can specify as many lines -as you want and you they can contain whatever information you choose, but it is standard to -include the admin's nickname and email address at a minimum. Other information may include any -other contact information you wish to give. - -4.0 Class block (Y:line) - -Syntax: -class { - pingfreq ; - connfreq ; - maxclients ; - sendq ; -}; - -Example: -class clients { - pingfreq 90; - maxclients 100; - sendq 50000; -}; - -The class block is a vastly simplified version of the Y:lines. You are no longer limited to -naming them with a number, you can now use an alpha-numeric string which is specified in the -class::. The values of this block define the connection classes, class::pingfreq specifies the -number of seconds between PINGs, class::connfreq is only used in server classes to specify the -time in seconds between connection attempts, class::maxclients specifies the maximum amount of -clients that may use this class to connect, and class::sendq specifies the amount of information -that can remain in the send queue buffer. - -5.0 Allow block (I:line) - -Syntax: -allow { - ip ; - hostname ; - class ; - password { ; }; - maxperip ; - redirect-server ; - redirect-port ; - options { -