man/ngircd.8

   1 .\"
   2 .\" $Id: ngircd.8,v 1.11 2005/08/12 13:20:54 alex Exp $
   3 .\"
   4 .TH ngircd 8 "August 2005" 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 include AIX, A/UX, FreeBSD, HP-UX, IRIX,
  22 Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
  23 .PP
  24 As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf
  25 there are good chances that it also supports other UNIX-based operating
  26 systems as well.
  27 .SH OPTIONS
  28 The default behaviour of
  29 .BR ngircd
  30 is to read its standard configuration file (see below), to detach from the
  31 controlling terminal and to wait for clients.
  32 .PP
  33 You can use these options to modify this default:
  34 .TP
  35 \fB\-f\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR
  36 Use
  37 .I file
  38 as configuration file.
  39 .TP
  40 \fB\-n\fR, \fB\-\-nodaemon\fR
  41 Don't fork a child and don't detach from controlling terminal.
  42 All log messages go to the console and you can use CTRL-C to
  43 terminate the server.
  44 .TP
  45 \fB\-p\fR, \fB\-\-passive\fR
  46 Disable automatic connections to other servers. You can use the IRC command
  47 CONNECT later on as IRC Operator to link this ngIRCd to other servers.
  48 .TP
  49 \fB\-t\fR, \fB\-\-configtest\fR
  50 Read, validate and display the configuration; then exit.
  51 .TP
  52 \fB\-\-version\fR
  53 Output version information and exit.
  54 .TP
  55 \fB\-\-help\fR
  56 Display a brief help text and exit.
  57 .SH FILES
  58 .I /usr/local/etc/ngircd.conf
  59 .RS
  60 The system wide default configuration file.
  61 .RE
  62 .I /usr/local/etc/ngircd.motd
  63 .RS
  64 Default "message of the day" (MOTD).
  65 .RE
  66 .SH AUTHOR
  67 Alexander Barton,
  68 .UR mailto:alex@barton.de
  69 alex@barton.de
  70 .UE
  71 .br
  72 Homepage:
  73 .UR http://ngircd.barton.de/
  74 http://ngircd.barton.de/
  75 .UE
  76 .SH "SEE ALSO"
  77 .BR ngircd.conf (5),
  78 .BR ircd (8)
  79 .\"
  80 .\" -eof-