.\" Automatically generated by Podwrapper::Man 1.10.3 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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-floppy-plugin 1"
.TH nbdkit-floppy-plugin 1 "2019-01-26" "nbdkit-1.10.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\-floppy\-plugin \- create virtual floppy disk from directory
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& nbdkit floppy [dir=]DIRECTORY
\&               [label=LABEL]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`nbdkit\-floppy\-plugin\*(C'\fR is a plugin for \fBnbdkit\fR\|(1) which creates a
virtual FAT-formatted floppy disk image from a directory on the fly.
The files in the specified directory (and subdirectories) appear in
the virtual floppy, which is served read-only over the \s-1NBD\s0 protocol.
.PP
The virtual floppy disk will have a single partition (using an \s-1MBR\s0
partition table).  In that partition will be a virtual \s-1FAT32\s0
filesystem containing the files.  Long filenames are supported.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
Create a virtual floppy disk:
.PP
.Vb 1
\& nbdkit floppy /path/to/directory
.Ve
.SH "PARAMETERS"
.IX Header "PARAMETERS"
.IP "\fBdir=\fR\s-1DIRECTORY\s0" 4
.IX Item "dir=DIRECTORY"
Specify the directory containing files and subdirectories which will
be added to the virtual floppy disk.  Files inside this directory will
appear in the root directory of the virtual floppy.
.Sp
This parameter is required.
.Sp
In nbdkit ≥ 1.8, \f(CW\*(C`dir=\*(C'\fR may be omitted.  To ensure that the
directory name does not end up being parsed accidentally as
\&\f(CW\*(C`key=value\*(C'\fR, prefix relative paths with \f(CW\*(C`./\*(C'\fR (absolute paths do not
need modification).
.IP "\fBlabel=\fR\s-1LABEL\s0" 4
.IX Item "label=LABEL"
The optional volume label for the filesystem.  This may be up to 11
\&\s-1ASCII\s0 characters.  If omitted, \f(CW\*(C`NBDKITFLOPY\*(C'\fR is used.
.SH "LIMITATIONS"
.IX Header "LIMITATIONS"
The maximum size of the disk is around 2TB.  The maximum size of a
single file is 4GB.  Non-regular files (such as block special,
symbolic links, sockets) are not supported and will be ignored.
.PP
The plugin does not support writes.
.PP
The plugin does not save a temporary copy of the files, so you must
leave the directory alone while nbdkit is running, else you may get an
error for example if the plugin tries to open one of the files which
you have moved or deleted.  (This is different from how
\&\fBnbdkit\-iso\-plugin\fR\|(1) works).
.PP
The virtual floppy will not be bootable.  This could be added in
future (using \s-1SYSLINUX\s0) but requires considerable work.  As a
workaround use \fBnbdkit\-iso\-plugin\fR\|(1) instead.
.PP
\&\s-1FAT32\s0 is always used, even for small disks (where dosfstools, for
example, would choose \s-1FAT12\s0 or \s-1FAT16\s0).  This results in extra wasted
space, but since it is only \fIvirtual\fR wasted space it isn't really
important, and it simplifies the implementation greatly.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1),
\&\fBnbdkit\-plugin\fR\|(3),
\&\fBnbdkit\-file\-plugin\fR\|(1),
\&\fBnbdkit\-iso\-plugin\fR\|(1).
.SH "AUTHORS"
.IX Header "AUTHORS"
Richard W.M. Jones
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2018 Red Hat Inc.
.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
\&\s-1THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS\s0 ''\s-1AS IS\s0'' \s-1AND
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\s0 (\s-1INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES\s0; \s-1LOSS OF
USE, DATA, OR PROFITS\s0; \s-1OR BUSINESS INTERRUPTION\s0) \s-1HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT\s0 (\s-1INCLUDING NEGLIGENCE OR OTHERWISE\s0) \s-1ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.\s0