1nbdkit-iso-plugin(1) NBDKIT nbdkit-iso-plugin(1)
2
3
4
6 nbdkit-iso-plugin - create virtual ISO (CD-ROM) from directory
7
9 nbdkit iso [dir=]DIRECTORY [[dir=]DIRECTORY ...]
10 [prog=mkisofs] [params='-JrT']
11
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 genisoimage(1) or mkisofs(1) to create the ISO
19 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
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 genisoimage(1) or mkisofs(1) command line,
32 specifying the required extensions. Note that unless you use at least
33 one of these extensions, filenames inside the ISO will be truncated
34 because of limitations of the basic ISO 9660 format.
35
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 genisoimage(1) or
50 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.
60
61 prog=mkisofs
62 Choose which program to use to create the ISO content. The default
63 is either genisoimage(1) or mkisofs(1) and is picked when nbdkit is
64 compiled. You only need to use this parameter if you want to
65 override it at run time.
66
68 "PATH"
69 genisoimage(1), mkisofs(1) or whatever you supply to the optional
70 "prog" parameter must be available on the $PATH.
71
72 "TMPDIR"
73 A temporary copy of the ISO is created in "TMPDIR". If this
74 environment variable is not set then /var/tmp is used instead.
75 There must be enough free space here to store the ISO, which might
76 be quite large.
77
79 nbdkit(1), nbdkit-plugin(3), nbdkit-file-plugin(1),
80 nbdkit-floppy-plugin(1), nbdkit-linuxdisk-plugin(1), genisoimage(1),
81 mkisofs(1).
82
84 Richard W.M. Jones
85
87 Copyright (C) 2018 Red Hat Inc.
88
90 Redistribution and use in source and binary forms, with or without
91 modification, are permitted provided that the following conditions are
92 met:
93
94 · Redistributions of source code must retain the above copyright
95 notice, this list of conditions and the following disclaimer.
96
97 · Redistributions in binary form must reproduce the above copyright
98 notice, this list of conditions and the following disclaimer in the
99 documentation and/or other materials provided with the
100 distribution.
101
102 · Neither the name of Red Hat nor the names of its contributors may
103 be used to endorse or promote products derived from this software
104 without specific prior written permission.
105
106 THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
107 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
108 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
109 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
110 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
111 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
112 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
113 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
114 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
115 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
116 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
117
118
119
120nbdkit-1.12.3 2019-05-21 nbdkit-iso-plugin(1)