home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / UPDATE12.ZIP / UPDATE.DOC < prev    next >
Text File  |  1991-05-14  |  11KB  |  337 lines
  1. Update - Disk file utility.  Version 1.20 - 5/8/91
  2. Update Plus - Disk file utility.  Version 1.20 - 5/8/91
  3. Copyright 1991 MJC Diversified. All rights reserved.
  4.  
  5.  
  6. The following documentation is for Update Plus. For a list of Update
  7. limitations see the end of this document.
  8.  
  9.  
  10. Description:
  11. ------------
  12.  
  13. Update Plus is designed to selectively copy files from one location
  14. to another based on the date and time the file was last modified. 
  15. This is useful for keeping backups of files on floppy disks.  Any
  16. unnecessary copying of files is avoided.  Update Plus can also be
  17. used to maintain files on a SneakerNet.  Update Plus is a bound
  18. executable file that can run in OS/2 or DOS.  Update Plus is
  19. basically an archive file utility.  The following help is displayed
  20. if you type 'update' and press <return> at a command prompt.
  21.  
  22. Usage: update -<switches> [-f<conflict file>] <source> [<destination>]
  23.  
  24.     -l   List newer or non-existent files.
  25.     -c   Copy newer or non-existent files.
  26.     -C   Prompt for copy of newer or non-existent files.
  27.     -m   Move newer or non-existent files.
  28.     -M   Prompt for move of newer or non-existent files.
  29.     -e   Only update existing files.
  30.     -r   Update read only files.
  31.     -p   Destination files are precious.
  32.     -i   Initialize conflict file.
  33.     -o   List orphaned files.
  34.     -d   Delete orphaned files.
  35.     -D   Prompt for delete of orphaned files.
  36.     -n   Do not echo results of copy, move, or delete.
  37.  
  38. Notes:
  39. ------
  40.  
  41. The destination specification can have a filename edit string.
  42. i.e. 'update -c *.c archive\*.sav'
  43.  
  44. The switch specifications are case sensitive.
  45.  
  46. The 'm' and 'M' options will move files by copying them first and
  47. then deleting them.  This allows files to be moved across volumes.
  48.  
  49. You cannot move read only source files.
  50.  
  51. The 'e' option will only compare files that already exist on the
  52. destination.  In other words Update Plus will not list, copy, or move
  53. non-existent files.
  54.  
  55. The 'r' option will overwrite read only destination files.  This is
  56. useful if you have read only source files that can change.
  57.  
  58. The 'p' option requires as much free disk space on the destination as
  59. the largest file that could be updated.
  60.  
  61. You cannot delete read only orphans.
  62.  
  63.  
  64. Wildcard matching:
  65. ------------------
  66.  
  67. Update Plus tries to copy the wildcard semantics of OS/2 since the
  68. API bind library does not have an entry for DosEditName. There are no
  69. known inconsistences at this time and the rules are as follows:
  70.  
  71. Edit string characters:
  72.  
  73. '*' - Copies characters from the source string to the end of the
  74. source string or until the next character in the edit string is
  75. found.
  76.  
  77. '?' - Copies one character excluding periods from the source string.
  78.  
  79. '.' - Does not copy characters from the source string to the end of
  80. the source string or until the next period is found.
  81.  
  82. <any other character> - Copies the character from the edit string and
  83. skips a character in the source string excluding periods.
  84.  
  85.  
  86. Orphans:
  87. --------
  88.  
  89. Orphans are files that exist on the destination that no longer exist
  90. on the source.  Only the files that match the destination filename
  91. specification are checked.  i.e. 'update -c *.c archive\*.sav'
  92. Only the missing .c file on the source of any .sav file on the
  93. destination is reported.  If the destination filename edit string is
  94. essentially *.*, then the source filename search string is used.
  95. i.e. 'update -c *.c archive' or 'update -c *.c archive\*.*'
  96. Only the missing .c file on the source of any .c file on the
  97. destination is reported.
  98.  
  99.  
  100. Conflict file:
  101. --------------
  102.  
  103. Update Plus has the ability to maintain a conflict file.  A conflict
  104. file has the date and time of the source files the last time an
  105. update was performed.  Only the source files specified are recorded. 
  106. This lets you update different files in the same directory at
  107. different times.  You just need to specify a different conflict file.
  108. i.e. 'update -c -fcfiles *.c arch' and 'update -c -fhfiles *.h arch'
  109. And only the filenames are recorded and not the drive and directory
  110. path.  This lets you change directories or volumes.
  111.  
  112. When a conflict file is specified but one does not exist a warning is
  113. generated and you are given the option to proceed.  If you do proceed
  114. obviously no conflict checking is performed but a conflict file will
  115. be created upon completion.  The 'i' option will not generate a
  116. warning if the conflict file does not exist, will not perform any
  117. conflict checking, and will create a new conflict file or overwrite
  118. any existing conflict file upon completion.
  119.  
  120.  
  121. Conflicts:
  122. ----------
  123.  
  124. When both the source and destination files have changed there are two
  125. possible conflicts.
  126.  
  127. 1) The destination file has changed and WILL be updated by the source.
  128. 2) The source file has changed and WILL NOT update the destination.
  129.  
  130. If there are any conflicts and after all the conflicts have been
  131. reported, you have the option to proceed with the update.  If you
  132. choose not to proceed no updates will be performed, orphans will
  133. still be listed or deleted, and the conflict file (if any) will not
  134. be created or changed.  This lets you execute the update command
  135. again and get the same list of conflicts.
  136.  
  137.  
  138. Messages:
  139. ---------
  140.  
  141. Switch specifications must begin with a '-' or '/'.
  142.     You must preceed the switch specifications with a '-' or '/'.
  143.  
  144. Invalid switch specification.
  145.     You specified an unknown switch.
  146.  
  147. Warning: no switches specified.
  148.     You typed a '-' or '/' with no switches.
  149.  
  150. Source specification is too long.
  151.     You typed too many characters for the source specification.
  152.  
  153. Invalid source specification.
  154.     For some reason the source specification is not valid.
  155.  
  156. Destination specification is too long.
  157.     You typed too many characters for the destination specification.
  158.  
  159. Invalid destination specification.
  160.     For some reason the destination specification is not valid.
  161.  
  162. Could not open conflict file.
  163. Proceed?
  164.     The specified conflict file does not exist.
  165.     Enter 'y' and press <return> to proceed without conflict checking.
  166.  
  167. Conflict file too large.
  168.     The specified conflict file is not an Update Plus conflict file.
  169.  
  170. Could not allocate memory to load conflict file.
  171.     There is not enough memory to load the conflict file.
  172.  
  173. Could not read conflict file.
  174.     The specified conflict file is bad.
  175.  
  176. No source files found.
  177.     There are no source files to update.
  178.  
  179. Destination <destination> has changed and WILL be updated.
  180.     One kind of conflict.
  181.  
  182. Source <source> has changed and WILL NOT update destination.
  183.     The other kind of conflict.
  184.  
  185. There are conflicts. Proceed with update? 
  186.     Enter 'y' and press <return> to proceed.
  187.  
  188. <source> would be copied or moved to <destination>.
  189.     Output produced by the 'l' option.
  190.  
  191. Copy <source> to <destination>? 
  192.     Output produced by the 'C' option.
  193.     Enter 'y' and press <return> to copy the file.
  194.  
  195. Move <source> to <destination>? 
  196.     Output produced by the 'M' option.
  197.     Enter 'y' and press <return> to move the file.
  198.  
  199. Could not allocate copy buffer.
  200.     There is not enough memory to perform the copy.
  201.  
  202. <destination> is read only.
  203.     The destination file is read only and the 'r' option was not
  204.     specified.  If the 'r' option was specified then could not
  205.     change the read access of the destination file.
  206.  
  207. Could not rename <destination>.
  208.     The 'p' option was specified and the destination file could
  209.     not be renamed.
  210.  
  211. Could not create <destination>.
  212.     Could not open or create the destination file.
  213.  
  214. Could not open <source>.
  215.     You do not have read access to the source file.
  216.  
  217. Could not read <source>.
  218.     The source file is probably bad.
  219.  
  220. Could not write <destination>.
  221.     Probably ran out of disk space.  The 'p' option requires as
  222.     much free disk space on the destination as the file being
  223.     updated.
  224.  
  225. Could not copy file dates and times.
  226.     Some kind of system error occurred.
  227.  
  228. Could not copy file attributes.
  229.     Some kind of system error occurred.
  230.  
  231. Could not restore original file.
  232.     The 'p' option was specified and after an unsuccessful copy
  233.     the original file could not be restored.  The original file
  234.     should still exist as '~~temp~~' in the destination directory.
  235.  
  236. Could not copy <source> to <destination>.
  237. Proceed?
  238.     Could not copy the file.  This message will follow 1 of the
  239.     prevoius 10 messages.
  240.     Enter 'y' and press <return> to proceed.
  241.  
  242. Could not delete <source>.
  243. Proceed?
  244.     The 'm' or 'M' option was specified and the source file could
  245.     not be deleted.  The source file is probably read only.
  246.     Enter 'y' and press <return> to proceed.
  247.  
  248. <source> moved to <destination>.
  249.     File was successfully moved.
  250.  
  251. <source> copied to <destination>.
  252.     File was successfully copied.
  253.  
  254. No destination files found.
  255.     No destination files to check as orphans.
  256.  
  257. <destination> has been orphaned.
  258.     The 'o' option was specified and the destination file has no
  259.     corresponding source file.
  260.  
  261. Delete <destination>?
  262.     Output produced by 'D' option.
  263.     Enter 'y' and press <return> to delete the orphaned file.
  264.  
  265. Could not delete orphan <destination>.
  266. Proceed?
  267.     Orphan is probably read only.
  268.     Enter 'y' and press <return> to proceed.
  269.  
  270. <destination> deleted.
  271.     Orphan successfully deleted.
  272.  
  273. Could not allocate memory to save conflict file.
  274.     There is not enough memory to create a conflict table.
  275.  
  276. Conflict file would be too large.
  277.     There are too many source files to record.
  278.  
  279. Could not open or create conflict file.
  280.     There is not enough disk space for the conflict file.
  281.  
  282. Could not write conflict file.
  283.     There is not enough disk space for the conflict file.
  284.  
  285. Note:
  286. -----
  287.  
  288. Update Plus will terminate if anything other than a 'y' or 'Y' is
  289. entered in response to 'Proceed?'.
  290.  
  291.  
  292. Revisions:
  293. __________
  294.  
  295.  
  296. 1.10    When DosOpen fails trying to open a non-existent file on a
  297.     network file resource, DosQFileInfo no longer works.  Now
  298.     when running under OS/2 DosQPathInfo is used.  DosOpen and
  299.     DosQFileInfo are still used when running under DOS since DOS
  300.     can have only one active find.
  301.  
  302. 1.20    If a copy is unsuccessful the destination file will be
  303.     deleted.  The 'p' option has been added to treat destination
  304.     files as precious files.  If the 'p' option is specified and
  305.     a copy is unsuccessful the original file will be restored.
  306.  
  307.  
  308. Update limitations:
  309. -------------------
  310.  
  311. Only the following options are supported by Update:
  312.  
  313.     -l   List newer or non-existent files.
  314.     -c   Copy newer or non-existent files.
  315.     -m   Move newer or non-existent files.
  316.     -p   Destination files are precious.
  317.     -i   Initialize conflict file.
  318.     -o   List orphaned files.
  319.     -d   Delete orphaned files.
  320.     -n   Do not echo results of copy, move, or delete.
  321.  
  322.  
  323. Registration and how to order Update Plus:
  324. ------------------------------------------
  325.  
  326. You can register your copy of Update for $10.  As a registered user
  327. you will be notified of any product enhancements or new products.  If
  328. you send $20 you will receive a copy of Update Plus with all the
  329. features described in this document and also be notified of any
  330. product enhancements or new products.
  331.  
  332. To register your copy of Update send $10,
  333. To order Update Plus send $20 to:
  334.         MJC Diversified
  335.         4036 Camino Calma
  336.         San Diego, CA 92122
  337.