home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 2 BBS
/
02-BBS.zip
/
sqav194e.zip
/
sqaverw.DOC
< prev
next >
Wrap
Text File
|
1995-04-02
|
25KB
|
746 lines
Documentation for SQAVERW
Index:
------
1.0 Copyright
1.1 Description
1.2 Files in the package
1.3 Required
1.4 Internals
2.0 Execution
2.1 Running
2.2 Configurationfile
2.3 Errorlevel
3.0 Commands in Netmail
3.1 Superuser
3.2 Read only areas
3.3 Errorcommand %ERROR
3.4 Area accesslevels
4.0 Guaranty
4.1 Thanks
4.2 Credits
1.0 Copyright
-------------
Copyright (c) 1993-1994 Martin Weigel
All rights reserved .
The use of the program is allowed for a testperiod of 30 days .
After testperiod you have to register the program or stop using
it . (see REGISTER.DOC)
I allow copying and distribution of the program with some restrictions:
1. Do not change the archive and its contents .
2. No fee is charged for copying and distribution .
1.1 Description
---------------
The main function of the program is to manage a messagebase .
Together with tosser "Squish" a user can handle his areas with
netmail messages . To process these messages SQAVERW searches in
the netmail directory for mail adressed to SQAVERW . SQAVERW
checks the password and executes the commands in the message .
additional funktions:
SQAVERW can automatically delete passthru areas which have no downlink .
In this case it sends a mail to the uplink to unlink the feed .
The areaflag "D" allows non passthru areas to be deleted .
SQAVERW can automatically link new areas at an uplink .
If a downlink requests an unknown area the program searches in
areas.bbs files for the area . If found the area is automatically
linked at uplink .
SQAVERW can scan the badmail folder .
It searches for mail from not linked nodes in the given area and link that node .
It searches for unknown areas and create a new area .
SQAVERW can handle automatic error messages .
SQAVERW detects mail from his own addresses (SUPERUSER)
All addresses defined with ADDRESS keyword are handled as his
own address . This means :
At linking the passthru flag ("-0") is deleted .
At unlinking the passthru flag is added ..
The own address is not shown in the list of linked nodes .
You can change the areastatus to PASSIVE if you want to avoid
automatic deleting of the area .
SQAVERW detects other tasks with itself . In this case it waits
until the other task ends . ( "\SEM32\SQAVERW" )
SQAVERW detects other tasks with Squish . In this case it waits
until the other task ends . ( "\SEM\SQUISH\DEFAULT" )
SQAVERW has HPFS filename support.
Warning :
The default areatype is *.MSG format ("-f").
If you delete the passthru flag to get the area in the messagebase
this format is default .
1.2 Files in the package
------------------------
Name of the package:
SQAV???E.ZIP English version
SQAV???G.ZIP German version
SQAVERW.EXE Executable .
SQAVERW.CFG Sample configurationfile.
SQAVERW.USE Helpfile , send with command %HELP .
SQAVERW.DOC This documentation .
SQAVERW.HIS History and errors .
REGISTER.DOC Some hints on registration .
KAREAXXE.ZIP An external utility from Martin Mirgel.
Usefull for MAXIMUS users .
1.3 Required
------------
OS/2 Version 2.x,3.x from IBM .
MSGAPI32.DLL from Scott J. Dudley .
1.4 Internals
-------------------
IBM CSet++ Firststep
OS/2 2.1 German Version
Compileroptions : /Tl- /Sp1 /Ss /Q /C /Gt+
2.0 Execution
-------------
1. Reading configurationfile .
2. Reading Squish-configurationfile .
3. Reading confuration file with deleted areas .
4. Checking configuration and exit at error .
5. Working commands .
6. Deleted areas and newly created areas were unlinked and linked
at uplink .
7. Saving the configuration .
Warning : The program renames "*.CFG" Files in "*.OLD"
2.1 Running
-----------
SQAVERW Command Parameter
Commands:
SCAN Searching and executing netmail .
DELETE Deleting of areas without downlink .
SCANDEL Scan and delete together .
BAD Searching badmail (only alone)
LIST Sending list of available areas .
QUERY Sending list of linked areas .
KILL Kill an area .
CREATE Create an area .
LINK Link a node to an area
UNLINK Unlink a node from an area
DESCRIBE Update area description
AREA Create AREAS.BBS
CHANGE Global changings
PAUSE Set a node passive
ACTIVE Set a node active
AVAIL Sending list of uplink areas.
RESCAN Rescan an area.
HELP Show help .
Parameter:
-c Name of the configuration file .
SQAVERW.CFG is default .
-cd:\test\x.cfg
-qn Screen output level . n=(1...15)
See LOGLEVEL.
-q14
-t Only for test purposes . Shows memory dump .
-h Show help about command .
-n Replace NODE keyword with NODEF keyword .
Command BAD
Scans the badmail area for mail from known nodes checks if the
area exist and if the group allow the linking .
If the area does not exist it will be created.
No other commands are executed .
WARNING : To avoid errors check the badmail first . The areas
will be linked without passwordchecking .
Command SCAN
Scans the netmail areas for mail to SQAVERW .
Command DELETE
Automatically deletes passthru areas without downlink .
Also non passthru areas without downlinks and with "D" flag
are deleted .
Command LIST ADDRESS [NETAREA]
Sends a mail with available areas to the defined address .
Send the mail in area NETAREA .
Command QUERY ADDRESS [NETAREA]
Sends a mail with linked areas to the defined address .
Send the mail in area NETAREA .
Command KILL AREATAG
Kills the defined area .
Command CREATE AREATAG ADDRESS "Description"
Creates an area with the defined values .
The ADDRESS defines the address of the uplink .
Command LINK AREATAG ADDRESS
Links a node to the defined area .
Command UNLINK AREATAG ADDRESS
Unlinks a node from the defined area .
Command AREA AREAS.BBS
Create an AREAS.BBS file ..
The file has the form AREATAG "Description".
Command DESCRIBE AREAS.BBS [OVER].
Update the area description from the AREAS.BBS file if there is
only the DEFAULTAREADESCR or spaces in the area decription of
SQAVERW.CFG .
If you add "OVER" all descriptions were overwritten.
The AREAS.BBS file has to be in the form
AREATAG "Description"
or
AREATAG Description ;
Command CHANGE NODE OLD-ADR NEW-ADR
Changes the nodeaddress of a node . All places where the old address
is found were changed and saved .
Restrictions:
In SQUISH.CFG only ECHOAREA entries were changed.
Command ACTIVE NODE [GROUPS]
Set a node active for the given groups.
If no group is given all groups will be changed.
Commando PAUSE NODE [GROUPS]
Set a node passive for the given groups.
If no group is given all groups will be changed.
Command AVAIL ADDRESS [NETAREA]
Sends a mail with available areas at the uplink to the defined address .
Send the mail in area NETAREA .
Command RESCAN AREA ADDRESS
Rescan an area for the given node .
2.2 Configurationfile
---------------------
ADDRESS 2:248/200.0
The keyword ADDRESS defines the main address . You can define
additional addresses . Also the addresses in the squish-configuration
are added .
ALIAS sqafix
The keyword ALIAS defines the name of the program . The program
only reacts if a mail is addressed to this name . You can define
additional names . The default is SQAVERW .
If there are spaces in the name use double quotes (ALIAS "imail areafix")
ALWAYSINTL
The keyword ALWAYSINTL causes SQAVERW to include always an INTL
line in the netmail .
AUTOMATIC Areaverwaltung
The keyword AUTOMATIC defines the name of a program which sends
automatic mails . This enables in addition with the nodeflag
"E" the communication between two areamangers . This means
sending and receiving a %ERROR command .
If there are spaces in the name use double quotes (AUTOMATIC "imail areafix")
DEFAULTAREADESCR "Description missing"
The keyword DEFAULTAREADESCR defines the areadescription if it is
not found .
DEFAULTAREAFLAGS +R
The keyword DEFAULTAREAFLAGS defines the default flags for each area.
You can overwrite these flags in the area definition .
Each flag begins with "+" .
Areaflags:
V Area is visible if the node has the "V" flag .
R Rescan is allowed if the node has the "R" flag .
D Allow deleting of the non passthru area .
U Internal area flag . Do not use this flag .
This flag prevents the automatically deletion of newly created areas.
DEFAULTNODEFLAGS +K +R +P +T
The keyword DEFAULTNODEFLAGS defines the default node flags .
You can overwrite these flags in the node definition .
Each flag begins with "+" .
ATTENTION : Node flags has to be upper case .
Node Flags :
K Send answer with Kill/Sent attribut
H Send answer with Hold attribut
C Send answer with Crash attribut
T Send answer with Private attribut
P Keep request for further use . The Recv attribut is set .
R Allow rescan
A Allow automatic creation of new areas
V Show areas with "V" flag
G Gecho flag . Send UNLINK mail if creation of new area fails
U Allow the commands DELETE and RENAME (usually for uplinks)
I Allow the command %AVAIL.
S Areamanager can handle the commands DELETE and RENAME .
E Areamanager can handle the Command %ERROR .
DEFAULTNODEGROUPS A
The keyword DEFAULTNODEGROUPS defines the groups which are valid
for all nodes .
DELETELOG sqaverw.del
The keyword DELETELOG create a file with all deleted areas .
ECHOAREA <Areaname> <Group> [^Level] ["Descr."] [Flags] [#Uplink] [Passive]
ECHOAREA NACHRICHT_AN_DEN_SYSOP Z "Description missing" +R 245/31
The keyword ECHOAREA defines the areas .
Each area has to be defined in both configuration files !
Areaname-- name of the area (AREATAG)
Group -- defines the group of the area
Upper case letters only .
Level -- Area accesslevel
Descr. -- short description of the area .
Flags -- together with DEFAULTAREAFLAGS these flags define
the valid flags for the area .
You can overwrite a default flag with "-" .
Uplink -- optional definition of uplink.
Passive -- list of passive nodes .
HPFSSUPPORT 0
0: New areafilenames will be in DOS-FAT format .
1: New areafilenames won't be cut.
There is a test at runtime if the drive has a HPFS filesystem.
2: New areafilenames won't be cut.
There is a test at runtime if the drive has a HPFS filesystem.
'.' will be changed to '_' .
Non valid characters will be cut.
( see OS/2 Online-Help)
IGNOREMSGSFROM MsgTrack
The keyword IGNOREMSGSFROM defines the names in the from field
which has to be ignored . You can define additional names .
If there are spaces in the name use double quotes (IGNOREMSGSFROM "imail areafix")
IGNOREPASSWORDCASE
The keyword IGNOREPASSWORDCASE makes the password checking
case insensitive .
INCLUDE test.cfg
The keyword INCLUDE defines the path and name of an additional
configuration file .
KEEPFAILEDREQUESTS
The keyword KEEPFAILEDREQUESTS is used to keep the messages which
have failed .
LOGFILE SQAVERW.LOG
The keyword LOGFILE defines name and path of the log file .
LOGLEVEL 14
The keyword LOGLEVEL defines the logfile output level .
The value is used bitwise .
1 : Warnings
2 : Working
4 : Functions
8 : Errors
NETAREA Netmail
NETAREA Netmsg
The keyword NETAREA defines the netmail area . This area is used
to search and write netmail . This can be a squish style message-
area . This area has to be defined in SQUISH.CFG .
You can define more than one area . The first area is used to send
automatic created messages .
NETMAIL e:\csource\area\msged
The keyword NETMAIL defines the netmail path .
Only the "*.MSG" format is allowed .
This is an old keyword . You should better use NETAREA instead .
NEWAREAFLAGS -$m200 -$d10
The keyword NEWAREAFLAGS defines the squish area flags for
newly created areas .
See also DEFAULTAREADESCR and DEFAULTAREAFLAGS .
You can define an alternate address for a new area for every node.
See NODE .
NEWAREAGROUP A
The keyword NEWARAEGROUP defines the group of newly created areas .
An entry in OLDAREAS.CFG overwrites this group . If the group is in lower
case the area will be read-only. You can define a NEWAREAGROUP for each
node (see NODEDEF).
NEWAREANODES 245/30
The keyword NEWAREANODES defines nodes wich are automatically linked
at newly created areas .
NEWAREANOTIFYECHO OS2.GER TEST_200
The keyword NEWAREANOTIFYECHO defines a list of areas .
SQAVERW writes a mail in each area if there is a new area .
NEWAREANOTIFYNET 1:25/30 1:10/1
The keyword NEWAREANOTIFYNET defines a list of nodes .
SQAVERW writes a netmail to each node if there is a new area .
NEWAREAPATH e:\csource\area\new
The keyword NEWAREAPATH defines the path for new automatically
created areas . The path is used in squish configuration file .
NEWAREAPLACE
The keyword NEWAREAPLACE defines the place where new areas are stored.
NODE <Address> <Password> <Groups> [^Level] [Flags] [#Areamgr] [*Areas.bbs] [~Newpath] ["Name"]
NODE 2:248/200.0 testsup AHSNZ ^100 +A -p2:247/6 #AREAFIX *AREAS.BBS "Martin Weigel"
The NODE keyword defines a node .
Here you can define password,groups and flags for your own addresses .
This allows SUPERUSER access .
Address -- 4D node address .
Password -- defines the password of the node .
the password is case sensitive .
Groups -- together with DEFAULTNODEGROUPS these groups define
the access of the node .
Only upper case letters 'A' - 'Z' are valid .
Lower case letters define the group read only for
this node .
Level -- Area access level
Flags -- together with DEFAULTNODEFLAGS these flags define
the valid flags for this node . You can overwrite
default flags with "-" .
in addition to the node flags (UPPER CASE) the flag
"-p" (lower case p) is allowed . This squish flag is
added at automatic creation of an area and tells squish
an alternate address . Also in netmail to this node
the address is used .
Areamgr -- Name of the areamanager of this node .
This name is required for the automatic deleting
of areas without downlinks .
Areas.bbs -- Defines an AREAS.BBS file for the node .
This file is used to search for new areas .
Format of the AREAS.BBS file :
AREANAME "Description" or
AREANAME Description .
Newpath -- Defines the newareapath for this node . If not given the
NEWAREAPATH is used .
Name -- Name of the sysop .
NODEDEF address
Password: Password
Sysopname: Sysopname
Areasbbs: Areas.bbs file
Groups: Groups
Nodeflags: Nodeflags
Netarea: Netmailarea for answers to this node .
This means automatic mails and notify mails .
Alternate: alternate address to use with this node
Areafix: Areamanager name
Newareapath: Path for new areas
Newareanodes: New nodes
Newareaflags: New Squish flags
Newareagroup: New group
Nodelevel: Area accesslevel of the node
END
The NODEDEF keyword defines a node .
Here you can define password,groups and flags for your own addresses .
This allows SUPERUSER access . Use this keyword only when you need
the additional configuration ability .
The END keyword is absolutely required .
ATTENTION ,in the block is no comment allowed .
OLDAREASCFG AREAS.CFG
The keyword OLDAREASCFG defines the name and path of the file with
deleted areas . The area flags and the area group are used if the
area is automatically linked .
This allows definition of areas with restricted status .
RESCANCOMMAND d:\binkley\squish\squishp rescan
The keyword RESCANCOMMAND defines the system command to make
a rescan . The areaname and the nodenumber is concatenated .
SERIAL 00000001
The keyword SERIAL is used for the serial-number in the MSGID
field .
WARNING : To avoid dupe messages do not change this number .
SQUISHCFG e:\csource\area\SQUISH.CFG
The keyword SQUISHCFG defines name and path of the squish
configuration file .
2.3 Errorlevel
--------------
0 No error occured , no mail
1 Configurationsfile not found
2 Squish-configurationsfile not found
3 Error in configuration
4 Error in commandline
5 Error opening MSGAPI.DLL
6 Error saving configuration
7 Error opening netmail area
8 Error requesting semaphore
16 Mail sent
99 Can not initialize desktop
3.0 Commands in netmail
-----------------------
From: <name> <address>
To : sqaverw <address>
Subj: <password> [-q] [-l] [-?] [-h]
The password is case sensitive .
Additional parameters in the subject field :
-? Send help file
-H Send help file
-L Send list of avaiable areas
-Q Send list and status of linked areas
-N Avoid answer . (WARNING for internal use only )
In the message text you can give commands to SQAVERW .
One command per line .
The tearline (---) ends the commands .
Commands allowed :
[+]<Areaname> ,R -- link area ,with rescan
-<Areaname> -- unlink area
[+]%ALL [Gruppen] -- link all areas in the given groups
-%ALL [Gruppen] -- unlink all areas in the given groups
%PASSIVE [Gruppen] -- set all areas in the given groups to passive
%PAUSE [Gruppen] -- same as %PASSIVE
%ACTIVE [Gruppen] -- set all areas in the given groups to aktive
%RESUME [Gruppen] -- same as %ACTIVE
%RESCAN <Areaname> -- rescan for the given area
%LIST -- request list of avaiable areas
%QUERY -- request list and status of linked areas
%HELP -- request help file
%PWD <Passwort> -- change password
%KILL <Areaname> -- delete area
only with node flag "U" allowed (DELETE)
~<Areaname> -- same as %KILL
%NOTIFY -- Notify on.
-%NOTIFY -- Notify off.
%AVAIL -- request list of avaiable areas at the uplinks.
#<oldname> <newname> -- rename the area . Allowed only with node flag "U" . (RENAME)
&<Areaname> "Descr" -- create area . Allowed only with node flag "U" .
If no group is given all allowed groups for the node are valid .
%ERROR <Number> <Areaname>
This command is send from SQAVERW if an error at automatic linking
of an area occurs . The area will be deleted .
3.1 Superuser
-------------
Superuser means it is you who request something from your own SQAVERW .
In this case there is a different handling of commands .
Instead of adding/deleting the address in the squish configuration
file the passthru flag of Squish is removed/set .
You can use this feature if you define a NODE entry with your first
address , groups and password .
Further addresses have automatically this parameters .
%NODE <Address> <command>
%NODE 2:243/4201.9 +TEST_200
This command in the mail allow the superuser to send a valid command
to SQAVERW .
SQAVERW reacts as if the mail is from this Node . The answer is send
to the Superuser . Only The %HELP command answer is send to the Node .
If you link an area which is not avaiable and let SQAVERW send an
automatically created mail you can send a rescan command to the uplink.
for example: +TESTAREA,R
3.2 Read only areas
-------------------
Read only areas are only avaiable in groups . This means , you can
define a Node readonly for a group of areas .
In this case you have to define the group in the NODE entry in lower
case letters . This is the only place where lower case groups were
accepted .
3.3 Errorcommand %ERROR
------------------------
This command is the first step to enable a communication between
two areamanagers . The concept of SQAVERW at automatic linking
needs AREAS.BBS files which area updated .
Nevertheless there are errors possible .
If a area is automatically linked at uplink , the area is created
at the own system .
If the area is not avaiable at uplink system a local area is cerated.
To avoid this SQAVERW reacts in the following way :
1.SQAVERW checks with the AUTOMATIC keyword if the mail is
automatically created .
2.SQAVERW checks with the nodeflag "E" if the areamanager of the
node can send and receive %ERROR commands .
3.If SQAVERW receive an %ERROR 1 AREATAG command , the area will
be deleted .
4.If SQAVERW can not link an area the %ERROR 1 AREATAG command
will be sent .
At the moment there is only the error 1 defined .
3.4 Area accesslevels
---------------------
To use the area accesslevels you have to look at some points:
1. Give an area an accesslevel with the [^level] option .
If no level is given the default is 0 .
2. Give an node an accesslevel with the Nodelevel statement or
with the [^level] option .
If no level is given the default is 0.
3. You can define accesslevels in the range of 0..255 .
4. SQAVERW compares the arealevel and the nodelevel .
If the nodelevel is greater or equal the arealevel access is
allowed.
4.0 Guaranty
------------
I give no guaranty for the correct function of the program .
Hints and error descriptions are welcome .
If you send me an error description please add the version number .
Martin Weigel
Soester Str. 413
59071 Hamm
Germany
PNoF 241:10000/1910
Fido 2:2444/4513.9
4.1 Thanks
----------
Many thanks to the following people for their hints and error
descriptions .
Martin Marschand
Michael Siebke
Jochen Peterson
Robert Gloeckner
Stuart Grimshaw
Jens Meske
Roland Lichti
Rene van der Voorden
Marco Kremer
Heinz Mueller
Martin Hadem
Peter Strunk
Michel Burens
Christian Coehn
Oliver Bruckauf
Michael Weyrauch
4.2 Credits
-----------
Squish is a trademark from Scott J. Dudley .
This program uses the MSGAPI32.DLL from Scott J. Dudley .