home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / mlzo100.zip / minilzo.100 / README.LZO < prev    next >
PGP Signed Message  |  1997-07-13  |  3KB  |  99 lines
  1. -----BEGIN PGP SIGNED MESSAGE-----
  2.  
  3.  
  4.  ============================================================================
  5.  miniLZO -- mini version of the LZO real-time data compression library
  6.  ============================================================================
  7.  
  8.  Author  : Markus Franz Xaver Johannes Oberhumer
  9.            <markus.oberhumer@jk.uni-linz.ac.at>
  10.            http://www.infosys.tuwien.ac.at/Staff/lux/marco/lzo.html
  11.  Version : 1.00
  12.  Date    : 13-Jul-1997
  13.  
  14.  I've created miniLZO for projects where it is inconvenient to
  15.  include (or require) the full LZO source code just because you
  16.  want to add a little bit of data compression to your application.
  17.  
  18.  miniLZO implements the LZO1X-1 compressor and both the standard and
  19.  safe LZO1X decompressor. Apart from fast compression it also useful
  20.  for situations where you want to use pre-compressed data files (which
  21.  must have been compressed with LZO1X-999).
  22.  
  23.  miniLZO consists of one C source file and two header files:
  24.     minilzo.c
  25.     minilzo.h
  26.     ../include/lzoconf.h
  27.  
  28.  To use miniLZO just copy these files into your source directory, add
  29.  minilzo.c to your Makefile and #include minilzo.h from your program.
  30.  
  31.  minilzo.o compiles to about 6 kB (using gcc or Watcom C on a i386), and
  32.  the sources are about 14 kB when packed with zip - so there's no more
  33.  excuse that your application doesn't support data compression :-)
  34.  
  35.  For more information, documentation and other support files (like Makefiles
  36.  and build scripts) please download the full LZO package from
  37.     http://www.infosys.tuwien.ac.at/Staff/lux/marco/lzo.html
  38.  
  39.  Have fun,
  40.   Markus
  41.  
  42.  
  43.  
  44.  Appendix A: building miniLZO
  45.  ----------------------------
  46.  miniLZO is written such a way that it (hopefully) should compile
  47.  and run out-of-the box on most machines.
  48.  
  49.  If you are running on an unusual architecture and lzo_init() fails then
  50.  you should first recompile with `-DLZO_DEBUG' to see what causes the
  51.  failure. The most probable case is that sizeof(char *) != sizeof(long).
  52.  
  53.  After identifying the problem you can workaround by adding some defines
  54.  like `-DSIZEOF_CHAR_P=8' to your Makefile.
  55.  The best solution is (of course) using Autoconf - if your project uses
  56.  Autoconf anyway just add `-DMINILZO_HAVE_CONFIG_H' to your compiler
  57.  flags. See the LZO distribution for an example how to set up `configure.in'.
  58.  
  59.  
  60.  Appendix B: list of public functions available in miniLZO
  61.  ---------------------------------------------------------
  62.  
  63.  Library initialization
  64.     lzo_init()
  65.  
  66.  Compression
  67.     lzo1x_1_compress()
  68.  
  69.  Decompression
  70.     lzo1x_decompress()
  71.     lzo1x_decompress_safe()
  72.  
  73.  Checksum functions
  74.     lzo_adler32()
  75.  
  76.  Version functions
  77.     lzo_version()
  78.     lzo_version_string()
  79.     lzo_version_date()
  80.  
  81.  Portable (but slow) string functions
  82.     lzo_memcmp()
  83.     lzo_memcpy()
  84.     lzo_memset()
  85.  
  86.  
  87.  
  88.  
  89. -----BEGIN PGP SIGNATURE-----
  90. Version: 2.6.3i
  91. Charset: noconv
  92.  
  93. iQCVAwUBM8jvFW10fyLu8beJAQGlIQQApVHFnjS6ZntZGQcggpp8P+UQXxnWbbKM
  94. 2bd6jDCuxIXETqiTGi8JaiG1izbu1x+fGVludpCCVwbteRvLC9++YGM5H0S7Fzam
  95. pgOWH1Z2iLYOWGhDbgBred882nyOIDiUksel0OD7s84xfcSuIV5QUqtd/K6korS6
  96. AoB5FYDrZQM=
  97. =qx4Z
  98. -----END PGP SIGNATURE-----
  99.