nbdkit-iso-plugin(1)

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

NAME

6       nbdkit-iso-plugin - create virtual ISO (CD-ROM) from directory
7

SYNOPSIS

9        nbdkit iso [dir=]DIRECTORY [[dir=]DIRECTORY ...]
10                   [prog=mkisofs] [params='-JrT']
11
12        nbdkit iso --dump-plugin
13

DESCRIPTION

15       "nbdkit-iso-plugin" is a plugin for nbdkit(1) which creates a virtual
16       ISO (CD-ROM) image from a directory on the fly.  The files from
17       DIRECTORY are added to a virtual ISO image which is served read-only
18       over the NBD protocol.
19
20       This plugin uses xorriso(1), genisoimage(1) or mkisofs(1) to create the
21       ISO content.  See also "DUMP PLUGIN OUTPUT" below.
22
23       To create a FAT-formatted virtual floppy disk instead of a CD, see
24       nbdkit-floppy-plugin(1).  To create a Linux compatible virtual disk,
25       see nbdkit-linuxdisk-plugin(1).
26

EXAMPLE

28       Create a virtual ISO which supports Joliet, Rock Ridge and TRANS.TBL
29       extensions, from files in a directory:
30
31        nbdkit iso /path/to/directory params='-JrT'
32
33       "params" adds -JrT to the xorriso(1), genisoimage(1) or mkisofs(1)
34       command line, specifying the required extensions.  Note that unless you
35       use at least one of these extensions, filenames inside the ISO will be
36       truncated because of limitations of the basic ISO 9660 format.
37

PARAMETERS

39       [dir=]DIRECTORY
40           Specify the directory containing files and subdirectories which
41           will be added to the virtual ISO.  Files inside this directory will
42           appear in the root directory of the ISO.
43
44           This parameter is required and may be specified one or more times.
45           If multiple directories are specified, they are merged together.
46
47           "dir=" is a magic config key and may be omitted in most cases.  See
48           "Magic parameters" in nbdkit(1).
49
50       params='parameters ...'
51           Any other parameters may be passed through to xorriso(1),
52           genisoimage(1) or mkisofs(1) by specifying this option.
53
54           For example:
55
56            params='-JrT -V "My Disk Image"'
57
58           would specify Joliet (-J), Rock Ridge (-r) and TRANS.TBL (-T)
59           extensions, and specify the volume ID (-V) as "My Disk Image".
60
61           Take care when quoting this parameter; nbdkit passes the resulting
62           string through another layer of shell interpretation without any
63           sanity checks for unquoted shell metacharacters.
64
65       prog=mkisofs
66           Choose which program to use to create the ISO content.  The default
67           is xorriso(1), genisoimage(1) or mkisofs(1) and is picked when
68           nbdkit is compiled.  You only need to use this parameter if you
69           want to override it at run time.
70

DUMP PLUGIN OUTPUT

72       Use:
73
74        nbdkit iso --dump-plugin
75
76       to find out which mkisofs-like program was used when the plugin was
77       compiled.  For example:
78
79        $ nbdkit iso --dump-plugin | grep ^iso_prog=
80        iso_prog=xorriso
81

ENVIRONMENT VARIABLES

83       "PATH"
84           xorriso(1), genisoimage(1), mkisofs(1) or whatever you supply to
85           the optional "prog" parameter must be available on the $PATH.
86
87       "TMPDIR"
88           A temporary copy of the ISO is created in "TMPDIR".  If this
89           environment variable is not set then /var/tmp is used instead.
90           There must be enough free space here to store the ISO, which might
91           be quite large.
92

FILES

94       $plugindir/nbdkit-iso-plugin.so
95           The plugin.
96
97           Use "nbdkit --dump-config" to find the location of $plugindir.
98

VERSION

100       "nbdkit-iso-plugin" first appeared in nbdkit 1.8.
101

AUTHORS

108       Richard W.M. Jones
109

COPYRIGHT

111       Copyright Red Hat
112

LICENSE

114       Redistribution and use in source and binary forms, with or without
115       modification, are permitted provided that the following conditions are
116       met:
117
118       •   Redistributions of source code must retain the above copyright
119           notice, this list of conditions and the following disclaimer.
120
121       •   Redistributions in binary form must reproduce the above copyright
122           notice, this list of conditions and the following disclaimer in the
123           documentation and/or other materials provided with the
124           distribution.
125
126       •   Neither the name of Red Hat nor the names of its contributors may
127           be used to endorse or promote products derived from this software
128           without specific prior written permission.
129
130       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
131       EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
132       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
133       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
134       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
135       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
136       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
137       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
138       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
139       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
140       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
141
142
143
144nbdkit-1.36.2                     2023-11-26              nbdkit-iso-plugin(1)