Manual for SetupCfg, component in AutoTest
------------------------------------------

Configuration always starts with zeros for all fields, except where
noted otherwise.


Requirements to run SetupCfg
----------------------------

- Environment variable WORKDRIVE pointing to the AutoTest drive
- Environment variable WGTESTLOG pointing to the logfile path+name
- One command line argument pointing to the configuration input file


List of commands available in SetupCfg
--------------------------------------

SYSTEMDIR <path to watergate system directory>
   Must be the first command in the configuration file.
   All databases are created and initialised.
   System directory is created by SetupCfg
   LogDebug is set.
   EmptyTear is set (to avoid version numbers in the output files)
   Example: SYSTEMDIR $:\WtrGate\

FIDOSYSTEM <system>
   Sets the system compatibility type to one of the following
   BINKLEY, FRONTDOOR, FD or DBRIDGE
   Example: FIDOSYSTEM FD

MAXFIDOMSGLEN <length>
   Sets the maximum size of a FTN message. If the message is bigger
   it will be split.

SPOOLDIR <path>
   Path to the UUCP spool directory.
   Path is created by SetupCfg.

SYSTEMDOMAIN <domain>
   Adds the domain to the list of system domains (max 6).

SYSTEMAKA <aka>
   Adds the aka to the list of system akas (max 100).
   Example: SYSTEMAKA 2:200/111.15

SYSTEMNETMAILTYPE <msgbase type>
   Sets the type of the primary netmail area
   Select from MSG, JAM or SQUISH

SYSTEMNETMAILPATH <path>
   Sets the path to the primary netmail area.
   The path is created by SetupCfg.

SYSTEMBADTYPE <msgbase type>
   Sets the type of the BAD area.
   Select from MSG, JAM, SQUISH or WILDCAT

SYSTEMBADPATH <path>
   Sets the path to the system BAD area.
   The path is created by SetupCfg.

SMARTHOST <name>
   Sets the name of the smarthost system. The name refers to one
   of the UUCP User Definitions or SMTP Link Definition.
   Example: SMARTHOST seunet

NOEMPTYTEAR
   When present, the EmptyTear option will be set to FALSE, causing
   WaterGate to create a tear-line with the program information instead
   of just an empty tear-line.

INBOUND1 <path>
   Sets the first FTN inbound path.
   The path is created by SetupCfg.
   Example: INBOUND1 $:\inbound\

INBOUND2 <path>
   Sets the second FTN inbound path.
   The path is created by SetupCfg.

OUTBOUND <path>
   Sets the FTN outbound path.
   The path is created by SetupCfg.

HEADERFULLNAME no|yes
   Selects whether the full name of the poster or the e-mail address
   of the poster should be put in the From: header on the FTN side.
   Yes selects the full name.
   No selects the e-mail address.

GATEMSGID Not|Include
   Sets the Gate MessageID option under Gateway Settings.
   "Not" means the Message-ID headers are not gated into a MSGID and
   a new MSGID is created instead.
   "Include" means it is gated according to the Gatebau rules.

ORGANIZATION-IN-ORIGIN no|yes|override
   Sets whether the Organization header contents is put in the Origin
   line of echomail or not.
   No - disables it
   Yes - enables it
   Override - makes sure the Organization header is not copied as well.

DEFAULTCOMPRESSION <compression>
   Sets the default compressor to use.

NOEMPTYTEAR
   Disable the empty tear-line feature (enabled by default).

NETMAILDECODE
   Enables file decoding for the primary netmail area (disable by
   default).

NETMAILDECODEPATH <path>
   Sets the path where to store the files decoded when a message is
   imported into the primary netmail area.

NEWAREA
   Creates a new area defintion and adds it to the database.

WRITEAREA
   Writes the area definition to the database again. Use this
   when you have changed one or more of the area fields.

FTNNAME <name>
   Sets the FTN name for the area definition.

RFCNAME <name>
   Sets the RFC name for the area definition.

AREATYPE <type>
   Sets the area type for the area definition. Select from
   ECHO, NETMAIL, LOCAL or E-MAIL.
   Example: AREATYPE ECHO

MANDATORY <no|yes>
   When set to Yes the users cannot unsubscribe this area via AreaFix.

ALLOWPASSIVE <no|yes>
   When set to Yes the area is never disconnected from the uplink.

MSGBASETYPE <type>
   Sets the message base type for the area definition. Select from
   MSG, JAM, SQUISH or WILDCAT. The default is NONE (set with the
   NEWAREA command). Something invalid for <type> also sets the
   message base type to NONE.
   Example: MSGBASETYPE JAM

MSGBASEPATH <path>
   Sets the path to the message base. The path is created by SetupCfg.

AREAGROUPS <groups>
   Selects the groups the area will belong to. Write each group as
   <letter><number> with spaces between each group.
   Example: AREAGROUPS A1 B5 Z1

NEWUSER <type>
NEWLINK <type>
   This command adds an empty user base record to the database.
   Use this as the first command before filling in any of the user
   record fields. Use WRITEUSER after updating one or more of the
   fields.
   <type> can be UUCP, FTN, SMTP, POP3, BBS, BAG or SOUP.
   An unknown or left out type results in FTN.

WRITEUSER
WRITELINK
   This command writes the updated user base record to the database.

ADDRESS <aka>
   Sets the AKA field in the user base record.
   Example: ADDRESS 2:200/111

USERTYPE <type>
   Sets the user type. Not required when the correct type has been
   set already with the NEWUSER command. Types can be _F (=FTN),
   _U (=UUCP), _S (=SMTP), _P (=POP3), _B (=BAD), _BBS.
   Example: USERTYPE _P

USERGROUPS <groups>
   Select the groups the user will be allowed to subscribe from.
   Write each group as <letter><number> with spaces between each group.
   Example: USERGROUPS A1 B5 Z1

AREAFIXPWD <password>
   Set the AreaFix password for FTN users.

NEWSFIXPWD <password>
   Set the newsfix password for RFC users.

UUCPNAME <name>
   Sets the UUCP name in the user base record.
   A sub-directory under the spool directory is created by SetupCfg.
   Set SPOOLDIR before using this command.
   User for UUCP style users only.
   Example: UUCPNAME wsd

SYSTEMNAME <name>
   Sets the system name field in the user base record.
   User for BAG and SMTP style users.

SMTPINPATH <path>
   Sets the SMTP inbound path for a SMTP style user.
   Example: SMTPINPATH $:\smtp-in\

SMTPOUTPATH <path>
   Sets the SMTP outbound path for a SMTP style user.

DOMAIN <domain>
   Adds a domain address to the user base record (max 3).

COMPRESSION <compression>
   Sets the compression type for FTN style users. Select from
   ARC, ARJ, LZH, PAK, ZIP, ZOO, RAR, OP1 or NONE.
   Example: COMPRESSION ZIP

PACKETPWD <password>
   Sets the packet password for PKT files.

PKTFORMAT <format>
   Sets the packet format for FTN style uses. Select from
   PKT, P2K or PKT2000.
   Example: PKTFORMAT P2K

SUBSCRIBE <area name>
   Subscribes the user definition to an area. The area must have been
   created and written to disk before this command can be used.
   In practise: create your areas first, then your users.
   The area name can be both the FTN or RFC name.
   The user record is written to disk automatically when the subscribe
   is succesful.
   The area definition is re-used for the subscribe, so the area
   definition must be written to disk before this command is used.
   Make sure you do not re-use the area definition to create a new
   area. NEWAREA *must* be used first to avoid cross links in the
   database.
   Example: SUBSCRIBE ALT.BBS.WATERGATE

BBSINBOUND <path>
   Sets the inbound path for the BBS Interface.

BBSOUTBOUND <path>
   Sets the outbound path for the BBS Interface.

BBSFAKEAKA <z:n/f>
   Sets the zone, net and node part of the Fake AKA for the BBS
   Interface.

BBSINBOUNDEXT <extension>
   Sets the extension for the files to search in the BBS Inbound.
   Example: PKT

BBSKEEPSBP <no|yes>
   Sets the keep SEEN-BY and PATH option of the BBS Interface for
   messages sent TO the BBS Interface.
   Yes means the SEEN-BY and PATH lines of the original message are
   kept and the fake aka is simply added.
   No means the original SEEN-BY and PATH lines are replaced with
   a new set, just mentioning the system and fake aka.

POP3FILE <filename>
   Sets the search path for a POP3 link. Can contain wildcards.
   Example: $:\pop3_in\*.*

POP3RECIPIENT <e-mail>
   Sets the e-mail address for the single recipient.

POP3SEPARATOR <text>
   Sets the POP3 separator line.
   Example: From

POP3ENVELOPEHEADER <text>
   Sets the envelope header name.
   Example: X-Recipient:

BAGBACKLINK <system name>
   Sets the reference to the user/link to use for return mail.
   Example: seunet
   A User Definition of Link Definition with this System Name or
   UUCP Name must be present.

BAGPATH <search path>
   Sets the search path to the BAG files.
   Example: C:\BAG-IN\*.BAG

NEWFILTER
   This routine creates a new filter definition and adds it to the
   database.

WRITEFILTER
   This command must be used when one or more of the filter fields
   have been updated using the commands below.

FILTERLIMIT <limit> [<limit> [...]]
   This command sets the scope for the filter. The must be followed by
   one or more of NETMAIL, ECHOMAIL, E-MAIL or NEWS.
   The default is nothing (the filter is disabled if nothing is
   selected).
   Example: FILTERLIMIT NETMAIL E-MAIL

FILTERACTION <action>
   This command sets the action type of the filter. Select from
   MOVE, COPY, DELETE, FORWARD, CC, BOUNCE, BOUNCETO, SAVE or NONE.
   Example: FILTERACTION MOVE

FILTERSEARCH <text>
   This command sets the text the filter will search for.
   Example: FILTERSEACH TriggerText

FILTERINOUT <inout>
   This commands sets the inbound/outbound limitation of the filter.
   Select from INBOUND, OUTBOUND or BOTH. The default is BOTH.
   Example: FILTERINOUT BOTH

FILTERWHERE <where>
   This command selects the part(s) of the message the filter will
   search. Select from ALL, BODY, HEADER, FROM, TO, SUBJECT.
   The default is ALL.
   Example: FILTERWHERE ALL

FILTERNOTE <yes/no>
   This command selects whether the filter will insert a note when
   it triggers. The text must be set with the FILTERARGUMENT option.
   Select from YES or NO.
   Example: FILTERNOTE YES

FILTERADDRTYPE <type>
   This command, in combination with the FILTERTO* commands sets the
   destination of the filter when used in combination with CC,
   FORWARD or BOUNCETO.
   Select the type of address from FTN, RFC or REMOTE-GW.
   Example: FILTERADDRTYPE RFC

FILTERTOAKA <aka>
   This command sets the AKA for the Filter TO address when an FTN
   or REMOTE-GW type of address is selected with the FILTEADDRTYPE
   command.
   Example: FILERTOAKA 2:200/111.15

FILTERTONAME <name>
   This command sets the FTN to-name for the filer TO address when
   an FTN or REMOTE-GW type of address is selected with the
   FILTERADDRTYPE command.
   Example: FILTERTONAME Ramon van der Winkel

FILTERTOEMAIL <address>
   This command sets the RFC e-mail address for the filter TO address
   when an RFC or REMOTE-GW type of address is selected with the
   FILTERADDRTYPE command.
   Example: FILTERTOEMAIL ramon@wsd.wline.se

FILTERARGUMENT <argument>
   This command must be used in combinations with some of the action
   command to select a second parameters. The following table lists
   the type of information that must be set for each of the FILTERACTION
   types this command applies to:
   MOVE - Area name
   COPY - Area name
   SAVE - Path (SetupCfg does *NOT* create the directory!)
   BOUNCE - Reason text excluding "Reason: "
   BOUNCETO - Reason text excluding "Reason: "

NEWLIST
   Starts a new mailing list record. Automatically assigns a ListID
   unique for this configuration file. All subscribers created after
   this record will automatically be subscribed to this list.

LISTNAME <name>
   Sets the name of the mailing list. No spaces in the name!

LISTDESCR <text>
   Sets the description of the mailing list. Spaces allowed.

LISTWELCOMEFILE <file>
   Sets the path and name of the welcome file.

LISTFOOTERFILE <file>
   Sets the path and name of the file containing the footer.

LISTPRIVATE <no|yes>
   Sets the Private flag. Yes mean nobody can subscribe via listserv.

LISTONLYKNOWN <no|yes>
   Sets the Only Known flag. Yes means only systems with a User
   Definition are allowed to subscribe.

LISTPASSIVE <no|yes>
   Sets the list passive or not.

LISTNAMEINSUBJ <no|yes>
   Sets the flag to put the name of the mailing list at the start
   of the subject line. Example when Yes: Subject: [ListName] Rest

LISTPRIOTITY <lower|higher>
   Sets the address priority for the reply address. If set to
   "lower" the replies will go to the user. If set to "higher"
   the replies will go to the mailing list.

LISTDEFAULTACCESS <access>
   Sets the default access type. Options:
   READWRITE or RW
   READONLY or RO
   WRITEONLY or WO

LISTCONFIRMINTERVAL <n>
   Sets the confirm interval in days.

LISTAREA <area name>
   Sets the name (FTN or RFC) of the area the list is connected to.
   Don't forget to set ListToArea or AreaToList to Yes.

LISTTOAREA YES|NO
   Sets the ListToArea option on (Yes) or off (No).

AREATOLIST YES|NO
   Sets the ListToArea option on (Yes) or off (No).

WRITELIST
   Writes the new mailing list record to the flex database.

NEWLISTUSER <type>
   Creates a new mailing list subscribed with the list that was last
   created with the NEWLIST statement.
   <type> selects the type of subscriber: DELETED, RFC, FTN or REMOTEGW.

LISTUSERNAME <name>
LISTUSERAKA <aka>
LISTUSEREMAIL <e-mail>
   These three keywords must be used to set the address information of
   the subscribers. The FTN subscriber needs the name and aka; the RFC
   subscriber needs the e-mail and the Remote Gateway subscriber needs
   all three (name and aka of the gateway plus the e-mail of the
   subscriber).

WRITELISTUSER
   Writes the mailing list user record to the LISTUSER.TDB file.

NEWAREAFIXFWD
   Creates a new AreaFix Forward Definition and writes it to disk.
   Update the difinition with the AREAFIXFWD* keywords and write it
   to disk afterwards using the WRITEAREAFIXFWD command.

AREAFIXFWDUNCONDITIONAL <no|yes>
   Selects whether the use the file or not. When set to Yes all
   requests are forwarded. When set to No the area name must be
   present in the file.

AREAFIXFWDPATH
   Sets the path to the file with the area names to select from.

AREAFIXFWDTYPE <type>
   Sets the type of the file pointed to by the path.
   <type> can be AreasBBS or Names

AREAFIXFWDAKA <aka>
   Sets the aka of the uplink areafix system.

AREAFIXFWDNAME <name>
   Sets the name of the areafix system. Example: AreaFix.

AREAFIXFWDPASSWORD <password>
   Sets the password to use when contacting this areafix.

AREAFIXFWDGROUP <single group>
   Selects the group the user must have access to in order to use
   this forward option.
   <single group> is in the form A2

AREAFIXFWDADDPLUS <no|yes>
   Selects the option to add a plus or not before each area name
   when subscribing them.

AREAFIXFWDEXPORTAKA
   Not implemented yet.

WRITEAREAFIXFWD
   Writes the AreaFixFwd record to disk. Use this after updates have
   been made with one of the AREAFIXFWD keywords.

<end of file>
