home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / ERRFLG29.RAR / ERRFLAGS.DOC < prev    next >
Text File  |  2000-08-05  |  10KB  |  227 lines
  1.   ErrFlags version 2.9
  2.   --------------------
  3.  
  4.     This program checks incoming nodelist segments for illegal and
  5.     redundant nodelist flags, and makes sure submitted segments are up to
  6.     standard. Fully configurable to suit <othernets> as well as fidonet.
  7.  
  8.     Openware - This program may be used and copied without any cost.
  9.  
  10.     Copyright 1995, jonny bergdahl data AB - All rights deserved.
  11.     Modifications (C)1999 by Johan Zwiekhorst, 2:292/100
  12.  
  13.  
  14.   Disclaimer
  15.   ----------
  16.  
  17.     I guarantee that this program will take up some space on your hard
  18.     disk. That is all. If you decide to run it despite this very meager
  19.     warranty, however, standard software disclaimers apply. This means:
  20.     I don't guarantee anything concerning this software and so will not
  21.     be liable in any way for any damages incurred.
  22.  
  23.   SEE LICENCE.TXT FOR FURTHER INFORMATION!
  24.  
  25.  
  26.   Preface
  27.   -------
  28.  
  29.     When the original author of this program, Jonny Bergdahl, was the
  30.     Region 20 Coordinator (RC20) of Fidonet Zone 2, the need for this
  31.     program arose from all of the hubs and NCs which apparently just
  32.     couldn't get their act together and submit a correct nodelist segment,
  33.     for whatever reasons that was.
  34.  
  35.     This program, once installed, aids such inadequately functioning
  36.     coordinators to make sure that the submitted segments use no illegal
  37.     flags, no redundant modem flags and even tidies up the user flag field by
  38.     reformatting it. It is fully configurable so that new flags may be added
  39.     as they are approved. It can be used by anone from a hub submitting his
  40.     hub segment via NC and RC up to the ZC handling a multitude of segment
  41.     files, even in different networks.
  42.  
  43.   Installation
  44.   ------------
  45.  
  46.     The following files are necessary for the proper functioning of the
  47.     program; 
  48.  
  49.        ERRFLAGS.EXE   Main DOS executable
  50.        ERRFLAG2.EXE   Main OS/2 executable
  51.        ERRFLAGS.CTL   Main configuration file
  52.        ERRFLAGS.TAB   Approved flag setup file
  53.  
  54.     The following file is not necessary, and may be removed if not used;
  55.  
  56.        ERRFLAGS.CMT   Text file containing the header that gets copied
  57.                       to all reports and notifications.
  58.  
  59.     Copy these files to any directory of your choice, and edit the CTL
  60.     and CMT files to suit your needs. Insert execution of ERRFLAGS.EXE 
  61.     at the proper place in your mailer batch file, and you're ready to go.
  62.  
  63.  
  64.   Command line parameters
  65.   -----------------------
  66.  
  67.      ErrFlags accepts one command line parameter, and that is the name
  68.      of the configuration file. The default name is ERRFLAGS.CTL.
  69.      Overriding this makes it possible to use ErrFlags when coordinating 
  70.      several FTN type networks such as FDNet, IntlNet, ZyXELnet etc, 
  71.      where flag approval may differ from fidonet.
  72.  
  73.  
  74.   ERRFLAGS.CTL
  75.   ------------
  76.  
  77.     This is the configuration file that tells ErrFlags all it has to
  78.     know at run time. Fire up your favourite ASCII editor [no, WP is
  79.     not a proper ASCII editor :-)] and change the parameters based on
  80.     the comments in this file.
  81.     Note that all lines preceeded with the ";" character are ignored,
  82.     thus you will have to remove it for keywords you want to use.
  83.  
  84.  
  85.   ERRFLAGS.TAB
  86.   ------------
  87.     2
  88.     This file defines the approved flags in Fidonet Zone 2 at the time
  89.     of release for this version of ErrFlags. When new flags are approved,
  90.     this is the file to edit. Fire up your ASCII editor and change the
  91.     flags according to the comments in the file. You can always freq the
  92.     latest file from Z2C with the name 'ERRFLAGS.ZC2'.
  93.  
  94.  
  95.   ERRFLAGS.CMT
  96.   ------------
  97.  
  98.     This is just a simple ASCII file that gets copied as a header of all
  99.     notifications. Change this to suit your needs, and forget it. It might
  100.     also be used for informational purposes since effectively this text
  101.     is being sent to all your nodelist segment providers. If you have
  102.     something important to tell them, this might be a good place.
  103.  
  104.  
  105.   Messages
  106.   --------
  107.     ErrFlags will generate four kinds of messages while working.
  108.     ERROR: this concerns a fatal flaw which is completely removed from the
  109.            nodelist entry. You will need to check and correct this, as the
  110.            removal could lead to other problems.
  111.     WARNING: this is a problem ErrFlags can and will correct itself.
  112.              The original nodelist segment will have to be adapted in order
  113.              to avoid future warnings.
  114.     BEWARE: this is something like a 'second level warning' and will follow
  115.             a WARNING if (an) additional problem(s) is detected.
  116.     : a simple message telling you what ErrFlags is doing or is going to
  117.       do.
  118.  
  119.  
  120.   Source code
  121.   -----------
  122.  
  123.     If there is something in this program that you don't like you can
  124.     rewrite it, as I am distributing the full source code in the file 
  125.     ERRFLAGS.PAS. You will need a Borland Pascal compatible compiler,
  126.     and as I have used nothing very special, just about any old
  127.     version will work when compiling. You might want to check out
  128.     FreePascal for various platforms (including Linux) if you would like to
  129.     compile ErrFlags for platforms other than what is included in the
  130.     distribution archive.
  131.     If you do change the program I would prefer if you would mail me a copy
  132.     of the revized source code. Write to Johan Zwiekhorst at
  133.     2:292/100@fidonet or johanzw@mail.com via internet.
  134.  
  135.  
  136.   Revision history
  137.   ----------------
  138.     Version 2.0
  139.     -  Initial release.
  140.  
  141.     Version 2.1
  142.     -  Increased limit of nodelist segments to 80.
  143.     -  Added a NoTouch mode for those who don't want to fix other peoples
  144.        problems.
  145.  
  146.     Version 2.1.1
  147.     - Added ERRFLAG2.EXE, the OS/2 executable.
  148.  
  149.     Version 2.2
  150.     - Added check/removal of duplicate flags.
  151.  
  152.     Version 2.3
  153.     - Added support for wildcards in segment names.
  154.     - Added support for unarcing incoming segments.
  155.     - Changed behaviour of reports not to be posted when no errors found,
  156.       (Ward filled my inbound with reports of no errors :-) but this can
  157.       be forced anyway with the REPORTALL key word.
  158.     - Changed the appearance of the report to work with the Mickey Mouse
  159.       software "ROBO" that Ward is using.
  160.     - Removed the OS/2 executable, to speed up distribution. Please contact
  161.       Morten Mertner, 23/0 about availability of this.
  162.     - Added user flag ENC and redundancy pair V32T - V32B in ERRFLAGS.TAB
  163.  
  164.     Version 2.4
  165.     - Fixed bug concerning the inbound path.
  166.     - Fixed bug concerning reports not being sent to the right system.
  167.     - Added support for the NOERR keyword that defines what to execute
  168.       for error free segments.
  169.     - Removed support for the REPORTALL key word (which btw never worked
  170.       anyway) that has been obsoleted by the NOERR key word.
  171.  
  172.     Version 2.5
  173.     - Fixed bug concerning the inbound path with no-arc files
  174.     - Fixed problem with command line capitalizing
  175.  
  176.     Version 2.6
  177.     - Fixed handling of zone mail flags
  178.  
  179.     Version 2.7
  180.     - by Johan Zwiekhorst, 2:292/100. Since Jonny Bergdahl is no longer
  181.       in Fidonet, I'll take over.
  182.     - You can now use 200 user flags instead of 80, which was not enough
  183.       according to ZC2. The maximum length of one flag has been increased
  184.       from 15 to 32 characters.
  185.     - The previous wildcard '*' is now '?' in accordance with DOS: it means
  186.       substitute any one character.
  187.     - There is still a wildcard '*' and that is also in accordance with
  188.       DOS: it means any number of characters until end of line or end of
  189.       string, whatever comes first.
  190.     - Added the OS/2 executable again.
  191.  
  192.     Version 2.8
  193.     - Ben Baker's MAKENL can't handle nodelist entries of more than
  194.       157 characters, so ErrFlags now checks for that. Lines which
  195.       exceed 157 characters are shortened and a warning is issued.
  196.       ErrFlags will first strip characters from the system name, then
  197.       from the location and then from the flags section. The latter
  198.       action usually means that the last flag on the line could become
  199.       corrupted and therefore considered erroneous, which will lead to
  200.       another warning. An extra warning will be generated when
  201.       ErrFlags cuts characters from the flags section. ErrFlags will
  202.       always leave at least one character for the system name and the
  203.       location.
  204.     - All flag equality checks are now done case-insensitive.
  205.       This should simplify the TAB file construction.
  206.       Nodelist flags (except their parameters) are converted to uppercase.
  207.  
  208.     Version 2.9
  209.     - Added nodelist entry prefix checking. Only nothing or the words
  210.       'Zone', 'Region', 'Host', 'Hub', 'Pvt', 'Hold' and 'Down' are
  211.       accepted. An error message is issued and the prefix stripped if it's
  212.       something else.
  213.     - Added baudrate checking. The baudrate parameter in the nodelist entry
  214.       is checked against the list in the TAB file. If it deviates, it will
  215.       be replaced by the BAUDDEFAULT value from the TAB file or 9600 if that
  216.       is absent.
  217.     - Added checking for Pvt/phone pairing. If a Pvt prefix is followed by a
  218.       phonenumber, that phonenumber will be replaced by '-Unpublished-'.
  219.       If an entry has no prefix but an '-Unpublished-' phonenumber, it will
  220.       get a 'Pvt' prefix.
  221.     - Cosmetic changes: 
  222.        + Replaced the '■' character by '#' in ErrFlags messages so it's
  223.          friendly for codepages other than 437 (default for IBM pc under DOS).
  224.        + Replaced 'illegal' by 'invalid' because nodelist errors are not
  225.          against the law!
  226.  
  227.