plugins/example2/nbdkit-example2-plugin.pod

   1 =head1 NAME
   2
   3 nbdkit-example2-plugin - example nbdkit plugin
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit example2 file=FILENAME
   8
   9 =head1 DESCRIPTION
  10
  11 C<nbdkit-example2-plugin> is an example L<nbdkit(1)> plugin.
  12
  13 It serves the named C<FILENAME> over NBD, readonly.
  14
  15 Mainly this is useful for testing nbdkit and as an example for writing
  16 nbdkit plugins (L<nbdkit-plugin(3)>).
  17
  18 There are two variations of this plugin which can be found in the
  19 source directory.  F<example2.c> is the regular plugin for Linux and
  20 other Unix-like systems.  F<winexample2.c> is the same plugin written
  21 for Windows using Win32 APIs to access the file.
  22
  23 =head1 DEBUG FLAGS
  24
  25 For extra debugging (only useful for developers) use
  26 S<I<-D example2.extra=1>>
  27
  28 =head1 FILES
  29
  30 =over 4
  31
  32 =item F<$plugindir/nbdkit-example2-plugin.so>
  33
  34 The plugin.
  35
  36 Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
  37
  38 =back
  39
  40 =head1 VERSION
  41
  42 C<nbdkit-example2-plugin> first appeared in nbdkit 1.0.
  43
  44 =head1 SEE ALSO
  45
  46 L<https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example2/example2.c>,
  47 L<https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example2/winexample2.c>,
  48 L<nbdkit(1)>,
  49 L<nbdkit-plugin(3)>
  50
  51 =head1 AUTHORS
  52
  53 Richard W.M. Jones
  54
  55 =head1 COPYRIGHT
  56
  57 Copyright Red Hat