home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / archives / ckc072.zip / ckdsq.hlp < prev    next >
Text File  |  1988-08-16  |  4KB  |  108 lines
  1.  
  2. Included in this distribution of 'sq' and 'usq' are:
  3.  
  4.     1) sq.1            - man page
  5.     2) sqcom.h        - header file for sq and usq compilations
  6.     3) sq.h            - header file for sq compilations
  7.     4) usq.h        - header file for usq compilations
  8.     5) sq.c, tr1.c, tr2.c,
  9.        sqio.c, sqdebug.c    - sources for sq
  10.     6) usq.c, utr.c        - sources for usq
  11.     7) makesq, makeusq    - 'make' files for sq and usq
  12.     8) README        -  this file
  13.  
  14. With the exception of providing 'make' files for Unix, Xenix, etc. systems,
  15. I have not included compilation instructions for other compilers.  The
  16. only thing you need to know is which modules are linked with which programs.
  17. To link 'sq', compile:
  18.  
  19.     sq.c
  20.     tr1.c
  21.     tr2.c
  22.     sqio.c
  23.  
  24. and then link the four object files with your standard libraries to produce
  25. the binary for 'sq'.  If you need to debug 'sq', compile sqdebug.c, set the
  26. DEBUG #define in tr2.c, recompile tr2.c, and relink the above four files
  27. plus sqdebug.
  28.  
  29. To create 'usq', compile:
  30.  
  31.     usq.c
  32.     utr.c
  33.  
  34. and then link the two object files with your standard libraries to produce
  35. the binary for 'usq'.
  36.  
  37. There are two system-dependent #define's in sq.c which may need to be
  38. modified.  They are at the beginning of the source (after the large block
  39. of comments), and are FNM_LEN and UNIX.
  40.  
  41. FNM_LEN should be set to the maximum length of a file name on the target
  42. system.
  43.  
  44. UNIX should be defined for Unix or a derivative, and undefined (i.e.,
  45. commented out) for CP/M, MP/M, MS-DOS, PC-DOS, or any system that
  46. has separate file "names" and "types" (delimited by a period).
  47.  
  48. I have compiled and tested the code with the following compilers on
  49. the following systems:
  50.  
  51. system "C" compiler        Xenix (Altos 586)
  52. system "C" compiler        Unix BSD 4.2 (Vax 780)
  53. system "C" compiler        Zeus (Zilog Z8000)
  54. Computer Innovations C86    PC-DOS (MS-DOS) (IBM PC, etc.)
  55. Computer Innovations C86    CP/M-86 (Altos 586)
  56. DeSmet C88            CP/M-86 (Altos 586)
  57. Aztec C II            CP/M-80 (CompuPro)
  58.  
  59. If some of the code looks funny (read: slow), remember that it has to be
  60. portable accross all the above systems, and I get tired of too many
  61. #define's.  If you successfully port it to some system that requires
  62. minor (but backwards compatible) changes, let me know, and I'll update
  63. them into my sources, and make sure they still work on the above systems.
  64.  
  65. Oh, and also, for those of you who argue that compact and uncompact should
  66. be used under Unix, consider the following:
  67.  
  68. 1)  These programs are compatible with the popular 'SQ' and 'USQ' programs
  69. found on many bulletin board systems.  Files squeezed by other programs
  70. will always be unsqueezable by any version of 'usq'.
  71.  
  72. 2)  You have the sources yourself.  PLEASE don't make changes which affect
  73. the internal format of the squeezed file.  This causes great portability
  74. and compatibility headaches.
  75.  
  76. 3)  'sq' and 'usq' are faster than compact/uncompact, and since they use
  77. an adaptive Huffman coding, rather than a fixed one, they compress files
  78. as well or better.
  79.  
  80. Notes for version 3.2:
  81.  
  82. Several files were modified to make all returns of form return (n), for the
  83. DECUS C compiler on VAX/VMS. Other than adding parens and incrementing 
  84. revision number, there were no changes. This has been tested on the system "C"
  85. compiler under Berkeley 4.2BSD [VAX 750].
  86. -William Swan
  87.  
  88. Notes for version 3.3:
  89.  
  90. Modifications were made to sq.c and usq.c to allow compilation for DEC ULTRIX
  91. and c/70 systems. Defines for these will be found near the beginning of the
  92. files, as ULTRIX and C70, respectively. sqio.c was also modified for c.70,
  93. but these changes should be universal (one assumption removed).
  94.  
  95. File names are now limited to 7-bit ASCII, after Ted Medin reported a problem
  96. related to this. If this causes problems with any systems, let me know.
  97. -William Swan    {ihnp4,decvax, allegra,...}!uw-beaver!tikal!sigma!bill
  98.  
  99. This is an upgraded version of the CPM world sq/usq programs, posted to
  100. usenet recently.  I have verified that they produce the same squeezed files
  101. as the version originally released on disk number 10, for my test case
  102. anyway...
  103.  
  104. Compress still seems to be faster and better for general use.
  105.  
  106. -Fred
  107. 10-Jan-87
  108.