source: project/wiki/lzma @ 13070

Last change on this file since 13070 was 13070, checked in by Alaric Snell-Pym, 11 years ago

Changes applied for alaric (217.205.201.45) through svnwiki:

Wrong tag?

  • Property svnwiki:title set to lzma
File size: 2.9 KB
Line 
1[[tags:egg]]
2
3== Introduction
4
5The lzma egg provides a simple wrapper around the C library lzmalib, which in turn provides access to the excellent [[http://en.wikipedia.org/wiki/LZMA|Lempel-Ziv-Markov chain algorithm]].
6
7Two functions are provided, which simply compress or decompress a buffer represented as a Chicken blob object.
8
9== Examples
10
11<examples>
12<example>
13<init>(use lzma)</init>
14<expr>(blob->string (lzma:decompress (lzma:compress (string->blob "Hello, World!"))))</expr>
15<result>"Hello, World!"</result>
16</example>
17<example>
18<init>(use lzma)</init>
19<expr>(blob-size (lzma:compress (string->blob "Hello, World!")))</expr>
20<result>32</result>
21</example>
22<example>
23<init>(use lzma)</init>
24<expr>(blob-size (lzma:compress (string->blob "Hello, World! Hello, World! Hello, World!")))</expr>
25<result>36</result>
26</example>
27</examples>
28
29== Library functions
30
31<procedure>(lzma:compress BLOB) => BLOB</procedure>
32
33Given a blob, returns a blob that's hopefully smaller, and contains all the entropy of the original blob.
34
35<procedure>(lzma:decompress BLOB) => BLOB</procedure>
36
37Given a blob returned by {{lzma:compress}}, returns the original blob.
38
39== Authors
40
41[[alaric-blagrave-snellpym|Alaric B. Snell-Pym]]
42
43== License
44
45  Copyright (c) 2003-2009, Warhead.org.uk Ltd
46  All rights reserved.
47  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
48  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
49  Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
50  Neither the names of Warhead.org.uk Ltd, Snell Systems, nor Kitten Technologies, nor the names of their contributors may be used to endorse or promote products derived from this software without specific prior written permission.
51  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52
53== Requirements
54
55You'll need lzmalib installed. Source of this can be had from [[http://tokyocabinet.sourceforge.net/misc/lzmalib-0.0.1.tar.gz]].
56
57== Version History
58
59* 1.0: Initial release
Note: See TracBrowser for help on using the repository browser.