.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.38.2 (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-partition-filter 1"
.TH nbdkit-partition-filter 1 2024-05-10 nbdkit-1.38.2 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\-partition\-filter \- nbdkit partition filter
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& nbdkit \-\-filter=partition plugin partition=PART [plugin\-args...]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`nbdkit\-partition\-filter\*(C'\fR is a filter that limits requests to a
single partition within a disk image that is served by another plugin.
.PP
Partition numbers are specified by the required \f(CW\*(C`partition\*(C'\fR
parameter, and count from 1.
.PP
This works like the \f(CW\*(C`qemu\-nbd \-P\*(C'\fR option.
.PP
The opposite of this filter is \fBnbdkit\-partitioning\-plugin\fR\|(1) which
adds a virtual partition table to a file or files.
.SH PARAMETERS
.IX Header "PARAMETERS"
.IP \fBpartition=\fRPART 4
.IX Item "partition=PART"
The partition number to serve, counting from 1.
.Sp
This parameter is required.
.IP \fBpartition\-sectorsize=\fRSECTOR_SIZE 4
.IX Item "partition-sectorsize=SECTOR_SIZE"
The default for this parameter is chosen according to the minimum block
size advertised by the underlying device.  If it is 512 or 4K, then the
sector size is set to that.  If the underlying device does not advertise
a minimum block size, or it is something other than 512 or 4K, the
default is 512 bytes.
.Sp
The user may specify 512 or 4096 as the sector size manually via config.
.Sp
However set, this parameter instructs the partition table
logic to treat the underlying storage as having the
indicated sector size.  This is important for MBR
and GPT logic using LBA (logical block addressing).
.SH EXAMPLE
.IX Header "EXAMPLE"
\&\fIdisk.img\fR is a partitioned disk image (eg. a virtual machine disk
image).  To serve the first partition only use:
.PP
.Vb 1
\& nbdkit \-\-filter=partition file disk.img partition=1
.Ve
.SH FILES
.IX Header "FILES"
.ie n .IP \fR\fI$filterdir\fR\fI/nbdkit\-partition\-filter.so\fR 4
.el .IP \fR\f(CI$filterdir\fR\fI/nbdkit\-partition\-filter.so\fR 4
.IX Item "$filterdir/nbdkit-partition-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\-partition\-filter\*(C'\fR first appeared in nbdkit 1.2.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1),
\&\fBnbdkit\-file\-plugin\fR\|(1),
\&\fBnbdkit\-filter\fR\|(3),
\&\fBnbdkit\-offset\-filter\fR\|(1),
\&\fBnbdkit\-partitioning\-plugin\fR\|(1),
\&\fBnbdkit\-protect\-filter\fR\|(1),
\&\fBnbdkit\-truncate\-filter\fR\|(1),
\&\fBparted\fR\|(8).
.SH AUTHORS
.IX Header "AUTHORS"
Eric Blake
.PP
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.