home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / OFU104.ZIP / README.OFU < prev   
Encoding:
Text File  |  1993-07-25  |  10.1 KB  |  224 lines
  1.  
  2.  Opus Filename Updater for the Opus CBCS v1.7x/v1.8x Files Database
  3.                    Copyright 1993 by Kevin Silcox
  4.  
  5.                                                              July 24, 1993
  6.  
  7. Disclaimer
  8. ----------
  9.     This software is available "AS IS".  It is not guaranteed to work at
  10. all.  If it trashes your system or ruins your life, you have been warned.
  11. I am not responsible for any damages incurred from the use or misuse of
  12. this software.  There is also no fee to use this software to keep with
  13. the spirit of Opus.
  14.  
  15.        ***********************************************************
  16.        **** ALWAYS HAVE A RECENT BACKUP COPY OF YOUR DATABASE ****
  17.        ***********************************************************
  18.  
  19.   *************************************************************************
  20.   *     It's not a requirement to run OFARE every time you run OFU,       *
  21.   *   however you should *ALWAYS* run OFARE when you are done changing    *
  22.   *   filenames with OFU before you run Opus to prevent database          *
  23.   *   corruption. (Opus v1.7x)                                            *
  24.   *************************************************************************
  25.  
  26. /-------------------------------------------------------------------------\
  27. |    There are now two versions of OFU released in this archive.  OFU.EXE |
  28. | is the DOS version, and OFUP.EXE is the OS/2 version.                   |
  29. \-------------------------------------------------------------------------/
  30.  
  31. ---===---
  32.     OFU allows you to automatically change filenames within the Opus
  33. Files Database via a command-line interface.  If OFU updates a filename
  34. then the file information (date/time, size) will be updated to match
  35. the new filename.  This program should be very handy for those that do
  36. automatic virus scanning of newly uploaded files, archive conversion,
  37. or when converting archives to a different format.
  38.  
  39.     OFU will automatically detect the version of files database you are
  40. using and use the correct structures.  Any structure changes made after
  41. the date of this release may cause problems with the operation of OFU.
  42. As of this release OFU works with Opus versions 1.7x, and the 1.99/1.8x
  43. beta and gamma releases.
  44.  
  45.     The files that OFU uses are the following:
  46.     (R-O) = Read-Only       (R/W) = Read/Write
  47.  
  48. (R-O)   PRM file                To locate the system files if necessary
  49. (R-O)   FILESBBS.ADX            To get valid area numbers and area
  50.                                   offsets within the database
  51. (R-O)   SYSFILE.DAT             To get default download paths
  52. (R/W)   FILESBBS.DAT            To read/update file information
  53.  
  54.     The FILESBBS.DAT file is the only one that is ever changed, and is
  55. opened in DENYWRITE share mode.  If this is an incorrect method please
  56. bring it to my attention.  Thanks.
  57. ---===---
  58.  
  59.     NOTICE:  This program will abort if it detects that Opus is
  60. currently active for the task it's processing.  If the files database
  61. is common between two or more tasks then you have to take the necessary
  62. precautions to make sure OFU doesn't run while another task is active.
  63. It is *highly* recommended that Opus is not active *at all* when running
  64. OFU since the database will need to be re-indexed (OFARE) if any filenames
  65. get changed.  See Errorlevels below.
  66.  
  67.  
  68.     The RAM requirement is based entirely on the buffer size, and the number
  69. of areas being processed (along with the download path length).  The base
  70. memory required to load OFU is somewhere around 35Kb.  Take the base value
  71. and add the following values to get the approximate RAM requirement:
  72.   - Buffer size
  73.   - Number of areas times 30 bytes.  Each area takes up 11 bytes plus the
  74.     length of the download path string (19 bytes is an approximation
  75.     for the download path string length).
  76.  
  77.     So processing 50 areas with a 4Kb buffer would require somewhere around
  78. 40Kb.  (50 * 30 + 4096 + 35840 = 41436 bytes or approximately 40Kb)
  79.  
  80. --=={*-------------------------------------------------*}==--
  81.  
  82. Errorlevels:
  83.  11: One or more filenames deleted/undeleted (run OFARE at your convenience)
  84.  10: One or more filenames changed (recommended to run OFARE immediately)
  85.   6: Error writing to file
  86.   5: Error reading file
  87.   4: Attempt to use *potential* invalid wildcard sequence
  88.   3: Current task active
  89.   2: Memory allocation error
  90.   1: Unsuccessful (General Error)
  91.   0: Nothing changed
  92.  
  93.  
  94. ------------------------------------------------------
  95. Usage:
  96.  
  97.   OFU oldName newName cmd [cmd] [...]
  98.  
  99.         When changing filename(s).
  100.  
  101.            or
  102.  
  103.   OFU Name cmd [cmd] [...]
  104.  
  105.         When using the Delete/Undelete or Clean option.
  106.  
  107.  
  108. Valid Command-line Switches (cmd):
  109.  
  110.   #       A valid area number (i.e. 1 {not the # symbol}) for
  111.         processing.
  112.  
  113.   /A      Process all areas (self explanatory).  All areas will be
  114.         searched for filename replacement.
  115.  
  116.   /B#     Multiply # by 2048 bytes (2Kb) for the memory buffer size.
  117.         This value will be used when allocating any buffer to read
  118.         data from a file (except the Area list which is determined
  119.         by the number of areas, and the size of the Download Path
  120.         strings).  The default value is 2 which uses a buffer size
  121.         of 4Kb (and should give good performance).  Valid values
  122.         are from 1 to 32.
  123.  
  124.   /C[A|Q]   Clean out MISSING filenames [All|Quick].  Any entry that is
  125.         marked MISSING in the database will be marked for deletion after
  126.         OFU confirms that the file is really missing.  If you activate
  127.         Quick mode then OFU won't verify that the file doesn't exist and
  128.         goes entirely by the flag in the database (not recommended).
  129.         This option works best after you've had OFARE process the database
  130.         since it only checks the filenames that are marked MISSING, and
  131.         not every filename in the database (for speed reasons).  If you use
  132.         the All mode then each matching filename will be checked to see if
  133.         it exists.  If it doesn't exist then it'll be marked for deletion.
  134.         You still need to specify the first filename (to match) but you can
  135.         use full wildcards.
  136.           i.e. OFU *.* /CA /A   to check each files existance and clean
  137.                                 out any missing files in all areas
  138.  
  139.   /D[!|U]   Delete/Undelete file(s) from database.  The first filename
  140.         listed on the command-line will be the one marked for
  141.         deletion/undeletion from the specified file area(s).  The
  142.         undelete is only useful if you just marked a file for deletion
  143.         (on accident?) and haven't re-indexed the database yet.  You can
  144.         also specify a exclamation-mark to have the file deleted from the
  145.         disk so it is no longer in the file area on your hard drive (or
  146.         whatever device you use for storage).
  147.  
  148.   /Q      Quiet mode.  Suppresses filename display.
  149.  
  150.   /R[Q][D][#]   Using /R by itself will call OFARE if any filenames have
  151.         been changed.  The 'Q' tells OFARE to do a quick update.  Adding
  152.         a 'D' after it (no space) will also call OFARE if a file has been
  153.         marked as DELETED which will physically remove the DELETED file.
  154.         Specifying a number at the end of the argument will pass that
  155.         number as a buffer setting to OFARE.  Check with the OFARE help
  156.         screen for more information on OFARE command-line options.
  157.  
  158.  
  159. ------------------------------------------------------
  160. Examples (and other information):
  161.  
  162.   OFU *.ARC *.ZIP /A
  163.  
  164.   OFU FILE1.ARC FILE1.ZIP 1 20
  165.  
  166.   OFU NODELIST.A?? NODELIST.Z?? 12 /B1
  167.  
  168.   OFU NODE*.A* *.Z* 6
  169.  
  170.   OFU NODE*.A* *.Z* 6 /RQD20
  171.  
  172.   OFU VIRUS.ZIP 1 /D
  173.  
  174. - Any valid DOS filename can be used, including the DOS wildcard
  175.   characters which should be processed the same way as DOS does.
  176.  
  177. - You can specify up to 64 areas to process on the command-line,
  178.   (if they'll fit) or OFU can process up to 4096 areas when using
  179.   the /A switch.
  180.  
  181. - Generally a small buffer size is best (especially when using /A),
  182.   unless you have exceptionally large file areas (over 200 files per
  183.   area).  You shouldn't ever need to change the buffer size from the
  184.   default value, but the option is there just in case.
  185.  
  186. - Please be careful with wildcards!  I've tried to screen out the more
  187.   dangerous combinations, but don't rely on my thinking of all possible
  188.   bad wildcard combinations.  The safest thing to do is automatically
  189.   make a backup (or archive) of your database files once a day.  That
  190.   way if something goes wrong you'll have a recent copy of the database.
  191.   If you discover a dangerous (one that makes OFU change filenames
  192.   incorrectly) wildcard combination that gets past OFU, please send me
  193.   Netmail as to the command-line and I'll try to add that combination
  194.   to the screening process.  Thank you.
  195.  
  196. ------------------------------------------------------
  197.  
  198. -={**}=-
  199.     Thank You for taking your time to read this, and use my program.
  200. If you have any comments or suggestions, I'd like to hear from you.
  201. Please contact me if you have any problems, or you would like to see
  202. any added features.  You may contact me (via NetMail) at the phone
  203. number (or Net Addresses) listed below.  I also read the NEWOPUS and
  204. MEADOW Echo's.  The latest version of my software is also available
  205. on my BBS.  It may be requested with the magic name of OFU.
  206.  
  207.                                 --=={ Kevin Silcox ------
  208.                                 SysOp of:
  209.                                     StormFront
  210.                                     in Orangevale, California
  211.                                     (916) 988-0407
  212.                                     FidoNet (1:203/407.0)
  213.                                     CalNet (49:916/407.0)
  214.  
  215.                                 BBS Hours:
  216.                                           24 hours a day,
  217.                                     excluding National Mail Hour:
  218.                                       1:00 a.m to 2:00 a.m PST
  219.  
  220.     Special Thanks to my Beta Test Team and the Opus Utility Team.
  221. OS/2 version was made possible with the assistance of Cheryl Buzzell
  222. since I don't have OS/2, or an OS/2 compiler.
  223.  
  224.