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

NAME

6       nbdkit-example3-plugin - example nbdkit plugin
7

SYNOPSIS

9        nbdkit example3 [size=SIZE]
10

EXAMPLE

12        nbdkit example3 size=1G
13        guestfish --ro --format=raw -a nbd://localhost
14

DESCRIPTION

16       "nbdkit-example3-plugin" is an example nbdkit(1) plugin.
17
18       On each connection, it generates a temporary writable block device of
19       size "SIZE".  The disk is thrown away when the client disconnects.
20
21       The "size=SIZE" parameter can use a number of common formats to specify
22       the size, eg. "100M", "2G".  If the parameter is omitted, it defaults
23       to 100M.
24
25       Mainly this is useful for testing nbdkit and as an example for writing
26       nbdkit plugins (nbdkit-plugin(3)).
27

FILES

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

VERSION

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

SEE ALSO

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

AUTHORS

42       Richard W.M. Jones
43

45       Copyright (C) 2013 Red Hat Inc.
46

LICENSE

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