home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / t / tdate120.zip / TRUEDATE.DOC < prev    next >
Text File  |  1993-03-17  |  16KB  |  375 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                                          TrueDate
  17.  
  18.                   Archive "True Date" Stamp Utility, version 1.20 Manual
  19.  
  20.                  Copyright 1993 by David G. Fisher.  All rights reserved.
  21.  
  22.  
  23.  
  24.           Introduction
  25.                What is TrueDate?.....................................3
  26.                Disclaimer............................................4
  27.                Documentation.........................................5
  28.  
  29.           Using TrueDate
  30.                Description of Syntax.................................6
  31.                Using TrueDate........................................8
  32.                Using TrueDate for Sysops.............................9
  33.                     Maximus - Last Write Date vs. Creation Date.....10
  34.  
  35.  
  36.  
  37.           TrueDate Users Manual                                          Page 3
  38.           ----------------------------------------------------------------------
  39.  
  40.           What is TrueDate?
  41.  
  42.           TrueDate is a utility that will reset the dates for archive files to a
  43.           more appropriate "true" date.  Many times, the files within an archive
  44.           are much older than the actual date of the archive itself.  The true
  45.           date of the archive may be changed to a newer date for a variety of
  46.           reasons.  System BBS operators may set the date of an archive to the
  47.           current date so users know that the file is new to their BBS.  Or, the
  48.           archive may be manually re-packed using a different archival method.
  49.           In short, there are a plethora of reasons that the true date of the
  50.           archive can change.
  51.  
  52.           I could not find a program to reset the date of archives under OS/2.
  53.           Therefore, I wrote this program.  While it is primarily intended as a
  54.           tool for my BBS, it may also be useful to the end user who wants to
  55.           set the dates on their archives to something more appropriate so they
  56.           can determine it's true age at a glance in the directory.
  57.  
  58.           TrueDate uses a simple method to determine the true date of an
  59.           archive.  TrueDate creates a listing of the archive, and then finds
  60.           the date of the NEWEST file within the archive.  It then sets the date
  61.           of the archive to this date.
  62.  
  63.           Archivers can be defined in the TrueDate configuration file.
  64.  
  65.           Currently, TrueDate is only available for OS/2 2.x.
  66.  
  67.           The most recent TrueDate release is always available here with the
  68.           magic File Request name of TRUEDATE.
  69.  
  70.                Dave Fisher
  71.                LiveNet,  1:170/110@fidonet.org
  72.                          40:4372/0 (ibmNET)
  73.                          81:202/201 (OS2NET)
  74.  
  75.           Please don't hesitate to send suggestions.  Find a bug and I'll
  76.           promptly try to make a new version, or at least a temporary work-
  77.           around, available to you.
  78.  
  79.           Please send me mail in any event!  I want to know if TrueDate has
  80.           proved as useful for others as it has for me.
  81.  
  82.  
  83.  
  84.           TrueDate Users Manual                                          Page 4
  85.           ----------------------------------------------------------------------
  86.  
  87.           Disclaimer
  88.  
  89.           This program is shareware.  There is absolutely no warranty for this
  90.           program or guarantee it will work.  The user of this program assumes
  91.           all risk.  While I feel confident this program will not harm your
  92.           system in any way, by using this program, you agree to assume full
  93.           responsibility for any adverse effect to your system.
  94.  
  95.           While I don't demand a contribution, if you find this program useful
  96.           and would like to contribute to ongoing shareware development, please
  97.           feel free to send a contribution of $10 or more to:
  98.  
  99.                Dave Fisher
  100.                5131 East 88th Court
  101.                Tulsa, Ok.  74137
  102.                USA
  103.  
  104.           Where applicable, all trademarks referred to here are the property of
  105.           their owners.
  106.  
  107.  
  108.  
  109.           TrueDate Users Manual                                          Page 5
  110.           ----------------------------------------------------------------------
  111.  
  112.           Documentation
  113.  
  114.           There are three document files that describe TrueDate.
  115.  
  116.           TRUEDATE.DOC
  117.  
  118.                The file you are reading is a basic description and
  119.                introduction to TRUEDATE.
  120.  
  121.           HISTORY.DOC
  122.  
  123.                History of changes to TrueDate should serve as a good
  124.                reference to track new TrueDate enhancements as they are
  125.                added.
  126.  
  127.           TRUEDATE.CFG
  128.  
  129.                The accompanying TRUEDATE.CFG configuration file is heavily
  130.                documented and demonstrates how I use TrueDate on my system.
  131.                It is a companion to this document, included to illustrate how
  132.                TrueDate's default settings are modified and how new Archiver
  133.                programs are defined.
  134.  
  135.  
  136.  
  137.           TrueDate Users Manual                                          Page 6
  138.           ----------------------------------------------------------------------
  139.  
  140.           Description of Syntax
  141.  
  142.           TrueDate ArcFileName [, ArcFileName, ...]
  143.  
  144.                /Config = <path+file name>         default: TRUEDATE.CFG
  145.                /[no]Log                           default: NoLog
  146.                /LogFile = <path+file name>        default: None
  147.                /LogLevel = <1..4>                 default: 4
  148.                /[no]Quiet                         default: NoQuiet
  149.                /[no]LastWriteDate                 default: LastWriteDate
  150.                /[no]CreationDate                  default: NoCreationDate
  151.                /[no]TestOnly                      default: NoTestOnly
  152.  
  153.           Notes on the syntax:
  154.  
  155.                Qualifiers can appear in any order, in any case, and are only
  156.                significant to four characters.  /LogFile, for instance, is
  157.                the same as /logf.
  158.  
  159.           Qualifiers
  160.  
  161.           Config = <path+file name>
  162.  
  163.                This is the name of the configuration file.  The default is
  164.                TRUEDATE.CFG in the current directory.  If you prefer, you can
  165.                define an environment variable using the DOS SET command
  166.                instead, with the following syntax:
  167.  
  168.                Set TRUEDATE_CONFIG=<path+filename>
  169.  
  170.           /[no]Log
  171.  
  172.                This qualifier will turn the logging function on and off.
  173.                Default is NoLog.
  174.  
  175.           /LogFile = <path+file name>
  176.  
  177.                This qualifier defines the name of the log file.
  178.  
  179.           /LogLevel = <1..4>
  180.  
  181.                This qualifier defines the level of log file detail.  Level 1
  182.                is the least detailed, while Level 4 is the most verbose.  The
  183.                levels indicate the 'importance' of a message, where Level 1
  184.                is the most important (usually error messages).
  185.  
  186.           /[no]Quiet
  187.  
  188.                This qualifier controls whether TrueDate should print detailed
  189.                output to the "standard output device", which is normally the
  190.                screen.  Set it to /Quiet and all you see are the program
  191.                copyright line and any error messages.  The default is
  192.                /NoQuiet.
  193.  
  194.           /[no]LastWriteDate
  195.  
  196.  
  197.  
  198.           TrueDate Users Manual                                          Page 7
  199.           ----------------------------------------------------------------------
  200.  
  201.                This qualifier controls whether TrueDate will reset the "Last
  202.                Write" date under OS/2.  This is the default action of
  203.                TrueDate.  Most programs, including the basic "dir" command,
  204.                will use and display this date.
  205.  
  206.           /[no]CreationDate
  207.  
  208.                This qualifier controls whether TrueDate will reset the
  209.                "Creation" date under OS/2.  The default action of TrueDate
  210.                will NOT set the creation date of the archive.  Many times, it
  211.                is beneficial to leave the Creation date alone, so it will
  212.                reflect the true date the archive was actually created, and
  213.                set the Last Write to the "true" date of the archive.
  214.                However, this default action of TrueDate can be overridden by
  215.                specifying /CreationDate on the command line.
  216.  
  217.           /[no]TestOnly
  218.  
  219.                If this qualifier is specified as /TestOnly (or /Test), then
  220.                TrueDate will analyze the indicated archives and report the
  221.                changes it would have made if not run in test mode.
  222.  
  223.  
  224.  
  225.           TrueDate Users Manual                                          Page 8
  226.           ----------------------------------------------------------------------
  227.  
  228.           Using TrueDate
  229.  
  230.           TrueDate is simple to use.  The most basic form is as follows:
  231.  
  232.                TrueDate [ArcFileName]
  233.  
  234.           where 'ArcFileName' is the name of the archive which is to have its
  235.           date reset.  'ArcFileName' can include wildcard matches such as
  236.           "*.ZIP", or even "*.*" which will reset the time stamp on every
  237.           archive defined in the current directory.  Multiple archive file
  238.           matches can be included, also.  However, all 'ArcFileName's MUST be
  239.           separated by commas on the command line, not spaces.  For example, if
  240.           you want to time stamp all *.ARJ and *.LZH files and one specific ZIP
  241.           file called "XYZ.ZIP", you would execute the following:
  242.  
  243.                TrueDate *.ARJ, *.LZH, XYZ.ZIP
  244.  
  245.           Full paths can also be specified such as:
  246.  
  247.                TrueDate f:\max\files\os2\newup\*.*
  248.  
  249.  
  250.  
  251.           TrueDate Users Manual                                          Page 9
  252.           ----------------------------------------------------------------------
  253.  
  254.           Using TrueDate for Sysops
  255.  
  256.           I invoke TrueDate each time I detect *.TIC files in my inbound
  257.           directory.  The following is an OS/2 REXX procedure I use:
  258.  
  259.                isfile "c:\binkley\inbound\*.tic"
  260.  
  261.                if ( rc <= 0 ) then
  262.                    return              /* No *.TIC files received */
  263.  
  264.                call bbslog "Tick", "Initiating TICK Processing"
  265.  
  266.                /*
  267.                 * Set the archive dates to the "True" archive date.
  268.                 */
  269.  
  270.                truedate "c:\binkley\inbound\* /Quiet"
  271.  
  272.                /*
  273.                 * Now call TICK to do the actual distribution
  274.                 */
  275.  
  276.                "c:"
  277.  
  278.                cd "\bbs\tick"
  279.  
  280.                TICP ">> c:\bbs\logs\tick.log"
  281.  
  282.                .... [and so on.]
  283.  
  284.           If there are *.TIC files found in the inbound directory, I run
  285.           TrueDate BEFORE I run Tick.  After TrueDate has reset the dates on any
  286.           archives found within the inbound directory, I run Tick and any other
  287.           appropriate post-Tick processing.
  288.  
  289.           Also, after I wrote TrueDate, I ran the program on every directory of
  290.           downloadable files.  Thus, every archive on the system now reflected
  291.           an accurate, true date of the archive.  This is not only helpful to
  292.           you, the Sysop, but also to your users calling in.  They also will now
  293.           know the true "age" of an archive without having to look inside the
  294.           archive itself.
  295.  
  296.  
  297.  
  298.           TrueDate Users Manual                                          Page 10
  299.           ----------------------------------------------------------------------
  300.  
  301.           :Maximus - Last Write Date vs. Creation Date
  302.  
  303.           Since Maximus was originally written under DOS, support for the
  304.           multiple dates associated with a file under OS/2 is minimal.  Searches
  305.           for "new" files by users on the BBS becomes a problem.  How do you
  306.           define "new?"  What date do you display (the "last write" date or
  307.           "creation" date) when it is found?  Under Maximus 2.00, this is
  308.           controlled by the program FB.EXE (the Filebase Build command).
  309.  
  310.           There are two version of FB.EXE which are important to note since they
  311.           handle the dates of files differently.
  312.  
  313.           FB.EXE bundled with Maximus 2.00:
  314.  
  315.                The version of FB which comes with the initial release will
  316.                build a database of all downloadable file sections using the
  317.                "creation" date of the file.  Thus, any file searches based on
  318.                date (especially using the "NewFiles" MECCA token) will search
  319.                for files based on the "creation" date and display this date
  320.                to the caller.
  321.  
  322.           FB.EXE bundled with Maximus 2.01/wb:
  323.  
  324.                This version of FB which comes bundled in the 2.01/wide beta
  325.                version of Maximus will build a database of all downloadable
  326.                file sections using the "last write" date of the file.  Thus,
  327.                any file searches based on date will search for files based on
  328.                the "last write" dat and display this date to the caller.
  329.  
  330.           The change in the wide beta version has caused quite a bit of
  331.           consternation among OS/2 Maximus Sysops.  In order to announce new
  332.           file arrivals, the Sysop must actually change the "last write" date of
  333.           the archive to the CURRENT date it was received on the system.  Many
  334.           systems use a Unix-like Touch program to accomplish this.
  335.           Unfortunately, the true date of that archive is now lost, and actually
  336.           misrepresents that actual age of the archive.
  337.  
  338.           In my opinion, setting the "last write" date to the date the archive
  339.           was received on a particular BBS clouds the issue of the true age of
  340.           an archive for both Sysops and users alike.
  341.  
  342.           The more appropriate way of dealing with this is to set the "last
  343.           write" date to the true date of the archive and display this date to
  344.           users when the scan for new files.  However, the scan itself should be
  345.           based on the CREATION DATE of the archive.  Thus, users will quickly
  346.           identify new files that have arrived on the BBS system, but will be
  347.           presented with the "true age" of the archive when it is displayed to
  348.           them.
  349.  
  350.           Currently, OS/2 Maximus sysops can only partially achieve this
  351.           behavior.  If you are running Maximus 2.01/wb, then you will have to
  352.           acquire FB.EXE version 2.00.  (This is available from my system as
  353.           FB200.ZIP.)  This version of FB will create a database using the
  354.           "creation" date of the file.  However, it also displays this date to
  355.           the user on file title/list displays.  Thus, while the true date of
  356.           the archive can be maintained in the "last write" date of the file,
  357.  
  358.  
  359.  
  360.           TrueDate Users Manual                                          Page 11
  361.           ----------------------------------------------------------------------
  362.  
  363.           users will still be somewhat mislead by the date they see in the
  364.           display list.
  365.  
  366.           HOWEVER, if you use Downsort to create your downloadable file lists,
  367.           the correct dates are used.  Downsort marks new files with an asterisk
  368.           and/or plus sign depending upon age.  Downsort uses the "creation"
  369.           date to do this.  However, the dates actually printed in the list is
  370.           the "last write" date.  Thus the actual age of the archive is
  371.           correctly represented.
  372.  
  373.           Therefore, I encourage Maximus Sysops to leave the "last write" date
  374.           intact, and use the "creation" date to indicate arrival/"newness" of
  375.           an archive on your system.