home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / OUTB103.ZIP / OUTBOUND.DOC < prev    next >
Text File  |  1994-03-27  |  6KB  |  137 lines
  1.  
  2.   OUTBOUND v1.03
  3.  
  4.   FrontDoor FDC packet reporter.
  5.   Copyright (C) 1994 by Chief Israeli Communication Systems (1993) Ltd.
  6.   All Rights Reserved.
  7.  
  8.   ┌──────────────────────────────────────────────────────────────────────────┐
  9.   │ OVERVIEW                                                                 │
  10.   └──────────────────────────────────────────────────────────────────────────┘
  11.  
  12.   OutBound is a small utility which generate report about outbound mail in
  13.   FrontDoor systems.
  14.   OutBound reads the FrontDoor FDC files from the PKT directory and generate a
  15.   table of outbound by nodes.
  16.  
  17.  
  18.   ┌──────────────────────────────────────────────────────────────────────────┐
  19.   │ REQUIREMENTS                                                             │
  20.   └──────────────────────────────────────────────────────────────────────────┘
  21.  
  22.   OutBound requires the following for proper operation:
  23.  
  24.   ■ An installed FrontDoor 2.11+ systsm, either single or multiline.
  25.   ■ DOS version 3.1 or higher.
  26.   ■ About 50 KB of free RAM.
  27.   ■ The FD= environment variable set correctly to point FrontDoor system
  28.     directory.
  29.   ■ Network configurations requires 'Read' access in the FrontDoor and PKT
  30.     directories.
  31.  
  32.  
  33.   ┌──────────────────────────────────────────────────────────────────────────┐
  34.   │ RUNNING                                                                  │
  35.   └──────────────────────────────────────────────────────────────────────────┘
  36.  
  37.   OutBound runs from the command line with optional command line parameter.
  38.   By default, OutBound will check the FDC files that were generated by the
  39.   FrontDoor that runs on TASK=1. If you run a multiline FrontDoor system, you
  40.   may specify the number of task which you want OutBound to check.
  41.  
  42.   OutBound's output my be redirected to a file by using DOS pipes (>).
  43.  
  44.   By default, OutBound will display a brief table of statistics. By adding the
  45.   /F command line parameter, OutBound will display full information about each
  46.   node. The report will contain all the message numbers, filenames etc.
  47.  
  48.  
  49.   ┌──────────────────────────────────────────────────────────────────────────┐
  50.   │ SYSOP NAMES                                                              │
  51.   └──────────────────────────────────────────────────────────────────────────┘
  52.  
  53.   OutBound is able to use an external sysop names file and replace the node
  54.   address in its output with a user defined string.
  55.   The name file must be named OUTBOUND.NAM and must be located in the current
  56.   directory, if the program's directory or in the DOS path.
  57.  
  58.   The names file contain one entry per line in the following format:
  59.  
  60.   FidoAddr  Sysop_Name
  61.  
  62.   The FidoAddr is the Fido address of the node, including the point number
  63.   (use .0 for nodes) and the Sysop_Name is the user defined string with blanks
  64.   replaced with underscore (_).
  65.  
  66.   The user defined string may be up to 24 characters long. Longer strings will
  67.   be truncated to 24 characters.
  68.  
  69.   A sample names file may look like this:
  70.  
  71.   ---------------------------------
  72.   2:403/138.0  Nemrod_Kedem
  73.   2:512/1.0    Peter_Janssens
  74.   2:270/17.1   Joaquim_Homrighausen
  75.   ---------------------------------
  76.  
  77.   If OutBound can not find a match for a node address, the node address itself
  78.   will be used.
  79.  
  80.  
  81.   ┌──────────────────────────────────────────────────────────────────────────┐
  82.   │ RESULTS                                                                  │
  83.   └──────────────────────────────────────────────────────────────────────────┘
  84.  
  85.   The output table of OutBound contain the following data:
  86.  
  87.   ■ Node Address  - The node address which all the mail/files are routed to.
  88.   ■ Msgs          - The number of messages (o/w files) for this node.
  89.   ■ Files         - The number of files (o/w messages) for this node.
  90.   ■ Bytes         - The total syze of files for this node.
  91.   ■ Age           - The age of oldest netmail message for this node.
  92.   ■ Time          - Time to send mail/files at 14400 baud (1600 CPS).
  93.  
  94.   Note that if the /F command line parameter is specified, the output is not
  95.   in a table but in a report style with LOTS of information.
  96.   Remember that the default output is in a summary table and the /F is a Full
  97.   output report.
  98.  
  99.  
  100.   ┌──────────────────────────────────────────────────────────────────────────┐
  101.   │ NOTES                                                                    │
  102.   └──────────────────────────────────────────────────────────────────────────┘
  103.  
  104.   OutBound will exit with errorlevel according to the total number of
  105.   Megabytes that are on old for other systems. In case of more then 254
  106.   megabytes of files are on hold, OutBound will set the erroelevel to 254.
  107.   This allows OutBound to be used in batch files.
  108.  
  109.   In any case of error during the FDC files process, OutBound will exit with
  110.   errorlevel of 255.
  111.  
  112.   If OutBound detects that FrontDoor is rescanning the mail directory during
  113.   its execution, it will abort with an error (Errorlevel 255).
  114.  
  115.  
  116.   ┌──────────────────────────────────────────────────────────────────────────┐
  117.   │ WARRANTY                                                                 │
  118.   └──────────────────────────────────────────────────────────────────────────┘
  119.  
  120.   None, Whatsoever.
  121.   Uses OutBound at your own risk.
  122.  
  123.  
  124.   ┌──────────────────────────────────────────────────────────────────────────┐
  125.   │ HISTORY                                                                  │
  126.   └──────────────────────────────────────────────────────────────────────────┘
  127.  
  128.   Version 1.00 - Initial program.
  129.   Version 1.01 - Added OUTBOUND.NAM support.
  130.   Version 1.02 - Cosmetic fix.
  131.                  Added /F command line parameter.
  132.                  Increased speed up to 6 times faster operation.
  133.   Version 1.03 - First public release.
  134.  
  135.  
  136.                                  -=≡ EOF ≡=-
  137.