.\" -*- 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-split-plugin 1"
.TH nbdkit-split-plugin 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\-split\-plugin \- nbdkit plugin to concatenate split files into one disk
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& nbdkit split [file=]file1 [[file=]file2 [file=]file3 ...]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`nbdkit\-split\-plugin\*(C'\fR is a file plugin for \fBnbdkit\fR\|(1).  One or more
filenames may be given using the \f(CW\*(C`FILENAME\*(C'\fR parameter.  These
files are logically concatenated into a single disk image.
.PP
If you want to add a virtual partition table, see
\&\fBnbdkit\-partitioning\-plugin\fR\|(1).
.SS "Differences from nbdkit-file-plugin"
.IX Subsection "Differences from nbdkit-file-plugin"
Normally to serve a single file you should use
\&\fBnbdkit\-file\-plugin\fR\|(1).  This plugin differs from nbdkit-file-plugin
as follows:
.IP \(bu 4
nbdkit-file-plugin is faster and more efficient.  It has a fully
parallel implementation, and does not have to deal with the complexity
of locating the correct file to serve or splitting requests across
files.
.IP \(bu 4
nbdkit-file-plugin allows you to resize the underlying file
dynamically.  The underlying files must \fBnot\fR be resized when using
the split plugin.
.IP \(bu 4
nbdkit-file-plugin can handle block devices, but the split plugin can
only handle plain files.
.IP \(bu 4
nbdkit-file-plugin handles writes of blocks of zeroes efficiently, but
the split plugin cannot.
.IP \(bu 4
nbdkit-file-plugin can "punch holes" in the backing file in response
to a trim request from the client, but the split plugin does not
support this.
.SH PARAMETERS
.IX Header "PARAMETERS"
.IP [\fBfile=\fR]FILENAME 4
.IX Item "[file=]FILENAME"
One or more files to open.  They are logically concatenated in
the order they appear on the command line.
.Sp
This parameter must appear at least once.
.Sp
\&\f(CW\*(C`file=\*(C'\fR is a magic config key and may be omitted in most cases.
See "Magic parameters" in \fBnbdkit\fR\|(1).
.SH FILES
.IX Header "FILES"
.ie n .IP \fR\fI$plugindir\fR\fI/nbdkit\-split\-plugin.so\fR 4
.el .IP \fR\f(CI$plugindir\fR\fI/nbdkit\-split\-plugin.so\fR 4
.IX Item "$plugindir/nbdkit-split-plugin.so"
The plugin.
.Sp
Use \f(CW\*(C`nbdkit \-\-dump\-config\*(C'\fR to find the location of \f(CW$plugindir\fR.
.SH VERSION
.IX Header "VERSION"
\&\f(CW\*(C`nbdkit\-split\-plugin\*(C'\fR first appeared in nbdkit 1.2.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1),
\&\fBnbdkit\-plugin\fR\|(3),
\&\fBnbdkit\-file\-plugin\fR\|(1),
\&\fBnbdkit\-partitioning\-plugin\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.