Fix double minus signs in manual pages
[ngircd-alex.git] / man / ngircd.8.tmpl
1 .\"
2 .\" $Id: ngircd.8.tmpl,v 1.2 2007/11/15 01:03:29 fw Exp $
3 .\"
4 .TH ngircd 8 "May 2008" 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. By default, ngIRCd writes diagnostic and informational messages using
27 the syslog mechanism.
28 .SH OPTIONS
29 The default behaviour of
30 .BR ngircd
31 is to read its standard configuration file (see below), to detach from the
32 controlling terminal and to wait for clients.
33 .PP
34 You can use these options to modify this default:
35 .TP
36 \fB\-f\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR
37 Use
38 .I file
39 as configuration file.
40 .TP
41 \fB\-n\fR, \fB\-\-nodaemon\fR
42 Don't fork a child and don't detach from controlling terminal.
43 All log messages go to the console and you can use CTRL-C to
44 terminate the server.
45 .TP
46 \fB\-p\fR, \fB\-\-passive\fR
47 Disable automatic connections to other servers. You can use the IRC command
48 CONNECT later on as IRC Operator to link this ngIRCd to other servers.
49 .TP
50 \fB\-t\fR, \fB\-\-configtest\fR
51 Read, validate and display the configuration; then exit.
52 .TP
53 \fB\-V\fR, \fB\-\-version\fR
54 Output version information and exit.
55 .TP
56 \fB\-h\fR, \fB\-\-help\fR
57 Display a brief help text and exit.
58 .SH FILES
59 .I :ETCDIR:/ngircd.conf
60 .RS
61 The system wide default configuration file.
62 .RE
63 .I :ETCDIR:/ngircd.motd
64 .RS
65 Default "message of the day" (MOTD).
66 .RE
67 .SH AUTHOR
68 Alexander Barton,
69 .UR mailto:alex@barton.de
70 alex@barton.de
71 .UE
72 .br
73 Homepage:
74 .UR http://ngircd.barton.de/
75 http://ngircd.barton.de/
76 .UE
77 .SH "SEE ALSO"
78 .BR ngircd.conf (5),
79 .BR ircd (8)
80 .\"
81 .\" -eof-