plugins/example1/nbdkit-example1-plugin.pod

   1 =head1 NAME
   2
   3 nbdkit-example1-plugin - minimal nbdkit plugin
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit example1
   8
   9 =head1 DESCRIPTION
  10
  11 C<nbdkit-example1-plugin> is a minimal L<nbdkit(1)> plugin.
  12
  13 It serves, readonly, from memory, a static blob of data which looks a
  14 little bit like a 100 MB disk image that contains a single empty
  15 partition.
  16
  17 Mainly this is useful for testing nbdkit and as an example for writing
  18 nbdkit plugins (L<nbdkit-plugin(3)>).
  19
  20 =head1 FILES
  21
  22 =over 4
  23
  24 =item F<$plugindir/nbdkit-example1-plugin.so>
  25
  26 The plugin.
  27
  28 Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
  29
  30 =back
  31
  32 =head1 VERSION
  33
  34 C<nbdkit-example1-plugin> first appeared in nbdkit 1.0.
  35
  36 =head1 SEE ALSO
  37
  38 L<https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example1/example1.c>,
  39 L<nbdkit(1)>,
  40 L<nbdkit-plugin(3)>
  41
  42 =head1 AUTHORS
  43
  44 Richard W.M. Jones
  45
  46 =head1 COPYRIGHT
  47
  48 Copyright Red Hat