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

NAME

6       nbdkit-example3-plugin - An 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

SEE ALSO

29       <https://github.com/libguestfs/nbdkit/blob/master/plugins/example3/example3.c>,
30       nbdkit(1), nbdkit-plugin(3)
31

AUTHORS

33       Richard W.M. Jones
34

36       Copyright (C) 2013 Red Hat Inc.
37

LICENSE

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