plugins/null/nbdkit-null-plugin.pod

   1 =head1 NAME
   2
   3 nbdkit-null-plugin - nbdkit bitbucket plugin
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit null [[size=]SIZE]
   8
   9 =head1 DESCRIPTION
  10
  11 C<nbdkit-null-plugin> is a null plugin for L<nbdkit(1)>.  Everything
  12 written to the virtual device is discarded, and reads back as zeroes.
  13
  14 Most NBD consumers will be very confused by this device.  Trying to
  15 create filesystems etc on it will likely fail badly.  If the client is
  16 caching writes locally then you will get inconsistent read behaviour.
  17
  18 The null plugin is also used when probing for installed filters, see
  19 L<nbdkit-probing(1)/Detect if a filter is installed>.
  20
  21 =head1 PARAMETERS
  22
  23 =over 4
  24
  25 =item [B<size=>]SIZE
  26
  27 Specify the virtual size of the disk image.
  28
  29 This parameter is optional.  If omitted then a zero-sized device is
  30 created.
  31
  32 C<size=> is a magic config key and may be omitted in most cases.
  33 See L<nbdkit(1)/Magic parameters>.
  34
  35 =back
  36
  37 =head1 FILES
  38
  39 =over 4
  40
  41 =item F<$plugindir/nbdkit-null-plugin.so>
  42
  43 The plugin.
  44
  45 Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
  46
  47 =back
  48
  49 =head1 VERSION
  50
  51 C<nbdkit-null-plugin> first appeared in nbdkit 1.2.
  52
  53 =head1 SEE ALSO
  54
  55 L<nbdkit(1)>,
  56 L<nbdkit-plugin(3)>,
  57 L<nbdkit-full-plugin(1)>,
  58 L<nbdkit-pattern-plugin(1)>,
  59 L<nbdkit-random-plugin(1)>.
  60 L<nbdkit-sparse-random-plugin(1)>,
  61 L<nbdkit-zero-plugin(1)>.
  62
  63 =head1 AUTHORS
  64
  65 Richard W.M. Jones
  66
  67 =head1 COPYRIGHT
  68
  69 Copyright Red Hat