Updated some docs/ & removed TROUBLESHOOTING as it is redundant.

6 files changed, 24 insertions, 373 deletions

diff --git a/docs/BUGS b/docs/BUGS
index 1f640fa5e..4c5bf2de9 100644
--- a/docs/BUGS
+++ b/docs/BUGS
@@ -1,4 +1 @@
-Reported Bugs from Bugzilla: http://bugs.anope.org/
----------------------------------------------------
-
-
+For all bug reports / updates please see http://bugs.anope.org
diff --git a/docs/INSTALL b/docs/INSTALL
index e011470b5..dbe90f528 100644
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -162,7 +162,7 @@ Note: You should also read the README and FAQ files!
 4) Starting Anope
 
     Go into the directory where binaries were installed (by default, this is
-    ~/services). Type ./services to launch Anope.
+    ~/services/bin). Type ./services to launch Anope.
 
     If there are syntax errors in the configuration file they will be
     displayed on the screen. Correct them until there are no errors anymore.
@@ -180,9 +180,7 @@ Note: You should also read the README and FAQ files!
 5) Setting up a crontab
 
     A crontab entry will allow you to check periodically whether Anope is
-    still running, and restart it if not. You'll need to have Anope binaries
-    and data installed in the same directory for this to work without
-    modification.
+    still running, and restart it if not.
 
     First rename the example.chk script that is in Anope path (by default,
     this is ~/services/data) to services.chk and edit it. You'll need to 
diff --git a/docs/LANGUAGE b/docs/LANGUAGE
index 0a2831e69..ca3838639 100644
--- a/docs/LANGUAGE
+++ b/docs/LANGUAGE
@@ -27,6 +27,8 @@ Anope Mutli Language Support
     If you have finished a language file translation and you want others to use it, please send it to team@anope.org
     (don't forget to mention clearly your (nick)name, your e-mail and the language name). You'll of course get full credit for it.
 
+    NOTE: There is no guarantee we will use your work so please do not be offended if we say no thanks.
+
 3) Using langages with modules
 
     Module authors can easially add the ability to have their modules translated by adding _() around the strings they
diff --git a/docs/README b/docs/README
index 58a6ace9a..16816d567 100644
--- a/docs/README
+++ b/docs/README
@@ -76,8 +76,8 @@ Table of Contents
         * Adam <adam@anope.org>

         * Alvaro Toledo <atoledo@keldon.org>

         * Amanda Folson <amanda@anope.org>

-        * Andrew Berquist <vash@anope.org>

-        * Björn Stiddien <keeper@anope.org>

+        * Andrew Berquist <vash@anope.org> 

+        * Björn Stiddien <keeper@anope.org>

         * Charles Kingsley <chaz@anope.org>

         * Chris Hogben <heinz@anope.org>

         * Daniel Engel <dane@zero.org>

@@ -91,13 +91,17 @@ Table of Contents
         * Jens Voss <dukepyrolator@anope.org>

         * JH <jh@irc-chat.net>

         * Joris Vink <joris@anope.org>

+        * Lee Holmes <lethality@anope.org>

         * Lucas Nussbaum <lucas@lucas-nussbaum.net>

         * Mark Summers <mark@goopler.net>

         * Matthew Beeching <jobe@invictachat.net>

         * Naram Qashat <cyberbotx@anope.org>

+        * Phil Lavin <phil@anope.org>

         * Pieter Bootsma <geniusdex@anope.org>

         * Robin Burchell <w00t@inspircd.org>

-        * Thomas Juberg Stensås <ShadowMaster@Shadow-Realm.org>

+        * Sean Roe <therock247uk@anope.org>

+        * Sebastian V <hal9000@anope.org>

+        * Thomas Juberg Stensås <ShadowMaster@Shadow-Realm.org>

         * Trystan .S Lee <trystan@nomadirc.net>

         * openglx <openglx@brasnerd.com.br>

 

@@ -105,10 +109,12 @@ Table of Contents
 

         * GeniusDex <geniusdex@anope.org> (nl.l)

         * Kein <kein-of@yandex.ru> (ru.l)

-        * Stuff <the.stuff@gmx.de> (de.l)

+        * Maik Funke <Han@mefalcon.org> (de.l)

         * Gabriel Acevedo H. <drstein@anope.org> (es.l)

         * Janos Kapitany <sarkanyka@cjbchat.hu>  (hun.l)

         * Szymon S'wierkosz <szymek@adres.pl> (pl.l)

+        * Christopher N. <saka@epiknet.org> (fr.l)

+        * Yusuf Kurekci <ysfm.20@gmail.com> (tr.l)

 

     Anope uses the strlcat() and strlcpy() functions from OpenSSH 2.5.1p2.

     These functions are copyrighted by Todd C. Miller:

@@ -256,64 +262,21 @@ Table of Contents
 

 5) Messages Translations

 

-    Anope has a powerful option in NickServ allowing users to choose what

-    language it must use when sending messages to users. Messages are stored

-    in language files (located in the lang directory).

-

-    Anope is currently provided with thirteen languages: Catalan, Dutch,

-    English, French, German, Greek, Hungarian, Italian, Polish, Portuguese,

-    Russian, Spanish and Turkish. If you want to translate Anope messages

-    into another language, follow this instructions:

-

-        * Copy the lang/en_us.l file to a meaningful name (for example, if

-          you would like to translate messages in Spanish, you would rename

-          it to es.l).

-

-        * Edit the file with your favorite text editor. Carefully read the

-          instructions given at the top of the file, and start translating

-          the whole file. The file is big, so make sure you have some coffee

-          available ;) Try to avoid the use of English words as much as

-          possible. If the new language contains only a few 'special'

-          characters, try and use latin representations of it, if possible.

-          Remember that most clients are only capable of handling the

-          ISO-8859-1 charset. Of course, if you are translating Anope to a

-          language with a totally different charset, such as Russian, feel

-          free to use the one that suites it best (and the one that is in use

-          by most speakers of that language ;)).

-

-        * When this is done, you have two solutions: either patch Services

-          source code so they take in account the new language file

-          (basically, you'll have to modify lang/Makefile, language.c and

-          maybe services.h), or send us the translated file so we can make

-          the patch and include your language in the next Anope release.

-

-        * Note that there is a language tool on bin/langtool.pl that can aid

-          the verification process on newly created language files. Try to

-          use it before you submit a language file.

-

-    When new major releases come out, you'll not have to retranslate the

-    whole file; the Changes.lang file will help you to know which messages

-    were added, modified or deleted.

-

-    If you did a language file translation, and want to let others use it,

-    please send it to team@anope.org (don't forget to mention clearly your

-    (nick)name, your e-mail and the language name). You'll of course get full

-    credit for it, and will even get future final major releases before

-    anyone else to complete the translation!... ;)

+   Please see LANGUAGE for this information

 

 6) Contact

 

     For announcements and discussions about Anope, please visit our

     Portal and Forums at http://www.anope.org/ -- make sure you register

-    yourself and your network to get full benefits.

+    yourself to get full benefits.

 

     If you read the documentation carefully, and didn't find the answer to

     your question, feel free to post on the website forums or join our irc

-    channel (irc.anope.org #anope). Once you join our Support channel, just

-    type "? report" for instructions on how to report a Bug. Be as precise as

-    possible when asking a question, because we have no extraordinary powers

-    and can't guess things if they aren't provided. The more precise you are,

-    the sooner you'll be likely to get an answer.

+    channel (irc.anope.org #anope). Once you join our Support channel be as 

+    precise as possible when asking a question, because we have no extraordinary

+    powers and can't guess things if they aren't provided. 

+

+    The more precise you are the sooner you'll be likely to get an answer.

 

     If you think you found a bug, add it to the bug tracking system

     (http://bugs.anope.org) and - again - be as precise as possible. Also say

diff --git a/docs/TOOLS b/docs/TOOLS
index 0771f0671..d33d142de 100644
--- a/docs/TOOLS
+++ b/docs/TOOLS
@@ -10,10 +10,10 @@ Anope Bundled Tools
     options. To use the SMTP client instead of sendmail, find the line in your
     services configuration file (services.conf) that defines sendmailpath. On
     that line, change the path to your services installation directory, then
-    followed by "tools/anopesmtp" and the IP address of a valid SMTP server. It
+    followed by "bin/anopesmtp" and the IP address of a valid SMTP server. It
     should look like this:
 
-        sendmailpath = "/home/anope/services/tools/anopesmtp 127.0.0.1"
+        sendmailpath = "/home/anope/services/bin/anopesmtp 127.0.0.1"
 
     If the SMTP client doesn't send mail, or if there's an other problem with
     it, you can compile it in debug mode. To do this, open anopesmtp.cpp, and look
diff --git a/docs/TROUBLESHOOTING b/docs/TROUBLESHOOTING
deleted file mode 100644
index 7220f18d4..000000000
--- a/docs/TROUBLESHOOTING
+++ /dev/null
@@ -1,309 +0,0 @@
-Troubleshooting Guide for Anope 1.9
-------------------------------------------------
-
-NOTE: 
-An updated version of this guide can be found on our wiki:
-
-http://wiki.anope.org/index.php/Troubleshooting
-
-Table of Contents
------------------
-
-1) General
-    1.1) Anope complains in the logfile about being unable to load the default
-         language.
-    1.2) Anope spricht kein Deutsch!, etc. (Anope doesn't speak my language!)
-    1.3) I selected a language other than English, but sometimes Anope sends
-         responses in English instead.
-    1.4) Anope always dies after about five minutes, saying "FATAL ERROR! Can't
-         back up nick.db".
-    1.5) Anope crashed with a segmentation fault.
-    1.6) I've found a bug that's not mentioned here or in the README or BUGS
-         files.  What should I do?
-    1.7) My FreeBSD box complains about 'Shared object "nss_dns.so.1" not
-         found'
-    1.8) Anope and long (more then 30 character) nicknames.
-
-2) Installation / Configuration
-    2.1) When I run "make", I get an error message like "missing separator",
-         "Unassociated shell command", "Unexpected end of line seen", etc.
-    2.2) I get an error like "Makefile.inc not found".
-    2.3) I typed "./services" at the command line, but nothing happened!
-    2.4) Whenever I start Anope, I get a message on my IRC server saying
-         "connection refused" or something similar, and Anope gives an error
-         message from the server saying "Closing Link: ...".
-    2.5) My IRC server is giving me messages like "Connection to
-         services.whatever.net[127.0.0.1] activated" and then "Access denied --
-         no N line".  Why?
-    2.6) When I say "/connect services.*", it doesn't work!
-    2.7) Anope starts up okay, but if I try to register a nickname, it comes
-         back with "Sorry, registration failed."
-    2.8) Anope reports (via /stats u or /msg OperServ STATS) a different number
-         of users online than I get from doing /lusers.
-         
-3) BotServ
-    3.1) How do I add bots to BotServ?
-    3.2) Why do kick triggers and fantasy commands fail to work with my Bahamut
-         IRCd?
-         
-4) ChanServ
-    4.1) Anope's channel mode setting doesn't work.  I can't set modes with
-         OperServ, and every time ChanServ tries to set a mode, my server
-         reverses the change.
-    4.2) Anope ignored the SET SUCCESSOR setting and deleted a channel when the
-         founder expired.
-    4.3) How to auto voice all those whom join my #channel?
-    4.4) Channel options like RESTRICTED or SECUREOPS don't work. What's wrong?
-
-5) OperServ
-    5.1) Using the OperServ JUPE command results in server messages like 
-         "Server juped.server introduced by non-hub server services.my.net".
-    5.2) When I add an AKILL, the users matching it don't get killed.
-    5.3) Trying to use OperServ gives me "Access denied".
-    5.4) I can't get /OS UMODES and /OS SVSNICK to work!
-    5.5) What is a Super-Admin? How does it work? Why might it not work?    
-
--------------------------------------------------------------------------------
-
-1) General
-
-1.1) Anope complains in the logfile about being unable to load the default
-     language.
-
-    You forgot to run "make install".
-
-1.2) Anope spricht kein Deutsch!, etc. (Anope doesn't speak my language!)
-
-    See section 5 of the README file.
-
-1.3) I selected a language other than English, but sometimes Anope sends
-     responses in English instead.
-
-    Some language files are not complete--in other words, they only have a
-    translation of some of the message Anope uses.  In this case, the 
-    missing messages will be displayed in English.  You can either wait for 
-    the primary translator to provide us with a translation, or do the
-    translation yourself and send us the messages translated into your
-    language.
-    
-1.4) Anope always dies after about five minutes, saying "FATAL ERROR! Can't
-     back up nick.db".
-
-    Make sure that the user Anope runs as has write access to the data
-    directory, and that the data directory actually exists (the latter
-    shouldn't be a problem if you ran the Config script). This means Anope
-    needs write and execute permission on the data directory itself and execute
-    permission on every parent directory of the data directory.
-
-1.5) Anope crashed with a segmentation fault.
-
-    See if you can reproduce this by doing a certain sequence of things.  If
-    so, please report it to us (see part 6 of README file).  If not, you're
-    probably out of luck; if you like, you can report it to us anyway, but
-    chances are it won't get fixed if we don't have instructions on reproducing
-    it.  If you do have such a problem, you may find the crontab utility useful
-    for dealing with it.
-    
-    Also, see the DumpCore directive in the configuration file. It allows Anope
-    to dump its core whenever it's segfaulting, usually calling it core and
-    placing it into Anope's main directory. Open up gdb by issuing the
-    following command at your shell:
-    
-        * gdb services core
-    
-    (of course replacing 'core' with the name of the core if different) and
-    type 'bt' at the gdb prompt. After that, send us the output you got and
-    keep the core file in a safe place, in case we need it to dig deeper into
-    the problem.
-
-1.6) I've found a bug that's not mentioned here or in the README or BUGS files.
-      What should I do?
-
-    See section 6 of the README file.
-
-1.7) My FreeBSD box complains about 'Shared object "nss_dns.so.1" not found'
-
-    We haven't figured out the exact cause yet, but as a quickfix you can
-    delete the /etc/nsswitch.conf file. Please keep in mind that removing a
-    configuration file can be dangerous, so only do this if you know what you
-    are doing.
-
-1.8) Anope and long (more then 30 character) nicknames.
-
-    By default, Anope only supports nicknames up to 30 characters (NICKLEN=30).
-    If your IRCd allows for longer nicknames or has been modified to do so 
-    Anope will start logging a lot of ("NICK from nonexistent nick") messages.
-    This is because once a user uses a nick that is too long for Anope to handle, 
-    Anope loses track of the user for the remainder of the session.
-    It is POSSIBLE but not NOT RECOMMENDED to extend the maximum length of nicknames
-    Anope can track, however this will also break database compatibility. DBs saved
-    with Anope set to allow for example 40 chars cannot be read by a clean Anope
-    installation and vice versa. So changing the maximum nick length is only possible
-    when starting with fresh databases and even then the consequences of this are
-    UNTESTED.
-    In order to change the maximum internal nick length, change the NICKMAX setting
-    in include/config.h, recompile anope and start without databases.
-
-
-2) Installation / Configuration
-
-2.1) When I run "make", I get an error message like "missing separator",
-     "Unassociated shell command", "Unexpected end of line seen", etc.
-
-    Your make program isn't compatible with the Makefile for Anope. The
-    Makefile was designed to work with GNU make, and as such may not work on
-    other systems' "make" programs.  If you get an error from "make", obtain
-    GNU make from ftp://prep.ai.mit.edu/pub/gnu/make/ (or wherever you prefer) and
-    use it instead of your system's default "make". Note that GNU make may
-    already be installed on your system; try using the command "gmake" instead
-    of "make".
-    
-    The make programs bundled with SunOS/Solaris and FreeBSD have been reported
-    not to work; you will need to use GNU make on these systems.
-
-2.2) I get an error like "Makefile.inc not found".
-
-    You forgot to run the Config script first.  See the INSTALL file for
-    compilation instructions.
-
-2.3) I typed "./services" at the command line, but nothing happened!
-
-    Anope puts itself in the background when it starts, so you get your shell
-    prompt right back. Meanwhile, Anope will continue setting up, then connect
-    to the IRC server specified in services.conf (or on the command line).  If
-    it doesn't connect, you probably specified the wrong IRCd or RemoteServer in 
-    the configuration file. Check to make sure that you are actually running one of
-    the supported IRCds, also. A list of supported IRCds can be found in the README
-    file.
-    
-    You can also check the log file (services.log by default) for error
-    messages. Starting services with the -support command line option
-    will prevent it from running in the background will output the
-    messages written to the log file to the console as well. Please note that this
-    will also prevent 3rd party modules from loading and will put Anope into
-    debug mode.
-
-2.4) Whenever I start Anope, I get a message on my IRC server saying
-     "connection refused" or something similar, and Anope gives an error
-     message from the server saying "Closing Link: ...".
-
-    See section 3 of the INSTALL file.
-
-2.5) My IRC server is giving me messages like "Connection to
-     services.whatever.net[127.0.0.1] activated" and then "Access denied -- no
-     N line".  Why?
-
-    This is typically caused by including a port number in the C:line for
-    services, which tells your server to try to autoconnect to it (depending on
-    the class (Y:line) settings).  This is not what you want, because Anope
-    will connect to the server itself, but does not listen for servers to
-    connect to it.  The solution is to remove the port number from the C:line.
-
-2.6) When I say "/connect services.*", it doesn't work!
-
-    You cannot /connect services. When you start Anope, it will attempt to
-    connect to the server you specified in services.conf. Please see the answer
-    above for more information.
-
-2.7) Anope starts up okay, but if I try to register a nickname, it comes back
-     with "Sorry, registration failed."
-
-    Make sure you've selected the correct IRC server type in the configure
-    script; see section 3 of the INSTALL file for details.
-
-2.8) Anope reports (via /stats u or /msg OperServ STATS) a different number of
-     users online than I get from doing /lusers.
-
-    Anope doesn't count its own pseudo-clients (NickServ, ChanServ, etc.) in
-    its user count, while the IRC server does.
-
-3) BotServ
-
-3.1) How do I add bots to BotServ?
-
-    Read /msg BotServ HELP and /msg BotServ HELP BOT. Note that you need to be
-    opered up and identified as a Services Administrator in Anope before you
-    can use the BOT command.
-
-3.2) Why do kick triggers and fantasy commands fail to work with my Bahamut
-     IRCd?
-
-    Bahamut allows you to setup a server as 'serviceshub'. This will filter
-    certain data that services usually don't need to process. This option also
-    filters channel messages, because DALnet's services have no use for them.
-    Anope parses the channel messages for kick triggers and fantasy commands.
-    To make sure these work the server type of the hub they're linked to should
-    be simply 'hub' and not 'serviceshub'.
-
-
-4) ChanServ
-
-4.1) Anope's channel mode setting doesn't work.  I can't set modes with
-     OperServ, and every time ChanServ tries to set a mode, my server reverses
-     the change.
-
-    Make sure EVERY server on your network has a U: line for Services in
-    ircd.conf, for example:
-    
-        U:services.whatever.net:*:*
-
-4.2) Anope ignored the SET SUCCESSOR setting and deleted a channel when the
-     founder expired.
-
-    Normally, this is because the successor had too many channels registered.
-    In this case, you will see an entry in the log file like the following:
-    
-        [date] Successor (SuccessorNick) of channel #somechannel owns too many
-        channels, deleting channel #somechannel
-    
-    If you don't get a message like this or you can verify that the successor
-    wasn't running into the channel limit, please report it using the
-    bug-reporting procedure in section 6 of the README file.
-
-4.3) How to auto voice all those whom join my #channel?
-
-    Execute the following commands (/cs is an alias for /msg ChanServ):
-    
-        /cs set #channel secure off
-        /cs set #channel xop off
-        /cs levels #channel set AUTOVOICE -1
-
-4.4) Channel options like RESTRICTED or SECUREOPS don't work. What's wrong?
-
-    Make sure that you didn't put any of your normal IRCd's as a ULined server
-    in Anope. Some access checks for clients from ULined servers are skipped to
-    avoid fights between the ULined servers. This is usually only useful when
-    you have a statistics server connected to your network.
-
-5) OperServ
-
-5.1) Using the OperServ JUPE command results in server messages like  "Server
-     juped.server introduced by non-hub server services.my.net".
-
-    Services' uplink must have an H: line for Services in the ircd.conf file,
-    which looks something like:
-    
-        H:*::services.whatever.net
-
-5.2) When I add an AKILL, the users matching it don't get killed.
-
-    Use the AkillOnAdd configuration directive.
-
-5.3) Trying to use OperServ gives me "Access denied".
-
-     Check that you're opered on your IRCd (ie, moded +o)
-     Check that you're identified to a nickname listed within an opertype allowed to do the command you're trying.
-     Check whether you can use /msg operserv staff
-
-5.4) I can't get /OS UMODES and /OS SVSNICK to work!
-
-    You need to be a SuperAdmin to be able to use these commands.
-
-5.5) What is a Super-Admin? How does it work? Why might it not work?
-
-    SuperAdmin's have extra privileges, including being founder on all
-    channels. It must be activated on a per user basis and is only available to
-    Services Roots. It is set using OperServ and is not persistent. It only
-    works if SuperAdmin is not commented in the services configuration file,
-    which is commented out by default. Read /msg OperServ HELP SET SUPERADMIN
-    for further help.