1// Package xz implements XZ decompression natively in Go.
2//
3// Usage
4//
5// For ease of use, this package is designed to have a similar API to
6// compress/gzip. See the examples for further details.
7//
8// Implementation
9//
10// This package is a translation from C to Go of XZ Embedded
11// (http://tukaani.org/xz/embedded.html) with enhancements made so as
12// to implement all mandatory and optional parts of the XZ file format
13// specification v1.0.4. It supports all filters and block check
14// types, supports multiple streams, and performs index verification
15// using SHA-256 as recommended by the specification.
16//
17// Speed
18//
19// On the author's Intel Ivybridge i5, decompression speed is about
20// half that of the standard XZ Utils (tested with a recent linux
21// kernel tarball).
22//
23// Thanks
24//
25// Thanks are due to Lasse Collin and Igor Pavlov, the authors of XZ
26// Embedded, on whose code package xz is based. It would not exist
27// without their decision to allow others to modify and reuse their
28// code.
29//
30// Bug reports
31//
32// For bug reports relating to this package please contact the author
33// through https://github.com/xi2/xz/issues, and not the authors of XZ
34// Embedded.
35package xz
36