Updated documentation.
This commit is contained in:
Alexander Barton
parent
b6999f10c0
commit
10bb43c66e
15
INSTALL
15
INSTALL
|
|
@ -118,15 +118,18 @@ In the sample configuration file, there are comments beginning with "#" OR
|
|||
";" -- this is only for the better understanding of the file.
|
||||
|
||||
The file is separated in four blocks: [Global], [Operator], [Server], and
|
||||
[Channel]. In the [Global] part, there is the main configuration, like the
|
||||
server-name and the ports, on which the server should be listening. In the
|
||||
[Operator] section, the server-operators are defined and [Server] is the
|
||||
section, where the server-links are configured. Use [Channel] blocks to
|
||||
[Channel].
|
||||
|
||||
In the [Global] section, there is the main configuration like the server
|
||||
name and the ports, on which the server should be listening. IRC operators
|
||||
of this server are defined in [Operator] blocks. [Server] is the section
|
||||
where server links are configured. And [Channel] blocks are used to
|
||||
configure pre-defined ("persistent") IRC channels.
|
||||
|
||||
The meaning of the variables in the configuration file is explained in the
|
||||
"doc/sample-ngircd.conf", which is used as sample configuration file in
|
||||
/usr/local/etc after running "make install" (if you don't already have one).
|
||||
/usr/local/etc after running "make install" (if you don't already have one)
|
||||
and in the "ngircd.conf" manual page.
|
||||
|
||||
|
||||
IV. Command line options
|
||||
|
|
@ -154,4 +157,4 @@ number. In both cases the server exits after the output.
|
|||
|
||||
|
||||
--
|
||||
$Id: INSTALL,v 1.13 2003/03/09 22:03:58 alex Exp $
|
||||
$Id: INSTALL,v 1.14 2003/03/10 00:23:34 alex Exp $
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# $Id: sample-ngircd.conf,v 1.19 2003/03/09 22:03:58 alex Exp $
|
||||
# $Id: sample-ngircd.conf,v 1.20 2003/03/10 00:23:34 alex Exp $
|
||||
|
||||
#
|
||||
# This is a sample configuration for the ngIRCd, which must adept to the
|
||||
# local preferences and needs.
|
||||
# This is a sample configuration file for the ngIRCd, which must adept to
|
||||
# the local preferences and needs.
|
||||
#
|
||||
# Comments are started with "#" or ";".
|
||||
#
|
||||
|
|
@ -12,56 +12,56 @@
|
|||
|
||||
[Global]
|
||||
|
||||
# In the [global] section of this file, there is the place of the
|
||||
# main server configuration. Needed is only the variable "Name",
|
||||
# Info you can adjust, if you like to. For all the others variables,
|
||||
# you can use the defaults, this means you can leave it by default.
|
||||
# The [Global] section of this file is used to define the main
|
||||
# configuration of the server, like the server name and the ports
|
||||
# on which the server should be listening.
|
||||
|
||||
# Server name in the IRC-network
|
||||
Name = irc.the.net
|
||||
|
||||
# Info-text of the server. This will be shown i.e. by a WHOIS- or
|
||||
# LINKS-request.
|
||||
# Info text of the server. This will be shown by WHOIS and
|
||||
# LINKS requests for example.
|
||||
Info = Server Info Text
|
||||
|
||||
# Information about the server and administrator in the ADMIN-request
|
||||
# Information about the server and the administrator, used by the
|
||||
# ADMIN command.
|
||||
;AdminInfo1 = Description
|
||||
;AdminInfo2 = Location
|
||||
;AdminEMail = admin@irc.server
|
||||
|
||||
# Ports, on which the server will listen. There may be more than
|
||||
# Ports on which the server should listen. There may be more than
|
||||
# one port, separated with ";". (Default: 6667)
|
||||
;Ports = 6667, 6668, 66694
|
||||
|
||||
# Text file with the "message of the day" (MOTD). This will be shown
|
||||
# on a user connection with the server.
|
||||
# Text file with the "message of the day" (MOTD). This message will
|
||||
# be shown to all users connecting to the server:
|
||||
;MotdFile = /usr/local/etc/ngircd.motd
|
||||
|
||||
# User-ID, under which the server is started (for that the server
|
||||
# must be started with root-rights). You can use the name of the
|
||||
# user or the numerical ID.
|
||||
# ATTENTION: the configuration and the MOTD file must be readable
|
||||
# by this user, otherwise RESTART won't work!
|
||||
# User ID under which the server should run; you can use the name
|
||||
# of the user or the numerical ID. ATTENTION: For this to work the
|
||||
# server must have been started with root privileges! In addition,
|
||||
# the configuration and MOTD files must be readable by this user,
|
||||
# otherwise RESTART and REHASH won't work!
|
||||
;ServerUID = 65534
|
||||
|
||||
# Group-ID, under which the server is running (for that the server
|
||||
# must be started with root-rights). You can use the name of the
|
||||
# group or the numerical ID.
|
||||
# Group ID under which the ngircd should run; you can use the name
|
||||
# of the group or the numerical ID. ATTENTION: For this to work the
|
||||
# server must have been started with root privileges!
|
||||
;ServerGID = 65534
|
||||
|
||||
# After <PingTimeout> seconds, the server will send a ping after
|
||||
# inactivity of this client.
|
||||
# After <PingTimeout> seconds of inactivity the server will send a
|
||||
# PING to the peer to test whether it is alive or not.
|
||||
;PingTimeout = 120
|
||||
|
||||
# If there is an answer of a client, to which the ping was sent,
|
||||
# not after <PongTimeout> seconds, it will be disconnected.
|
||||
# If a client fails to answer a PING with a PONG within <PongTimeout>
|
||||
# seconds, it will be disconnected by the server.
|
||||
;PongTimeout = 20
|
||||
|
||||
# The server tries every <ConnectRetry> seconds, not yet connected
|
||||
# or not anymore connected servers to connect.
|
||||
# The server tries every <ConnectRetry> seconds to establish a link
|
||||
# to not yet (or no longer) connected servers.
|
||||
;ConnectRetry = 60
|
||||
|
||||
# Should IRC-operators be allowed to use the MODE command even if
|
||||
# Should IRC Operators be allowed to use the MODE command even if
|
||||
# they are not(!) channel-operators?
|
||||
;OperCanUseMode = no
|
||||
|
||||
|
|
@ -73,39 +73,37 @@
|
|||
;MaxJoins = 10
|
||||
|
||||
[Operator]
|
||||
# In this [operator]-section, there will be the configuration of
|
||||
# the name and password of an IRC operator. There may be more than
|
||||
# one operator-block (for each operator one).
|
||||
# [Operator] sections are used to define IRC Operators. There may be
|
||||
# more than one [Operator] block, one for each local operator.
|
||||
|
||||
# ID of the operator (may be different of the nick)
|
||||
# ID of the operator (may be different of the nick name)
|
||||
;Name = TheOper
|
||||
|
||||
# Password of the operator
|
||||
# Password of the IRC operator
|
||||
;Password = ThePwd
|
||||
|
||||
[Server]
|
||||
# In this [Server] section, there is the configuration of the
|
||||
# servers, which are allowed to connect to your own server.
|
||||
# There may be more than one server-block.
|
||||
# If you configured a port for the connection, then the ngIRCd
|
||||
# tries to connect to this port. If not, it waits for the other
|
||||
# server.
|
||||
# Other servers are configured in [Server] 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
|
||||
# for the other server to connect.
|
||||
# There may be more than one server block.
|
||||
#
|
||||
# Server-groups:
|
||||
# The ngIRCd allows "server-groups": that means, that you can assign
|
||||
# server-groups for every server, to which you want the ngIRCd to
|
||||
# connect to. If one server of a server-group won't answer, the
|
||||
# ngIRCd tries the next one of this group.
|
||||
# ATTENTION: Server-groups will only work if you defined a port!
|
||||
# Server Groups:
|
||||
# The ngIRCd allows "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 answer, the ngIRCd tries to connect to the next server
|
||||
# in the given group. But the ngircd never tries to connect to two
|
||||
# servers with the same group ID.
|
||||
|
||||
# IRC-name of the server
|
||||
# IRC name of the server
|
||||
;Name = irc2.the.net
|
||||
|
||||
# Hostname of the server
|
||||
# Internet host name of the peer
|
||||
;Host = connect-to-host.the.net
|
||||
|
||||
# Port of the server, to which the ngIRCd should connect. If you
|
||||
# assign no port, the ngIRCd waits for an answer of that server.
|
||||
# Port of the server to which the ngIRCd should connect. If you
|
||||
# assign no port the ngIRCd waits for incoming connections.
|
||||
;Port = 6666
|
||||
|
||||
# Own password for the connection. This password has to be configured
|
||||
|
|
@ -116,23 +114,24 @@
|
|||
# configured as "MyPassword" on the other server.
|
||||
;PeerPassword = PeerSecret
|
||||
|
||||
# Group of that server (optional)
|
||||
# Group of this server (optional)
|
||||
;Group = 123
|
||||
|
||||
[Channel]
|
||||
# In the [Channel] there can be defined "persistent channels". This
|
||||
# means, that the server creates the channel and even if all users
|
||||
# left this channel, it will persist. There may be more than one
|
||||
# block. Signed with the mode "P", which can be set or unset, like
|
||||
# normal modes.
|
||||
# Pre-defined channels can be configured in [Channel] sections.
|
||||
# Such channels are created by the server when starting up and even
|
||||
# persist when there are no more members left.
|
||||
# Persistent channels are marked with the mode 'P', which can be set
|
||||
# and unset by IRC operators like other modes on the fly.
|
||||
# There may be more than one [Channel] block.
|
||||
|
||||
# Name of the channel
|
||||
;Name = #TheName
|
||||
|
||||
# Topic for the channel
|
||||
# Topic for this channel
|
||||
;Topic = a great topic
|
||||
|
||||
# Channel-modes
|
||||
# Initial channel modes
|
||||
;Modes = tn
|
||||
|
||||
# -eof-
|
||||
|
|
|
|||
Loading…
Reference in New Issue