Blame


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