ngircd-tor/man/ngircd.8.tmpl

.\"
.\" $Id: ngircd.8.tmpl,v 1.2 2007/11/15 01:03:29 fw Exp $
.\"
.TH ngircd 8 "May 2008" ngircd "ngIRCd Manual"
.SH NAME
ngIRCd \- the next generation IRC daemon
.SH SYNOPSIS
.B ngircd [
.I Options
.B ]
.SH DESCRIPTION
.BR ngIRCd
is a free open source daemon for the Internet Relay Chat (IRC),
developed under the GNU General Public License (GPL).
.PP
It's written from scratch and is not based upon the original IRCd like
many others. It is easy to configure, supports server links (even with
original ircd's) and runs on hosts with changing IP addresses (such as
dial-in networks).
.PP
Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX, IRIX,
Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
.PP
As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf
there are good chances that it also supports other UNIX-based operating
systems as well. By default, ngIRCd writes diagnostic and informational messages using
the syslog mechanism.
.SH OPTIONS
The default behaviour of
.BR ngircd
is to read its standard configuration file (see below), to detach from the
controlling terminal and to wait for clients.
.PP
You can use these options to modify this default:
.TP
\fB\-f\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR
Use
.I file
as configuration file.
.TP
\fB\-n\fR, \fB\-\-nodaemon\fR
Don't fork a child and don't detach from controlling terminal.
All log messages go to the console and you can use CTRL-C to
terminate the server.
.TP
\fB\-p\fR, \fB\-\-passive\fR
Disable automatic connections to other servers. You can use the IRC command
CONNECT later on as IRC Operator to link this ngIRCd to other servers.
.TP
\fB\-t\fR, \fB\-\-configtest\fR
Read, validate and display the configuration; then exit.
.TP
\fB\-V\fR, \fB\-\-version\fR
Output version information and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display a brief help text and exit.
.SH FILES
.I :ETCDIR:/ngircd.conf
.RS
The system wide default configuration file.
.RE
.I :ETCDIR:/ngircd.motd
.RS
Default "message of the day" (MOTD).
.RE
.SH AUTHOR
Alexander Barton,
.UR mailto:alex@barton.de
alex@barton.de
.UE
.br
Homepage:
.UR http://ngircd.barton.de/
http://ngircd.barton.de/
.UE
.SH "SEE ALSO"
.BR ngircd.conf (5),
.BR ircd (8)
.\"
.\" -eof-
- Manual-Pages unter neuen Namen begonnen. 2002-04-02 20:14:33 +02:00			`.\"`
add tiny note about ngircd using syslog(3) by default. 2007-11-15 02:03:29 +01:00			`.\" $Id: ngircd.8.tmpl,v 1.2 2007/11/15 01:03:29 fw Exp $`
- Manual-Pages unter neuen Namen begonnen. 2002-04-02 20:14:33 +02:00			`.\"`
Update ngIRCd manual pages - Update timestamp, - enhance some phrasing, - and fix "Passive" ([Server]) formatting. 2008-05-11 17:08:46 +02:00			`.TH ngircd 8 "May 2008" ngircd "ngIRCd Manual"`
- Manual-Pages unter neuen Namen begonnen. 2002-04-02 20:14:33 +02:00			`.SH NAME`
Updated manual pages. 2005-06-04 15:39:20 +02:00			`ngIRCd \- the next generation IRC daemon`
- Manual-Pages unter neuen Namen begonnen. 2002-04-02 20:14:33 +02:00			`.SH SYNOPSIS`
			`.B ngircd [`
			`.I Options`
			`.B ]`
			`.SH DESCRIPTION`
Updated manual pages. 2005-06-04 15:39:20 +02:00			`.BR ngIRCd`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`is a free open source daemon for the Internet Relay Chat (IRC),`
			`developed under the GNU General Public License (GPL).`
Fixed up and enhanced formating of manual pages. 2003-03-10 01:58:06 +01:00			`.PP`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`It's written from scratch and is not based upon the original IRCd like`
			`many others. It is easy to configure, supports server links (even with`
			`original ircd's) and runs on hosts with changing IP addresses (such as`
			`dial-in networks).`
Fixed up and enhanced formating of manual pages. 2003-03-10 01:58:06 +01:00			`.PP`
Updated manual pages. 2005-06-04 15:39:20 +02:00			`Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX, IRIX,`
			`Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.`
Fixed up and enhanced formating of manual pages. 2003-03-10 01:58:06 +01:00			`.PP`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf`
			`there are good chances that it also supports other UNIX-based operating`
add tiny note about ngircd using syslog(3) by default. 2007-11-15 02:03:29 +01:00			`systems as well. By default, ngIRCd writes diagnostic and informational messages using`
			`the syslog mechanism.`
- Manual-Pages unter neuen Namen begonnen. 2002-04-02 20:14:33 +02:00			`.SH OPTIONS`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`The default behaviour of`
Updated manual page. 2003-03-10 01:35:51 +01:00			`.BR ngircd`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`is to read its standard configuration file (see below), to detach from the`
			`controlling terminal and to wait for clients.`
Fixed up and enhanced formating of manual pages. 2003-03-10 01:58:06 +01:00			`.PP`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`You can use these options to modify this default:`
Fixed up and enhanced formating of manual pages. 2003-03-10 01:58:06 +01:00			`.TP`
			`\fB\-f\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`Use`
- Manual Page aktualisiert. 2002-04-02 22:19:22 +02:00			`.I file`
			`as configuration file.`
Fixed up and enhanced formating of manual pages. 2003-03-10 01:58:06 +01:00			`.TP`
			`\fB\-n\fR, \fB\-\-nodaemon\fR`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`Don't fork a child and don't detach from controlling terminal.`
Updated manual pages. 2005-06-04 15:39:20 +02:00			`All log messages go to the console and you can use CTRL-C to`
			`terminate the server.`
Fixed up and enhanced formating of manual pages. 2003-03-10 01:58:06 +01:00			`.TP`
			`\fB\-p\fR, \fB\-\-passive\fR`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`Disable automatic connections to other servers. You can use the IRC command`
			`CONNECT later on as IRC Operator to link this ngIRCd to other servers.`
Fixed up and enhanced formating of manual pages. 2003-03-10 01:58:06 +01:00			`.TP`
Updated manual page to reflect changes in daemon. 2004-04-05 12:59:10 +02:00			`\fB\-t\fR, \fB\-\-configtest\fR`
			`Read, validate and display the configuration; then exit.`
			`.TP`
Add option aliases -V (for --version) and -h (for --help). This patch adds -h and -V short options (to complement the usage). It is based on a patch attached to Debian bug #466063, see <http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=466063>. Idea by Jari Aalto <jari.aalto@cante.net>, patch adapted by Alexander Barton <alex@barton.de>. 2008-02-15 20:29:24 +01:00			`\fB\-V\fR, \fB\-\-version\fR`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`Output version information and exit.`
Fixed up and enhanced formating of manual pages. 2003-03-10 01:58:06 +01:00			`.TP`
Add option aliases -V (for --version) and -h (for --help). This patch adds -h and -V short options (to complement the usage). It is based on a patch attached to Debian bug #466063, see <http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=466063>. Idea by Jari Aalto <jari.aalto@cante.net>, patch adapted by Alexander Barton <alex@barton.de>. 2008-02-15 20:29:24 +01:00			`\fB\-h\fR, \fB\-\-help\fR`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`Display a brief help text and exit.`
- Manual-Pages unter neuen Namen begonnen. 2002-04-02 20:14:33 +02:00			`.SH FILES`
Customize manual pages to reflect the actual installation location of files. 2006-12-25 17:13:26 +01:00			`.I :ETCDIR:/ngircd.conf`
- Manual Page aktualisiert. 2002-04-02 22:19:22 +02:00			`.RS`
			`The system wide default configuration file.`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`.RE`
Customize manual pages to reflect the actual installation location of files. 2006-12-25 17:13:26 +01:00			`.I :ETCDIR:/ngircd.motd`
Updated and enhanced the daemon manual page. 2003-03-10 00:08:24 +01:00			`.RS`
			`Default "message of the day" (MOTD).`
			`.RE`
- Manual-Pages unter neuen Namen begonnen. 2002-04-02 20:14:33 +02:00			`.SH AUTHOR`
- Manual Page aktualisiert. 2002-04-02 22:19:22 +02:00			`Alexander Barton,`
			`.UR mailto:alex@barton.de`
			`alex@barton.de`
			`.UE`
- Zeilenumbruch korrigiert. 2002-04-02 22:38:50 +02:00			`.br`
- Manual Page aktualisiert. 2002-04-02 22:19:22 +02:00			`Homepage:`
Updated URL and some minor changes. 2005-08-12 15:20:54 +02:00			`.UR http://ngircd.barton.de/`
			`http://ngircd.barton.de/`
- Manual Page aktualisiert. 2002-04-02 22:19:22 +02:00			`.UE`
- Manual-Pages unter neuen Namen begonnen. 2002-04-02 20:14:33 +02:00			`.SH "SEE ALSO"`
- Dokumentation aktualisiert. 2002-09-16 13:11:21 +02:00			`.BR ngircd.conf (5),`
- Manual-Pages unter neuen Namen begonnen. 2002-04-02 20:14:33 +02:00			`.BR ircd (8)`
			`.\"`
			`.\" -eof-`