plugins/example3/nbdkit-example3-plugin.pod

   1 =head1 NAME
   2
   3 nbdkit-example3-plugin - example nbdkit plugin
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit example3 [size=SIZE]
   8
   9 =head1 EXAMPLE
  10
  11  nbdkit example3 size=1G
  12  guestfish --ro --format=raw -a nbd://localhost
  13
  14 =head1 DESCRIPTION
  15
  16 C<nbdkit-example3-plugin> is an example L<nbdkit(1)> plugin.
  17
  18 On each connection, it generates a temporary writable block device of
  19 size C<SIZE>.  The disk is thrown away when the client disconnects.
  20
  21 The C<size=SIZE> parameter can use a number of common formats to
  22 specify the size, eg. C<100M>, C<2G>.  If the parameter is omitted, it
  23 defaults to 100M.
  24
  25 Mainly this is useful for testing nbdkit and as an example for writing
  26 nbdkit plugins (L<nbdkit-plugin(3)>).
  27
  28 =head1 FILES
  29
  30 =over 4
  31
  32 =item F<$plugindir/nbdkit-example3-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-example3-plugin> first appeared in nbdkit 1.0.
  43
  44 =head1 SEE ALSO
  45
  46 L<https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example3/example3.c>,
  47 L<nbdkit(1)>,
  48 L<nbdkit-plugin(3)>
  49
  50 =head1 AUTHORS
  51
  52 Richard W.M. Jones
  53
  54 =head1 COPYRIGHT
  55
  56 Copyright Red Hat