home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / mailers / fet_122.zip / FETOOL.DOC next >
Text File  |  1993-07-20  |  12KB  |  270 lines
  1.  
  2.  
  3.                  ■■■■■■■■  ■■■■■■■■  ■■■■■■■■                  ■
  4.                 ■■        ■■           ■■                     ■
  5.                ■■■■■■    ■■■■■■       ■■   ■■■■■■   ■■■■■■   ■
  6.               ■■        ■■           ■■   ■    ■   ■    ■   ■
  7.              ■■        ■■           ■■   ■    ■   ■    ■   ■
  8.             ■■        ■■■■■■■■     ■■   ■■■■■■   ■■■■■■   ■
  9.  
  10.                    FETool - FastEcho value added Tools
  11.  
  12.                                    ╔════════════════════╗
  13.                     Joerg Michael, ║ 2:244/1129@fidonet ║
  14.                                    ╚══╦═════════════════╝
  15.                                       ║
  16.                                       ╚══ NOTE: NEW ADDRESS
  17.  
  18. ===== FETool Features ========================================================
  19.  
  20.       FETool will be most useful to node sysops, but at least one function
  21.       will also be convenient for points using the FrontDoor or InterMail
  22.       mailer and its editor.
  23.  
  24.       * For FrontDoor/InterMail users: automatic maintenance of your
  25.         FOLDER.FD/.CFG file beyond FastEcho's auto create feature.
  26.         Deletes areas from FrontDoor's/InterMail's setup when they have
  27.         been deleted in FESetup. Adds areas you have created manually to
  28.         your mailer's setup. Also checks for crosslinked areas.
  29.  
  30.       * Create echo area lists for different purposes. Command line
  31.         switches let you define the listing by 'groups' and 'read security'
  32.         levels. The available formats are:
  33.  
  34.            - 'human readable'
  35.            - FastEcho AreaFix compatible, used for FastEcho's area request
  36.              forwarding feature.
  37.            - simple list containing only area tags, perfect input files
  38.              for delareas and fakereq commands.
  39.            - list of "passive" areas. Some people like to kill these.
  40.            - list of area tags ordered by group letters
  41.            - list of connected areas for a specific system
  42.            - Yuppie! point system compatible [Yuppie! is a german point
  43.              package based on a modified Binkley with a proprietary mail
  44.              base (programmed in Clipper) topped off with a really neat
  45.              editor). This list will be turned into a nice area-request
  46.              menu at the Yuppie-point.
  47.  
  48.       * For nodes: create a list of passthru areas with only one link
  49.         ('empty' areas)
  50.  
  51.       * For nodes: create 'fake' AreaFix requests from your downlinks
  52.         to *your* AreaFix to connect them to echo areas, to send them
  53.         area setup information or the help file. Simply: create requests
  54.         on behalf of your downlinks.
  55.  
  56.       * "Delete" echo areas from FastEcho by command line or list file.
  57.         This function will only delete areas with exactly one link and will
  58.         automatically create areafix-unlink requests to shut down these
  59.         areas.
  60.  
  61. ===== FETool License =========================================================
  62.  
  63.       YOU may ...
  64.  
  65.       - use this release of FETool free of charge in a non-commercial
  66.         environment.
  67.       - distribute non-beta versions of FETool to your friends or
  68.         via public BBS systems as long as the complete archive file
  69.         is passed on.
  70.       - keep both parts if FETool breaks :-), but you may also
  71.       - send bug reports to the author.
  72.  
  73.       YOU may NOT ...
  74.  
  75.       - use this version of FETool in a commercial environment without
  76.         prior arrangements with the author.
  77.       - charge any amount of money for the distribution of FETool.
  78.  
  79.       I will ...
  80.  
  81.       - not assume any responsibility for whatever FETool may do to
  82.         you, your system, your family or your wordly possessions.
  83.       - consider implementing changes and features requested by users
  84.         but in no way commit myself to any kind of support activity.
  85.  
  86.       Joerg Michael,
  87.       2:244/1129.0@fidonet
  88.  
  89. ===== Requirements ===========================================================
  90.  
  91.       FETool supports/requires:
  92.  
  93.       FastEcho Tosser Version 1.25 or later (minimum is 1.21)
  94.  
  95.       FrontDoor 2.02 or later w/ QBBS/FIDO message base for MAINT function
  96.       InterMail 2.21 or later w/ QBBS/FIDO message base for MAINT function
  97.  
  98. ===== Usage ==================================================================
  99.  
  100.       Basically, run FETOOL.EXE without parameters and take it from there.
  101.       Use "FETOOL <command> ?" for help about specific commands.
  102.  
  103.       The remainder of this document will only list information not found
  104.       in the help screens. Nevertheless, you should still read it, because
  105.       it explains some special things to look out for ...
  106.  
  107.       ------------------------------------------------------------------------
  108.  
  109.       FASTECHO.CFG
  110.  
  111.       FETool uses the following logic to find FASTECHO.CFG:
  112.  
  113.       - if the FE environment variable is set, look in the directory pointed
  114.         to by FE.
  115.       - if the FE variable is not set, look in the current directory.
  116.       - if not found, scan the directories in PATH for fastecho.cfg
  117.  
  118.       If FASTECHO.CFG cannot be found by this method, FETool will abort with
  119.       an appropriate message.
  120.  
  121.       ------------------------------------------------------------------------
  122.  
  123.       THE LIST FUNCTIONS
  124.  
  125.       For all commands to create area lists (AREAS, AFIXLIST, EMPTY, GROUPS,
  126.       PLAIN, MEMBER, YUPPIE) please note that you MUST also specify at least
  127.       the '-Sec' parameter or you will probably get an empty list since by
  128.       default only areas with security level 0 are listed. All groups are
  129.       selected by default. For the GROUPS list, any security level you specify
  130.       will be ignored - all areas will be listed regardless of security levels.
  131.  
  132.       You may also shorten these options to "-g" and "-s".
  133.  
  134.       If you specify ' -Groups * ', areas in all groups will be listed. This
  135.       may be useful to override a default groups option in the environment
  136.       variable.
  137.  
  138.       ------------------------------------------------------------------------
  139.  
  140.       FETOOL ENVIRONMENT VARIABLE
  141.  
  142.       The following settings may be set as default in the FETOOL environment
  143.       variable and will be used by several functions:
  144.  
  145.       lists:           SEC=nnn
  146.                        GROUPS=<list of group letters>
  147.                        NOHELP                           (*)
  148.  
  149.                        NOHELP will skip the areafix metacommands inserted at
  150.                        the top of the Yuppie!-type area listing.
  151.  
  152.       maint:           AUTO                             (*)
  153.                        FORCEIM                          (*)
  154.  
  155.                        FORCEIM is intended for use in InterMail systems that
  156.                        also use tools which require the FD variable to be set.
  157.                        Normally, if both FD and IM are set, FETool will use
  158.                        "FD" and look for SETUP.FD. You can use FORCEIM to
  159.                        force FETool to look for IM's FD.SYS.
  160.  
  161.       (*) these can not be overriden from the command line.
  162.  
  163.       separate them with commas, as in
  164.  
  165.       SET FETOOL=SEC=100,GROUPS=AILS,AUTO
  166.  
  167.       ------------------------------------------------------------------------
  168.  
  169.       FETOOL MAINT
  170.  
  171.       Will only work with FrontDoor or InterMail mailer.
  172.  
  173.       MAINT does the following 5 steps:
  174.  
  175.       1 - for all FD/IM QBBS folders, check if an area with the same QBBS board
  176.           number exists in FE. if not, delete the folder from FD/IM.
  177.       2 - for all FE QBBS areas, check if a folder with the same QBBS board
  178.           number exists in FD/IM. if not, create the folder in FD/IM.
  179.    +--3 - for all FD/IM *.MSG areas without FD's 'local' flag, check if an area
  180.    |      with the same name exists in FE. if not, delete folder from FD/IM.
  181.    +--4 - for all FE *.MSG areas, check if an area with the same name exists
  182.    |      in FD/IM. if not, create *.MSG folder in FD/IM.
  183.    |  5 - check for any crosslinks in the area configuration.
  184.    |
  185.    +-->   *.MSG folders are not yet supported by FastEcho.
  186.  
  187.       For QBBS, please consider: if you delete a qbbs-area from FE and
  188.       immeditately create a new area using the same qbbs board number,
  189.       MAINT will not update FOLDER.FD with the new area title, because
  190.       to MAINT, there has been no change - the board number is present
  191.       in both setups. Run MAINT before adding new areas.
  192.  
  193.       Note that any other folders you define in FDSETUP/IMSETUP should have
  194.       the local flag set to make sure FETool will never delete them because
  195.       they are not defined in FESetup. 'local' is used as 'safety device'.
  196.  
  197.       Before FETool rewrites FOLDER.FD/.CFG, the current version is renamed
  198.       to FOLDER.BAK.
  199.  
  200.       For areas added to FOLDER.FD/.CFG, FETool will attempt to find an AKA
  201.       in the mailer's setup that matches the zone used for that area in FESetup.
  202.       Note: if you have more than one aka for one zone, make sure the one
  203.       you want to use for echomail is listed first in FDSetup.
  204.  
  205.       Also note that '-Comment' and '-Tags' options are never applied to
  206.       FIDO style *.MSG folders. The tag will always be used. The area name
  207.       should never be changed in FDSETUP for *.MSG areas.
  208.  
  209.       ------------------------------------------------------------------------
  210.  
  211.       FETOOL EMPTY
  212.  
  213.       This command creates a list of "empty" echomail areas. An area must be
  214.       qualified by security and group as in other lists. To be "empty", an
  215.       area must match all of the following criteria:
  216.  
  217.          - area is PASSTHRU, i.e. *not* stored in your message base
  218.          - area has only *one* link address for export, i.e. your uplink
  219.          - area is *not* set 'passive'
  220.  
  221.       As you can see, it really does not make sense to poll these areas, as
  222.       *you* don't read them (passthru) and none of your downlinks want them.
  223.       You may just want to feed this list into DELAREAS :-)
  224.  
  225.       ------------------------------------------------------------------------
  226.  
  227.       FETOOL DELAREAS
  228.  
  229.       This command is used to delete an entire list of areas from FastEcho and
  230.       to automatically create unlink requests for these areas.
  231.  
  232.       FETool will rename your current FASTECHO.CFG to FASTECHO.BAK before
  233.       re-writing the file.
  234.  
  235.       Remember to run FETOOL MAINT after DELAREAS to update your FD folder
  236.       setup as well. Also note that you will end up with 'messages in undefined
  237.       boards' if you delete areas that you also have in your messagebase.
  238.       This is normal and nothing to worry about. FEUTIL PURGE -DELETE will
  239.       'fix' this for you.
  240.  
  241.       DELAREAS will process a maximum of 300 areas in one run.
  242.  
  243.       Of course, worst case: let's assume you DELAREA an area. It no longer
  244.       exists in your setup. Life is beautiful and you feel happy. Then, when
  245.       your system calls your uplink to deliver the unlink request, it picks
  246.       up a mail bundle containing mails in the deleted area .... -> see
  247.       'badmail' and 'auto-area create' in FastEcho :-) Such is life.
  248.  
  249.       ------------------------------------------------------------------------
  250.  
  251.       ERRORLEVELS
  252.  
  253.       FETool will return specific errorlevels to DOS in certain situations.
  254.       You may want to check for these in batch files.
  255.  
  256.        0        no error, normal exit
  257.        1        command line error, invalid command or parameter
  258.        2        no error, help was displayed. nothing was done.
  259.        3        FD environment variable not set for MAINT command
  260.        4        invalid address given for FAKEREQ command
  261.        5        other error (currently: FastEcho.cfg revision level
  262.                 not supported, i.e. pre 1.20)
  263.  
  264.       11        error opening a file
  265.       12        error reading from a file
  266.       13        error writing to file
  267.       14        memory allocation error (not enuff :-)
  268.  
  269. [EOF]
  270.