plugins/floppy/nbdkit-floppy-plugin.pod

   1 =head1 NAME
   2
   3 nbdkit-floppy-plugin - create virtual floppy disk from directory
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit floppy [dir=]DIRECTORY
   8                [label=LABEL] [size=SIZE]
   9
  10 =head1 DESCRIPTION
  11
  12 C<nbdkit-floppy-plugin> is a plugin for L<nbdkit(1)> which creates a
  13 virtual FAT-formatted floppy disk image from a directory on the fly.
  14 The files in the specified directory (and subdirectories) appear in
  15 the virtual floppy, which is served read-only over the NBD protocol.
  16
  17 The virtual floppy disk will have a single partition (using an MBR
  18 partition table).  In that partition will be a virtual FAT32
  19 filesystem containing the files.  Long filenames are supported.
  20
  21 To create a CD/ISO, see L<nbdkit-iso-plugin(1)>.  To create a Linux
  22 compatible virtual disk, see L<nbdkit-linuxdisk-plugin(1)>.
  23
  24 B<Note:> The plugin does not save a temporary copy of the files, so
  25 you must leave the directory alone while nbdkit is running, else you
  26 may get an error (for example if the plugin tries to open one of the
  27 files which you have moved or deleted).  This is different from how
  28 L<nbdkit-iso-plugin(1)> and L<nbdkit-linuxdisk-plugin(1)> work, as
  29 both of those plugins keep a temporary copy of the files and
  30 directories.
  31
  32 =head1 EXAMPLE
  33
  34 Create a virtual floppy disk:
  35
  36  nbdkit floppy /path/to/directory
  37
  38 =head1 PARAMETERS
  39
  40 =over 4
  41
  42 =item [B<dir=>]DIRECTORY
  43
  44 Specify the directory containing files and subdirectories which will
  45 be added to the virtual floppy disk.  Files inside this directory will
  46 appear in the root directory of the virtual floppy.
  47
  48 This parameter is required.
  49
  50 C<dir=> is a magic config key and may be omitted in most cases.
  51 See L<nbdkit(1)/Magic parameters>.
  52
  53 =item B<label=>LABEL
  54
  55 The optional volume label for the filesystem.  This may be up to 11
  56 ASCII characters.  If omitted, C<NBDKITFLOPY> is used.
  57
  58 =item B<size=>SIZE
  59
  60 Optional total disk size.  If omitted then the disk will only be large
  61 enough to store all the files and directories from C<DIRECTORY> with
  62 no free space.
  63
  64 =back
  65
  66 =head1 LIMITATIONS
  67
  68 The maximum size of the disk is around 2TB.  The maximum size of a
  69 single file is 4GB.  Non-regular files (such as block special,
  70 symbolic links, sockets) are not supported and will be ignored.
  71
  72 The plugin does not support writes.  L<nbdkit-cow-filter(1)> can be
  73 placed on top to enable writes, but they will be thrown away when
  74 nbdkit exits and not written to the underlying directory.
  75
  76 The virtual floppy will not be bootable.  This could be added in
  77 future (using SYSLINUX) but requires considerable work.  As a
  78 workaround use L<nbdkit-iso-plugin(1)> instead.
  79
  80 FAT32 is always used, even for small disks (where dosfstools, for
  81 example, would choose FAT12 or FAT16).  This results in extra wasted
  82 space, but since it is only I<virtual> wasted space it isn't really
  83 important, and it simplifies the implementation greatly.
  84
  85 =head1 FILES
  86
  87 =over 4
  88
  89 =item F<$plugindir/nbdkit-floppy-plugin.so>
  90
  91 The plugin.
  92
  93 Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
  94
  95 =back
  96
  97 =head1 VERSION
  98
  99 C<nbdkit-floppy-plugin> first appeared in nbdkit 1.8.
 100
 101 =head1 SEE ALSO
 102
 103 L<nbdkit(1)>,
 104 L<nbdkit-plugin(3)>,
 105 L<nbdkit-file-plugin(1)>,
 106 L<nbdkit-linuxdisk-plugin(1)>,
 107 L<nbdkit-iso-plugin(1)>.
 108
 109 =head1 AUTHORS
 110
 111 Richard W.M. Jones
 112
 113 =head1 COPYRIGHT
 114
 115 Copyright Red Hat