.\" Automatically generated by Podwrapper::Man 1.20.6 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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-ext2-plugin 1"
.TH nbdkit-ext2-plugin 1 "2020-06-18" "nbdkit-1.20.6" "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\-ext2\-plugin \- read and write files inside ext2, ext3 or
ext4 filesystems
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& nbdkit ext2 disk=fs.img file=/disks/disk.raw
.Ve
.SH "DEPRECATED"
.IX Header "DEPRECATED"
\&\fBThe ext2 plugin is deprecated in nbdkit ≥ 1.17.8 and will be
removed in nbdkit 1.22\fR.  It has been replaced with a filter with
the same functionality, see \fBnbdkit\-ext2\-filter\fR\|(1).  You can use the
filter like this:
.PP
.Vb 1
\& nbdkit \-\-filter=ext2 file fs.img ext2file=/disks/disk.raw
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`nbdkit\-ext2\-plugin\*(C'\fR is an nbdkit plugin which can read and
write files inside ext2, ext3 or ext4 filesystem images.
.PP
Suppose you have an ext2/3/4 filesystem image called \fIfs.img\fR
which contains inside itself a file called \fIdisk.raw\fR
inside a directory on the filesystem called \fI/disks\fR, then
you could serve that file over \s-1NBD\s0 using:
.PP
.Vb 1
\& nbdkit ext2 disk=fs.img file=/disks/disk.raw
.Ve
.PP
This plugin can both read and write to the file inside the filesystem.
Use the \fI\-r\fR flag to force a readonly connection, but note this does
\&\fInot\fR guarantee that no writes are made to the filesystem.  In
particular we may have to replay the ext3 journal in order to open a
filesystem even read-only.
.PP
The plugin does \fInot\fR support multiple parallel connections, because
there is a risk of corrupting the filesystem (as if the filesystem was
mounted by multiple machines).  If a second connection is made to
nbdkit, it will block until the first connection closes.
.PP
The plugin is implemented using the ext2fs library which is provided
in most Linux distros, and also available as part of the e2fsprogs
project.
.PP
\&\fBnbdkit\-guestfs\-plugin\fR\|(1) is a more generic plugin which can read
files from all kinds of different filesystem types, even if they are
partitioned or use logical volumes.  It uses libguestfs instead of
e2fsprogs.
.SH "PARAMETERS"
.IX Header "PARAMETERS"
.IP "\fBdisk=\fR\s-1FILENAME\s0" 4
.IX Item "disk=FILENAME"
The ext2, ext3 or ext4 filesystem, a file on the host.
.Sp
You could also use a device name here if the filesystem is located on
a device.  Be careful that the filesystem is not being accessed in
parallel by another program and is not mounted, as that will almost
certainly result in disk corruption in the filesystem.
.Sp
The plugin expects a raw filesystem.  If the file/device is
partitioned, use \fBnbdkit\-partition\-filter\fR\|(1).
.IP "\fBfile=\fR\s-1PATH\s0" 4
.IX Item "file=PATH"
The full path of the file within the filesystem that will be exposed
over \s-1NBD.\s0  The path must be absolute (starts with \f(CW\*(C`/\*(C'\fR).
.SH "FILES"
.IX Header "FILES"
.IP "\fI\f(CI$plugindir\fI/nbdkit\-ext2\-plugin.so\fR" 4
.IX Item "$plugindir/nbdkit-ext2-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\-ext2\-plugin\*(C'\fR first appeared in nbdkit 1.4.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1),
\&\fBnbdkit\-plugin\fR\|(3),
\&\fBnbdkit\-ext2\-filter\fR\|(1),
\&\fBnbdkit\-partition\-filter\fR\|(1),
\&\fBnbdkit\-guestfs\-plugin\fR\|(1),
http://e2fsprogs.sourceforge.net/,
\&\fBfuse2fs\fR\|(1).
.SH "AUTHORS"
.IX Header "AUTHORS"
Richard W.M. Jones
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2018\-2020 Red Hat Inc.
.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
\&\s-1THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS\s0 ''\s-1AS IS\s0'' \s-1AND
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\s0 (\s-1INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES\s0; \s-1LOSS OF
USE, DATA, OR PROFITS\s0; \s-1OR BUSINESS INTERRUPTION\s0) \s-1HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT\s0 (\s-1INCLUDING NEGLIGENCE OR OTHERWISE\s0) \s-1ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.\s0