mirror of
https://github.com/osmarks/ngircd.git
synced 2025-05-23 09:34:09 +00:00
Update ngIRCd manual pages
- Update timestamp, - enhance some phrasing, - and fix "Passive" ([Server]) formatting. (cherry picked from commit aad49bd260494878aed6795c7a897ad1d28c3082)
This commit is contained in:
parent
a3dc42534b
commit
42207d160b
@ -1,7 +1,7 @@
|
|||||||
.\"
|
.\"
|
||||||
.\" $Id: ngircd.8.tmpl,v 1.2 2007/11/15 01:03:29 fw Exp $
|
.\" $Id: ngircd.8.tmpl,v 1.2 2007/11/15 01:03:29 fw Exp $
|
||||||
.\"
|
.\"
|
||||||
.TH ngircd 8 "August 2005" ngircd "ngIRCd Manual"
|
.TH ngircd 8 "May 2008" ngircd "ngIRCd Manual"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
ngIRCd \- the next generation IRC daemon
|
ngIRCd \- the next generation IRC daemon
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
.\"
|
.\"
|
||||||
.\" $Id: ngircd.conf.5.tmpl,v 1.7 2007/11/23 16:26:03 fw Exp $
|
.\" $Id: ngircd.conf.5.tmpl,v 1.7 2007/11/23 16:26:03 fw Exp $
|
||||||
.\"
|
.\"
|
||||||
.TH ngircd.conf 5 "August 2005" ngircd "ngIRCd Manual"
|
.TH ngircd.conf 5 "May 2008" ngircd "ngIRCd Manual"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
ngircd.conf \- configuration file of ngIRCd
|
ngircd.conf \- configuration file of ngIRCd
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
@ -26,19 +26,20 @@ Sections contain parameters of the form
|
|||||||
.RE
|
.RE
|
||||||
.PP
|
.PP
|
||||||
Empty lines and any line beginning with a semicolon (';') or a hash ('#')
|
Empty lines and any line beginning with a semicolon (';') or a hash ('#')
|
||||||
character is treated as a comment and will be ignored.
|
character are treated as a comment and will be ignored. Leading and trailing
|
||||||
|
whitespaces are trimmed before any processing takes place.
|
||||||
.PP
|
.PP
|
||||||
The file format is line-based - that means, each newline-terminated line
|
The file format is line-based - that means, each non-empty newline-terminated
|
||||||
represents either a comment, a section name or a parameter.
|
line represents either a comment, a section name, or a parameter.
|
||||||
.PP
|
.PP
|
||||||
Section and parameter names are not case sensitive.
|
Section and parameter names are not case sensitive.
|
||||||
.SH "SECTION OVERVIEW"
|
.SH "SECTION OVERVIEW"
|
||||||
The file can contain blocks of four types: [Global], [Operator], [Server],
|
The file can contain blocks of four types: [Global], [Operator], [Server],
|
||||||
and [Channel].
|
and [Channel].
|
||||||
.PP
|
.PP
|
||||||
In the
|
The main configuration of the server is stored in the
|
||||||
.I [Global]
|
.I [Global]
|
||||||
section, there is the main configuration like the server name and the
|
section, like the server name, administrative information and the
|
||||||
ports on which the server should be listening. IRC operators of this
|
ports on which the server should be listening. IRC operators of this
|
||||||
server are defined in
|
server are defined in
|
||||||
.I [Operator]
|
.I [Operator]
|
||||||
@ -57,7 +58,7 @@ section is used to define the server main configuration, like the server
|
|||||||
name and the ports on which the server should be listening.
|
name and the ports on which the server should be listening.
|
||||||
.TP
|
.TP
|
||||||
\fBName\fR
|
\fBName\fR
|
||||||
Server name in the IRC network
|
Server name in the IRC network, must contain at least one dot (".").
|
||||||
.TP
|
.TP
|
||||||
\fBInfo\fR
|
\fBInfo\fR
|
||||||
Info text of the server. This will be shown by WHOIS and LINKS requests for
|
Info text of the server. This will be shown by WHOIS and LINKS requests for
|
||||||
@ -83,7 +84,8 @@ to all users connecting to the server.
|
|||||||
.TP
|
.TP
|
||||||
\fBMotdPhrase\fR
|
\fBMotdPhrase\fR
|
||||||
A simple Phrase (<256 chars) if you don't want to use a MOTD file.
|
A simple Phrase (<256 chars) if you don't want to use a MOTD file.
|
||||||
If it is set no MotdFile will be read at all.
|
If it is set no MotdFile will be read at all which can be handy if the
|
||||||
|
daemon should run inside a chroot directory.
|
||||||
.TP
|
.TP
|
||||||
\fBServerUID\fR
|
\fBServerUID\fR
|
||||||
User ID under which the server should run; you can use the name of the user
|
User ID under which the server should run; you can use the name of the user
|
||||||
@ -205,31 +207,34 @@ Example: nick!ident@*.example.com
|
|||||||
Other servers are configured in
|
Other servers are configured in
|
||||||
.I [Server]
|
.I [Server]
|
||||||
sections. If you configure a port for the connection, then this ngIRCd
|
sections. If you configure a port for the connection, then this ngIRCd
|
||||||
tries to connect to to the other server on the given port; if not, it waits
|
tries to connect to to the other server on the given port (active);
|
||||||
for the other server to connect.
|
if not, it waits for the other server to connect (passive).
|
||||||
.PP
|
.PP
|
||||||
The ngIRCd allows "server groups": You can assign an "ID" to every server
|
ngIRCd supports "server groups": You can assign an "ID" to every server
|
||||||
with which you want this ngIRCd to link. If a server of a group won't
|
with which you want this ngIRCd to link, and the daemon ensures that at
|
||||||
answer, the ngIRCd tries to connect to the next server in the given group.
|
any given time only one direct link exists to servers with the same ID.
|
||||||
But ngIRCd never tries to connect to two servers with the same group ID.
|
So if a server of a group won't answer, ngIRCd tries to connect to the next
|
||||||
|
server in the given group (="with the same ID"), but never tries to connect
|
||||||
|
to more than one server of this group simultaneously.
|
||||||
.PP
|
.PP
|
||||||
There may be more than one
|
There may be more than one
|
||||||
.I [Server]
|
.I [Server]
|
||||||
block.
|
block.
|
||||||
.TP
|
.TP
|
||||||
\fBName\fR
|
\fBName\fR
|
||||||
IRC name of the server
|
IRC name of the remote server.
|
||||||
.TP
|
.TP
|
||||||
\fBHost\fR
|
\fBHost\fR
|
||||||
Internet host name of the peer
|
Internet host name (or IP address) of the peer.
|
||||||
.TP
|
.TP
|
||||||
\fBBind\fR
|
\fBBind\fR
|
||||||
IP address to use as source IP for the outgoing connection. Default ist
|
IP address to use as source IP for the outgoing connection. Default ist
|
||||||
to let the operating system decide.
|
to let the operating system decide.
|
||||||
.TP
|
.TP
|
||||||
\fBPort\fR
|
\fBPort\fR
|
||||||
Port of the server to which the ngIRCd should connect. If you assign no port
|
Port of the remote server to which ngIRCd should connect (active).
|
||||||
the ngIRCd waits for incoming connections.
|
If no port is assigned to a configured server, the daemon only waits for
|
||||||
|
incoming connections (passive).
|
||||||
.TP
|
.TP
|
||||||
\fBMyPassword\fR
|
\fBMyPassword\fR
|
||||||
Own password for this connection. This password has to be configured as
|
Own password for this connection. This password has to be configured as
|
||||||
@ -241,6 +246,7 @@ Foreign password for this connection. This password has to be configured as
|
|||||||
.TP
|
.TP
|
||||||
\fBGroup\fR
|
\fBGroup\fR
|
||||||
Group of this server (optional).
|
Group of this server (optional).
|
||||||
|
.TP
|
||||||
\fBPassive\fR
|
\fBPassive\fR
|
||||||
Disable automatic connection even if port value is specified. Default: false.
|
Disable automatic connection even if port value is specified. Default: false.
|
||||||
You can use the IRC Operator command CONNECT later on to create the link.
|
You can use the IRC Operator command CONNECT later on to create the link.
|
||||||
@ -258,19 +264,19 @@ There may be more than one
|
|||||||
block.
|
block.
|
||||||
.TP
|
.TP
|
||||||
\fBName\fR
|
\fBName\fR
|
||||||
Name of the channel
|
Name of the channel, including channel prefix ("#").
|
||||||
.TP
|
.TP
|
||||||
\fBTopic\fR
|
\fBTopic\fR
|
||||||
Topic for this channel
|
Topic for this channel.
|
||||||
.TP
|
.TP
|
||||||
\fBModes\fR
|
\fBModes\fR
|
||||||
Initial channel modes.
|
Initial channel modes.
|
||||||
.TP
|
.TP
|
||||||
\fBKey\fR
|
\fBKey\fR
|
||||||
Sets initial channel key (only relevant if mode k is set)
|
Sets initial channel key (only relevant if mode k is set).
|
||||||
.TP
|
.TP
|
||||||
\fBMaxUsers\fR
|
\fBMaxUsers\fR
|
||||||
Set maximum user limit for this channel (only relevant if mode l is set)
|
Set maximum user limit for this channel (only relevant if mode l is set).
|
||||||
.SH HINTS
|
.SH HINTS
|
||||||
It's wise to use "ngircd --configtest" to validate the configuration file
|
It's wise to use "ngircd --configtest" to validate the configuration file
|
||||||
after changing it. See
|
after changing it. See
|
||||||
|
Loading…
x
Reference in New Issue
Block a user