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

NAME

6       nbdkit-example4-plugin - example nbdkit plugin written in Perl
7

SYNOPSIS

9        nbdkit example4 size=<N>
10

EXAMPLE

12        nbdkit example4 size=1048576
13        guestfish -a nbd://localhost
14

DESCRIPTION

16       "nbdkit-example4-plugin" is an example nbdkit(1) plugin written in
17       Perl.
18
19       The "size=N" parameter is required.  It specifies the disk size in
20       bytes.  A single disk image, initially all zeroes, is created and can
21       be read and written by all clients.  When nbdkit shuts down the disk
22       image is thrown away.
23
24       Mainly this is useful for testing and as an example of nbdkit plugins
25       written in Perl.  You should also read nbdkit-plugin(3) and
26       nbdkit-perl-plugin(3).  Note that nbdkit plugins may be written in C or
27       other scripting languages.
28

VERSION

30       "nbdkit-example4-plugin" first appeared in nbdkit 1.2.
31

SEE ALSO

33       https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example4/example4.pl,
34       nbdkit(1), nbdkit-plugin(3), nbdkit-perl-plugin(3).
35

AUTHORS

37       Richard W.M. Jones
38

40       Copyright Red Hat
41

LICENSE

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