Update and enhance the manual pages a bit

[ngircd.git] / man / ngircd.8.tmpl

diff --git a/man/ngircd.8.tmpl b/man/ngircd.8.tmpl
index 524fe3c1885a90af0d3efbf566a89eff1df691c7..e71d2cefd7f65c1b3efc5d255086a6c752f95b3c 100644 (file)
--- a/man/ngircd.8.tmpl
+++ b/man/ngircd.8.tmpl
@@ -1,7 +1,7 @@
 .\"
 .\" ngircd(8) manual page template
 .\"
 .\"
 .\" ngircd(8) manual page template
 .\"

-.TH ngircd 8 "Oct 2013" ngIRCd "ngIRCd Manual"
+.TH ngircd 8 "Sep 2023" ngIRCd "ngIRCd Manual"

 .SH NAME
 ngIRCd \- the "next generation" IRC daemon
 .SH SYNOPSIS
 .SH NAME
 ngIRCd \- the "next generation" IRC daemon
 .SH SYNOPSIS


@@ -13,18 +13,21 @@ ngIRCd \- the "next generation" IRC daemon
 .BR ngIRCd
 is a free, portable and lightweight Internet Relay Chat server for small
 or private networks, developed under the GNU General Public License (GPL).
 .BR ngIRCd
 is a free, portable and lightweight Internet Relay Chat server for small
 or private networks, developed under the GNU General Public License (GPL).

-It is easy to configure, can cope with dynamic IP addresses, and supports
-IPv6, SSL-protected connections as well as PAM for authentication.
-It is written from scratch and not based on the original IRCd.
+.PP
+The server is quite easy to configure, can handle dynamic IP addresses, and
+optionally supports IDENT, IPv6 connections, SSL-protected links, and PAM for
+user authentication as well as character set conversion for legacy clients. The
+server has been written from scratch and is not based on the "forefather", the
+daemon of the IRCNet.

 .PP
 The name ngIRCd means
 .PP
 The name ngIRCd means

-.IR "next generation IRC daemon",
+.IR "next-generation IRC daemon",

 which is a little bit exaggerated:
 .IR "lightweight Internet Relay Chat server"
 most probably would have been a better name :-)
 .PP
 Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX, Hurd, IRIX,
 which is a little bit exaggerated:
 .IR "lightweight Internet Relay Chat server"
 most probably would have been a better name :-)
 .PP
 Currently supported platforms include AIX, A/UX, FreeBSD, HP-UX, Hurd, IRIX,

-Linux, Mac OS X, Minix, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
+Linux, macOS, Minix, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.

 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.
 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.


@@ -54,14 +57,25 @@ terminate the server.
 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
 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\-y\fR, \fB\-\-syslog\fR
+Write log messages to the syslog even when running in the foreground. This only
+makes sense when
+.I \-n/\-\-nodaemon
+was given on the command line
+.I before
+this option!
+.PP
+The following options prevent ngIRCd from starting regularly, but perform a
+specific action and then exit the daemon again:
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display a brief help text and exit.
+.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.
 \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
 .SH FILES
 .I :ETCDIR:/ngircd.conf
 .RS


@@ -81,8 +95,10 @@ Shut down all connections and terminate the daemon.
 Shut down all listening sockets, re-read the configuration file and
 re-initialize the daemon.
 .SH HINTS
 Shut down all listening sockets, re-read the configuration file and
 re-initialize the daemon.
 .SH HINTS

-It's wise to use "ngircd \-\-configtest" to validate the configuration file
-after changing it.
+It is
+.I always wise
+to use "ngircd \-\-configtest" to validate the configuration of ngIRCd after
+making changes to the configuration files!

 .SH DEBUGGING
 When ngIRCd is compiled with debug code, that is, its source code has
 been ./configure'd with "\-\-enable\-debug" and/or "\-\-enable\-sniffer" (witch
 .SH DEBUGGING
 When ngIRCd is compiled with debug code, that is, its source code has
 been ./configure'd with "\-\-enable\-debug" and/or "\-\-enable\-sniffer" (witch