Provided by: nbdkit-plugin-dev_1.36.3-1ubuntu10_amd64 bug

NAME
       nbdkit-example2-plugin - example nbdkit plugin


SYNOPSIS
        nbdkit example2 file=FILENAME


DESCRIPTION
       "nbdkit-example2-plugin" is an example nbdkit(1) plugin.

       It serves the named "FILENAME" over NBD, readonly.

       Mainly this is useful for testing nbdkit and as an example for writing nbdkit plugins (nbdkit-plugin(3)).

       There are two variations of this plugin which can be found in the source directory.  example2.c is the
       regular plugin for Linux and other Unix-like systems.  winexample2.c is the same plugin written for
       Windows using Win32 APIs to access the file.


DEBUG FLAGS
       For extra debugging (only useful for developers) use -D example2.extra=1


FILES
       $plugindir/nbdkit-example2-plugin.so
           The plugin.

           Use "nbdkit --dump-config" to find the location of $plugindir.


VERSION
       "nbdkit-example2-plugin" first appeared in nbdkit 1.0.


SEE ALSO
       https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example2/example2.c,
       https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example2/winexample2.c, nbdkit(1), nbdkit-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.

nbdkit-1.36.3                                      2024-03-31                          nbdkit-example2-plugin(1)