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

NAME

6       nbdkit-example2-plugin - example nbdkit plugin
7

SYNOPSIS

9        nbdkit example2 file=FILENAME
10

DESCRIPTION

12       "nbdkit-example2-plugin" is an example nbdkit(1) plugin.
13
14       It serves the named "FILENAME" over NBD, readonly.
15
16       Mainly this is useful for testing nbdkit and as an example for writing
17       nbdkit plugins (nbdkit-plugin(3)).
18
19       There are two variations of this plugin which can be found in the
20       source directory.  example2.c is the regular plugin for Linux and other
21       Unix-like systems.  winexample2.c is the same plugin written for
22       Windows using Win32 APIs to access the file.
23

DEBUG FLAGS

25       For extra debugging (only useful for developers) use
26       -D example2.extra=1
27

FILES

29       $plugindir/nbdkit-example2-plugin.so
30           The plugin.
31
32           Use "nbdkit --dump-config" to find the location of $plugindir.
33

VERSION

35       "nbdkit-example2-plugin" first appeared in nbdkit 1.0.
36

SEE ALSO

38       https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example2/example2.c,
39       https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example2/winexample2.c,
40       nbdkit(1), nbdkit-plugin(3)
41

AUTHORS

43       Richard W.M. Jones
44

46       Copyright Red Hat
47

LICENSE

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