home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / FDROP100.ZIP / FDROPT.DOC next >
Text File  |  1994-08-29  |  9KB  |  233 lines
  1. FDROPT - FrontDoor Route.Fd Optimizer // Absolute Solutions
  2. -----------------------------------------------------------
  3.  
  4.     Copyright 1993, 1994 Mats Wallin; All rights reserved.
  5.  
  6.  
  7.     Introduction
  8.     ------------
  9.  
  10.         FDROPT is a small utility that can make your life with
  11.         ROUTE.FD a little bit simpler. 
  12.  
  13.         It does a number of things:
  14.  
  15.         1) It "optimizes" your ROUTE.FD, e.g. makes it smaller,
  16.            which will decrease the time FD needs to process the
  17.            netmail folder.
  18.  
  19.         2) It verifies ROUTE.FD, and will let you know if it
  20.            finds any errors.
  21.  
  22.         3) For multiline users, it makes it possible to have one
  23.            single route file for all lines, even if there are
  24.            differences needed between the different tasks. This
  25.            makes it easier to maintain your routing.
  26.  
  27.         4) It adds macro capabilities, e.g. you can define macros
  28.            and use them instead of nodenumbers, flags, or anything
  29.            else.
  30.  
  31.         5) It adds support for ? in nodenumbers. A ? will be
  32.            expanded to all digits (0-9).
  33.  
  34.         All these things put together will hopefully make your 
  35.         routing life easier.
  36.  
  37.  
  38.  
  39.     Requirements
  40.     ------------
  41.  
  42.         FDROPT requires the following to run:
  43.  
  44.         * FrontDoor 2.11 or later
  45.  
  46.         * The environment variable FD pointing to the directory 
  47.           where SETUP.FD is located, or SETUP.FD in the current 
  48.           directory
  49.  
  50.         * For multiline users, the environment variable TASK 
  51.           containing the task number.
  52.  
  53.  
  54.     Installation
  55.     ------------
  56.  
  57.         FDROPT doesn't require a normal installation. The only thing
  58.         needed is the source routing file in FrontDoor's system
  59.         directory. When it exists, you can start to use FDROPT.
  60.  
  61.         The source routing file should be named ROUTE.FDR (note
  62.         the trailing R).
  63.  
  64.         If you only have one ROUTE.FD file, it's very easy to create
  65.         ROUTE.FDR, just copy your ROUTE.FD file, since the format
  66.         is exactly the same.
  67.  
  68.         If you have multiple routing files, e.g. you're running a
  69.         multiline installation, you have to decide which one of your
  70.         ROUTE?.FD files that should be the original source file. 
  71.         Copy that one to ROUTE.FDR. You can then modify this file
  72.         to contain the contents of all ROUTE?.FD files, see below
  73.         for more information.
  74.  
  75.  
  76.     How to use it
  77.     -------------
  78.  
  79.         When the ROUTE.FDR file is created, you only have to run
  80.         FDROPT. It will then create a ROUTE.FD file.
  81.  
  82.         If you're running multiline, and have different routing
  83.         configurations in ROUTE.FDR, you have to run FDROPT for
  84.         each task, and changing the TASK environment variable
  85.         between each run. The easiest thing is to run FDROPT in
  86.         each task.
  87.  
  88.  
  89.  
  90.     Optimizing
  91.     ----------
  92.  
  93.         The ROUTE?.FD files that FDROPT creates are optimized,
  94.         to minimize the time it takes for FD to parse them. When
  95.         optimizing, FDROPT will do the following things:
  96.  
  97.         *) All comments are removed
  98.  
  99.         *) Commands that doesn't have to be in a specific order
  100.            are rearranged, so that the same commands are directly
  101.            after each other. (Only inside each schedule block).
  102.  
  103.         *) If two lines directly after each other contains the
  104.            same command, and this command only have a list of
  105.            nodes (e.g. no target), the list of nodes on the second 
  106.            line are appended to the first line.
  107.  
  108.         *) As much data as possible are put on one line, e.g. the
  109.            maximum line length FD supports are used (254 characters).
  110.  
  111.  
  112.  
  113.     ROUTE.FDR
  114.     ---------
  115.  
  116.         The ROUTE.FDR file is a standard ROUTE.FD file, with a 
  117.         few additions:
  118.  
  119.         *) There are a few FDROPT commands that can be added. A 
  120.            FDROPT commands begins with a # character. See below.
  121.  
  122.         *) Macros can be used anywhere in the ROUTE.FDR file. A
  123.            macro is defined with one of the FDROPT commands.
  124.  
  125.         *) ? characters can be used in nodenumbers. A ? character
  126.            will be replaced with every digit. As an example, it's
  127.            possible to specify 2:20?/*, which will be expanded
  128.            to 2:200/* 2:201/* 2:202/* 2:203/* 2:204/* 2:205/* 
  129.            2:206/* 2:207/* 2:208/* 2:209/*. If two ? characters
  130.            are used in the same nodenumber, e.g. 2:2??/*, it
  131.            will be expanded to all addresses between 2:200/* and
  132.            2:299/*.
  133.  
  134.  
  135.         There is one thing in ROUTE.FD that FD supports, but are
  136.         not supported by FDROPT, and that is the macros MYPOINTS,
  137.         MYNET and MYZONE. Since these macros doesn't work very
  138.         well when beeing a member of multiple networks, they are
  139.         not supported. If something similiar is required, it's
  140.         possible to define macros that can behave like these.
  141.  
  142.  
  143.         The FDROPT commands that can be used are:
  144.  
  145.         #macro NAME     TEXT
  146.  
  147.                 This FDROPT command defines a macro, that later
  148.                 can be used in ROUTE.FDR.
  149.  
  150.                 NAME    is the name of the defined macro. A macro
  151.                         can then be used in the ROUTE.FDR file, and 
  152.                         will be translated to TEXT.
  153.                 TEXT    is what NAME will be translated to.
  154.  
  155.                 A macro can then be used anywhere in the ROUTE.FDR
  156.                 file. To use it, just enter %[NAME] (replace NAME
  157.                 with the macro name).
  158.  
  159.  
  160.         #task TASK [TASK [TASK [...]]]
  161.                 
  162.                 This FDROPT command defines a section of ROUTE.FDR
  163.                 that only should be included for certain tasks.
  164.  
  165.                 TASK    The tasknumber for the task, which should
  166.                         have the following lines included. To return
  167.                         back to normal, e.g. include lines for
  168.                         all tasks, enter a 0 for TASK.
  169.                         More then one TASK number can be specified,
  170.                         with a space between each number.
  171.  
  172.                 If this FDROPT command is used, FDROPT will create
  173.                 ROUTE%TASK%.FD files, instead of the normal
  174.                 ROUTE.FD file.
  175.  
  176.  
  177.         #expandaddress
  178.  
  179.                 This FDROPT command tells FDROPT that it should
  180.                 expand all following short form addresses that it
  181.                 founds in the ROUTE.FDR file. This expansion is done a
  182.                 little bit different then the expansion FD does. FD
  183.                 always uses your main AKA as the default address when
  184.                 expanding a short form address. FDROPT will instead
  185.                 always use the previous address found in ROUTE.FDR as
  186.                 the default address, which is the way most users
  187.                 assume FD does it too.
  188.  
  189.                 I would recommend to use #expandmacros in the
  190.                 beginning of the ROUTE.FDR file.
  191.  
  192.  
  193.     Legal notice
  194.     ------------
  195.  
  196.         FDROPT is provided to you as is, without warranty of any
  197.         kind. In no event shall Mats Wallin be liable to you or
  198.         anyone else for any damages or costs arising from the use
  199.         or inability to use this program.
  200.  
  201.         FDROPT is protected by copyright laws, and may not be 
  202.         modified, reversed engineered, sold or distributed in any
  203.         way that would involve some sort of trade, without written
  204.         permission from Mats Wallin.
  205.  
  206.         FrontDoor is a registered trademark of Joaquim Homrighausen.
  207.  
  208.         All other brand or product names are trademarks or registered
  209.         trademarks of their respective holder.
  210.  
  211.  
  212.     Registration
  213.     ------------
  214.  
  215.         You're allowed to use FDROPT for a trial period of 30 days,
  216.         free of charge. But if you contiue to use FDROPT after this
  217.         trial period, you're required to register it. See the file
  218.         REGISTER.DOC for details.
  219.  
  220.         The unregistered version of this program has a short pause
  221.         built in, that can be bypassed if you press any key. The
  222.         registered version does not have this pause.
  223.  
  224.  
  225.     Bug reports, suggestions, etc.
  226.     ------------------------------
  227.  
  228.         If you find any bugs, or have suggestions or comments on 
  229.         this program, I would appreciate if you would let me know.
  230.         Send the information to me at:
  231.  
  232.         2:270/19@fidonet       or      mw@abs.lu
  233.