44a87a14953321ccba5570aa7fc9f2dc65ad6363
[ngircd-alex.git] / man / ngircd.8
1 .\"
2 .\" $Id: ngircd.8,v 1.6 2003/03/09 23:08:24 alex Exp $
3 .\"
4 .TH ngircd 8 "March 2003" ngircd "ngIRCd Manual"
5 .SH NAME
6 ngircd \- the next generation IRC daemon
7 .SH SYNOPSIS
8 .B ngircd [
9 .I Options
10 .B ]
11 .SH DESCRIPTION
12 .B ngircd
13 is a free open source daemon for the Internet Relay Chat (IRC),
14 developed under the GNU General Public License (GPL).
15
16 It's written from scratch and is not based upon the original IRCd like
17 many others. It is easy to configure, supports server links (even with
18 original ircd's) and runs on hosts with changing IP addresses (such as
19 dial-in networks).
20
21 Currently supported platforms (tested versions) are: AIX (3.2.5 with IBM XL
22 C Compiler), A/UX (3.x, Apple pre-ANSI C Compiler and GNU C), FreeBSD
23 (4.5/i386, GNU C), HP-UX (10.20, GNU C), IRIX (6.5, SGI MIPSpro C 7.30),
24 Linux (2.2.x/i386, 2.4.x/i386 and 2.4.x/hppa, GNU C), Mac OS X (10.x, GNU C),
25 NetBSD (1.5.2/i386 and 1.5.3/m68k, GNU C), Solaris (2.5.1 and 2.6, GNU C),
26 and Windows with Cygwin (GNU C).
27
28 As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf
29 there are good chances that it also supports other UNIX-based operating
30 systems.
31
32 .SH OPTIONS
33 The default behaviour of
34 .B ngircd
35 is to read its standard configuration file (see below), to detach from the
36 controlling terminal and to wait for clients.
37
38 You can use these options to modify this default:
39 .IP --configtest
40 Read, validate and display the configuration; then exit.
41 .IP "-f file, --config file"
42 Use
43 .I file
44 as configuration file.
45 .IP "-n, --nodaemon"
46 Don't fork a child and don't detach from controlling terminal.
47 All log messages go to the console.
48 .IP "-p, --passive"
49 Disable automatic connections to other servers. You can use the IRC command
50 CONNECT later on as IRC Operator to link this ngIRCd to other servers.
51 .IP --version
52 Output version information and exit.
53 .IP --help
54 Display a brief help text and exit.
55 .SH FILES
56 .I /usr/local/etc/ngircd.conf
57 .RS
58 The system wide default configuration file.
59 .RE
60 .I /usr/local/etc/ngircd.motd
61 .RS
62 Default "message of the day" (MOTD).
63 .RE
64 .SH AUTHOR
65 Alexander Barton,
66 .UR mailto:alex@barton.de
67 alex@barton.de
68 .UE
69 .br
70 Homepage:
71 .UR http://arthur.ath.cx/~alex/ngircd/
72 http://arthur.ath.cx/~alex/ngircd/
73 .UE
74 .SH "SEE ALSO"
75 .BR ngircd.conf (5),
76 .BR ircd (8)
77 .\"
78 .\" -eof-