Blame minilzo/README.LZO

Packit 679830
Packit 679830
 ============================================================================
Packit 679830
 miniLZO -- mini subset of the LZO real-time data compression library
Packit 679830
 ============================================================================
Packit 679830
Packit 679830
 Author  : Markus Franz Xaver Johannes Oberhumer
Packit 679830
           <markus@oberhumer.com>
Packit 679830
           http://www.oberhumer.com/opensource/lzo/
Packit 679830
 Version : 2.08
Packit 679830
 Date    : 29 Jun 2014
Packit 679830
Packit 679830
 I've created miniLZO for projects where it is inconvenient to
Packit 679830
 include (or require) the full LZO source code just because you
Packit 679830
 want to add a little bit of data compression to your application.
Packit 679830
Packit 679830
 miniLZO implements the LZO1X-1 compressor and both the standard and
Packit 679830
 safe LZO1X decompressor. Apart from fast compression it also useful
Packit 679830
 for situations where you want to use pre-compressed data files (which
Packit 679830
 must have been compressed with LZO1X-999).
Packit 679830
Packit 679830
 miniLZO consists of one C source file and three header files:
Packit 679830
    minilzo.c
Packit 679830
    minilzo.h, lzoconf.h, lzodefs.h
Packit 679830
Packit 679830
 To use miniLZO just copy these files into your source directory, add
Packit 679830
 minilzo.c to your Makefile and #include minilzo.h from your program.
Packit 679830
 Note: you also must distribute this file ('README.LZO') with your project.
Packit 679830
Packit 679830
 minilzo.o compiles to about 6 KiB (using gcc or Visual C on an i386), and
Packit 679830
 the sources are about 30 KiB when packed with zip - so there's no more
Packit 679830
 excuse that your application doesn't support data compression :-)
Packit 679830
Packit 679830
 For more information, documentation, example programs and other support
Packit 679830
 files (like Makefiles and build scripts) please download the full LZO
Packit 679830
 package from
Packit 679830
    http://www.oberhumer.com/opensource/lzo/
Packit 679830
Packit 679830
 Have fun,
Packit 679830
  Markus
Packit 679830
Packit 679830
Packit 679830
 P.S. minilzo.c is generated automatically from the LZO sources and
Packit 679830
      therefore functionality is completely identical
Packit 679830
Packit 679830
Packit 679830
 Appendix A: building miniLZO
Packit 679830
 ----------------------------
Packit 679830
 miniLZO is written such a way that it should compile and run
Packit 679830
 out-of-the-box on most machines.
Packit 679830
Packit 679830
 If you are running on a very unusual architecture and lzo_init() fails then
Packit 679830
 you should first recompile with '-DLZO_DEBUG' to see what causes the failure.
Packit 679830
 The most probable case is something like 'sizeof(void *) != sizeof(size_t)'.
Packit 679830
 After identifying the problem you can compile by adding some defines
Packit 679830
 like '-DSIZEOF_VOID_P=8' to your Makefile.
Packit 679830
Packit 679830
 The best solution is (of course) using Autoconf - if your project uses
Packit 679830
 Autoconf anyway just add '-DMINILZO_HAVE_CONFIG_H' to your compiler
Packit 679830
 flags when compiling minilzo.c. See the LZO distribution for an example
Packit 679830
 how to set up configure.ac.
Packit 679830
Packit 679830
Packit 679830
 Appendix B: list of public functions available in miniLZO
Packit 679830
 ---------------------------------------------------------
Packit 679830
 Library initialization
Packit 679830
    lzo_init()
Packit 679830
Packit 679830
 Compression
Packit 679830
    lzo1x_1_compress()
Packit 679830
Packit 679830
 Decompression
Packit 679830
    lzo1x_decompress()
Packit 679830
    lzo1x_decompress_safe()
Packit 679830
Packit 679830
 Checksum functions
Packit 679830
    lzo_adler32()
Packit 679830
Packit 679830
 Version functions
Packit 679830
    lzo_version()
Packit 679830
    lzo_version_string()
Packit 679830
    lzo_version_date()
Packit 679830
Packit 679830
 Portable (but slow) string functions
Packit 679830
    lzo_memcmp()
Packit 679830
    lzo_memcpy()
Packit 679830
    lzo_memmove()
Packit 679830
    lzo_memset()
Packit 679830
Packit 679830
Packit 679830
 Appendix C: suggested macros for 'configure.ac' when using Autoconf
Packit 679830
 -------------------------------------------------------------------
Packit 679830
 Checks for typedefs and structures
Packit 679830
    AC_CHECK_TYPE(ptrdiff_t,long)
Packit 679830
    AC_TYPE_SIZE_T
Packit 679830
    AC_CHECK_SIZEOF(short)
Packit 679830
    AC_CHECK_SIZEOF(int)
Packit 679830
    AC_CHECK_SIZEOF(long)
Packit 679830
    AC_CHECK_SIZEOF(long long)
Packit 679830
    AC_CHECK_SIZEOF(__int64)
Packit 679830
    AC_CHECK_SIZEOF(void *)
Packit 679830
    AC_CHECK_SIZEOF(size_t)
Packit 679830
    AC_CHECK_SIZEOF(ptrdiff_t)
Packit 679830
Packit 679830
 Checks for compiler characteristics
Packit 679830
    AC_C_CONST
Packit 679830
Packit 679830
 Checks for library functions
Packit 679830
    AC_CHECK_FUNCS(memcmp memcpy memmove memset)
Packit 679830
Packit 679830
Packit 679830
 Appendix D: Copyright
Packit 679830
 ---------------------
Packit 679830
 LZO and miniLZO are Copyright (C) 1996-2014 Markus Franz Xaver Oberhumer
Packit 679830
 All Rights Reserved.
Packit 679830
Packit 679830
 LZO and miniLZO are distributed under the terms of the GNU General
Packit 679830
 Public License (GPL).  See the file COPYING.
Packit 679830
Packit 679830
 Special licenses for commercial and other applications which
Packit 679830
 are not willing to accept the GNU General Public License
Packit 679830
 are available by contacting the author.
Packit 679830
Packit 679830