man/ngircd.8

   1 .\"
   2 .\" $Id: ngircd.8,v 1.8 2003/03/10 00:58:06 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 .BR ngircd
  13 is a free open source daemon for the Internet Relay Chat (IRC),
  14 developed under the GNU General Public License (GPL).
  15 .PP
  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 .PP
  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 .PP
  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 .SH OPTIONS
  32 The default behaviour of
  33 .BR ngircd
  34 is to read its standard configuration file (see below), to detach from the
  35 controlling terminal and to wait for clients.
  36 .PP
  37 You can use these options to modify this default:
  38 .TP
  39 \fB\-\-configtest\fR
  40 Read, validate and display the configuration; then exit.
  41 .TP
  42 \fB\-f\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR
  43 Use
  44 .I file
  45 as configuration file.
  46 .TP
  47 \fB\-n\fR, \fB\-\-nodaemon\fR
  48 Don't fork a child and don't detach from controlling terminal.
  49 All log messages go to the console.
  50 .TP
  51 \fB\-p\fR, \fB\-\-passive\fR
  52 Disable automatic connections to other servers. You can use the IRC command
  53 CONNECT later on as IRC Operator to link this ngIRCd to other servers.
  54 .TP
  55 \fB\-\-version\fR
  56 Output version information and exit.
  57 .TP
  58 \fB\-\-help\fR
  59 Display a brief help text and exit.
  60 .SH FILES
  61 .I /usr/local/etc/ngircd.conf
  62 .RS
  63 The system wide default configuration file.
  64 .RE
  65 .I /usr/local/etc/ngircd.motd
  66 .RS
  67 Default "message of the day" (MOTD).
  68 .RE
  69 .SH AUTHOR
  70 Alexander Barton,
  71 .UR mailto:alex@barton.de
  72 alex@barton.de
  73 .UE
  74 .br
  75 Homepage:
  76 .UR http://arthur.ath.cx/~alex/ngircd/
  77 http://arthur.ath.cx/~alex/ngircd/
  78 .UE
  79 .SH "SEE ALSO"
  80 .BR ngircd.conf (5),
  81 .BR ircd (8)
  82 .\"
  83 .\" -eof-