home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / INFO / COMPRESS / SQUPORT.ZIP / README < prev    next >
Encoding:
Text File  |  1985-06-16  |  3.0 KB  |  78 lines
  1. Included in this distribution of 'sq' and 'usq' are:
  2.  
  3.     1) sq.1            - man page
  4.     2) sqcom.h        - header file for sq and usq compilations
  5.     3) sq.h            - header file for sq compilations
  6.     4) usq.h        - header file for usq compilations
  7.     5) sq.c, tr1.c, tr2.c,
  8.        sqio.c, sqdebug.c    - sources for sq
  9.     6) usq.c, utr.c        - sources for usq
  10.     7) makesq, makeusq    - 'make' files for sq and usq
  11.     8) README        -  this file
  12.  
  13. With the exception of providing 'make' files for Unix, Xenix, etc. systems,
  14. I have not included compilation instructions for other compilers.  The
  15. only thing you need to know is which modules are linked with which programs.
  16. To link 'sq', compile:
  17.  
  18.     sq.c
  19.     tr1.c
  20.     tr2.c
  21.     sqio.c
  22.  
  23. and then link the four object files with your standard libraries to produce
  24. the binary for 'sq'.  If you need to debug 'sq', compile sqdebug.c, set the
  25. DEBUG #define in tr2.c, recompile tr2.c, and relink the above four files
  26. plus sqdebug.
  27.  
  28. To create 'usq', compile:
  29.  
  30.     usq.c
  31.     utr.c
  32.  
  33. and then link the two object files with your standard libraries to produce
  34. the binary for 'usq'.
  35.  
  36. There are two system-dependent #define's in sq.c which may need to be
  37. modified.  They are at the beginning of the source (after the large block
  38. of comments), and are FNM_LEN and UNIX.
  39.  
  40. FNM_LEN should be set to the maximum length of a file name on the target
  41. system.
  42.  
  43. UNIX should be defined for Unix or a derivative, and undefined (i.e.,
  44. commented out) for CP/M, MP/M, MS-DOS, PC-DOS, or any system that
  45. has separate file "names" and "types" (delimited by a period).
  46.  
  47. I have compiled and tested the code with the following compilers on
  48. the following systems:
  49.  
  50. system "C" compiler        Xenix (Altos 586)
  51. system "C" compiler        Unix BSD 4.2 (Vax 780)
  52. system "C" compiler        Zeus (Zilog Z8000)
  53. Computer Innovations C86    PC-DOS (MS-DOS) (IBM PC, etc.)
  54. Computer Innovations C86    CP/M-86 (Altos 586)
  55. DeSmet C88            CP/M-86 (Altos 586)
  56. Aztec C II            CP/M-80 (CompuPro)
  57.  
  58. If some of the code looks funny (read: slow), remember that it has to be
  59. portable accross all the above systems, and I get tired of too many
  60. #define's.  If you successfully port it to some system that requires
  61. minor (but backwards compatible) changes, let me know, and I'll update
  62. them into my sources, and make sure they still work on the above systems.
  63.  
  64. Oh, and also, for those of you who argue that compact and uncompact should
  65. be used under Unix, consider the following:
  66.  
  67. 1)  These programs are compatible with the popular 'SQ' and 'USQ' programs
  68. found on many bulletin board systems.  Files squeezed by other programs
  69. will always be unsqueezable by any version of 'usq'.
  70.  
  71. 2)  You have the sources yourself.  PLEASE don't make changes which affect
  72. the internal format of the squeezed file.  This causes great portability
  73. and compatibility headaches.
  74.  
  75. 3)  'sq' and 'usq' are faster than compact/uncompact, and since they use
  76. an adaptive Huffman coding, rather than a fixed one, they compress files
  77. as well or better.
  78.