home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 642a.lha / huffman_v1.0 / huffman.doc.pp / huffman.doc
Text File  |  1992-06-01  |  4KB  |  117 lines
  1.  
  2.                                   huffman
  3.                                   -------
  4.           Documentation for version 1.0, on September 11th, 1991
  5.  
  6.                       by Bruno Costa and Lucia Darsa
  7.  
  8.  
  9.  
  10. WARNING
  11.  
  12.   Although  this  program  is freely distributable (see COPYRIGHT below), I
  13. would  appreciate  if  you  take the time to write me a line or two (E-Mail
  14. please)  if  you  are  using  any of my programs or if you have any kind of
  15. ideas  or  suggestions  (This is not too much to ask, is it?).  If you feel
  16. particularly  generous,  I  would  like  to  receive a disk with any useful
  17. programs you have written, preferrably with source.  Thanks!
  18.  
  19.  
  20. DESCRIPTION
  21.  
  22.   Huffman  is  a  (not so) simple program to compress files, using the well
  23. known  huffman  coding  algorithm.  The compression ratios achieved by this
  24. method  are worse than those obtained by compress, arc, lharc, zoo, zip and
  25. many  others,  but at least you have the source code ;-).  Huffman has been
  26. ported  easily  to  MeSsy-DOS  and UNIX, and can be used as a simple way to
  27. compress  files to be transferred between different systems, over which you
  28. have  control  (to  remove  bugs or add features).  Huffman works perfectly
  29. under  AmigaDOS  1.3,  but  under  2.0  you  must disable fast memory using
  30. NoFastMem  (don't  ask  me why!), as is necessary to run PKAZIP.  Note that
  31. this  was  tested in an Amiga 3000 under Kickstart v36.209, with burst mode
  32. and caches turned either on or off.
  33.  
  34.  
  35. OPTIONS
  36.  
  37.   usage: huffman [-c | -u | -r] [-f | <files>...]
  38.  
  39.   You  must select one and only one of the 'c', 'u' or 'r' options.  Option
  40. 'c'  makes  huffman compress the given files, and 'u' is used to uncompress
  41. them.  To just estimate the compression ratio, use 'r'.
  42.  
  43.   Option 'f' is used to make huffman work as a filter (not implemented).
  44.  
  45.   You may give as many files as you wish, huffman will compress each one in
  46. turn, and if the compression is successful, it will replace the old file
  47. with the compressed one, keeping the same name.
  48.  
  49.  
  50. EXAMPLES
  51.  
  52.   To compress some files:
  53.  
  54.   > huffman -c foo.c bar.c test
  55.   foo.c (38.2%)
  56.   bar.c (33.1%)
  57.   test (27.6%)
  58.  
  59.   To uncompress them:
  60.  
  61.   > huffman -u foo.c bar.c test
  62.  
  63.   To estimate the compression ratio:
  64.  
  65.   > huffman -r foo.c bar.c test
  66.   foo.c (38.2%)
  67.   bar.c (33.1%)
  68.   test (27.6%)
  69.  
  70.  
  71. BUGS
  72.  
  73.   Does not work perfectly under WB 2.0, v36.209.
  74.  
  75.   Option 'f' (filter mode) not implemented yet. Note that due to nature of
  76. the huffman algorithm, it is necessary to read the input file two times,
  77. one to determine the codification, and one to really compress. This makes
  78. necessary to buffer the standard input to be able to re-read it later.
  79.  
  80.   Although the program does compress both text and binary files, and
  81. does not seem to fail in any of the tests made with it, it has not been
  82. tested in extreme conditions. Since the program destroys the original file
  83. when compressing or decompressing, care should be taken.
  84.  
  85.  
  86. AUTHORS
  87.  
  88.   The  accompanying  program  and  this documentation were written by Bruno
  89. Costa and Lucia Darsa.  They can be reached in the following ways:
  90.  
  91.   E-Mail: bruno@brlncc.bitnet (InterNet)
  92.           bruno@BRLNCC        (BitNet)
  93.  
  94.   Mail:   Bruno Costa
  95.           Rua Almirante Guilhem 454/102 bloco 1
  96.           Leblon - Rio de Janeiro
  97.           RJ 22440
  98.           BRAZIL
  99.  
  100.  
  101. COPYRIGHT
  102.  
  103.   This  program  is  copyrighted by Bruno Costa and Lucia Darsa.  It may be
  104. freely  distributed  if  and only if the source code, the documentation and
  105. the  executables  are  provided  in  original  form.  It may be included in
  106. Public  Domain/Shareware compilations, like the one organized by Fred Fish,
  107. as  long as just a nominal fee is charged for each disk (no more than US$10
  108. per  disk),  and may also be uploaded to BBS's or network services like BIX
  109. and CompuServe.
  110.  
  111.  
  112. DISCLAIMER
  113.  
  114.   The authors make no warranty of any kind with respect to this product and
  115. explicitly  disclaim  any  implied warranties of merchantability or fitness
  116. for any particular purpose.
  117.