NAME

       nbdkit-example4-plugin - example nbdkit plugin written in Perl

SYNOPSIS

        nbdkit example4 size=<N>

EXAMPLE

        nbdkit example4 size=1048576
        guestfish -a nbd://localhost

DESCRIPTION

       "nbdkit-example4-plugin" is an example nbdkit(1) plugin written in Perl.

       The "size=N" parameter is required.  It specifies the disk size in bytes.  A single disk
       image, initially all zeroes, is created and can be read and written by all clients.  When
       nbdkit shuts down the disk image is thrown away.

       Mainly this is useful for testing and as an example of nbdkit plugins written in Perl.
       You should also read nbdkit-plugin(3) and nbdkit-perl-plugin(3).  Note that nbdkit plugins
       may be written in C or other scripting languages.

VERSION

       "nbdkit-example4-plugin" first appeared in nbdkit 1.2.

SEE ALSO

       https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example4/example4.pl, nbdkit(1),
       nbdkit-plugin(3), nbdkit-perl-plugin(3).

AUTHORS

       Richard W.M. Jones

COPYRIGHT

       Copyright Red Hat

LICENSE

       Redistribution and use in source and binary forms, with or without modification, are
       permitted provided that the following conditions are met:

       •   Redistributions of source code must retain the above copyright notice, this list of
           conditions and the following disclaimer.

       •   Redistributions in binary form must reproduce the above copyright notice, this list of
           conditions and the following disclaimer in the documentation and/or other materials
           provided with the distribution.

       •   Neither the name of Red Hat nor the names of its contributors may be used to endorse
           or promote products derived from this software without specific prior written
           permission.

       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED
       WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
       FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS
       BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
       DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
       OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
       LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
       POSSIBILITY OF SUCH DAMAGE.