.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.36.3 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "nbdkit-xz-filter 1"
.TH nbdkit-xz-filter 1 2024-01-17 nbdkit-1.36.3 NBDKIT
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
nbdkit\-xz\-filter \- nbdkit xz filter
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& nbdkit \-\-filter=xz file FILENAME.xz
.Ve
.PP
.Vb 1
\& nbdkit \-\-filter=xz curl https://example.com/FILENAME.xz
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`nbdkit\-xz\-filter\*(C'\fR is a filter for \fBnbdkit\fR\|(1) which uncompresses
the underlying plugin on the fly.  The filter only supports read-only
connections.
.SS "Getting best random access performance from xz"
.IX Subsection "Getting best random access performance from xz"
\&\fBxz\fR\|(1) files are split into streams and blocks.  Most xz files
contain only one stream which contains one or more blocks.  You can
find out how many streams and blocks are in an xz file by doing:
.PP
.Vb 5
\& $ xz \-\-list winxp.img.xz
\& Strms  Blocks   Compressed Uncompressed  Ratio  Check   Filename
\&     1       1  2,100.0 MiB  6,144.0 MiB  0.342  CRC64   winxp.img.xz
\&    ↑↑↑     ↑↑↑
\&  streams  blocks
.Ve
.PP
xz files are seekable on block boundaries only.  Seeking is done by
seeking directly to the lower block boundary, then uncompressing data
until the precise byte is reached.  As uncompressing xz data is slow,
\&\fBto get best random access performance, you must prepare your xz
files with many small blocks.\fR
.PP
Use the \fI\-\-block\-size\fR option with a small-ish block size.  For
example this is the same image compressed with a 16 MB block size:
.PP
.Vb 7
\& $ xz \-\-best \-\-block\-size=16777216 winxp.img
\&             ─────────────────────
\& $ xz \-\-list winxp.img.xz
\& Strms  Blocks   Compressed Uncompressed  Ratio  Check   Filename
\&     1     384  2,120.1 MiB  6,144.0 MiB  0.345  CRC64   winxp.img.xz
\&           ↑↑↑
\&          blocks
.Ve
.PP
This file can be accessed randomly.  At most 16 MB will have to be
uncompressed to seek to any byte.
.PP
As you would expect, xz cannot compress as efficiently when using a
smaller block size.  The space penalty in the above example is
<\ 1% of the compressed file size.
.SH PARAMETERS
.IX Header "PARAMETERS"
.IP \fBxz\-max\-block=\fRSIZE 4
.IX Item "xz-max-block=SIZE"
The maximum block size that the filter will read.  The filter will
refuse to read xz files that contain any block larger than this size.
.Sp
See the discussion above about creating xz files with small block
sizes in order to reduce memory usage and increase performance.
.Sp
This parameter is optional.  If not specified it defaults to 512M.
.IP \fBxz\-max\-depth=\fRN 4
.IX Item "xz-max-depth=N"
Maximum number of blocks stored in the LRU block cache.
.Sp
This parameter is optional.  If not specified it defaults to 8.
.Sp
The filter may allocate up to
maximum\ block\ size\ in\ file\ ×\ maxdepth
bytes of memory \fIper connection\fR.
.SH FILES
.IX Header "FILES"
.ie n .IP \fR\fI$filterdir\fR\fI/nbdkit\-xz\-filter.so\fR 4
.el .IP \fR\f(CI$filterdir\fR\fI/nbdkit\-xz\-filter.so\fR 4
.IX Item "$filterdir/nbdkit-xz-filter.so"
The filter.
.Sp
Use \f(CW\*(C`nbdkit \-\-dump\-config\*(C'\fR to find the location of \f(CW$filterdir\fR.
.SH VERSION
.IX Header "VERSION"
\&\f(CW\*(C`nbdkit\-xz\-filter\*(C'\fR first appeared in nbdkit 1.10.
It is derived from an earlier plugin that first appeared in nbdkit 1.0.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1),
\&\fBnbdkit\-filter\fR\|(3),
\&\fBnbdkit\-curl\-plugin\fR\|(1),
\&\fBnbdkit\-file\-plugin\fR\|(1),
\&\fBxz\fR\|(1).
.SH AUTHORS
.IX Header "AUTHORS"
Richard W.M. Jones
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Red Hat
.SH LICENSE
.IX Header "LICENSE"
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
.IP \(bu 4
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
.IP \(bu 4
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
.IP \(bu 4
Neither the name of Red Hat nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
.PP
THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.