diff options
| author | Lasse Collin <lasse.collin@tukaani.org> | 2012-06-14 10:52:33 +0300 |
|---|---|---|
| committer | Lasse Collin <lasse.collin@tukaani.org> | 2012-06-22 09:31:42 +0300 |
| commit | ef8b8e5f111469b5bc005975f7abb9abbd372b25 (patch) | |
| tree | aee6d9b35b2414719e696b225d8f43b82d522a17 /doc/examples/00_README.txt | |
| parent | Docs: Move xz_pipe_comp.c and xz_pipe_decomp.c to doc/examples_old. (diff) | |
| download | xz-ef8b8e5f111469b5bc005975f7abb9abbd372b25.tar.xz | |
Docs: Add new example programs.
These have more comments than the old examples and
human-readable error messages. More tutorial-like examples
are needed but these are a start.
Diffstat (limited to 'doc/examples/00_README.txt')
| -rw-r--r-- | doc/examples/00_README.txt | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/examples/00_README.txt b/doc/examples/00_README.txt new file mode 100644 index 00000000..a3b9eaa1 --- /dev/null +++ b/doc/examples/00_README.txt @@ -0,0 +1,27 @@ + +liblzma example programs +======================== + +Introduction + + The examples are written so that the same comments aren't + repeated (much) in later files. + + On POSIX systems, the examples should build by just typing "make". + + The examples that use stdin or stdout don't set stdin and stdout + to binary mode. On systems where it matters (e.g. Windows) it is + possible that the examples won't work without modification. + + +List of examples + + 01_compress_easy.c Multi-call compression using + a compression preset + + 02_decompress.c Multi-call decompression + + 03_compress_custom.c Like 01_compress_easy.c but using + a custom filter chain + (x86 BCJ + LZMA2) + |