home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / com / bbs / paths / paths.doc next >
Encoding:
Text File  |  1991-05-02  |  8.0 KB  |  230 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                        PATHS
  9.                    Show the path a message takes within an echo.
  10.                                Release 1a - May 1991
  11.                         Copyright (C) 1991 by Graham Stair
  12.  
  13.  
  14.      What is PATHS?
  15.      --------------
  16.  
  17.      PATHS is a program that will go through an *.MSG base and create a
  18.      "database" of information about the path a message takes to go through
  19.      that echo. The information collected in the database can then be reported
  20.      to a file in a format that is easy to understand.
  21.  
  22.      The information that can be reported on is ...
  23.       ..   what nodes have had a message pass through their system
  24.       ..   how many messages have originated from a particular node
  25.       ..   how many messages have passed through a particular node
  26.       ..   the last time a message passed through or originated from a
  27.            particular node
  28.  
  29.  
  30.      Table of Contents
  31.      -----------------
  32.  
  33.              What is PATHS?  . . . . . . . . . . . . . . . . . . . . . . . . 1
  34.              Table of Contents . . . . . . . . . . . . . . . . . . . . . . . 1
  35.              How to use PATHS  . . . . . . . . . . . . . . . . . . . . . . . 2
  36.              Examples  . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  37.              How PATHS does it!  . . . . . . . . . . . . . . . . . . . . . . 3
  38.              Future  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  39.              History . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
  40.              Other Program Offerings . . . . . . . . . . . . . . . . . . . . 4
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.      How to use PATHS
  49.      ----------------
  50.  
  51.      PATHS usage is ...
  52.  
  53.            PATHS  command  message_directory  {options}
  54.  
  55.      where 'command' is one of the following ...
  56.  
  57.      PROCESS   Process a message directory for new messages and add them to
  58.                the message directories database.
  59.      REPORT    Read the message directory database and produce a paths report
  60.  
  61.      'message_directory' is a directory containing *.MSG echomail type
  62.      messages.
  63.  
  64.      'options' is any combination of the following options...
  65.  
  66.      -p<file>  Used for REPORTing,  <file> is the location the PATHS report
  67.                will be written too. If no -p option is used when a REPORT is
  68.                being generated, a default filename of  'MSG-PATH.PTH' will be
  69.                generated in the message_directory.
  70.  
  71.      -q        Quiet operation, do not display copyright and other work in
  72.                process information.
  73.  
  74.      -s        Shareware notice.
  75.  
  76.      -v        Verbose operation, show extra information about the work in
  77.                process
  78.  
  79.      -w        Use the date a message was written as opposed to the date the
  80.                message was received on the local system.
  81.  
  82.      -?        Short help information.
  83.  
  84.  
  85.      Examples
  86.      --------
  87.  
  88.      PATHS PROCESS m:\msg\os2
  89.  
  90.                This will process all the new messages that are in the
  91.                directory m:\msg\os2, using the date they were received on the
  92.                system for any date calculations.
  93.  
  94.      PATHS PROCESS m:\msg\os2 -q -w
  95.  
  96.                This will  process all the new messages that are in the
  97.                directory m:\msg\os2, -q will not give the percentage progress
  98.                status and -w will use the date the message was written rather
  99.                than the default of when the message was received on the system
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.      PATHS -s
  108.  
  109.                Display the shareware notice.
  110.  
  111.      PATHS REPORT m:\msg\msg\os2 -pc:\temp\os2.pth
  112.  
  113.                Create the paths report for the message directory 'm:\msg\os2'
  114.                into a file called 'c:\temp\os2.pth'.
  115.  
  116.  
  117.      How PATHS does it!
  118.      ------------------
  119.  
  120.      PATHS first gathers up all the message numbers in the specified message
  121.      directory, sorts them in reverse numerical order, then starts processing
  122.      them from the highest message back to the lowest. PATHS keeps track of
  123.      the last message it read from a previous PROCESS and will only process
  124.      back to that one, thus saving a lot of processing. Of course, if that
  125.      message gets deleted, then the whole message base will be read again, and
  126.      duplicate information will be created.
  127.  
  128.      For each new message PATHS processes,  it finds both the origin line and
  129.      the path line(s). It extracts the zone and point numbers from the origin
  130.      line (if it can) and applies them to the paths information (again, if it
  131.      can). This path information is then written to the database with either
  132.      the date the message was received onto the system, or the date it was
  133.      written by the author.
  134.  
  135.      Finally the reporting section, reads the database, and works out the
  136.      paths and writes it to a file.
  137.  
  138.  
  139.      Future
  140.      ------
  141.  
  142.      The following is what I have planned for future versions of PATHS. These
  143.      are in no particular order.
  144.  
  145.      *   Allow the size of the PATHS database to be at the  SYSOP's
  146.          discretion.
  147.      *   Read *.PKT directly, thus making PATHS a bit more BBS software
  148.          independent.
  149.      *   Report PATHS with "another" node as the top most.
  150.      *   Read and act on AREAS.BBS
  151.      *   Add "your node" to the list automatically
  152.      *   Dig some info out of the seen-by list.
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.      History
  161.      -------
  162.  
  163.      17 Feb 91 - Originally released as a subset of MSG
  164.          - Released for limited testing.
  165.  
  166.      10 Mar 91 - Release 0a
  167.          - Changed name to PATHS.
  168.          - Started work on creating a database of PATHS for each echo
  169.          - Fixed crashing when finding a non-numeric *.MSG. eg OLDONE.MSG.
  170.          - Fixed so PATHS will look for '\n^APATH: ', instead of '^APATH:'.
  171.            This should stop most of the "false" paths when a PATH: is quoted
  172.            without removing the <ctrl> A.
  173.  
  174.      02 May 91 - Release 1a
  175.          - Getting Zone and Point information from within the origin line if
  176.            it's available.
  177.          - Database is in place, but at this stage there is no control on how
  178.            big it will get.
  179.          - First general release.
  180.  
  181.  
  182.      Other Program Offerings
  183.      -----------------------
  184.  
  185.      The following program offerings are other software developed by myself
  186.      and distributed as shareware. If you would like any of them please
  187.      contact me.
  188.  
  189.      GOOSE     On-line password checker/changer/enforcer for OPUS 1.0x, OPUS
  190.                1.1x and MAXIMUS 1.0x. (DOS, OS/2 version in the works)
  191.      LOG       Split and/or Merge OPUS/BINK/MAXIMUS style log files. (DOS and
  192.                OS/2)
  193.      RECURR    Schedule recurring events. (DOS)
  194.      LOGMSG    Log messages (incl disk space) to an OPUS/BINK style log. (DOS
  195.                and OS/2, source available)
  196.      MSG       Report on information about a message area. (DOS and OS/2)
  197.      DATES     Enhanced replacement for DAYNBR. (DOS and OS/2, source
  198.                available)
  199.      FILESIZE  Reports a files size via an ERRORLEVEL (DOS and OS/2, source
  200.                available)
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.      License Information
  209.      -------------------
  210.  
  211.      No warranty is given. If it breaks, or breaks something, try gluing it
  212.      back together.
  213.  
  214.      PATHS is SHAREWARE, if you like it, send me a couple of dollars; a
  215.      postcard; a thank you note via netmail or something YOU have written. I
  216.      *DO* expect you to send me something, what it is, is totally up to you,
  217.      surprise me!
  218.  
  219.      So far I haven't been too impressed with the responses to my shareware
  220.      registration requests, it's doesn't really encourage me to do anything
  221.      else and distribute it via shareware.
  222.  
  223.      All donations, postcards, supportive comments, bug reports (with details)
  224.      and suggestions should be directed to
  225.  
  226.                Graham Stair
  227.                FidoNet - 3:711/409.0
  228.  
  229.                - or -
  230.  
  231.                Graham Stair
  232.                PO Box 99
  233.                Pymble, NSW, 2073
  234.                Australia
  235.