home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / PATHS1B.LZH / PATHS.DOC next >
Text File  |  1991-06-16  |  12KB  |  291 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                        PATHS
  9.                    Show the path a message takes within an echo.
  10.                               Release 1b - June 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  . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  37.              How PATHS does it!  . . . . . . . . . . . . . . . . . . . . . . 3
  38.              Future  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
  39.              History . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
  40.              Other Program Offerings . . . . . . . . . . . . . . . . . . . . 6
  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
  59.                   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.      -a<address>  The full <address> of YOUR node. This is in the form
  67.                   'zone:net/node.point'. The .point is optional. This is used
  68.                   to place your node in its rightful spot, at the top of all
  69.                   the other nodes. This is needed because most mail processors
  70.                   don't put the address of their own system in the messages
  71.                   that stay on their system. This option is only needed for
  72.                   the PROCESS command, REPORT ignores it. If you address is a
  73.                   point-net address, better results will be obtained using the
  74.                   fake point-net address.
  75.  
  76.      -p<file>     Used for REPORTing,  <file> is the location the PATHS report
  77.                   will be written too. If no -p option is used when a REPORT
  78.                   is being generated, a default filename of  'MSG-PATH.PTH'
  79.                   will be generated in the message_directory. This option is
  80.                   only used by the REPORT command, the PROCESS command ignores
  81.                   it.
  82.  
  83.      -q           Quiet operation, do not display copyright and other work in
  84.                   process information.
  85.  
  86.      -s           Shareware notice.
  87.  
  88.      -t           Use the text date contained in the message header for any
  89.                   date type calculations. This is usually the date the message
  90.                   was originally written.
  91.  
  92.      -v           Verbose operation, show extra information about the work in
  93.                   process
  94.  
  95.      -w           Use the binary date a message was written as opposed to the
  96.                   default of using the binary date the message was received on
  97.                   the local system. This option is mutually exclusive with the
  98.                   -t option. The -t option takes precedent if both are used.
  99.  
  100.      -?           Short help information.
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.      Examples
  108.      --------
  109.  
  110.      PATHS PROCESS m:\msg\os2 -a3:711/409.0
  111.  
  112.                   This will process all the new messages that are in the
  113.                   directory m:\msg\os2, using the binary date they were
  114.                   received on the system for any date calculations. The
  115.                   address of 3:711/409.0 will be added to end of all message
  116.                   paths, it it not already there.
  117.  
  118.      PATHS PROCESS m:\msg\os2 -q -w
  119.  
  120.                   This will  process all the new messages that are in the
  121.                   directory m:\msg\os2, -q will not give the percentage
  122.                   progress status and -w will use the date the message was
  123.                   written rather than the default of when the message was
  124.                   received on the system. No address will be added to the
  125.                   message paths, this assumes the processing nodes address is
  126.                   already in each message path.
  127.  
  128.      PATHS -s
  129.  
  130.                   Display the shareware notice.
  131.  
  132.      PATHS REPORT m:\msg\msg\os2 -pc:\temp\os2.pth
  133.  
  134.                   Create the paths report for the message directory
  135.                   'm:\msg\os2' into a file called 'c:\temp\os2.pth'.
  136.  
  137.  
  138.      How PATHS does it!
  139.      ------------------
  140.  
  141.      PATHS first gathers up all the message numbers in the specified message
  142.      directory, sorts them in reverse numerical order, then starts processing
  143.      them from the highest message back to the lowest. PATHS keeps track of
  144.      the last message it read from a previous PROCESS and will only process
  145.      back to that one, thus saving a lot of processing. Of course, if that
  146.      message gets deleted, then the whole message base will be read again, and
  147.      duplicate information will be created.
  148.  
  149.      For each new message PATHS processes,  it finds both the origin line and
  150.      the path line(s). It extracts the zone and point numbers from the origin
  151.      line (if it can) and applies them to the paths information (again, if it
  152.      can). If the <address> option has been specified, PATHS adds it to the
  153.      end of the path information. This path information is then written to the
  154.      database with either the date the message was received onto the system,
  155.      or the date it was written by the author.
  156.  
  157.      Finally the reporting section, reads the database, and works out the
  158.      paths and writes it to a file.
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.      Future
  166.      ------
  167.  
  168.      The following is what I have planned for future versions of PATHS. These
  169.      are in no particular order.
  170.  
  171.      *   Allow the size of the PATHS database to be at the  SYSOP's
  172.          discretion.
  173.      *   Read *.PKT directly, thus making PATHS a bit more BBS software
  174.          independent.
  175.      *   Report PATHS with "another" node as the top most.
  176.      *   Read and act on AREAS.BBS
  177.      *   Dig some info out of the seen-by list.
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.      History
  185.      -------
  186.  
  187.      17 Feb 91 - Originally released as a subset of MSG
  188.          - Released for limited testing.
  189.  
  190.      10 Mar 91 - Release 0a
  191.          - Changed name to PATHS.
  192.          - Started work on creating a database of PATHS for each echo
  193.          - Fixed crashing when finding a non-numeric *.MSG. eg OLDONE.MSG.
  194.          - Fixed so PATHS will look for '\n^APATH: ', instead of '^APATH:'.
  195.            This should stop most of the "false" paths when a PATH: is quoted
  196.            without removing the <ctrl> A.
  197.  
  198.      02 May 91 - Release 1a
  199.          - Getting Zone and Point information from within the origin line if
  200.            it's available.
  201.          - Database is in place, but at this stage there is no control on how
  202.            big it will get.
  203.          - First general release.
  204.  
  205.      16 June 91 - Release 1b
  206.          - Maintenance release.
  207.          - Added the -a<address> option. This gets around the problem of the
  208.            reporting nodes address not being at the top of the report. This
  209.            was because most mail processors don't update messages that remain
  210.            on the node with the nodes address. This confused PATHS.
  211.          - Ignored any "dates" that are older than 2 years and in the future
  212.            by more than 1 year. This should help some people produce some
  213.            stats on their message base, although its probably going to be way
  214.            off base.
  215.          - Added the -t option to read the "date" information from the text
  216.            part of the header. This is for those mail processors/editors that
  217.            don't use the "binary" date fields that have been remove from the
  218.            current standards. The standard says the date format should look
  219.            like this...    '03 JUN 91  12:13:20'   ...but a LOT of mail
  220.            editors do not conform to this "standard". PATHS will read this
  221.            format and one other that seems to be common...
  222.            '03 JUN 91 12:13:20'  <note one space between year and hour>.
  223.          - Fixed up a problem where PATHS was ignoring all but the first
  224.            ^APATH: line in QMAIL processed messages.
  225.          - Made PATHS more robust when dealing with its temporary file during
  226.            PROCESSing.
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.      Other Program Offerings
  234.      -----------------------
  235.  
  236.      The following program offerings are other software developed by myself
  237.      and distributed as shareware. If you would like any of them please
  238.      contact me.
  239.  
  240.      GOOSE     On-line password checker/changer/enforcer for OPUS 1.0x, OPUS
  241.                1.1x and MAXIMUS 1.0x. (DOS, OS/2 version in the works)
  242.      LOG       Split and/or Merge OPUS/BINK/MAXIMUS style log files. (DOS and
  243.                OS/2)
  244.      RECURR    Schedule recurring events. (DOS)
  245.      LOGMSG    Log messages (incl disk space) to an OPUS/BINK style log. (DOS
  246.                and OS/2, source available)
  247.      MSG       Report on information about a message area. (DOS and OS/2)
  248.      DATES     Enhanced replacement for DAYNBR. (DOS and OS/2, source
  249.                available)
  250.      FILESIZE  Reports a files size via an ERRORLEVEL (DOS and OS/2, source
  251.                available)
  252.      VPURGE    With statistics and logging. This is enhancement I've added to
  253.                Bill Andrus's VPurge. Included in VPurge V4.09d and up. (DOS
  254.                and OS/2, source available)
  255.      VPSTATS   A companion program to VPurge with statistics and logging to
  256.                consolidate the stats put out by VPurge. (DOS and OS/2)
  257.      XDEL      Extended deletion program. It combines VDEL and KILLDIR into
  258.                one program. (DOS and OS/2)
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.      License Information
  266.      -------------------
  267.  
  268.      No warranty is given. If it breaks, or breaks something, try gluing it
  269.      back together.
  270.  
  271.      PATHS is SHAREWARE, if you like it, send me a couple of dollars; a
  272.      postcard; a thank you note via netmail or something YOU have written. I
  273.      *DO* expect you to send me something, what it is, is totally up to you,
  274.      surprise me!
  275.  
  276.      So far I haven't been too impressed with the responses to my shareware
  277.      registration requests, it's doesn't really encourage me to do anything
  278.      else and distribute it via shareware.
  279.  
  280.      All donations, postcards, supportive comments, bug reports (with details)
  281.      and suggestions should be directed to
  282.  
  283.                Graham Stair
  284.                FidoNet - 3:711/409.0
  285.  
  286.                - or -
  287.  
  288.                Graham Stair
  289.                PO Box 99
  290.                Pymble, NSW, 2073
  291.                Australia