1nbdkit-example1-plugin(1)           NBDKIT           nbdkit-example1-plugin(1)
2
3
4

NAME

6       nbdkit-example1-plugin - minimal nbdkit plugin
7

SYNOPSIS

9        nbdkit example1
10

DESCRIPTION

12       "nbdkit-example1-plugin" is a minimal nbdkit(1) plugin.
13
14       It serves, readonly, from memory, a static blob of data which looks a
15       little bit like a 100 MB disk image that contains a single empty
16       partition.
17
18       Mainly this is useful for testing nbdkit and as an example for writing
19       nbdkit plugins (nbdkit-plugin(3)).
20

FILES

22       $plugindir/nbdkit-example1-plugin.so
23           The plugin.
24
25           Use "nbdkit --dump-config" to find the location of $plugindir.
26

VERSION

28       "nbdkit-example1-plugin" first appeared in nbdkit 1.0.
29

SEE ALSO

31       https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example1/example1.c,
32       nbdkit(1), nbdkit-plugin(3)
33

AUTHORS

35       Richard W.M. Jones
36

38       Copyright Red Hat
39

LICENSE

41       Redistribution and use in source and binary forms, with or without
42       modification, are permitted provided that the following conditions are
43       met:
44
45       •   Redistributions of source code must retain the above copyright
46           notice, this list of conditions and the following disclaimer.
47
48       •   Redistributions in binary form must reproduce the above copyright
49           notice, this list of conditions and the following disclaimer in the
50           documentation and/or other materials provided with the
51           distribution.
52
53       •   Neither the name of Red Hat nor the names of its contributors may
54           be used to endorse or promote products derived from this software
55           without specific prior written permission.
56
57       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
58       EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
59       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
60       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
61       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
62       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
63       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
64       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
65       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
66       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
67       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
68
69
70
71nbdkit-1.34.4                     2023-09-26         nbdkit-example1-plugin(1)
Impressum