fe8510b536d51bd0024fa8d62af7ad3712d349e3
[ngircd-alex.git] / doc / FAQ.txt
1
2                      ngIRCd - Next Generation IRC Server
3
4                       (c)2001-2010 by Alexander Barton,
5                     alex@barton.de, http://www.barton.de/
6
7                ngIRCd is free software and published under the
8                    terms of the GNU General Public License.
9
10                     -- FAQ: Frequently Asked Questions --
11
12
13 I. General
14 ~~~~~~~~~~
15
16 Q: Is it possible to link the ngIRCd with non-ngIRCd servers?
17 A: Yes. ngIRCd is compatible to the original ircd used by IRCNet. Actually
18    this is being tested with version 2.10.3p3. Please note that newer
19    versions (2.11.x) aren't compatible any more!
20
21 Q: Is there a homepage with further information and downloads?
22 A: Yes. Please visit <http://ngircd.barton.de/>.
23
24 Q: Why should I use ngIRCd instead of the original one?
25 A: ngIRCd offers several benefits: no problems with dynamic IPs, easy to
26    configure, open source (GPL), under active development.
27
28
29 II. Compilation
30 ~~~~~~~~~~~~~~~
31
32 Q: I did a "CVS checkout" but can't execute ./configure because the script
33    is missing in the generated directory!?
34 A: When using development versions via CVS, the configure script as well as
35    the Makefile.in templates must be generated using GNU automake and GNU
36    autoconf. To simplify this task run the ./autogen.sh script which will
37    execute the required tools for you; then continue with executing the
38    ./configure script as usual.
39
40 Q: The ./autogen.sh script complains "aclocal: command not found".
41 A: GNU automake is missing on your system but required for building CVS
42    versions of ngIRCd. Install GNU automake 1.6 or later and try again.
43
44 Q: The ./autogen.sh script stops with "autoheader: command not found".
45 A: GNU autoconf is missing on your system but required for building CVS
46    versions of ngIRCd. Install GNU autoconf 2.52 or later and try again.
47
48 Q: The ./autogen.sh script fails and the message "automake: configure.in:
49    AM_INIT_AUTOMAKE must be used" is displayed.
50 A: Most probably you are using version 1.5 of GNU automake which seems to be
51    incompatible to the build system of ngIRCd. Solution: upgrade to at least
52    version 1.6 of GNU automake.
53    (If you are using Debian 3.0 "Woody" you can try to downgrade to version
54    1.4 of GNU automake shipped with this distribution; it should work, too.)
55
56
57 III. Runtime
58 ~~~~~~~~~~~~
59
60 Q: Where is the log file located?
61 A: ngIRCd does not write its own log file. Instead, ngIRCd uses syslog(3).
62    Check the files in /var/log/ and/or consult the documentation for your
63    system logger daemon.
64
65 Q: I cannot connect to remote peers when I use the chroot option, the
66    following is logged: "Can't resolve example.com: unknown error!".
67 A: see next question blow ...
68
69 Q: When running ngIRCd inside a chroot, no IP addresses can be translated
70    in DNS names, errors like "Name or service not known" are logged.
71 A: On Linux/glibc with chroot enabled you need to put some libraries inside
72    the chroot as well, notably libnss_dns; maybe others. Unfortunately, even
73    linking ngIRCd statically does not help this. So you can either copy
74    all the required files into the chroot directory:
75      $ mkdir -p ./chroot/etc ./chroot/lib
76      $ cp -a /etc/hosts /etc/resolv.conf /etc/nsswitch.conf ./chroot/etc/
77      $ cp -a /lib/libresolv* /lib/libnss_* ./chroot/lib/
78    Or you can try to link ngIRCd against an other C library (like dietlibc)
79    that doesn't depend on NSS modules and/or these files.
80
81 Q: I have added an [Oper] section, how do i log on as IRC operator?
82 A: You can use the /OPER command in your IRC client to become an IRC operator.
83    ngIRCd will also log all OPER requests (using syslog), if OPER fails you
84    can look there to determine why it did not work (bad password, unauthorized
85    host mask, etc.)
86
87 Q: I am an IRC operator, but MODE doesn't work!
88 A: You need to set 'OperCanUseMode = yes' in ngircd.conf, then IRC operators
89    can use the MODE command for changing modes even when they are not joined
90    to the specific channel.
91
92
93 IV. Bugs!?
94 ~~~~~~~~~~
95
96 Q: Is there a list of known bugs and desired feature enhancements?
97 A: Yes. Have a look at the bug tracking system (Bugzilla) for ngIRCd located
98    at <http://ngircd.barton.de/bugzilla/index.cgi>. There you can file bug
99    reports and feature requests as well as search the bug database.
100
101 Q: What should I do if I found a bug?
102 A: Please file a bug report at <http://ngircd.barton.de/bugzilla/index.cgi>!
103    The author of the particular component will be notified automagically :-)
104