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

DESCRIPTION

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

EXAMPLE

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

PARAMETERS

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

ENVIRONMENT VARIABLES

70       "PATH"
71           xorriso(1), genisoimage(1), mkisofs(1) or whatever you supply to
72           the optional "prog" parameter must be available on the $PATH.
73
74       "TMPDIR"
75           A temporary copy of the ISO is created in "TMPDIR".  If this
76           environment variable is not set then /var/tmp is used instead.
77           There must be enough free space here to store the ISO, which might
78           be quite large.
79

FILES

81       $plugindir/nbdkit-iso-plugin.so
82           The plugin.
83
84           Use "nbdkit --dump-config" to find the location of $plugindir.
85

VERSION

87       "nbdkit-iso-plugin" first appeared in nbdkit 1.8.
88

AUTHORS

95       Richard W.M. Jones
96

COPYRIGHT

98       Copyright (C) 2018 Red Hat Inc.
99

LICENSE

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