aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/lzw/README.md
diff options
context:
space:
mode:
authorDavid M. Syzdek <syzdek@bindlebinaries.com>2017-07-06 18:15:35 -0800
committerDavid M. Syzdek <syzdek@bindlebinaries.com>2017-07-06 18:15:35 -0800
commitb30a6c380904feb0c8ab2f9f643e31e068767e7d (patch)
treefbb735b0fc13829e56314faddcd34133e26f915d /src/lzw/README.md
parentc4b51f67a18a6f21c8f8cfadbe1f0361319b9c78 (diff)
downloadsecurecoreutils-b30a6c380904feb0c8ab2f9f643e31e068767e7d.tar.gz
securecoreutils-b30a6c380904feb0c8ab2f9f643e31e068767e7d.tar.bz2
securecoreutils-b30a6c380904feb0c8ab2f9f643e31e068767e7d.tar.xz
securecoreutils-b30a6c380904feb0c8ab2f9f643e31e068767e7d.zip
Adding native LZW compression support.
Diffstat (limited to 'src/lzw/README.md')
-rw-r--r--src/lzw/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/lzw/README.md b/src/lzw/README.md
new file mode 100644
index 0000000..e911946
--- /dev/null
+++ b/src/lzw/README.md
@@ -0,0 +1,32 @@
1# Basics
2
3* HOMEPAGE: https://github.com/vapier/liblzw
4* BUGS: https://github.com/vapier/liblzw/issues
5* AUTHOR: Mike Frysinger <vapier@gmail.com>
6
7# About
8
9liblzw is a small library that provides an API for reading
10[LZW](http://en.wikipedia.org/wiki/LZW) compressed (.Z) files. The API is
11similar to that of [zlib](http://www.zlib.net/) (for reading .gz files) and
12[libbzip2](http://www.bzip.org/) (for reading .bz2 files) which themselves
13are just like the classical UNIX functions for reading files
14(e.g. open/read/fopen/fread/etc...).
15
16The core compression code was taken from the canonical
17[ncompress](https://github.com/vapier/ncompress) program.
18
19# License
20
21Since the compression algorithms were ripped out of the public-domain package
22[ncompress](https://github.com/vapier/ncompress), liblzw has also been released
23into the public-domain for people to do with as they will. Just please send me
24bugfixes as you find them :).
25
26See the [UNLICENSE](UNLICENSE) file for more details.
27
28# Patents
29
30All existing patents on the LZW algorithm have
31[expired world-wide](http://en.wikipedia.org/wiki/LZW#Patent_issues).
32So LZW is now patent free.