README
1
2XZ for Java
3===========
4
5Introduction
6
7 This aims to be a complete implementation of XZ data compression
8 in pure Java. Features:
9 - Full support for the .xz file format specification version 1.0.4
10 - Single-threaded streamed compression and decompression
11 - Single-threaded decompression with limited random access support
12 - Raw streams (no .xz headers) for advanced users, including LZMA2
13 with preset dictionary
14
15 Threading is planned but it is unknown when it will be implemented.
16
17 For the latest source code, see the project home page:
18
19 http://tukaani.org/xz/java.html
20
21 The source code is compatible with Java 1.4 and later.
22
23Building
24
25 It is recommended to use Apache Ant. Type "ant" to compile the
26 classes and create the .jar files. Type "ant doc" to build the
27 javadoc HTML documentation. Note that building the documentation
28 will download a small file named "package-list" from Oracle to
29 enable linking to the documentation of the standard Java classes.
30
31 If you cannot or don't want to use Ant, just compile all .java
32 files under the "src" directory.
33
34Demo programs
35
36 You can test compression with XZEncDemo, which compresses from
37 standard input to standard output:
38
39 java -jar build/jar/XZEncDemo.jar < foo.txt > foo.txt.xz
40
41 You can test decompression with XZDecDemo, which decompresses to
42 standard output:
43
44 java -jar build/jar/XZDecDemo.jar foo.txt.xz
45
46Reporting bugs
47
48 Report bugs to <lasse.collin@tukaani.org> or visit the IRC channel
49 #tukaani on Freenode and talk to Larhzu.
50
51