nbdkit-floppy-plugin(1)

1nbdkit-floppy-plugin(1)             NBDKIT             nbdkit-floppy-plugin(1)
2
3
4

NAME

6       nbdkit-floppy-plugin - create virtual floppy disk from directory
7

SYNOPSIS

9        nbdkit floppy [dir=]DIRECTORY
10                      [label=LABEL]
11

DESCRIPTION

13       "nbdkit-floppy-plugin" is a plugin for nbdkit(1) which creates a
14       virtual FAT-formatted floppy disk image from a directory on the fly.
15       The files in the specified directory (and subdirectories) appear in the
16       virtual floppy, which is served read-only over the NBD protocol.
17
18       The virtual floppy disk will have a single partition (using an MBR
19       partition table).  In that partition will be a virtual FAT32 filesystem
20       containing the files.  Long filenames are supported.
21
22       To create a CD/ISO, see nbdkit-iso-plugin(1).  To create a Linux
23       compatible virtual disk, see nbdkit-linuxdisk-plugin(1).
24
25       Note: The plugin does not save a temporary copy of the files, so you
26       must leave the directory alone while nbdkit is running, else you may
27       get an error (for example if the plugin tries to open one of the files
28       which you have moved or deleted).  This is different from how
29       nbdkit-iso-plugin(1) and nbdkit-linuxdisk-plugin(1) work, as both of
30       those plugins keep a temporary copy of the files and directories.
31

EXAMPLE

33       Create a virtual floppy disk:
34
35        nbdkit floppy /path/to/directory
36

PARAMETERS

38       [dir=]DIRECTORY
39           Specify the directory containing files and subdirectories which
40           will be added to the virtual floppy disk.  Files inside this
41           directory will appear in the root directory of the virtual floppy.
42
43           This parameter is required.
44
45           "dir=" is a magic config key and may be omitted in most cases.  See
46           "Magic parameters" in nbdkit(1).
47
48       label=LABEL
49           The optional volume label for the filesystem.  This may be up to 11
50           ASCII characters.  If omitted, "NBDKITFLOPY" is used.
51

LIMITATIONS

53       The maximum size of the disk is around 2TB.  The maximum size of a
54       single file is 4GB.  Non-regular files (such as block special, symbolic
55       links, sockets) are not supported and will be ignored.
56
57       The plugin does not support writes.
58
59       The virtual floppy will not be bootable.  This could be added in future
60       (using SYSLINUX) but requires considerable work.  As a workaround use
61       nbdkit-iso-plugin(1) instead.
62
63       FAT32 is always used, even for small disks (where dosfstools, for
64       example, would choose FAT12 or FAT16).  This results in extra wasted
65       space, but since it is only virtual wasted space it isn't really
66       important, and it simplifies the implementation greatly.
67

FILES

69       $plugindir/nbdkit-floppy-plugin.so
70           The plugin.
71
72           Use "nbdkit --dump-config" to find the location of $plugindir.
73

VERSION

75       "nbdkit-floppy-plugin" first appeared in nbdkit 1.8.
76

AUTHORS

82       Richard W.M. Jones
83

COPYRIGHT

85       Copyright (C) 2018 Red Hat Inc.
86

LICENSE

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