.\" -*- 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-offset-filter 1"
.TH nbdkit-offset-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\-offset\-filter \- nbdkit offset filter
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& nbdkit \-\-filter=offset plugin offset=OFFSET range=LENGTH [plugin\-args...]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`nbdkit\-offset\-filter\*(C'\fR is a filter that limits requests to the byte
range \f(CW\*(C`[offset .. offset+range\-1]\*(C'\fR within another plugin.
.SH PARAMETERS
.IX Header "PARAMETERS"
.IP \fBoffset=\fROFFSET 4
.IX Item "offset=OFFSET"
The start offset.  The offset must be ≥ 0.
.Sp
This parameter is optional.  If not given then \f(CW\*(C`offset=0\*(C'\fR is assumed.
.IP \fBrange=\fRLENGTH 4
.IX Item "range=LENGTH"
The length of data to serve.
.Sp
This parameter is optional.  If not given then the range is served
starting from the offset through to the end of the underlying
file/device.
.PP
Note it is an error if the offset and/or range specify data which lies
beyond the end of the underlying device.  Use
\&\fBnbdkit\-truncate\-filter\fR\|(1) to truncate or extend the size of
plugins.
.SH EXAMPLES
.IX Header "EXAMPLES"
.SS "Serve part of a file"
.IX Subsection "Serve part of a file"
Using \fBnbdkit\-file\-plugin\fR\|(1), serve the file \f(CW\*(C`disk.img\*(C'\fR starting at
offset \f(CW\*(C`1M\*(C'\fR.  The total length served is \f(CW\*(C`100M\*(C'\fR (the underlying file
must therefore be at least \f(CW\*(C`101M\*(C'\fR in length):
.PP
.Vb 1
\& nbdkit \-\-filter=offset file disk.img offset=1M range=100M
.Ve
.SS "Serve a single partition"
.IX Subsection "Serve a single partition"
\&\fIAn easier way to do this is with \fR\f(BInbdkit\-partition\-filter\fR\fI\|(1).\fR
.PP
One way to serve a single partition from a disk is to find the start
and length of the partition, eg using:
.PP
.Vb 4
\& $ parted disk.img \-\- unit b print
\& ...
\& Number  Start   End         Size        Type     File system  Flags
\&  1      65536B  104792575B  104727040B  primary  ext2
.Ve
.PP
You can then serve the partition only using:
.PP
.Vb 1
\& nbdkit \-\-filter=offset file disk.img offset=65536 range=104727040
.Ve
.SH FILES
.IX Header "FILES"
.ie n .IP \fR\fI$filterdir\fR\fI/nbdkit\-offset\-filter.so\fR 4
.el .IP \fR\f(CI$filterdir\fR\fI/nbdkit\-offset\-filter.so\fR 4
.IX Item "$filterdir/nbdkit-offset-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\-offset\-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\-partition\-filter\fR\|(1),
\&\fBnbdkit\-protect\-filter\fR\|(1),
\&\fBnbdkit\-tar\-filter\fR\|(1),
\&\fBnbdkit\-truncate\-filter\fR\|(1).
.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.