FIDOGATE uses the following config files:
config.common
config.gate
config.main
config.ffx
hosts
aliases
areas
bounce.*
ftn2rfc
passwd
permissions
routing
ftntoss
and ftnroute
packing
ftnpack
areas.bbs
fareas.bbs
FIDOGATE tries to find these config files in LIBDIR
(compiled-in
default), if no -L
command line option is used. In addition,
FIDOGATE 4.2.7 and newer supports the environment variable
FIDOGATE
, which tells the various programs where to look for
their config files.
config.*
configuration files
hosts
FTN address to host name conversion
aliases
user aliases
areas
FTN area to newsgroup conversion
ftn2rfc
passwd
password config file
routing
file for ftntoss
and ftnroute
packing
file for ftnpack
areas.bbs
EchoMail distribution
All config files use the #
character for introducing a comment
and ignore empty lines. Keywords and commands are not case-sensitive.
All config files (with the execption of areas.bbs
support an
include
command for reading in other config files. include
must be the first keyword on the line, the filename is the next
argument.
All options and config statements which take file or directory names
accept the following %
abbreviations:
%L
LibDir
%S
SpoolDir
%G
LogDir
%O
Outbound
%I
Inbound
%P
PInbound
%U
UUInbound
config.*
Configuration FilesFIDOGATE uses different config files:
config.common
config.gate
ftn2rfc
,
ftnin
, ftninpost
, ftninrecomb
, rfc2ftn
.
config.main
ftn2ftn
,
ftnaf
, ftnbounce
, ftnbsy
, ftnconfig
,
ftnhatch
, ftnlock
, ftnlog
, ftnpack
,
ftnroute
, ftnseq
, ftntick
, ftntoss
,
ftnfattach
.
config.ffx
ffx
, ffxbatch
,
ffxqt
The format of these files is
keyword [ arg ... ]
Keywords and arguments may be quoted in ""
, keywords are
case-insensitive.
Common configuration:
include file
Address node
Address
statements (MAXADDRESS
from config.h
).
Uplink node
Address
statements. There may be up to 32
Uplink
statements.
LibDir directory
config.make
).
SpoolDir directory
config.make
).
LogDir directory
config.make
).
Outbound directory
out.
nnn zone directory.
Inbound directory
PInbound directory
Inbound
).
UUInbound directory
Hostname name
Domain name
HostsDomain name
hosts
config file. Default is
the same as Domain
.
Origin text
rfc2ftn
. Quote text in ""
if it contains
spaces. Individual origin lines may be specified in the areas
file using the -o
option.
Organization text
ftn2rfc
. Quote text in ""
if it contains spaces.
Zone zone domain ftndomain out
Outbound
) for the
FTN zone zone. zone may be default
, then this is the
default entry for not explicitely specified zones. Up to 32 Zone
entries may be specified (MAXADDRESS
from config.h
).
DosDrive drive directory
H:
) to a
directory. This is useful, if you keep your outbound on a UNIX server
and run BinkleyTerm on a DOS client. If one or more DosDrive
statements are specified, FIDOGATE will automatically translate file
attaches to the file names seen by the DOS client. Up to 16
DosDrive
entries may be specified (MAXDOSDRIVE
from
config.h
).
AreasXlate area-chars newsgroup-chars
areas
file) of characters for
Fido area <-> Internet newsgroup name conversion.
Aliases file
aliases
config file.
Areas file
areas
config file.
Hosts file
hosts
config file.
Passwd file
passwd
config file.
Packing file
packing
config file.
Routing file
routing
config file.
History file
history
database.
Special configuration ffx
(config file config.ffx
):
FFXDataFlav flavour
ffx
program.
FFXDataCompr command ...
ffx
data files.
FFXDataExt parameter
ffx
data files.
FFXDataDecompr parameter
ffx
data files (will be run by
ffxqt
).
FFXDataComprN parameter
ffx
data files (option
-n
).
FFXDataExtN parameter
ffx
data files
(option -n
).
FFXDataDecomprN parameter
ffx
data files (option
-n
, will be run by ffxqt
).
Special configuration ffx
(config file config.ffx
):
Special configuration ffxbatch
(config file config.ffx
):
FFXBatchArc command ...
ffx
files.
FFXBatchArcV command ...
ffx
files if option
-v
is given.
FFXBatchArcExt parameter
FFXBatchArcCmd parameter
ffxqt
.
FFXDataFlav parameter
ffxqt
program.
Special configuration ffxqt
(config file config.ffx
):
FFXCommand name command ...
ffxqt
. Only the commands listed can be executed. This replaces
the old LIBDIR/ffxqt-dir/name structure of previous FIDOGATE
versions.
FFXUncompress name command ...
ffxqt
.
Special configuration ftn2rfc
(config file config.gate
):
DotNames
rfc2ftn
recognizes both address
types.
X-FTN header
ftn2rfc
:
f
X-FTN-From
t
X-FTN-To
T
X-FTN-Tearline
O
X-FTN-Origin
V
X-FTN-Via
D
X-FTN-Domain
S
X-FTN-Seen-By
P
X-FTN-Path
X-FTN-From
is required for the proper operation of ftnaf
.
BounceCCMail user@do.main
TrackerMail user@do.main
KillUnknownMSGIDZone
^AMSGID
from an unknown zone (not
listed in Zone
statements).
KillNoMSGID
^AMSGID
kludge.
KillSplit
^ASPLIT
kludge.
UseOriginForOrganization
UseFTNToAddress
Max Mueller 2:2452/110.2with a HOSTS entry
2:2452/110.2 orodruin-ftn.fido.deis converted to
To: Max_Mueller@orodruin-ftn.fido.deWithout this option the standard local HOST.DOMAIN is used, e.g.
To: Max_Mueller@orodruin.fido.de
HostsRestricted
hosts
.
FTNJunkGroup name
ErrorsTo user@do.main
NoAddressInToField
@ ! %
chars in the FTN to field, thus preventing
users from putting Internet addresses in the to field.
NetMail8bit
NetMailQuotedPrintable
NetMailQP
NetMailQuotedPrintable
overrides NetMail8bit
if
both are specified.
SingleArticles
tmpnews
), not news
batches containing several articles (batch is default).
RFCAddrMode mode
() p 0
<> a 1
Special configuration ftninpost
(config file config.gate
):
FTNInSendmail command ...
ftninpost
with options. The option
-fsender
will be automatically added by ftninpost
. For
compatibility with old FIDOGATE configurations, any -f%s
option
will be removed.
FTNInRnews command ...
ftninpost
.
FTNInRecombine
ftninrecomb
to recombine split messages.
Special configuration rfc2ftn
(config file config.gate
):
Gateway node
NoFromLine
From:
header and FSC-0035 kludges. Must be set for
a non-gateway, point FIDOGATE configuration.
NoFSC0035
^AREPLYADDR
, ^AREPLYTO
.
NoFSC0047
^ASPLIT
, use old * Large message
split by
... text line.
MaxMsgSize bytes
LimitMsgSize bytes
MausDomain .do.main
MausGate address
maus
config file. MausDomain
sets the Internet domain of MAUS addresses, MausGate
the address
of the Fido-MAUS gateway.
If set, User_Name@xy.maus.domain will be converted to User Name %
XY for the Fido-MAUS gateway.
EchoMail4D
HostsRestricted
hosts
.
RFCLevel n
-R
option in areas
.
UseOrganizationForOrigin
XFlagsPolicy
n N 0
s S 1
a A 2
DontUseReplyTo
RFCAddrMode mode
() p 0
<> a 1
ReplyAddrIfMailTX
^AREPLYADDR
(if FSC0035
is enabled) to only contains
^AREPLYADDR <user@do.main>
for compatibility with ifmail-TX.
Special configuration ftnhatch
(config file config.main
):
TickFlav flavour
ftnhatch
.
Special configuration ftntick
(config file config.main
):
TickFlav flavour
ftntick
.
TickReplacedDir directory
ftntick
.
UnknownTickArea area
Special configuration ftnaf
(config file config.main
):
AreasBBS name
areas.bbs
EchoMail distribution file used by
ftnaf
and ftntoss
.
FAreasBBS name
fareas.bbs
file echo distribution file used by
ftnaf -F
and ftnhatch
/ ftntick
.
CCMail user@do.main
ftnaf
's replies to this address.
Special configuration ftnexpire
(config file config.main
):
MaxHistory days
Special configuration ftnpack
(config file config.main
):
MaxArc Kbyte
ftnpack
. See also
-m
option.
Special configuration ftnroute
(config file config.main
):
MaxOpenFiles n
MAXOPENFILES
from config.h
), see also -M
option.
Special configuration ftntoss
(config file config.main
):
AddToSeenBy area nodes
*?[a-z]
.
ZoneGate node seenby
ZoneGate 1:105/42 105/42 2452/110
KillEmpty
KillBlank
KillUnknown
KillRouted
KillInsecure
areas.bbs
).
KillCircular
^APATH
).
LogNetMail
Track
CheckPath
KillCircular
).
DupeCheck
/history
database).
KillNoMSGID
^AMSGID
, i.e. treat as dupes.
KillDupe
KillDupes
DupeCheck
is enabled.
KillOld
MaxHistory
, i.e. treat as
dupes.
MaxMsg n
-m
option.
MaxOpenFiles n
MAXOPENFILES
from config.h
), see also -M
option.
AreasBBS name
areas.bbs
EchoMail distribution file used by
ftnaf
and ftntoss
.
MaxHistory days
MaxHistory
are
considered old.
EchoMail4D
NoEmptyPath
Special configuration runtoss
(config file config.main
):
MinDiskFree Kbyte
runtoss
script. runtoss
will terminate if there is less than Kbyte
free disk space in SPOOLDIR.
Special configuration ftnfattach
(config file config.main
):
FAttachFlav flavour
ftnfattach
.
hosts
FTN Address to Host Name Conversion
This file contains the FTN addresses and host names for registered FTN
nodes. If HostsRestricted
is defined in config.gate
, this
file controls the access to the gateway.
The format of this file is
node hostname [ options ]
Fields:
.
is a hostname in the local
domain (specified by HostsDomain
or default Domain
in config
).
.
is a fully qualified domain name
for this node.
-
-
specifies a listed node, but without a host name
translation, using the standard p.f.n.z address.
-p
p99.hippo.fido.de
.
Default is omitting the point part.
-d
The hosts
file is read into memory during startup of FIDOGATE.
The first entry found matches, so a host name for a point must be
specified before the boss node, if there are entries for both.
Example:
config
:
HostsDomain .Fido.DE
hosts
:
2:2452/110 hippo 2:2452/990 test -p 2:2452/991 test.wusel.org. 2:2452/999 -
Resulting data base read into memory:
Node: 2:2452/110.0 Hostname: hippo.Fido.DE Flags: Node: 2:2452/990.0 Hostname: test.Fido.DE Flags: POINT Node: 2:2452/991.0 Hostname: test.wusel.org Flags: Node: 2:2452/999.0 Hostname: Flags:
This results in the following conversion of addresses from FTN to Internet:
2:2452/110 -> hippo.Fido.DE 2:2452/110.99 -> hippo.Fido.DE 2:2452/990.99 -> p99.test.Fido.DE 2:2452/991.1 -> test.wusel.org 2:2452/999.2 -> p2.f999.n2452.z2.Fido.DE
aliases
User AliasesThis file contains user aliases, the FTN address, and the full name of the user.
The format of this file is
alias node "full name"
Fields:
The FTN address node may be a point address. In this case mail addressed to the user at the boss node address will be readdressed to this point, see example below.
Example:
aliases
:
mvr 2:2452/110.6 "Marc van.Rey"
Using the definitions from the section on hosts
, this results in
the following address conversion:
Marc van.Rey @ 2:2452/110.6 <-> mvr@hippo.Fido.DE
areas
FTN Area to Newsgroup ConversionThis file contains FTN areas with corresponding newsgroups and options.
The format of this file is
area newsgroup [ options ]
Fields:
-a address
-z zone
-d distribution
distribution
for this newsgroup when gating from FTN
to Internet.
-o "origin"
config
.)
-g
-l
-x
-8
-Q
-H
GNU. gnu. -z 242 -H
gnu.announce
will be converted to GNU.ANNOUNCE
,
gnu.bug.gcc
to GNU.BUG.GCC
, similar for all other.
-!
-H
). Usefull to exclude certain newsgroups from a hierarchy for
gating.
Example:
ALT.BINARIES. alt.binaries. -z 242 -H -! ALT. alt. -z 242 -HThis is roughly equivalent to INN's
alt.*,!alt.binaries.*
. Please
note that the first areas
entry matches, so any -!
must be
placed before the -H
hierarchy definition.
-R level
^ARFC-
Header put into FIDO messages for this
area. Level:
^ARFC-
header at all.
^ARFC-
header.
^ARFC-
header.
-m bytes
MaxMsgSize
for this area (0 = no limit).
-M bytes
LimitMsgSize
for this area (0 = no limit).
-X "RFC-Header: text"
ftn2rfc
. Multiple -X
options are possible.
Only newsgroups listed in this file will be gated from Internet to FTN.
FTN area not listed in this file will be gated into the
FTNJunkGroup
newsgroup specified in config.gate
.
ftn2rfc
ftn2rfc
uses the following files for messages sent to the FTN
user when bouncing mail for some reason:
bounce.noto
UUCP
or GATEWAY
without a
To
line at the very beginning of the message.
bounce.down
hosts
(-d
flag).
bounce.restricted
hosts
, gateway running in
restricted mode.
bounce.insecure
To
line. This requires the -t
option to
ftn2rfc
.
Within a bounce message, the following substitutions can be used:
%F
%T
%O
%d
%t
%f
%s
%R
To
line, Internet address.
%M
passwd
Password Config File
This file contains passwords used by ftnaf
, ffx
, and the
tosser programs.
The format of this file is:
context node password options
Contexts:
packet
ftntoss
, inserted by all
FIDOGATE programs which create FTN packets. Password checking for
incoming packets is NOT YET IMPLEMENTED.
af
ftnaf
.
ff
ftnaf -F
.
ffx
ffx
command passwords, checked by ffxqt
, inserted by
ffx
into the .ffx
command files.
Optional stuff (options) is used for ftnaf
permission
settings:
lvl key "Sysop Name"
lvl is the access level, which must be greater or equal than the one
in areas.bbs
. key is the access key, which must be a super
set of the one in areas.bbs
.
Example:
packet 2:1234/5678 WUERG ffx 242:1111/99 BLAHBLUB af 2:1234/5678 WUSEL 1 F "Test Sysop" ff 242:1234/5678 WUSEL 4 UQ "Yet Another Sysop"
routing
Config File
This file contains the routing commands performed by ftntoss
(commands remap
and rewrite
) and ftnroute
(everything else). The first routing command found matches.
The syntax of the routing
commands is very similar to the routing
file used by the well-known FIDO tossers QMail and SQUISH.
The format of this file is:
remap src-node dest-node name remapto src-node dest-node name remapfrom src-node dest-node name rewrite src-node dest-node echomail netmail send flavor nodes route flavor dest-node nodes hostroute flavor nodes hubroute flavor nodes xroute flavor dest-node from-node to-node bossroute flavor nodes change old-flavor new-flavor nodes sendmove flavor nodes
Commands:
remap
remapto
remapfrom
rewrite
echomail
netmail
allmail
send
send
(when compared to the operation of e.g. SQUISH). A command send
hold 2:123/456
actually equals send hold 2:123/456.*
, i.e. mail
for every single point of this node is put onto hold. Use the command
route hold 2:123/456
instead to get the desired behaviour!!!
route
hostroute
hubroute
xroute
bossroute
change
sendmove
send
, but ftnroute
doesn't copy the mail packets,
they are moved instead. This requires that SPOOLDIR/toss/tmp and
SPOOLDIR/toss/out are on the same file system/disk drive.
Node addresses nodes, src-node, dest-node support wildcards
using *
and all
, which can be used for the zone, net,
node, and point component of an address. *
alone matches all
addresses. rewrite
wildcards in the destination address are
replaced with the corresponding component of the source address.
The outbound flavor string flavor can be any of
normal
, hold
, crash
, direct
, out
,
hut
, cut
, dut
.
Example:
Remap 2:2452/110.0 2:2452/110.7 "Martin Koser" Rewrite 242:241/* 2:241/* NetMail send hold 242:1000/1.all change crash hold 242:1000/1.all 2.all send hold 242:1000/3 route hold 242:1000/50 51 52 53 54 55 56 57 58 59
packing
Config File
This file contains the packer (archiver) definitions and packing
commands for ftnpack
.
The format of this file is:
arc name"
archiver"
prog name"
program"
pack name nodes rpack name dest-node nodes fpack name dest-node nodes dirpack dir name nodes
Packer/program definitions:
arc
%s
, the first one is replaced with the
archive name, the second one with the packet name.
prog
%s
, which is replaced with the name of the packet to be
processed.
Packing definitions:
pack
noarc
indicates that the mail packet
should not be packed, but copied to the OUT file of the node.
rpack
pack
, but pack all mail addressed to nodes to the
archive for dest-node.
fpack
rpack
, but the packet is archived for the normal
arcmail packet for each node. This archive is then attached to the FLO
file of dest-node.
dirpack
Example:
arc zip "/usr/local/bin/zip -gkj %s %s" rpack zip 2:242/41 2:242/42 242:2000/* 254:*/* pack noarc 2:2452/110.1 242:4900/99 254:2410/6.1 pack zip *
areas.bbs
EchoMail Distribution
This file contains the EchoMail areas and linked nodes. The file
fareas.bbs
is used for file echos.
The format of this file is as follows, the first line being ignored for compatibility with the standard DOS AREAS.BBS.
[#]directory area [options] nodes
-a
) will be created.
-a address
-z zone
ftnaf
will
automatically rewrite areas.bbs
, inserting the -z
option.
-l lvl
-k key
Go to the first, previous, next, last section, table of contents.