1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
=head1 NAME
nbdkit-iso-plugin - create virtual ISO (CD-ROM) from directory
=head1 SYNOPSIS
nbdkit iso [dir=]DIRECTORY [[dir=]DIRECTORY ...]
[prog=mkisofs] [params='-JrT']
=for paragraph
nbdkit iso --dump-plugin
=head1 DESCRIPTION
C<nbdkit-iso-plugin> is a plugin for L<nbdkit(1)> which creates a
virtual ISO (CD-ROM) image from a directory on the fly. The files
from F<DIRECTORY> are added to a virtual ISO image which is served
read-only over the NBD protocol.
This plugin uses L<xorriso(1)>, L<genisoimage(1)> or L<mkisofs(1)> to
create the ISO content. See also L</DUMP PLUGIN OUTPUT> below.
To create a FAT-formatted virtual floppy disk instead of a CD, see
L<nbdkit-floppy-plugin(1)>. To create a Linux compatible virtual
disk, see L<nbdkit-linuxdisk-plugin(1)>.
=head1 EXAMPLE
Create a virtual ISO which supports Joliet, Rock Ridge and TRANS.TBL
extensions, from files in a directory:
nbdkit iso /path/to/directory params='-JrT'
C<params> adds I<-JrT> to the L<xorriso(1)>, L<genisoimage(1)> or
L<mkisofs(1)> command line, specifying the required extensions. Note
that unless you use at least one of these extensions, filenames inside
the ISO will be truncated because of limitations of the basic S<ISO
9660> format.
=head1 PARAMETERS
=over 4
=item [B<dir=>]DIRECTORY
Specify the directory containing files and subdirectories which will
be added to the virtual ISO. Files inside this directory will appear
in the root directory of the ISO.
This parameter is required and may be specified one or more times. If
multiple directories are specified, they are merged together.
C<dir=> __IS_MAGIC__
=item B<params=>'parameters ...'
Any other parameters may be passed through to L<xorriso(1)>,
L<genisoimage(1)> or L<mkisofs(1)> by specifying this option.
For example:
params='-JrT -V "My Disk Image"'
would specify Joliet (I<-J>), Rock Ridge (I<-r>) and TRANS.TBL (I<-T>)
extensions, and specify the volume ID (I<-V>) as C<My Disk Image>.
Take care when quoting this parameter; nbdkit passes the resulting
string through another layer of shell interpretation without any
sanity checks for unquoted shell metacharacters.
=item B<prog=>mkisofs
Choose which program to use to create the ISO content. The default is
L<xorriso(1)>, L<genisoimage(1)> or L<mkisofs(1)> and is picked when
nbdkit is compiled. You only need to use this parameter if you want
to override it at run time.
=back
=head1 DUMP PLUGIN OUTPUT
Use:
nbdkit iso --dump-plugin
to find out which mkisofs-like program was used when the plugin was
compiled. For example:
$ nbdkit iso --dump-plugin | grep ^iso_prog=
iso_prog=xorriso
=head1 ENVIRONMENT VARIABLES
=over 4
=item C<PATH>
L<xorriso(1)>, L<genisoimage(1)>, L<mkisofs(1)> or whatever you supply
to the optional C<prog> parameter must be available on the C<$PATH>.
=item C<TMPDIR>
A temporary copy of the ISO is created in C<TMPDIR>. If this
environment variable is not set then F</var/tmp> is used instead.
There must be enough free space here to store the ISO, which might be
quite large.
=back
=head1 FILES
=over 4
=item F<$plugindir/nbdkit-iso-plugin.so>
The plugin.
Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
=back
=head1 VERSION
C<nbdkit-iso-plugin> first appeared in nbdkit 1.8.
=head1 SEE ALSO
L<nbdkit(1)>,
L<nbdkit-plugin(3)>,
L<nbdkit-file-plugin(1)>,
L<nbdkit-floppy-plugin(1)>,
L<nbdkit-linuxdisk-plugin(1)>,
L<nbdkit-torrent-plugin(1)>,
L<genisoimage(1)>,
L<mkisofs(1)>,
L<xorriso(1)>.
=head1 AUTHORS
Richard W.M. Jones
=head1 COPYRIGHT
Copyright Red Hat
|
