.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.36.3 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "nbdkit-iso-plugin 1"
.TH nbdkit-iso-plugin 1 2024-01-17 nbdkit-1.36.3 NBDKIT
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
nbdkit\-iso\-plugin \- create virtual ISO (CD\-ROM) from directory
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& nbdkit iso [dir=]DIRECTORY [[dir=]DIRECTORY ...]
\&            [prog=mkisofs] [params=\*(Aq\-JrT\*(Aq]
.Ve
.PP
.Vb 1
\& nbdkit iso \-\-dump\-plugin
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`nbdkit\-iso\-plugin\*(C'\fR is a plugin for \fBnbdkit\fR\|(1) which creates a
virtual ISO (CD-ROM) image from a directory on the fly.  The files
from \fIDIRECTORY\fR are added to a virtual ISO image which is served
read-only over the NBD protocol.
.PP
This plugin uses \fBxorriso\fR\|(1), \fBgenisoimage\fR\|(1) or \fBmkisofs\fR\|(1) to
create the ISO content.  See also "DUMP PLUGIN OUTPUT" below.
.PP
To create a FAT-formatted virtual floppy disk instead of a CD, see
\&\fBnbdkit\-floppy\-plugin\fR\|(1).  To create a Linux compatible virtual
disk, see \fBnbdkit\-linuxdisk\-plugin\fR\|(1).
.SH EXAMPLE
.IX Header "EXAMPLE"
Create a virtual ISO which supports Joliet, Rock Ridge and TRANS.TBL
extensions, from files in a directory:
.PP
.Vb 1
\& nbdkit iso /path/to/directory params=\*(Aq\-JrT\*(Aq
.Ve
.PP
\&\f(CW\*(C`params\*(C'\fR adds \fI\-JrT\fR to the \fBxorriso\fR\|(1), \fBgenisoimage\fR\|(1) or
\&\fBmkisofs\fR\|(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 ISO\ 9660 format.
.SH PARAMETERS
.IX Header "PARAMETERS"
.IP [\fBdir=\fR]DIRECTORY 4
.IX Item "[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.
.Sp
This parameter is required and may be specified one or more times.  If
multiple directories are specified, they are merged together.
.Sp
\&\f(CW\*(C`dir=\*(C'\fR is a magic config key and may be omitted in most cases.
See "Magic parameters" in \fBnbdkit\fR\|(1).
.IP "\fBparams=\fR'parameters ...'" 4
.IX Item "params='parameters ...'"
Any other parameters may be passed through to \fBxorriso\fR\|(1),
\&\fBgenisoimage\fR\|(1) or \fBmkisofs\fR\|(1) by specifying this option.
.Sp
For example:
.Sp
.Vb 1
\& params=\*(Aq\-JrT \-V "My Disk Image"\*(Aq
.Ve
.Sp
would specify Joliet (\fI\-J\fR), Rock Ridge (\fI\-r\fR) and TRANS.TBL (\fI\-T\fR)
extensions, and specify the volume ID (\fI\-V\fR) as \f(CW\*(C`My Disk Image\*(C'\fR.
.Sp
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.
.IP \fBprog=\fRmkisofs 4
.IX Item "prog=mkisofs"
Choose which program to use to create the ISO content.  The default is
\&\fBxorriso\fR\|(1), \fBgenisoimage\fR\|(1) or \fBmkisofs\fR\|(1) and is picked when
nbdkit is compiled.  You only need to use this parameter if you want
to override it at run time.
.SH "DUMP PLUGIN OUTPUT"
.IX Header "DUMP PLUGIN OUTPUT"
Use:
.PP
.Vb 1
\& nbdkit iso \-\-dump\-plugin
.Ve
.PP
to find out which mkisofs-like program was used when the plugin was
compiled.  For example:
.PP
.Vb 2
\& $ nbdkit iso \-\-dump\-plugin | grep ^iso_prog=
\& iso_prog=xorriso
.Ve
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
.ie n .IP """PATH""" 4
.el .IP \f(CWPATH\fR 4
.IX Item "PATH"
\&\fBxorriso\fR\|(1), \fBgenisoimage\fR\|(1), \fBmkisofs\fR\|(1) or whatever you supply
to the optional \f(CW\*(C`prog\*(C'\fR parameter must be available on the \f(CW$PATH\fR.
.ie n .IP """TMPDIR""" 4
.el .IP \f(CWTMPDIR\fR 4
.IX Item "TMPDIR"
A temporary copy of the ISO is created in \f(CW\*(C`TMPDIR\*(C'\fR.  If this
environment variable is not set then \fI/var/tmp\fR is used instead.
There must be enough free space here to store the ISO, which might be
quite large.
.SH FILES
.IX Header "FILES"
.ie n .IP \fR\fI$plugindir\fR\fI/nbdkit\-iso\-plugin.so\fR 4
.el .IP \fR\f(CI$plugindir\fR\fI/nbdkit\-iso\-plugin.so\fR 4
.IX Item "$plugindir/nbdkit-iso-plugin.so"
The plugin.
.Sp
Use \f(CW\*(C`nbdkit \-\-dump\-config\*(C'\fR to find the location of \f(CW$plugindir\fR.
.SH VERSION
.IX Header "VERSION"
\&\f(CW\*(C`nbdkit\-iso\-plugin\*(C'\fR first appeared in nbdkit 1.8.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1),
\&\fBnbdkit\-plugin\fR\|(3),
\&\fBnbdkit\-file\-plugin\fR\|(1),
\&\fBnbdkit\-floppy\-plugin\fR\|(1),
\&\fBnbdkit\-linuxdisk\-plugin\fR\|(1),
\&\fBnbdkit\-torrent\-plugin\fR\|(1),
\&\fBgenisoimage\fR\|(1),
\&\fBmkisofs\fR\|(1),
\&\fBxorriso\fR\|(1).
.SH AUTHORS
.IX Header "AUTHORS"
Richard W.M. Jones
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Red Hat
.SH LICENSE
.IX Header "LICENSE"
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
.IP \(bu 4
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
.IP \(bu 4
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
.IP \(bu 4
Neither the name of Red Hat nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
.PP
THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.