; wtrutil.txt
;
; This is the WaterGate help file
; This file is included by wtrgate.txt
;
; Contents: WtrUtil 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)


;---------------------------------------------------------------------------
; WtrUtil Main Menu
;
#topic(WtrUtil Main Menu)
#title(WtrUtil Main Menu)
Welcome in the WaterGate Utility program (WtrUtil).

You can select the following functions from the main menu:

#highlight(Area Maintenance)
You will be able to select one or more areas and then perform
a purge, link, renum or re-index on the message base(s).

#highlight(Pack databases)
Run this every once in a while to clean up or repair the WaterGate
Databases (*.TDB files).

#highlight(RFC bad manager)
This option will allow you to inspect the messages dumped in the
RFC bad directory and then delete them.

#highlight(Shrink log file)
Use this option to remove old information from the WaterGate log
file (wtrgate.log). You are asked for the number of days to keep
and the rest will be removed.

#highlight(Shrink statistics file)
Use this option to remove old information from the WaterGate
statistics file. You are asked for the number of days to keep
and the rest will be removed.

#highlight(Re-build BBS users index)
With this option you can create the BBS users database that is
used by WtrGate to find the names of the users on the BBS and
move mail from them to the BBS area defined in the ROUTE.TDB file.

Press #HL(F1) for information on how to use the on-line help system.

 #LINK(HowToUse)(How to use the user interface)
;
;>>>> OLD BELOW
;Area maintenance       - Link, purge, renum and reindex on a
;                         selection of areas.
;
;Pack databases         - Remove deleted records from the WaterGate
;                         databases (*.TDB) and rebuild any broken
;                         links.
;
;Shrink log file        - Trim the wtrgate.log or wtrgate.sta files
;Shrink statistics file   by keeping only the last x number of days.
;
;Rebuild BBS user index - Rebuild the BBSUSERS.TDB file WaterGate
;                         optionally uses to forward mail for users
;                         on your BBS to a certain area or via a
;                         certain user.
#end


;---------------------------------------------------------------------------
; WtrUtil ShrinkDays Input
;
#topic(WtrUtil ShrinkDays Input)
#title(Shrink Days input)
Enter the number of days of the history in the WaterGate logfile
you want to keep. If input is 0, only today will be kept.
#end


;---------------------------------------------------------------------------
; 4301: Script Filename help
;
;#topic 4301
;Enter the filename of the script file. This ascii text file has to contain
;a series of (partitial) area names you want to keep or want to remove.
;It looks like this:
;
;       +ALT.*
;       +REC.*
;       -BIO.*
;       ##execute
;
;Without the last statement, the areas are not really deleted, but a list
;of the areas that would be deleted is written to the logfile instead. It
;is also possible to override previous statements, like:
;
;       -ALT.*
;       +ALT.BBS.WATERGATE
; or:
;       -*
;       +ALT.*
;       +REC.*
;       +COMP.OS.LINUX
;#end


;---------------------------------------------------------------------------
; BBSUsers Path
;
#topic(BBSUsers Path)
#title(Path to BBS users file)
Enter the filename where the text file can be found.

WtrUtil expects a single name on each line in that file.
Empty lines are allowed.

The file is read and the database BBSUSERS.TDB is rebuilt
with index codes for each of the names. This file is then
used by WtrGate to find out if a certain e-mail is for a
user on your BBS, so it can import it into the designated
area directly.

An example text file:
 Ramon van der Winkel
 Martijn Dijksterhuis
 Michel van.der.Laan
 Anthony Tibbs
#end


;---------------------------------------------------------------------------
; AreaMaintenance Groups
;
#topic(AreaMaintenance Groups)
#title(Area Maintenance group selection)
Select the groups from which you want to see the areas. You can
then select the areas to perform the maintenance on.

Press enter to select a group or use the tag keys to first select
one or more groups and then press enter to select all the tagged
groups.
#end


;---------------------------------------------------------------------------
; AreaMaintenance Select
;
#topic(AreaMaintenance Select)
#title(Area Maintenance area selection)
Select the areas you want to perform maintenance actions on.
You can use the function keys F5, F6 and F7 to make multiple
selections.

Press enter for the menu of action you can perform.
#end


;---------------------------------------------------------------------------
; AreaMaintenance Menu
;
#topic(AreaMaintenance Menu)
#title(Area Maintenance action menu)
You can now select the maintenance action you want to perform
on the area(s) you just selected.

Link: Link messages for threaded reading.

Purge: Remove messages marked deleted, recover unused space
and optionally trim areas with an limit set for the
age of messages or the amount of messages.

Renumber: Renumber the messages sequentially.

Reindex: Rebuild the index table for this message base.

The above actions can only be performed on *.MSG, Jam or Squish
areas. Renumber for Squish is not implemented. You can safely
include areas with other message base formats - these are skipped.
#end


;---------------------------------------------------------------------------
; RFCBadManager
;
#topic(BadMgr DirectoryContents)
#title(RFC bad directory contents)
This window shows the contents of the RFC bad directory. Press
Enter to select one of the files and view its contents. You
will then be asked to delete the file or not.
#end

#topic(BadMgr FileContents)
#title(Contents of RFC bad file)
This window shows the contents of an file from the RFC bad directory.

The file was created there when the system detect an inconsistent or
abnormal situation and decided not continue to process the message.

The window shows the following sections:

#highlight(Header)
Shows when this file was created and why.

#highlight(Bad destination) (Optional)
Shows which of the destinations (see below) triggered this write.
This information is not always available. If it is absent and there
is only one destination, then that destination is the one that
triggered this write.

#highlight(Destinations)
This section shows all the destinations the message had. Notice
that the message was still delivered to all the destinations
except for the one that caused the write to the bad directory.

The message can have had more destinations as are listed here.
When a message is delivered to one of its destinations, the
destination is removed from the list and can no longer be presented
here.

#highlight(Message headers)
This section shows the raw RFC message headers. Some headers may be
unreadable because they are encoded with a transport format.

#highlight(Message body)
This section shows the raw RFC message body. The body contains multiple
parts (MIME) or alternate parts (MIME, ASCII and HTML for example).
Some or all parts can be encoded in a readable or non-readable way
(strange character set, UU-encoded, XX-encoded, BinHex or Base64 encoded).
#end

#topic(BadMgr DeleteFile)
#title(Delete RFC bad file?)
If you have inspected the RFC bad file and see no reason to keep it,
then select Yes to delete the file.
#end

; end of file wtrutil.txt

