debian: Prepare for upload
[xz/debian.git] / doc / examples / 00_README.txt
blob120e1eb7e7c507a8293a060767d60fcfac3babde
2 liblzma example programs
3 ========================
5 Introduction
7     The examples are written so that the same comments aren't
8     repeated (much) in later files.
10     On POSIX systems, the examples should build by just typing "make".
12     The examples that use stdin or stdout don't set stdin and stdout
13     to binary mode. On systems where it matters (e.g. Windows) it is
14     possible that the examples won't work without modification.
17 List of examples
19     01_compress_easy.c                  Multi-call compression using
20                                         a compression preset
22     02_decompress.c                     Multi-call decompression
24     03_compress_custom.c                Like 01_compress_easy.c but using
25                                         a custom filter chain
26                                         (x86 BCJ + LZMA2)
28     04_compress_easy_mt.c               Multi-threaded multi-call
29                                         compression using a compression
30                                         preset