nbdkit-tar-plugin(1)

1nbdkit-tar-plugin(1)                NBDKIT                nbdkit-tar-plugin(1)
2
3
4

NAME

6       nbdkit-tar-plugin - read and write files inside tar files without
7       unpacking
8

SYNOPSIS

10        nbdkit tar tar=FILENAME.tar file=PATH_INSIDE_TAR
11

EXAMPLE

13   Serve a single file inside a tarball
14        nbdkit tar tar=file.tar file=some/disk.img
15        guestfish --format=raw -a nbd://localhost
16
17   Opening a disk image inside an OVA file
18       The popular "Open Virtual Appliance" (OVA) format is really an
19       uncompressed tar file containing (usually) VMDK-format files, so you
20       could access one file in an OVA like this:
21
22        $ tar tf rhel.ova
23        rhel.ovf
24        rhel-disk1.vmdk
25        rhel.mf
26        $ nbdkit -r tar tar=rhel.ova file=rhel-disk1.vmdk
27        $ guestfish --ro --format=vmdk -a nbd://localhost
28

DESCRIPTION

30       "nbdkit-tar-plugin" is a plugin which can read and writes files inside
31       an uncompressed tar file without unpacking the tar file.
32
33       The "tar" and "file" parameters are required, specifying the name of
34       the uncompressed tar file and the exact path of the file within the tar
35       file to access as a disk image.
36
37       This plugin will not work on compressed tar files.
38
39       Use the nbdkit -r flag to open the file readonly.  This is the safest
40       option because it guarantees that the tar file will not be modified.
41       Without -r writes will modify the tar file.
42
43       Also writing to the tar file does not change data checksums stored in
44       other files (the "rhel.mf" file in the example above), and as these
45       will become incorrect you probably won't be able to open the file with
46       another tool afterwards.
47
48       The disk image cannot be resized.
49

VERSION

51       "nbdkit-tar-plugin" first appeared in nbdkit 1.2.
52

AUTHORS

58       Richard W.M. Jones.
59
60       Based on the virt-v2v OVA importer written by Tomáš Golembiovský.
61

COPYRIGHT

63       Copyright (C) 2017 Red Hat Inc.
64

LICENSE

66       Redistribution and use in source and binary forms, with or without
67       modification, are permitted provided that the following conditions are
68       met:
69
70       ·   Redistributions of source code must retain the above copyright
71           notice, this list of conditions and the following disclaimer.
72
73       ·   Redistributions in binary form must reproduce the above copyright
74           notice, this list of conditions and the following disclaimer in the
75           documentation and/or other materials provided with the
76           distribution.
77
78       ·   Neither the name of Red Hat nor the names of its contributors may
79           be used to endorse or promote products derived from this software
80           without specific prior written permission.
81
82       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
83       EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
84       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
85       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
86       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
87       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
88       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
89       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
90       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
91       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
92       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
93
94
95
96nbdkit-1.16.1                     2019-12-03              nbdkit-tar-plugin(1)