This is Info file fidogate.info, produced by Makeinfo-1.55 from the
input file fidogate.texi.

   This file documents the usage of FIDOGATE.

   Copyright (C) 1994-1995, Martin Junius

   Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

   Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

   Permission is granted to copy and distribute translations of this
manual into other languages, under the above conditions for modified
versions.


File: fidogate.info,  Node: Hosts,  Next: Aliases,  Prev: Config,  Up: Config files

`hosts' FTN Address to Host Name Conversion
===========================================

This file contains the FTN addresses and host names for registered FTN
nodes. If `HOSTS_RESTRICTED' is defined in `config.h', this file
controls the access to the gateway.

The format of this file is

     node  hostname  [ options ]

Fields:

node
     FTN address. An address for a node will match all points of this
     node, see example below.

hostname
     Host name, one of

    local host name
          A name without a trailing `.' is a hostname in the local
          domain (specified by `HostsDomain' or default `Domain' in
          `config').

    fully qualified domain name
          A name with a trailing `.' is a fully qualified domain name
          for this node.

    `-'
          A `-' specifies a listed node, but without a host name
          translation, using the standard p.f.n.z address.

options
    `-p'
          Generate addresses with point, e.g. `p99.hippo.fido.de'.
          Default is omitting the point.

    `-d'
          Mark the node as down, mail to this address will be bounced
          with an appropiate error message.

   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


File: fidogate.info,  Node: Aliases,  Next: Areas,  Prev: Hosts,  Up: Config files

`aliases' User Aliases
======================

This 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:

alias
     Alias for the user.

node
     FTN address of the user.

full name
     Full name of the user.

   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


File: fidogate.info,  Node: Areas,  Next: Maus,  Prev: Aliases,  Up: Config files

`areas' FTN Area to Newsgroup Conversion
========================================

This file contains FTN areas with corresponding newsgroups and options.

The format of this file is

     area  newsgroup  [ options ]

Fields:

area
     FTN area.

newsgroup
     Usenet newsgroup.

options
     IMPORTANT: there must be spaces between the option and its
     arguments!

    `-z zone'
          Select zone AKA zone for this area/newsgroup.

    `-d distribution'
          Use Usenet `distribution' for this newsgroup when gating from
          FTN to Internet.

    `-o "origin"'
          Use an alternate origin line for this area when gating from
          Internet to FTN.  (Default specified in `config'.)

    `-l'
          Only local crosspostings are allowed in this newsgroup/area.

    `-x'
          No crosspostings are allowed in this newsgroup/area.

    `-m'
          Don't gate messages coming from MAUSNET to this newsgroup.
          NOT YET IMPLEMENTED.

    `-g'
          Don't gate messages coming from another FTN gateway to this
          newsgroup.

    `-8'
          Use the ISO-8859-1 charset when gating to this newsgroup. NOT
          YET IMPLEMENTED.

    `-H'
          Area/newsgroup matches entire hierarchy. Names are converted
          automatically, using upper case for area names and lower case
          for newsgroups. `_' in area names is converted to `-' in
          newsgroup names, and vice versa.

          Example:
               GNU.    gnu.    -z 242  -H
          `gnu.announce' will be converted to `GNU.ANNOUNCE',
          `gnu.bug.gcc' to `GNU.BUG.GCC', similar for all other.

    `-!'
          Don't gate this area/newsgroup or hierarchy (if combined with
          `-H'). Usefull to exclude certain newsgroups from a hierarchy
          for gating.

          Example:
               ALT.BINARIES.    alt.binaries.    -z 242  -H -!
               ALT.             alt.             -z 242  -H
          This 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'
          Select level of `^ARFC-'Header put into FIDO messages for this
          area. Level:
         0
               No `^ARFC-'header at all.

         1
               Only important `^ARFC-'header.

         2
               All `^ARFC-'header.          NOT YET IMPLEMENTED.

   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 `FTN_JUNK'
newsgroup specified in `config.h'.


File: fidogate.info,  Node: Maus,  Next: Bounce,  Prev: Areas,  Up: Config files

`maus' Internet Addresses for MAUS Systems
==========================================

This file contains MAUS system names and corresponding Internet
addresses.

The format of this file is

     maus  address  [ gateway ]

Fields:

maus
     MAUS system name or `default' for the default entry.

address
     Internet address of the MAUS system or `-' for no Internet
     address. Either complete FQDN or just the domain (leading dot
     `.'). If only the domain is specified, the address is the
     concatenation of maus and domain.

gateway
     Optional specification of an FTN-MAUS gateway for this system.

   The `default' entry specifies the default domain for all MAUS system
not explicitely given an alternate address in this config file.
Therefore you should specify a domain part only.

   The `default' entry must contain a gateway field, if `rfc2ftn' shall
convert Internet MAUS to FTN MAUS addresses.  `rfc2ftn' currently only
recognizes the default MAUS domain.

   The list of MAUS systems and corresponding Internet addresses is
posted regularly to the newsgroup `de.comm.gateways'.

   Example:

     default    .maus.de    2:2452/101.6
     
     A-L        a-l.maus.sub.org
     A-W        a-w.maus.sub.org


File: fidogate.info,  Node: Bounce,  Next: Passwd,  Prev: Maus,  Up: Config files

Bounce Messages of `ftn2rfc'
============================

`ftn2rfc' uses the following files for messages sent to the FTN user
when bouncing mail for some reason:

`bounce.noto'
     Message addressed to user `UUCP' or `GATEWAY' without a `To' line
     at the very beginning of the message.

`bounce.restricted'
     Messages from nodes not listed in `hosts', gateway running in
     restricted mode.

`bounce.insecure'
     Messages came via an insecure (i.e. not password protected) link
     and contain a `To' line. This requires the `-t' option to
     `ftn2rfc'.

   Within a bounce message, the following substitutions can be used:

`%F'
     FTN address of message sender.

`%T'
     FTN address of message recipient (the gateway, that is).

`%O'
     FTN address of message origin.

`%d'
     Date/time of message.

`%t'
     Name of message recipient.

`%f'
     Name of message sender.

`%s'
     Message subject.

`%R'
     `To' line, Internet address.

`%M'
     The entire message body.


File: fidogate.info,  Node: Passwd,  Next: Permissions,  Prev: Bounce,  Up: Config files

`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'
     FTN packet passwords, checked by `ftntoss', inserted by all
     FIDOGATE programs which create FTN packets. Password checking for
     incoming packets is NOT YET IMPLEMENTED.

`af'
     Areafix passwords for requests to `ftnaf'.

`ff'
     Filefix passwords for requests to `ftnaf -F'.

`ffx'
     `ffx' command passwords, checked by `ffxqt', inserted by `ffx'
     into the `.ffx' command files.

   Optional stuff (options) is currently ignored, but will be used in
the future for `ftnaf' permission settings.

   Example:

     packet      2:1234/5678     WUERG
     af          2:1234/5678     WUSEL       F
     af          242:1234/5678   WUSEL       U
     ffx         242:1111/99     BLAHBLUB


File: fidogate.info,  Node: Permissions,  Next: Routing,  Prev: Passwd,  Up: Config files

`permissions' Config File
=========================

This file contains the permissions used by `ftnaf'. NOT YET IMPLEMENTED.

The format of this file is:

     context  area  level  flags

Contexts:

`af'
     EchoMail areas (`ftnaf').

`ff'
     File areas (`ftnaf -F').


File: fidogate.info,  Node: Routing,  Next: Packing,  Prev: Permissions,  Up: Config files

`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
     rewrite    src-node  dest-node
     
     echomail
     netmail
     
     send       flavor    nodes
     route      flavor    dest-node nodes
     hostroute  flavor    nodes
     hubroute   flavor    nodes
     
     change     old-flavor  new-flavor  nodes
     
     sendmove   flavor    nodes

Commands:

`remap'
     Remaps NetMail addressed to name at src-node to the new address
     dest-node. Most usefull for remapping to points based on their
     name.  name supports shell-style wildcard patterns.

`rewrite'
     Rewrites NetMail from and to addresses. A node address matching
     src-node will be changed to dest-node.

`echomail'
     Starts routing commands for EchoMail.

`netmail'
     Starts routing commands for NetMail.

`allmail'
     Starts routing commands for both EchoMail and NetMail. NOT YET
     IMPLEMENTED.

`send'
     Send normal mail addressed to nodes with flavor.

`route'
     Route normal mail addressed to nodes via dest-node, using flavor.

`hostroute'
     Route normal mail addressed to nodes via their host (i.e. Z:N/0),
     using flavor.

`hubroute'
     Route normal mail addressed to nodes via their hub, using flavor.
     NOT YET IMPLEMENTED.

`change'
     Change flavor of mail packet from old-flavor to new-flavor.

`sendmove'
     Like `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/3 6 7
     route     hold         242:1000/50 51 52 53 54 55 56 57 58 59
     change    crash  hold  242:1000/1.all 2.all


File: fidogate.info,  Node: Packing,  Next: Areas.bbs,  Prev: Routing,  Up: Config files

`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

Packer/program definitions:

`arc'
     Defines the archiver name as program archiver. The archiver string
     must contain two `%s', the first one is replaced with the archive
     name, the second one with the packet name.

`prog'
     Defines the program name as program. The program string must
     contain a `%s', which is replaced with the name of the packet to be
     processed.

Packing definitions:

`pack'
     Pack all mail addressed to nodes using the archiver defined as
     name. The archiver name `noarc' indicates that the mail packet
     should not be packed, but copied to the OUT file of the node.

`rpack'
     Same as `pack', but pack all mail addressed to nodes to the
     archive for dest-node.

`fpack'
     Similar to `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.

   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     *


File: fidogate.info,  Node: Areas.bbs,  Next: Index,  Prev: Packing,  Up: Config files

`areas.bbs' EchoMail Distribution
=================================

This file contains the EchoMail areas and linked nodes.

   The format of this file is as follows, the first line being ignored
for compatibility with the standard DOS AREAS.BBS.

     [`#'][`$']directory  area  nodes

`#'
     Indicates that this is a passthru EchoMail area (ignored by
     FIDOGATE).

`$'
     Indicates that this is an EchoMail area with a SQUISH message base
     (ignored by FIDOGATE).

directory
     The directory where the message base/file base for this area is
     located (ignored for EchoMail by FIDOGATE).

area
     The area name.

nodes
     The list of downlink nodes. This is a sorted short list of nodes
     as in FIDO EchoMail SEEN-BYs and PATH. The first node in nodes
     stays at this place, though.

   Do not put your own address into `areas.bbs'. FIDOGATE will select
the AKA corresponding to the zone of the first node listed in nodes.


File: fidogate.info,  Node: Index,  Prev: Areas.bbs,  Up: Top

Index
*****

* Menu:

* Aliases:                              Aliases.
* ArcMail:                              ftnpack.
* Areafix:                              ftnaf.
* Areas:                                Areas.
* areas.bbs:                            Areas.bbs.
* Bounce:                               ftnbounce.
* Bounce messages:                      Bounce.
* Busy files:                           ftnbsy.
* Checksum:                             sumcrc.
* Compiling:                            Compiling.
* Config:                               Config.
* Config files:                         Config files.
* Connecting:                           Connecting.
* CRC:                                  sumcrc.
* EchoMail:                             Areas.bbs.
* ffx:                                  ffx.
* ffxbatch:                             ffxbatch.
* ffxmail:                              ffxmail.
* ffxqt:                                ffxrun.
* ffxqt:                                ffxrmail.
* ffxqt:                                ffxqt.
* ffxrmail:                             ffxrmail.
* ffxrun:                               ffxrun.
* FIDONET:                              Connecting.
* File attach:                          out-attach.
* ftn2ftn:                              ftn2ftn.
* ftn2rfc:                              ftnin.
* ftn2rfc:                              ftn2rfc.
* ftnaf:                                ftnaf.
* ftnbounce:                            ftnbounce.
* ftnbsy:                               ftnbsy.
* ftnin:                                ftnin.
* ftninpost:                            ftninpost.
* ftninrecomb:                          ftninrecomb.
* ftnlock:                              ftnlock.
* ftnlog:                               ftnlog.
* ftnpack:                              ftnpack.
* ftnroute:                             ftnroute.
* ftnseq:                               ftnseq.
* ftntoss:                              ftntoss.
* Gateway:                              rfc2ftn.
* Gateway:                              ftn2rfc.
* Gateway:                              ftn2ftn.
* Hosts:                                Hosts.
* Installation:                         Compiling.
* Installation:                         Installation.
* Integration:                          Integration.
* Introduction:                         Introduction.
* Introduction:                         Top.
* Lock files:                           ftnlock.
* Log file:                             ftnlog.
* Logging:                              ftnlog.
* Mail:                                 ffxmail.
* Maus:                                 Maus.
* out-attach:                           out-attach.
* Packing:                              Packing.
* Password:                             Passwd.
* Permissions:                          Permissions.
* pktdebug:                             pktdebug.
* Point:                                Point.
* Programs:                             Programs.
* Remote Execution:                     ffxqt.
* Remote execution:                     ffxbatch.
* Remote execution:                     ffx.
* rfc2ftn:                              rfc2ftn.
* Routing:                              Routing.
* Routing:                              ftnroute.
* rundf:                                rundf.
* runin:                                runin.
* runout:                               runout.
* runtoss:                              runtoss.
* rununpack:                            rununpack.
* sumcrc:                               sumcrc.
* Testing:                              Testing.
* Tossing:                              rununpack.
* Tossing:                              runtoss.
* Tossing:                              runout.
* Tossing:                              runin.
* Tossing:                              rundf.
* Tossing:                              ftntoss.


