albino
/
ngircd-tor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Spell check and enhance ngIRCd manual pages.

This commit is contained in:
Alexander Barton 2008-12-30 19:20:09 +01:00
parent 307cdce908
commit 9d20397470
2 changed files with 44 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
man/ngircd.8.tmpl
View File

@ -64,15 +64,16 @@ The system wide default configuration file.
.RS .RS
Default "message of the day" (MOTD). Default "message of the day" (MOTD).
.RE .RE
.SH HINTS
It's wise to use "ngircd \-\-configtest" to validate the configuration file
after changing it.
.SH AUTHOR .SH AUTHOR
Alexander Barton, Alexander Barton,
.UR mailto:alex@barton.de .UR mailto:alex@barton.de
alex@barton.de
.UE .UE
.br .br
Homepage: Homepage:
.UR http://ngircd.barton.de/ .UR http://ngircd.barton.de/
http://ngircd.barton.de/
.UE .UE
.SH "SEE ALSO" .SH "SEE ALSO"
.BR ngircd.conf (5), .BR ngircd.conf (5),

77
man/ngircd.conf.5.tmpl
View File

@ -12,6 +12,9 @@ is the configuration file of the
.BR ngircd (8) .BR ngircd (8)
Internet Relay Chat (IRC) daemon which you should adept to your local Internet Relay Chat (IRC) daemon which you should adept to your local
preferences and needs. preferences and needs.
.PP
Most variables can be modified while the ngIRCd daemon is already running:
It will reload its configuration when a HUP signal is received.
.SH "FILE FORMAT" .SH "FILE FORMAT"
The file consists of sections and parameters. A section begins with the name The file consists of sections and parameters. A section begins with the name
of the section in square brackets and continues until the next section of the section in square brackets and continues until the next section
@ -58,7 +61,9 @@ 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, must contain at least one dot ("."). Server name in the IRC network. This is an individual name of the IRC
server, it is not related to the DNS host name. It must be unique in the
IRC network and must contain at least one dot (".") character.
.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
@ -70,11 +75,12 @@ command.
.TP .TP
\fBPorts\fR \fBPorts\fR
Ports on which the server should listen. There may be more than one port, Ports on which the server should listen. There may be more than one port,
separated with ','. Default: 6667. separated with commas (","). Default: 6667.
.TP .TP
\fBSSLPorts\fR \fBSSLPorts\fR
Same as \fBPorts\fR , except that ngircd will expect incoming connections Same as \fBPorts\fR , except that ngIRCd will expect incoming connections
to be SSL/TLS encrypted. Default: None to be SSL/TLS encrypted. Common port numbers for SSL-encrypted IRC are 6669
and 6697. Default: none.
.TP .TP
\fBSSLKeyFile\fR \fBSSLKeyFile\fR
Filename of SSL Server Key to be used for SSL connections. This is required for Filename of SSL Server Key to be used for SSL connections. This is required for
@ -84,20 +90,20 @@ SSL/TLS support.
(OpenSSL only:) Password to decrypt private key. (OpenSSL only:) Password to decrypt private key.
.TP .TP
\fBSSLCertFile\fR \fBSSLCertFile\fR
Certificate of the private key Certificate file of the private key.
.TP .TP
\fBSSLDHFile\fR \fBSSLDHFile\fR
Name of the Diffie-Hellman Parameter file. Can be created with gnutls Name of the Diffie-Hellman Parameter file. Can be created with gnutls
"certtool \-\-generate-dh-params" or "openssl dhparam". "certtool \-\-generate-dh-params" or "openssl dhparam".
If this file is not present, it will be generated on startup when ngircd If this file is not present, it will be generated on startup when ngIRCd
was compiled with gnutls support (this may take some time). If ngircd was compiled with gnutls support (this may take some time). If ngIRCd
was compiled with OpenSSL, then (Ephemeral)-Diffie-Hellman Key Exchanges and several was compiled with OpenSSL, then (Ephemeral)-Diffie-Hellman Key Exchanges and several
Cipher Suites will not be available. Cipher Suites will not be available.
.TP .TP
\fBListen\fR \fBListen\fR
A comma seperated list of IP address on which the server should listen. A comma separated list of IP address on which the server should listen.
If unset, the defaults value is "0.0.0.0", or, if ngircd was compiled If unset, the defaults value is "0.0.0.0" or, if nIRCcd was compiled
with IPv6 support, "::,0.0.0.0", so the server listens on all configured with IPv6 support, "::,0.0.0.0". So the server listens on all configured
IP addresses and interfaces by default. IP addresses and interfaces by default.
.TP .TP
\fBMotdFile\fR \fBMotdFile\fR
@ -106,8 +112,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 which can be handy if the If this variabke is set, no \fBMotdFile\fR will be read at all which can be
daemon should run inside a chroot directory. 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
@ -168,35 +174,35 @@ Should IRC Operators be allowed to use the MODE command even if they are
not(!) channel-operators? Default: no. not(!) channel-operators? Default: no.
.TP .TP
\fBOperServerMode\fR \fBOperServerMode\fR
If OperCanUseMode is enabled, this may lead the compatibility problems with If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems with
Servers that run the ircd-irc2 Software. This Option "masks" mode requests Servers that run the ircd-irc2 Software. This Option "masks" mode requests
by non-chanops as if they were coming from the server. Default: no. by non-chanops as if they were coming from the server. Default: no.
.TP .TP
\fBPredefChannelsOnly\fR \fBPredefChannelsOnly\fR
If enabled, no new channels can be created. Useful if If enabled, no new channels can be created. Useful if
you do not want to have channels other than those defined in you do not want to have channels other than those defined in
the config file. [Channel] sections in the configuration file.
Default: No. Default: no.
.TP .TP
\fBNoDNS\fR \fBNoDNS\fR
If set to true, ngircd will not make DNS lookups when clients connect. If set to true, ngIRCd will not make DNS lookups when clients connect.
If you configure ngircd to connect to other servers, ngircd may still If you configure the daemon to connect to other servers, ngIRCd may still
perform a DNS lookup if required. perform a DNS lookup if required.
Default: false. Default: no.
.TP .TP
\fBNoIdent\fR \fBNoIdent\fR
If ngircd is compiled with IDENT support this can be used to disable IDENT If ngIRCd is compiled with IDENT support this can be used to disable IDENT
lookups at run time. lookups at run time.
Default: false. Default: no.
.TP .TP
\fBConnectIPv4\fR \fBConnectIPv4\fR
Set this to no if you do not want ngircd to connect to other irc servers using ipv4. Set this to no if you do not want ngIRCd to connect to other IRC servers using
This allows use of ngircd in ipv6-only setups. IPv4. This allows usage of ngIRCd in IPv6-only setups.
Default: Yes. Default: yes.
.TP .TP
\fBConnectIPv6\fR \fBConnectIPv6\fR
Set this to no if you do not want ngircd to connect to other irc servers using ipv6. Set this to no if you do not want ngIRCd to connect to other irc servers using IPv6.
Default: Yes. Default: yes.
.TP .TP
\fBMaxConnections\fR \fBMaxConnections\fR
Maximum number of simultaneous in- and outbound connections the server is Maximum number of simultaneous in- and outbound connections the server is
@ -217,7 +223,7 @@ note that all servers in an IRC network MUST use the same maximum nick name
length! length!
.TP .TP
\fBSSLConnect\fR \fBSSLConnect\fR
Connect to the remote server using TLS/SSL (Default: false) Connect to the remote server using TLS/SSL. Default: false.
.SH [OPERATOR] .SH [OPERATOR]
.I [Operator] .I [Operator]
sections are used to define IRC Operators. There may be more than one sections are used to define IRC Operators. There may be more than one
@ -258,21 +264,21 @@ IRC name of the remote server.
Internet host name (or IP address) 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 is
to let the operating system decide. to let the operating system decide.
.TP .TP
\fBPort\fR \fBPort\fR
Port of the remote server to which ngIRCd should connect (active). Port of the remote server to which ngIRCd should connect (active).
If no port is assigned to a configured server, the daemon only waits for If no port is assigned to a configured server, the daemon only waits for
incoming connections (passive). incoming connections (passive, default).
.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
"PeerPassword" on the other server. Must not have ':' as first character. \fBPeerPassword\fR on the other server. Must not have ':' as first character.
.TP .TP
\fBPeerPassword\fR \fBPeerPassword\fR
Foreign password for this connection. This password has to be configured as Foreign password for this connection. This password has to be configured as
"MyPassword" on the other server. \fBMyPassword\fR on the other server.
.TP .TP
\fBGroup\fR \fBGroup\fR
Group of this server (optional). Group of this server (optional).
@ -282,13 +288,13 @@ 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.
.TP .TP
\fBServiceMask\fR \fBServiceMask\fR
Define a (case insensitive) mask matching nick names that sould be treated as Define a (case insensitive) mask matching nick names that should be treated as
IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED
this parameter, so leave it empty (which is the default). this parameter, so leave it empty (which is the default).
.PP .PP
.RS .RS
When you are connecting IRC services which mask as a IRC server and which use When you are connecting IRC services which mask as a IRC server and which use
"virtual users" to communicate with, for example "NickServ" amd "ChanServ", "virtual users" to communicate with, for example "NickServ" and "ChanServ",
you should set this parameter to something like "*Serv". you should set this parameter to something like "*Serv".
.SH [CHANNEL] .SH [CHANNEL]
Pre-defined channels can be configured in Pre-defined channels can be configured in
@ -304,7 +310,7 @@ There may be more than one
block. block.
.TP .TP
\fBName\fR \fBName\fR
Name of the channel, including channel prefix ("#"). Name of the channel, including channel prefix ("#" or "&").
.TP .TP
\fBTopic\fR \fBTopic\fR
Topic for this channel. Topic for this channel.
@ -316,7 +322,8 @@ Initial channel modes.
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 channel 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
@ -325,12 +332,10 @@ for details.
.SH AUTHOR .SH AUTHOR
Alexander Barton, Alexander Barton,
.UR mailto:alex@barton.de .UR mailto:alex@barton.de
alex@barton.de
.UE .UE
.br .br
Homepage: Homepage:
.UR http://ngircd.barton.de/ .UR http://ngircd.barton.de/
http://ngircd.barton.de/
.UE .UE
.SH "SEE ALSO" .SH "SEE ALSO"
.BR ngircd (8) .BR ngircd (8)