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

NAME

6       nbdkit-gzip-plugin - nbdkit gzip plugin
7

SYNOPSIS

9        nbdkit gzip [file=]FILENAME.gz
10

DESCRIPTION

12       "nbdkit-gzip-plugin" is a file serving plugin for nbdkit(1).
13
14       It serves the named "FILENAME.gz" over NBD, uncompressing it on the
15       fly.  The plugin only supports read-only connections.
16
17       Note that gzip files are not very good for random access in large files
18       because seeking to a position in the gzip file involves uncompressing
19       lots of data.  A more practical method to compress large disk images is
20       to use the xz(1) format and nbdkit-xz-plugin(1).
21

PARAMETERS

23       [file=]FILENAME.gz
24           Serve the compressed file named "FILENAME.gz".
25
26           This parameter is required.
27
28           "file=" is a magic config key and may be omitted in most cases.
29           See "Magic parameters" in nbdkit(1).
30

FILES

32       $plugindir/nbdkit-gzip-plugin.so
33           The plugin.
34
35           Use "nbdkit --dump-config" to find the location of $plugindir.
36

VERSION

38       "nbdkit-gzip-plugin" first appeared in nbdkit 1.2.
39

SEE ALSO

41       nbdkit-xz-plugin(1), nbdkit(1), nbdkit-plugin(3).
42

AUTHORS

44       Richard W.M. Jones
45

47       Copyright (C) 2013 Red Hat Inc.
48

LICENSE

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