home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / WSP150.ZIP / WSP1.DOC < prev   
Text File  |  1993-06-11  |  16KB  |  356 lines
  1. << WSP.DOC >>
  2.  
  3. WSP  version 1.50            ;Binary Diff Update Program
  4. -----------------------------------------------------------------------------
  5.                                                           1992/12/23
  6.                                                           amapro Wakichi
  7. -----------------------------------------------------------------------------
  8. WSP.COM compares two files and extracts smallest 
  9.         possible difference in a file with extension WUP.  
  10. WSP.COM updates OLDFILE with WUP-file, to NEWFILE. 
  11. WSP.COM makes SelfUpdating COM file. Namely, you can put a SelF-eXtracting 
  12.         header to WUP of size less than 1 Kilobyte.
  13.         Then you may run this file to upgrade all OLDFILE into NEWFILE.
  14.         This SFX.COM knows everything you just run and get upgraded.
  15. WSP.COM works as DIFF.EXE, and as PATCH.EXE of Larry Wall. With BINARIES!
  16.         
  17. WSP.COM is an ideal tool for shareware authors because of the minimum
  18.         costs of communication expenses, and the ease of upgrading for
  19.         your customers. Or if your database files are formattedbut wth the sa
  20.         but with different contents, you may take differences and compact the
  21.         storage by eliminating the formatting frames.
  22. WSP.COM works under generic MS-DOS. 
  23. WSP.COM is FREE for loyalty, FREE to use, and FREE to distribute.
  24.         You may distribute WSP150.lzh file and use for shareware 
  25.         distributions. You may distribute  your upgrading files in 
  26.         SelF-eXtracting.COM file without our permission. You may use
  27.         WSP.COM for your commercial distribution, as long as
  28.         you attach our copyright statement somewhere.
  29. -----------------------------------------------------------------------------
  30. WSP.COM features:
  31.  
  32. (1) WSP compares ASCII and Binary files byte by byte and tries to make
  33.     smallest possible diff-file, ignoring common parts of files.
  34.     WSP extracts difference even from two different files as far as
  35.     there are some common parts among them.
  36. (2) WSP makes self-updating COM file with a small header of size less than
  37.     1KB. You just run this self-extracting self-executing COM file to
  38.     update your customers.
  39. (3) You may add a telop file to the DIFFFILE explaining what the COM is to do,
  40.     You may use this message to instruct users how to update, and whether
  41.     the update was complete.
  42. (4) WSP.COM has a tiny size, runs very fast., and has a simple command     structure.
  43. (5) WSP.COM takes number of distinct DIFF files together to update
  44.     number of files by a single COM file.
  45. (6) WSP.COM displays while it is making difference. You will see from
  46.     this display the part where two files differ by bar charts.
  47. (7) WSP.COM keeps the file size, time stamps and CRC of both old and
  48.     new files. Alert for the unexpected changes in the files and for 
  49.     possible infection from Virus in your system.
  50.  
  51. -----------------------------------------------------------------------------
  52. Usage:
  53.   You need at least 256KB of free memory to use this software.
  54.   When you are to use this program as a child process, you may
  55.   fail to update or properly update your files.
  56.   You may use both '-' and '/' for switch character. You may write
  57.   options successively when you use more than two options except for
  58.   the message options, see below for messages.
  59.   The following message will be displayed when you type WSP from
  60.   your command line.
  61. -----------------------------------------------------------------------------
  62. C>WSP
  63. WSP  version 1.50 FILE UPDATING UTILITY ; copyright (C) amapro Wakichi 1992-93
  64. ==============================================================================
  65. [1] To update a file with .WUP file:
  66.   WSP [-D | -T, B] diffile[.WUP] [outdir\]
  67.     -D: display .WUP     -T: overrides Time Stamp of OLDFILE
  68.     -B: do not backup old.file(s).
  69. [2] To make .WUP DIFFFILE.
  70.   WSP [-A, M,!,Pn,Qn,Rn,W,N,O,L] OLDFILE NEWFILE [DIFFFILE[.WUP] | selffile.COM]
  71.     -A: Add or Assemble .WUP files into one.
  72.     -M:-M=MSGFILE Display msgfile at the termination
  73.     -!:-!=msgfile  Display msgfile as the telop before execution.
  74.     -P: n (n=1-255) Default P21 minimum off set for pointer.
  75.     -Q: n (n=1-255) Default Q7  minimum bytes for comparison.
  76.     -R: n (n=1-255) Default R18 minimum bytes for a match.
  77.     -W: Let WSP try to make minimal sized DIFFFILE
  78.     -N: Use NEWFILE name when OLDFILE and NEWFILE have distinct name.
  79.     -O: Use OLDFILE name when OLDFILE and NEWFILE have distinct name.
  80.     -L: Extract Diff in old format 1.20
  81. [3] To make a self-updating COM file.
  82.   WSP -S diffile[.WUP] [selfupd [.COM]] Specify any name for COM.
  83. ------------------------------------------------------------------------------
  84. WSP.COM is a copyright reserved FREE software. You may Distribution and Use
  85. this software without our permission, without any loyalty.
  86.  
  87. [1] How to update.
  88.  
  89.   WSP [-D | -T, B] difffile.wup [output directory]
  90.  
  91.      By default, WSP names all diff-file with extension .WUP.
  92.  
  93.   Example: You want to update UFO.COM, you have old UFO.COM and UFO.WUP
  94.      on your current directory. Then type:
  95.  
  96.     A>WSP UFO
  97.  
  98.     You have to have the old-file on your current directory, but you may
  99.     specify .WUP file from different directory with full path name.
  100.  
  101.     When you update FILE.exe with FILE.WUP, you will get new FILE.EXE
  102.     and you are left with $ILE.EXE as the backup. When you already have
  103.     $ILE.EXE on your directory, you will be asked 
  104.     "$ILE.EXE exits Overwrite [Y/N]?"
  105.     Answer Y if you don't need the older version of FILE.EXE.
  106.     Answer N and copy $ILE.EXE to some other place for your reference.
  107.     Then proceed with back up. A FILE with the name starting with $
  108.     is backuped with the name '$' replaced by '!'.
  109.  
  110.     When you don't need the older version, use '-B' option.
  111.     Older file is replaced by Updated file.
  112.  
  113.     C>WSP -B C:\SOFT\UFO 
  114.  
  115.     will erase old UFO.COM in the current directory and replace it with 
  116.     new UFO.COM. using UFO.WUP in the directory C:\SOFT as updating
  117.     DIFFFILE.
  118.  
  119.     You may specify the directory of updated new file.
  120.  
  121.        C>WSP B:UFO C:\
  122.  
  123.     Old UFO.COM is in the current directory, UFO.WUP is in the drive
  124.     B: and you get the new UFO.COM in the root directory.
  125.     Remember you have to put '\' to specify a directory.
  126.  
  127.     To DISPLAY the content of a diff-file, use '-D' switch.
  128.  
  129.     C>WSP -D UFO
  130.     
  131.     UFO.WUP is supposed to be on your current directory.
  132.     What You see is the message:
  133.     
  134.     "UFO.WUP :OLDFILE name date, time -> NEWFILE name, date, time."
  135.  
  136.  
  137.     WSP.COM checks the TIME STAMP and FILE SIZE of the original file.
  138.     If you have copied or touched the TIME STAMP or padded some codes
  139.     you are refused by WSP to update. Use switch '-T' to override
  140.     this difficulty.
  141.  
  142.      C>WSP -T UFO
  143.  
  144.      C>Self_Upd.COM
  145.  
  146.     Selfupdating COM file is an executable. Just type the name of
  147.     the self-updating COM file while OLDFILE is on your current directory.
  148.     This COM file always back up the OLDFILE with the name first character
  149.     replaced by '$', as FILE.EXE is backed up with $ILE.EXE. If you already
  150.     have $ILE.EXE on your current directory, self-updating COM will not ask 
  151.     you and overwrites the older file.
  152.  
  153.     You may use self-updating COM file as a .WUP DIFFFILE.
  154.     You may display the contents by
  155.  
  156.      C>WSP -D self_upd.COM
  157.  
  158.     or you may update retouched OLDFILE ignoring the Time Stamp by
  159.  
  160.      C>WSP -T selfupd.COM
  161.  
  162. -----------------------------------------------------------------------------
  163. [2] How to make a .WUP file.
  164.     
  165.     WSP [-A, M,!,Pn,Qn,Rn,W,N,O] OLDFILE NEWFILE [DIFFFILE]
  166.  
  167.     Basic Usage. 
  168.  
  169.     C>WSP B:UFO.COM C:UFO.COM
  170.  
  171.              You update OLDFILE UFO.COM in B: drive to NEWFILE 
  172.              C:UFO.COM with UFO.WUP on the current directory.
  173.              You don't need to specify the name of updating diff-file.
  174.  
  175.              When you have to use some specific name for updating
  176.              DIFFFILE, especially when you are to make self-updating
  177.              file.
  178.  
  179.     C>WSP B:UFO.COM C:UFO.COM UFO_UP
  180.              You get UFO_UP.WUP on your current directory.
  181.              NEWFILE name is not necessarily the same with
  182.              the OLDFILE. NEWFILE name overrides the OLDFILE
  183.              name.
  184.  
  185.    When WSP is working to make DIFFFILE, WSP shows a bar chart showing
  186.    progress and what it does. WSP print "=" when it sees common part and
  187.    "*" when it sees different part. Caution, WSP shows displays signs
  188.    "=" or "*" per 64KB block. Hence if WSP makes up a DIFFFILE of size
  189.    more than that, WSP is not displaying a rough map of what it does.
  190. -----------------------------------------------------------------------------
  191.     Options. 
  192.     -A:
  193.         Add or Assemble .WUP files into one. You can update executables and
  194.         documents with one updating .WUP file.
  195.         C>WSP B:UFO.COM C:UFO.COM UFO-UP1
  196.         C>WSP B:UFO.DOC C:UFO.DOC UFO-UP2
  197.         C>WSP -A UFO-UP1 UFO-UP2 UFO-UP
  198.         
  199.         Two WUP files UFO-UP1.WUP and UFO-UP2.WUP is assembled in UFO-UP.WUP.
  200.  
  201.  
  202.     -M: Message can be displayed when an error occurred.
  203.         A>WSP -M=B:MSG.TXT B:UFO.COM C:UFO.COM
  204.         MSG.TXT is included in UFO.WUP. The maximum size of message
  205.         is 510 bytes.
  206.  
  207.     -!: Telop file to display at updating.
  208.         C>WSP -!=B:MSG.TXT B:UFO.COM C:UFO.COM
  209.  
  210.         MSG.TXT will be displayed when you start updating. Here is a
  211.         sample:
  212.   
  213.         You are updating your older version of UFO.COM to newer
  214.         version. You have to have your UFO.WUP on your current
  215.         directory. Your new UFO.COM is generated here and your
  216.         old UFO.COM is supposed to be in C:\SOFT\. Are you ready [Y/N]?
  217.    
  218.         There is no restriction in the size of this MSG.TXT. 
  219.         You can only use up to 23 lines when you don't want to miss 
  220.         any line of text.
  221.  
  222.     -P: Minimum offset for the Pointer.         (n=1-255) default:21
  223.     -Q: Minimum length of replacement for a match.(n=1-255) default: 7
  224.     -R: Minimum length of a match.               (n=1-255) default:18
  225.         These three options affect the size of .WUP file.ü@ü@ü@
  226.         For text files with small changes, like proof readings,
  227.         larger values of P, Q, R will decrease the size dramatically.
  228.  
  229.     -W: Optimal .WUP file construction. Time consuming, but makes
  230.         relatively small .WUP file, almost always. This option is 
  231.         particularly effective if your data were sorted with different 
  232.         key, for an example. WSP may fail to generate smaller DIFFFILE
  233.         in case of two very similar files. Display character "=" changes
  234.         into ">" with this option.
  235.  
  236.  
  237.     -N: NEWFILE Name by default.
  238.     -O: OLDFILE Name by default.
  239.  
  240.         When you try to update files with different names, you may choose
  241.         either one of two names as the NEWFILE name. Useful when your
  242.         .WUP file contains several distinct .WUP files.
  243.  
  244.      -L: WSP generates DIFFFILE compatible with Version 1.20 or earlier.
  245.          WSP ver.1.50 is upper compatible and hence can update any file
  246.          made by all versions. However versions 1.20 or earlier had diff-
  247.          erent file headers.
  248. -----------------------------------------------------------------------------
  249. Remark. Some known tips to generate minimal sized DIFFFILE.
  250. (1) Changing Q-option will show you an immediate change in size.
  251.     Try the values Q4-Q20 first.
  252. (2) -W option is time consuming but results in a favorable diff-file
  253.     generally. However, if you compare two small files, you may
  254.     run into a larger DIFFFILE.
  255. (3) -P option has the default value P21. When you change the value,
  256.     you had better change with step 10, from P10-P200.
  257. (4) -R option would not change the size of DIFFFILE from certain
  258.     values up. Set large values for Text files.
  259.  
  260. I recommend to change -P,-R first. Then try -W option. 
  261. Finally increase -Q option starting with the value Q4.
  262. -----------------------------------------------------------------------------
  263.  
  264.  
  265. [3] How to make a self-updating COM file.
  266. There are two ways to make.
  267.  
  268. (a) Sepecify .COM name for DIFFFILE.
  269.  
  270.     C>WSP B:UFO.COM C:UFO.COM UFO_SUP.COM
  271.  
  272.     WSP.COM will automatically generate a self-extracting and self-executing
  273.     COM file. I emphasize, the size of DIFFFILE must be less than 60KB.
  274.  
  275. (b) Make with -S option form .WUP file(s).
  276.  
  277.   WSP -S DIFFFILE [.WUP] [sfxupdt[.COM]]
  278.   WSP -s DIFFFILE
  279.  
  280.  You can't make a self-update file from a .WUP file of size more than
  281.  60KB. You don't need to type .WUP or .COM. 'Sfxupdt.com' can be any
  282.  name.
  283.  
  284.   Example
  285.     A>WSP -S UFO UFO_SUP
  286.     UFO.WUP has SFX header and becomes UFO_SUP.COM that updates
  287.     UFO.COM to a newer version.
  288.  
  289. ----------------------------------------------------------------------------
  290.  [4].
  291.  WSP.COM is a new simple tool to update your informations. There are so many
  292.  documents, databases or communication BBS's which are updating contents
  293.  every moment. I wish WSP.COM to help you decrease your troubles and amount
  294.  of Disk storages by keeping the differences only. Please try and send
  295.  your suggestions or bug reports. Please send them through:
  296.  kenjirou@mathdent.im.uec.ac.jp 
  297.  K.Okubo on GEnie
  298.  74100,2565 Compuserve.
  299.  
  300.  Finally I gratefully acknowledge the kind cooperation of K.Okubo
  301.  for the preparation of this English Document, and my friends who contributed
  302.  fresh ideas and bug reports during the designing and upgrading of this 
  303.  program.
  304.  
  305.                                amapro Wakiti Koichi Wada.
  306.  
  307. -----------------------------------------------------------------------------
  308. Revision History
  309.  
  310. version 1.00  92/09/05 First Version
  311.  
  312. Version 1.01  92/09/13
  313. (1) There were  some hardware specific problems in managing memories.  
  314.     More general routines were devised.
  315. (2) Abnormal behavior corrected when there were Upper and Lower characters in
  316.     file_names.
  317. (3) Self-updating accepts -T option from this version on.
  318. (4) Back_up file name was changed form .BAK to $*.*.
  319. (5) New options -B and -Q were introduced.
  320.  
  321. Version 1.11  92/09/26
  322. (1) Graphic display in the extraction of DIFFFILE was introduced.
  323. (2) Option -! to show telop file. Telop is displayed with self-updating
  324.     file, too.
  325. (3) Option -M to display a message upon the completion.
  326. (4) New switches to enforce default names -N and -O.
  327.  
  328. Version 1.12  92/09/28
  329. (1) Fill the gap between 64KB barrier between OLDFILE less than 64KB and
  330.     NEWFILE greater than 64KB.
  331. (2) A new graphic display is designed for the case when the NEWFILE size
  332.     is greater than 64KB. Display is always in one single line now.
  333.  
  334. Version 1.20  92/12/23
  335. (1) Some machine dependent escape sequence is removed.
  336. (2) A bug in graphic display is corrected. When the size of a file is
  337.     too small, display looked froze.
  338. (3) Disk Full Warning is newly added.
  339.  
  340. Version 1.50 93/06/01
  341. (1) New DIFFFILE format for smaller file size.
  342. (2) New version with English message were added.
  343. (3) New Display while making up DIFFFILE.
  344. (4) Self-Validation check for updating the original file.
  345. (5) Following Bugs fixed:
  346.     Hang Up in extracting a new DIFFFILE.
  347.     Failed to make correct DIFFFILE in making DIFF of more than 60KB. 
  348.     Forced the extension .COM to self-updating file of size more than 64KB.
  349. (6) Some of Parameters were changed.
  350.     File descripter had 25 bytes max-size, now 47 size.
  351.     Option switches may be written successively without '-'  interruption.
  352.     You don't need '\' at the end of path specification.
  353. (7) If WSP sees no file specified in -A option, a void file is added.
  354.     Similarly, WSP dose not delete DIFF for non-existing update, keep original.
  355.     Display for Self-Updating COM is modified.
  356.     New option -L is added for compatibility.