nbdkit-example2-plugin.pod

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