plugins/example3/nbdkit-example3-plugin.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 nbdkit-example3-plugin - An example nbdkit plugin
   6
   7 =head1 SYNOPSIS
   8
   9  nbdkit .../plugins/nbdkit-example3-plugin.so [size=SIZE]
  10
  11 =head1 EXAMPLE
  12
  13  nbdkit .../plugins/nbdkit-example3-plugin.so size=1G
  14  guestfish -a nbd://localhost
  15
  16 =head1 DESCRIPTION
  17
  18 C<nbdkit-example3-plugin> is an example L<nbdkit(1)> plugin.
  19
  20 On each connection, it generates a temporary writable block device of
  21 size C<SIZE>.  The disk is thrown away when the client disconnects.
  22
  23 The C<size=SIZE> parameter can use a number of common formats to
  24 specify the size, eg. C<100M>, C<2G>.  If the parameter is omitted, it
  25 default to 100 megabytes.
  26
  27 Mainly this is useful for testing nbdkit and as an example for writing
  28 nbdkit plugins (L<nbdkit-plugin(3)>).
  29
  30 =head1 SEE ALSO
  31
  32 L<example3.c> in the nbdkit source tree,
  33 L<nbdkit(1)>,
  34 L<nbdkit-plugin(3)>
  35
  36 =head1 AUTHORS
  37
  38 Richard W.M. Jones
  39
  40 =head1 COPYRIGHT
  41
  42 Copyright (C) 2013 Red Hat Inc.
  43
  44 =head1 LICENSE
  45
  46 Redistribution and use in source and binary forms, with or without
  47 modification, are permitted provided that the following conditions are
  48 met:
  49
  50 =over 4
  51
  52 =item *
  53
  54 Redistributions of source code must retain the above copyright
  55 notice, this list of conditions and the following disclaimer.
  56
  57 =item *
  58
  59 Redistributions in binary form must reproduce the above copyright
  60 notice, this list of conditions and the following disclaimer in the
  61 documentation and/or other materials provided with the distribution.
  62
  63 =item *
  64
  65 Neither the name of Red Hat nor the names of its contributors may be
  66 used to endorse or promote products derived from this software without
  67 specific prior written permission.
  68
  69 =back
  70
  71 THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
  72 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  73 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  74 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
  75 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  76 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  77 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  78 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  79 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  80 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  81 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  82 SUCH DAMAGE.