; list.txt
;
; This is the WaterGate help file
; This file is included by wtrgate.txt
;
; Contents: WtrConf Mailing List 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)


;=======================================================================
; Mailing list subscriber editor
;
#topic(Mailing list subscriber editor)
#title(Mailing list subscriber)
This help topic explains the fields related to a Mailing list
subscriber. This topic covers all three types of subscribers:
FTN, RFC and RFC user behind remove FTN-RFC gateway.

#subtopic(ListUser Name)
#title(Name)
Enter the full name of the user receiving this list.

Example: Joep Meloen

#subtopic(ListUser AKA)
#title(AKA)
Enter the full FTN address of this user.

Example: 2:280/802.6@fidonet.org

#subtopic(ListUser Email)
#title(E-mail)
Enter the full RFC address of the user receiving this list.

Example: joep@meloen.network.nl

#subtopic(ListUser Access)
#title(Access)
This fields set the access this user has to the mailing
list.

You can prevent users from posting to an announcement
list by settings this option to "receive only".

You can create special "relay users" that do not receive
a copy of the message they posted, for example messages
received from another mailing list. Use the "post only"
options for this case.

#subtopic(ListUser ReceiveOwnMail)
#title(Receive Own Mail)
This field controls whether or not the user should receive his
or her own messages.  Normally (if this is set to Yes), WaterGate
sends a copy of the message back to the user, so that they know
the message was distributed.  There are certain situations,
however, where this may not be desirable.

It may be possible in the future for the user to choose whether
they would like to receive their own mail.

#subtopic(ListUser ConfirmState)
#title(Confirm State)
This field controls the current state of the re-confirmation
mechanism and is automatically updated by WaterGate. It should
normally be set to OK, unless WaterGate has sent out a
re-confirmation request.

You can manually change it to DISABLED to disable the mechanism
for this user only.
#end


;-------------------------------------------------------------------------
; ListUser Add
;
#topic(ListUser Add)
#title(Add subscriber)
Use this option to select a type of user to add to the current
mailing list. This can be either a single FTN or RFC user,
or a file containing a list of users. See below for the file
formats.

- For a RFC user you specify an Internet e-mail address.

- For a FTN user you specify the full name of the user and node
  number.

- For a Remote Gateway user, you need the node number and user
  name for the netmail sent to the gateway and the e-mail address
  for in the To: line.

 #link(Remote Gateway User)(More info on Remote Gateway Users)

#subtopic(ListUserImport FTN)
#title(File format for FTN users list)
The file containing FTN users that you want to add to a mailing
list must have the following structure:

 ; optional comment line
 <aka> <name>

Example:

 ; ftn.txt
 ;
 2:280/802.6  Jaap Aap
 2:500/239    Klaas Vaak
 1:212/12     Michael Conner

#subtopic(ListUserImport RFC)
#title(File format for RFC users list)
The file containing RFC users that you want to add to a mailing
list must have the following structure:

 ; optional comment line
 <e-mail address>

Example:

 ; rfc.txt
 ;
 jaap@aap.network.nl
 klaas@vaak.network.nl
 John@Johnson.sons.com

#title(Export subscribed users)
Follow the links below to find out about exporting a list of
users subscribed to the mailing list to a file.

 #link(ListUser Export)(Export subscribed users)
#end


;---------------------------------------------------------------------------
; ListUser List
;
#topic(ListUser List)
#title(List of subscribed users)
This list shows all the users subscribed to the mailing list (if any).
You can use the following keys:

 Insert - Add a new subscriber to the list
 Enter  - Edit the selected user
 Delete - Delete the selected list

You can also tag one or more users (using F5, F6, F7) and then press:

 F2     - Export all tagged users
 Enter  - Change access type for all tagged users

#end


;-----------------------------------------------------------------------
; ListUser Export
;
#topic(ListUser Export)
#title(Export subscribed users)
This option allows you to export a list of users subscribed to a
mailing list to a file. This is done by tagging the users you want
to export in the list of subscribed users and then pressing F2. You
can then enter a file name and press F10 to export the users.

Notice that it is possible to mix FTN, RFC and remote gateway users,
but WtrConf can only import a list of FTN user or a list of RFC users.
A mixed list is not possible.

This is the format of the created file and the format for the
three subscriber types.

 ; optional comment line
 <e-mail address>
 <user name> <aka>
 <e-mail address> via <user name> <aka>

The first is for RFC, the second for FTN and the last for a remote
gateway subscriber.

Example:

 ; Created by WtrConf
 ;
 jaap@aap.wlink.nl
 ramon@wline.se
 Ramon van der Winkel 2:200/111.15
 ramon@work.se via UUCP 2:200/111.15

#end


;-----------------------------------------------------------------------
; ListEdit SelectArea
;
#topic(ListEdit SelectArea)
#title(Select Area)
Select the Area you want to be connected to this mailing list.

Once selection, you must enable either List to Area or Area to List
before there will be any flow of messages to the selected area.
#end


;-----------------------------------------------------------------------
; ListEdit SelectAKA
;
;## while wondering if the below is correct, I started wonder if we
;## can't let WG select the correct AKA automatically. When writing a
;## reply, it should use the closest matching system AKA.
#topic(ListEdit SelectAKA)
#title(Select AKA)
Select the AKA you want the mailing list to use when creating
a FTN message.
#end


;---------------------------------------------------------------------------
; ListEdit SelectHomeDomain
;
#topic(ListEdit SelectHomeDomain)
#title(Select home domain)
Select the system RFC domain you want this mailing list to use.
The mailing list will use the selected domain in its e-mail address.

This is used when you have multiple domains and you don't want the
mailing list to use the first system domain.

Notice that both the list server and all the mailing lists can be
reached on any of the system domains.
#end


;===========================================================================
; Mailing List Definition Editor
;
#topic(Mailing list definition editor)
#title(Mailing list definition)
This topic is related to all the fields of a Mailing list Definition.

#subtopic(ListEdit Name)
#title(List name)
Choose a name for the list, the list server will recognize any netmail
or mail message addressed with this name to this system. After checking
if it was sent by a valid user, it is copied to everyone who is
connected to this list.

Examples for addressing the list "WorldWonder" follow below.

For FTN users:

 From: Sysop             2:280/803
 To  : WorldWonder       2:280/802
 Subj: About number 9....

For RFC users:

 From: paladin@hero.network.nl
 To:   WorldWonder@your.domain
 Subj: About number 9....

#subtopic(ListEdit Description)
#title(Description)
Enter a short description of this particular list.

This information is shown to everyone who writes a message
to the mailing list server, requesting a list of available
mailing lists.

#subtopic(ListEdit Private)
#title(Private list)
Set this option to Yes to make this a private mailing lists.
It will then not show up on the list of mailing lists that
people can subscribe to and you will have to connect/disconnect
people manually.

#subtopic(ListEdit OnlyKnown)
#title(Only known)
By setting this option to Yes, only nodes directly known to
this system are capable of requesting access to this list.

#subtopic(ListEdit Passive)
#title(Passive)
By setting this option to Yes, the list becomes passive. Messages
for this list are ignored, and no-one can remotely connect this list.

#subtopic(ListEdit ListAKA)
#title(List AKA)
Select your system node number to use when the list server
distributes messages for this list.

#subtopic(ListEdit ListDomain)
#title(List domain)
Select the system RFC domain you want this mailing list to use.
The mailing list will use the selected domain in its e-mail address.

This is used when you have multiple domains and you don't want the
mailing list to use the first system domain.

Notice that both the list server and all the mailing lists can be
reached on any of the system domains.

#subtopic(ListEdit ListAddress)
#title(List address)
This option selects the priority of the mailing list
address over the sender's address.

If it is set to #Higher# then the user will send the reply
to the mailing list when pressing the reply button.

When set to #Lower#, the reply will in the first place always
go to the user that posted the message to the mailing list.

Depending on the type of mailing list, either can be selected.

Notice that the address with the highest priority will be
put in the From: fields when the message is translation from
RFC e-mail to FTN netmail format, so the same reply effect as
above is obtained.

But when translated to FTN echomail format, the poster's address
is always shown in the From: field in order to hide the fact
that the echo is actually connected to a mailing list.

#subtopic(ListEdit NameInSubject)
#title(Name in subject)
When this open is set to Yes, WaterGate will insert
the name of the mailing list inside square brackets
in the subject lines for netmail and e-mail messages
sent to the subscribers of this list.

Example: [WaterGate] New feature

#subtopic(ListEdit WelcomeFile)
#title(Welcome file)
When someone connects to a mailing list, you can send a welcome
file explaining some things about the list or the @FAQ@. Just
specify the filename here.

It is possible to make the reply message more personal by using
tokens, as described in the manual.

#subtopic(ListEdit FooterFile)
#title(Footer file)
A footer can be added to each message distributed by
this mailing list. Set the path to the file containing
this footer in this field.

Press F3 to use the File Manager to select the file.
;
;#subtopic(ListEdit AdminPassword)
;#title(Admin password)
;You can fill in the remote administration password in this
;field. If you leave it empty, remote admnistration of this
;mailing list will not be possible.
;
;Note that every mailing list must have a unique password
;because the password selects the mailing list.

#subtopic(ListEdit AreaName)
#title(Area name)
Define an Areaname here if you want to also post messages received
for a mailing-list into a newsgroup (and the other way around).

To avoid typos, you can only pick the name from a list of existing
areas.

#subtopic(ListEdit AreaToList)
#title(Area to List)
If you set this option to YES then WaterGate distributes the
messages found in the area via the mailing list.

The area must be defined in the Area Definitions section and
can effectively be an echomail area or a newsgroup, or both.
It can also be a local message base.

So, you can get messages from a newsgroup, echomail area or
local message base into this mailing list.

#subtopic(ListEdit ListToArea)
#title(List to Area)
You can feed all messages that are posted on this mailing list
straight into an area by settings to option to YES.

The area must be defined in the Area Definitions section and
can effectively be an echomail area or newsgroups, or both.
It can also be a local message base.

So, you can get messages from this mailing list into a
newsgroup, echomail area or message base.

#subtopic(ListEdit DefaultAccess)
#title(Default access)
By default all subscribers to a mailing list receive a copy
when something is posted and can post themselves.

You can limit this though to receiving messages only (no
posting) or posting messages only (not receiving). This can
prevent people from posting to an announcement list and
you can create special users to are used to send messages
to the list, but which should not receive anything posted
on the list.

This field holds the default value for new users subscribing
to your mailing list.

#subtopic(ListEdit ConfirmInterval)
#title(Confirm Interval)
This option selects the re-confirmation interval for users subscribed
to the mailing list. You can set it between 1 and 255 days, or to 0
to disable the re-confirmation mechanism.

If the number of days since the last confirmation has passed the
number of days set in this field, then WaterGate will send a message
to the user, asking him or her to reply with the give code. When the
code is received back, WaterGate sets the last confirmation date to
the current date.

If the user does not reply after three attempts, or when the messages
bounce (most important reason), then the user is deleted from the list.

It is possible to disable the mechanism on a per-user basis.

#subtopic(ListEdit UseMessageNums)
#title(Use Message #s)
This option selects whether you wish to stamp each message with a unique
ID number.  This number is inserted in the header ("This message was 
distributed by the mailing list xxx (msg #nnn)").

By turning this option on, participants will know whether they missed
a message for some reason (network errors, etc.).  In the future, this
may also allow WaterGate to handle digest lists and message rescans.
#end

;-----------------------------------------------------------------------
; Mailing list definitions
;
#topic(Mailing list definitions)
#title(Mailing List Definitions)
This list contains a listing of all the defined mailing lists.

You can use the following keys:

 Insert - Create a new mailing list definition
 Enter  - Edit the selected mailing list definition
 Delete - Delete a mailing list definition

#end


;---------------------------------------------------------------------------
; ListUser ChangeAccess
;
#topic(ListUser ChangeAccess)
#title(Change access for tagged subscribers)
This menu shows up if you have tagged one or more users
subscribed to this mailing list. You can now change the
access type for all these users at once by selecting one
of the options.
#end


; end of file list.txt

