; user.txt
;
; This is the WaterGate help file
; This file is included by wtrgate.txt
;
; Contents: WtrConf User Definitions specific help
;

; quick reference:
;
; #topic(reference text)
; #subtopic(reference text)
; #end
; #title(text)
; Space at start of line or #linebreak
; Empty line or #break
; #link(reference)(text)
; #highlight(text) or #hl(text)


;---------------------------------------------------------------------------
; UserEdit SubscribedAreas
;
#topic(UserEdit SubscribedAreas)
#title(Areas subscribed by user)
The listed areas are currently subscribed by this user.

 Delete - Remove selected areas from this user
 Insert - Lists the area the user can connect to

#end


;---------------------------------------------------------------------------
; UserEdit SubscribableAreas
;
#topic(UserEdit SubscribableAreas)
#title(Areas that can be subscribed by user)
Lists the areas this user is not yet subscribed to.

Tag one or more areas and press Enter to subscribe the user
to these areas.
#end


;---------------------------------------------------------------------------
; UserEdit UnSubscribe AreYouSure
;
#topic(UserEdit Unsubscribe AreYouSure)
#title(Are you sure to unsubscribe area(s))
Please confirm if you are sure you want to unsubscribe this
user from the selected area(s).
#end


;---------------------------------------------------------------------------
; UserEdit SelectExportAKA
;
#topic(UserEdit SelectExportAKA)
#title(Select user export AKA)
Select the system node number to use when sending messages to
this system. The AKA is used for sending packets with echomail
or netmail.

If you set it to Automatic, WtrGate will choose the best AKA itself.
#end


;---------------------------------------------------------------------------
; UserEdit SelectReturnSystem
;
#topic(UserEdit SelectReturnSystem)
#title(Select return system)
BAG is for receiving news (and sometimes e-mail) only. The messages
in the other direction must go via a UUCP system. Here you select which
system to use for the return path.
#end


;===========================================================================
; User and Link Definition Editor
;
#topic(User and Link Definition Editor)
#title(User Definition)
This topic is related to the fields of the User Definition editor
and Link Definition editor in WtrConf.

#subtopic(UserEdit Address)
#title(Address)
Enter the unique FTN matrix address for this user.

 Example:   2:512/17.6@fidonet.org

#subtopic(UserEdit SysOp)
#title(SysOp)
Enter the Sysop name for this user, this name is used in
Area Manager request messages, to verify the message is
originating from the correct user.

It is also used in the To: field for file attach messages
to this user, but only when using a FrontDoor style mailer.

#subtopic(UserEdit Organization)
#title(Organization)
Use this field to give a short description of this system.
For Link Definitions, this field is just informative and is shown in
the list to easily identify a system. For FTN system, the information
in this field is put in the #hl(Organization:) header when gating
an FTN message to RFC format.

Example:
 Organization: Stargate IV, gate to Proxima IV

#subtopic(UserEdit AllowedGroups)
#title(Allowed groups)
This field shows the groups this user or link has access to.

#subtopic(UserEdit SubscribedTo)
#title(Subscribed to)
Press Enter on this field to show the areas this user or link
currently is subscribed to.

#subtopic(UserEdit AreafixNewsfixPassword)
#title(Areafix/Newsfix password)
For enter the password this system must use to access the Area Manager
(Areafix for FTN system or Newsfix for RFC systems).

#subtopic(UserEdit AreafixNewsfixSpecial)
#title(Areafix/Newsfix special)
Select this option if you want a system to be capable of doing some
limited remote maintenance to the WaterGate configuration.

   #hl(Only use it for yourself, or your co-sysops)

Extra areafix commands include %LISTNEW, %MOVENEW, %DELNEW.

#subtopic(UserEdit CreateNewAreas)
#title(Create new areas)
Set this option to Yes if you want WaterGate to automatically create
an Area Definition for any area detected in the echomail packets
sent by this user.

You might want to enable this option for your uplink.

New areas are created in group Z1.

#subtopic(UserEdit Passive)
#title(Passive)
If a user is temporarily unable to receive his or her mail,
toggle this option to YES. News and Echomail messages will
no longer be sent to this system, Mail and Netmail messages
are still queued. The user can set this option by using
the Area Manager commands %ACTIVE and %PASSIVE.

#subtopic(UserEdit Notify)
#title(Notify)
When set to Yes this user will receive an informational
Notification message with the settings and subscribed areas
when WtrGate is started with the NOTIFY command line option.

#subtopic(UserEdit PKTPassword)
#title(PKT Password)
Enter the password that is put in each packet created for this
node.

If you use a security inbound, then each packet from this
node is checked for this password.

#subtopic(UserEdit ExportAKA)
#title(Export AKA)
The Export AKA is the system node number that is used in the .PKT
files that are created for this user. You can let WaterGate automatically
select the appropriate export AKA, or you can select one manually.

#subtopic(UserEdit PacketSizeLimit)
#title(Packet size limit)
This setting sets the maximum size for an echomail PKT file in bytes.
WaterGate creates a new packet when this size has been reached.

A setting of zero means "unlimited". The minimum value is otherwise 50000
bytes.

#subtopic(UserEdit ArchiveSizeLimit)
#title(Archive size limit)
Enter the maximum size for an outgoing Archive for this user.

WaterGate checks the size of a bundle before it adds a .PKT file.
If it has reached or passed its limit, then a new archive is
started.

You can set it to zero for an unlimited length (a new archive is
first started when the user has picked up mail).
Note that there is a minimum of 50000 bytes for this option.

This field is also used to decide whether an tunnel archive can
be mailed already. The size of the archive has to be at least the
size set in this field before it is sent via e-mail.

A setting of zero causes the archives from being sent at the end
of each run.

#subtopic(UserEdit PKTFormat)
#title(PKT format)
Select the format for the PKT files WaterGate creates.

 #PKT# is the normal FTN PKT format.
 #PKT2000# is the new STN PKT format.

#subtopic(UserEdit Compression)
#title(Compression)
Select the compression program used to compress outgoing echomail
bundles (FTN users) or news bundles (UUCP users).

#subtopic(UserEdit SendFormat)
#title(Send format)
This options select how bundles are to be sent to this user.
The first four options are flags for your mailer, the other two
select sending of the archive via Internet mail using either
WaterGate's own MailTunnel format (for backwards compatibility)
or the new SEAT format.

How your mailer handles these flags must be defined in your mailer setup.

Notice that the MailTunnel option is for sending only. You must
put a TUNNEL-FROM statement in the ROUTE.TDB file to enable reception
of MailTunnel e-mails!

#subtopic(UserEdit TunnelEmailAddress)
#title(Tunnel e-mail address)
Enter the e-mail address where to send the tunneled archives.

You only need to fill in this field when using the MailTunnel
or SEAT option to send ARCmail bundles for this user via e-mail.

#subtopic(UserEdit DecodeFiles)
#title(Decode files)
When set to Yes, WtrGate will uu/xx/binhex/mime-decode files from
messages sent to this user and send the file along in binary format.

#subtopic(UserEdit SmtpInPath)
#title(SMTP-In path)
This is the path where WtrGate searches for .WRK and .TXT files.
This directory is often referred to as the RQUEUE.

#subtopic(UserEdit SmtpOutPath)
#title(SMTP-Out path)
This is the path where WtrGate creates .WRK and .TXT files. This
directory is often referred to as the MQUEUE.

#subtopic(UserEdit SoupInPath)
#title(SOUP-In path)
Enter the path where WtrGate will search for the files downloaded
and created by the SOUP mailer.

#subtopic(UserEdit SoupOutPath)
#title(SOUP-Out path)
Enter the path where WtrGate will create files for delivering by
the SOUP mailer.

#subtopic(UserEdit BagSearchPath)
#title(BAG search path)
Enter the path where WtrGate can find your BAG files. Optionally
supply a search pattern as well.

Examples:
 C:\NEWS\*.BAG
 C:\DL_BAG\

#subtopic(UserEdit OutboundPath)
#title(Outbound path)
If you wish to have all outgoing files for this node saved in
a special directory, enter that path here.  Normally you will
leave this field empty and Watergate will place the files in the
normal outbound directory.

This may be useful if you need to upload the node's mail to an
FTP server, or you wish to setup #link(Glossary LocalPoint)(local points).

#subtopic(UserEdit UUCPname)
#title(UUCP name)
Enter the UUCPname for this UUCP system. WaterGate will use this
name in the outbound UUCP jobs created in the sub-directory of the
main spool directory with this UUCPname.

Example:
 seunet
 Directory: C:\SPOOL\SEUNET\

The UUCPname is also used to refer to this system from the
 #link(SysRFC Smarthost)(smarthost) field under the RFC settings.

#subtopic(UserEdit SystemName)
#title(System name)
Fill in this field if you want to refer to this system from
the #link(SysRFC Smarthost)(smarthost) field under the RFC settings.

#subtopic(UserEdit AddBatchHeader)
#title(Add batch header)
Select this option to add a special header to each compressed
news batch. WaterGate will add the text "#! cunbatch"@ to the
compressed archive, when compressed with compress.

The header "#! gunbatch" is added to GZip batches, but that can
be controlled with the GZIPBATCH option in the ROUTE.TDB file.

Normally you want to do this for all your compressed new bundles,
so this option is set to YES by default. It is best to set it
to NO for your UUCP uplink though, because if reliability issues.

The "#! cunbatch" string is used by UNIX machine so they can easily
detect that your news bundle is compressed (it is an execute
command to start a script that decompresses the archive).

#subtopic(UserEdit MailNewsGrade)
#title(Mail and News grade)
These fields hold a single letter that indicates the transport
priority for mail and news. The highest priority is A and the
lowest is Z. You can tell your UUCP mailer to transport packets
up to a certain grade, so you can transport news in the cheaper
hours only.

The defaults are A for Mail and Z for news.

#subtopic(UserEdit GigoT)
#title(GigoT specials)
WaterGate can work together with the GIGOT mail and news
demons. This is done through modified UUCP jobs.

Set this options to Yes if you want to use this UUCP user
to interface the GIGOT demons.

#subtopic(UserEdit ReturnSystem)
#title(Return system)
BAG file supply systems (satellite receivers, for example) have
no way to send messages back, so there has to be an other way back
to the network.

You have to enter the UUCPname of the return UUCP system here.
This system has to be defined in your userbase, with the same
UUCPname as entered here. WaterGate will check this when running.

The return system does not have to be connect to all the areas
of the BAG supplier anymore, as with previous versions (0.16
and before).

You only connect the return system to an area if you want it to
receive the full feed of it. This saves you the work of manually
connecting the return system to all the newly created areas and
saves subscription base space on disk and improves speed.

#subtopic(UserEdit AllowSubDomains)
#title(Allow sub-domains)
If you set this option to Yes, you allow the system to have system
underneath it.

For example, if the system wsd.wlink.nl was allowed to have
sub-domains, it could hook up a friend with the domain address
upstairs.wsd.wlink.nl and send mail from do you know how many
extra users? If you don't want this, set it to NO.

If you set it to Yes, all mail for the sub-domains is
automatically routed via this system. If you have some ROUTE-RFC
lines in your ROUTE.TDB file for this, you can now remove them.

FUTURE EXTENSION:
#linebreak
If this option is set to No, WaterGate isn't just not routing mail #hl(to)
sub-domains of this system anymore, but will also block mail
#hl(from) any sub-domains of this system.

#subtopic(UserEdit DomainAddresses)
#title(Domain addresses)
Enter up to three domain addresses for this node.

Examples:
 pwrdial.network.nl
 pwrdial.host.Network.nl

The domain address is the part #hl(after) the @-sign. In the example
ramon@wsd.wline.se, the part "wsd.wline.se" is the domain address.

The domain name you put in these fields must not start with an @-sign.

You can allow sub-domains though by added a dot in front of the
domain name. But you should not do this for the first domain address.
If you want to allow sub-domains for all the domain addresses, then
simply set the toggle "Allow sub-domains" to Yes and do not add any
dots in front of the domain addresses.

#subtopic(UserEdit Pop3MailboxPath)
#title(POP3 mailbox path)
This field points to the location of the downloaded mailbox file.
Search paths are allowed.

Examples:
 C:\POP3\INBOUND\MAILBOX.TXT
 C:\POP3\INBOUND\*.TXT

#subtopic(UserEdit Pop3Separator)
#title(POP3 message separator)
POP3 mailbox files have the nasty habit not to contain an explicit
separator between two messages. Instead, WaterGate must be told what the
first line of the next message looks like, so it can search for it. When
found, it processes the messages it has read so far and then starts over
with the next message in the file.

The default is "From ", as this is almost always the first header at the
start of the next message. WaterGate expects an empty line followed by
this "From " in the exact same capitalization.

But this same sequence can show up in the body of the message as well. If
your From header always has certain characters following the actual
"From" and the space, then please add them here. You can type in up to 15
characters for the entire search string.

If you only type "From", then WaterGate will search for "From ", with a
space at the end. If you type more, then it will not check for the space.

Type an astrix (*) at the start of the sequence to tell WaterGate #not# to
check for an empty line before the header.

#subtopic(UserEdit POP3EnvelopeHeader)
#title(POP3 envelope header)
Enter the name of the header where your ISP puts the envelope
information. This allows mail for multiple recipients to be
sent via a single POP3 mailbox file.

If WaterGate finds this header, then it will process all e-mail
addresses found in that header and sends a copy to each recipient.

Commonly used header names are "X-Envelope-To:" and "X-POP3-Rcpt:".

If your ISP does not insert an envelope header, then leave this
field empty. WaterGate will search the Received: headers for the
e-mail address of the final recipient. If nothing was found there
either, then the #Single Recipient# field can be used instead.

#subtopic(UserEdit Pop3SingleRecipient)
#title(POP3 single recipient)
A mail message contains To:, Cc: and other headers with e-mail
addresses, but neither of those has to be the address of the
actual recipient. It's like a letter with an envelope: the
address of the recipient is on the envelope.

Envelope information is lost when a message is stored in a POP3
mailbox, which is normally no problem because all messages in
that mailbox are intended for one user only.

To support POP3 mailboxes with mail for more than one recipient,
your ISP has to add a special header to the actual message,
indicating the e-mail address of the actual recipient.

You then fill in the name of that header in this field so
WaterGate can find the information.

If you don't have this header, or simple only receive mail for
one user, then fill in the e-mail address of that user in this
field. For example: ramon@@wsd.wline.se

#subtopic(UserEdit SoupEnvelopeHeader)
#title(SOUP envelope header)
Enter the name of the header where your ISP puts the envelope
information. This allows mail for multiple recipients to be
sent via a single POP3 mailbox file that is downloaded with SOUP.

If WaterGate finds this header, then it will process all e-mail
addresses found in that header and sends a copy to each recipient.

Commonly used header names are "X-Envelope-To:" and "X-POP3-Rcpt:".

If your ISP does not insert an envelope header, then leave this
field empty. WaterGate will search the Received: headers for the
e-mail address of the final recipient. If nothing was found there
either, then the #Single Recipient# field can be used instead.

#subtopic(UserEdit SoupSingleRecipient)
#title(SOUP single recipient)
A mail message contains To:, Cc: and other headers with e-mail
addresses, but neither of those has to be the address of the
actual recipient. It's like a letter with an envelope: the
address of the recipient is on the envelope.

Envelope information is lost when a message is stored in a POP3
mailbox, which is normally no problem because all messages in
that mailbox are intended for one user only.

To support POP3 mailboxes with mail for more than one recipient,
your ISP has to add a special header to the actual message,
indicating the e-mail address of the actual recipient.

You then fill in the name of that header in this field so
WaterGate can find the information.

If you don't have this header, or simple only receive mail for
one user, then fill in the e-mail address of that user in this
field. For example: ramon@@wsd.wline.se

#subtopic(UserEdit SoupUsingWGSOUP)
#title(SOUP Using WGSOUP mailer)
If you are using the WGSOUP mailer to deliver your news and e-mail,
enable this option.  WGSOUP is designed to take advantage of a few
of WaterGate's advanced features, such as mailing list distribution,
which normal SOUP mailers will not support.

For example, with a regular SOUP mailer, sending messages through a
mailing list requires that each and every address appear in the To:
field.  (And WaterGate's `Multiple recipients' message confuses them.)
WGSOUP uses a special 'envelope file' to decide where messages will
be sent.

For news, and in situations where these special features are not
required, any SOUP mailer will work.  (You can also use SOUP for news
and a standard SMTP queue for e-mail.)

#subtopic(USERBBS System AKA)
#title(System AKA)
Select the System AKA to put in the .PKT files that are created for
this link. The System AKA is used as the #to# AKA.

#subtopic(USERBBS Fake AKA)
#title(Fake AKA)
This Zone:Net/Node number combination is used #only# between WaterGate
and the BBS tosser/scanner. This is what the BBS Interface link is all
about.

WaterGate pretends it is this system when sending packets to the BBS
tosser and the BBS tosser exports to this node number.

WaterGate will never expose this number in SEEN-BY or PATH lines and
will replace the SEEN-BY and PATH in messages received from the BBS
tosser.

This allows you to use the same node number for the BBS and WaterGate,
even though there is a "system" in between that would otherwise
require an extra (official) node number.

#subtopic(USERBBS KeepSBP)
#title(SEEN-BY and PATH)
When set to STRIP, WaterGate will replace the SEEN-BY and
PATH lines in echomail messages sent to the BBS tosser. The
new SEEN-BY line will list the system AKA and fake AKA. The
new PATH will only list the fake AKA.

When set to KEEP, WaterGate keeps the complete SEEN-BY and
PATH information and adds the fake AKA to the SEEN-BY on a
separate line. The PATH line is not modified.

The STRIP option is enough to satisfy your BBS tosser and
get the messages into the BBS. The KEEP option keeps more
information about the source of the message.

#subtopic(USERBBS Inbound)
#title(Inbound)
WaterGate searches this directory for .PKT created by the BBS tosser.
The .PKT files must not be archived!

Do not mix this up with your regular inbound directory!!

#subtopic(USERBBS Packet extension)
#title(Packet extension)
Enter the extension of the packets created by your BBS tosser.

The default is "PKT", so WaterGate searches for *.PKT, but you
can change it to the extension used by your BBS tosser when
creating packets. "OUT" is sometimes seen.

#subtopic(USERBBS Outbound)
#title(Outbound)
WaterGate creates .PKT files for the BBS tosser in this directory.
If you are using multiple BBS Interface link definitions (one for
each network), then you can safely point all definitions to the
same outbound directory.

Do not mix this up with your regular outbound directory!!
#end


;---------------------------------------------------------------------------
; UserEdit NewLinkType
;
#topic(UserEdit NewLinkType)
#title(New Link Definition selection)
Select what type of link you would like to add, or press Escape to
return to the list.

If you receive news from a satellite feed, in BAG format, select
the "BAG supplier link" option. This is a special one-way feed that
can supply you with your messages.

Downloaded POP3 mailbox files can be processed by adding a POP3
"mailbox link". Point it to the downloaded file. Multi-user POP3
mailboxes are supported!

Create an "SMTP mailer link" when you have installed an mailer
capable of the SMTP protocol. WaterGate supports the KA9Q style
directory structure to interface it.
;## BBS interface
;## SOUP interface
#end


;---------------------------------------------------------------------------
; UserEdit NewUserType
;
#topic(UserEdit NewUserType)
#title(New User Definition selection)
Select what type of user you would like to add, or press Escape to
return to the list.
#end


;---------------------------------------------------------------------------
; UserEdit UsersList
;
#topic(UserEdit UsersList)
#title(List of User Definitions)
This list shows all of the users (FTN and UUCP) which you have
configured.  There are four columns on this list:

FTN  33:500/700.10     + NS   Anthony Tibbs
UUCP JOE_BBS           - NS   (Joe's BBS)
UUCP WORLDNET          +C     (Worldnet)

The first column specifies the type of node (FTN for Fido-style network,
and UUCP for UUCP/UUPC users).

The second column gives the Fido AKA or UUCP name for this user.

The third column contains four spaces for flags:
     +    - node is active, and receiving mail
     -    - node's Passive flag has been set, meaning that they will
            not receive echomail messages (in the case of a Fido node),
            or that they will not receive mail at all (in the case of a
            UUCP node)
     C    - Create New Areas has been set for this user
     N    - notification messages will be sent to this user when WTRGATE
            NOTIFY is run
     S    - the Allow Sub-domains option has been enabled for this user

The fourth, and final, column gives the SysOp name and/or Organization
for this user (if one has been set).

  Eenter - Edit user the cursor is on
  Insert - Create a new user
  Delete - Delete one or more users

#end


;---------------------------------------------------------------------------
; UserEdit LinksList
;
#topic(UserEdit LinksList)
#title(List of Link Definitions)
This list shows all of the links (BAG, POP3, SMTP, SOUP, and BBS interface
links) which you have configured.  There are four columns on this list:

SOUP SOUPLINK           C     (SOUP provider - news/mail)
SOUP TEAMWG                   (TEAMWG mailbox)
BAG  WORLDNET           C     (news provider)

The first column specifies the type of link (SOUP, BAG, POP3, SMTP, or BBS-
interface).

The second column gives the UUCP name for this user.

The third column contains four spaces for flags:
     C    - Create New Areas has been set for this user
     S    - the Allow Sub-domains option has been enabled for this user

The fourth, and final, column gives the SysOp name and/or Organization
for this user (if one has been set).


  Enter  - Edit the link definition the cursor is on
  Insert - Create a new link definition
  Delete - Delete one or more link definitions

#end


;---------------------------------------------------------------------------
; UserEdit DeleteTaggedUsers AreYouSure
;
#topic(UserEdit DeleteTaggedUsers AreYouSure)
#title(Are you sure to delete the tagged user(s)?)
Please confirm that you are sure you want to remove these users.
#end


;---------------------------------------------------------------------------
; 1213: User edit: World registered
;
; (not supported anymore)
;
;#topic 1213
;Only toggle this option to "Yes" if the UUCP name of this user is
;world-registered.
;#end


;---------------------------------------------------------------------------
; UserEdit NowAllowedGroups
;
#topic(UserEdit NowAllowedGroups)
#title(List of allowed groups)
List of groups this user has access to

 Insert - List the groups not yet available
 Delete - Make the tagged groups unavailable

#end


;---------------------------------------------------------------------------
; UserEdit NotYetAllowedGroups
;
#topic(UserEdit NotYetAllowedGroups)
#title(List of not yet allowed groups)
List of Groups not yet available to this user
#end


; end of file user.txt

