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