NAME

       nbdkit-gzip-plugin - nbdkit gzip plugin

SYNOPSIS

        nbdkit gzip [file=]FILENAME.gz

DESCRIPTION

       "nbdkit-gzip-plugin" is a file serving plugin for nbdkit(1).

       It serves the named "FILENAME.gz" over NBD, uncompressing it on the fly.  The plugin only supports read-
       only connections.

       Note that gzip files are not very good for random access in large files because seeking to a position in
       the gzip file involves uncompressing lots of data.  A more practical method to compress large disk images
       is to use the xz(1) format and nbdkit-xz-plugin(1).

PARAMETERS

       [file=]FILENAME.gz
           Serve the compressed file named "FILENAME.gz".

           This parameter is required.

           "file=" is a magic config key and may be omitted in most cases.  See "Magic parameters" in nbdkit(1).

FILES

       $plugindir/nbdkit-gzip-plugin.so
           The plugin.

           Use "nbdkit --dump-config" to find the location of $plugindir.

VERSION

       "nbdkit-gzip-plugin" first appeared in nbdkit 1.0.

SEE ALSO

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

AUTHORS

       Richard W.M. Jones

COPYRIGHT

       Copyright (C) 2013 Red Hat Inc.

LICENSE

       Redistribution and use in source and binary forms, with or without modification, are permitted provided
       that the following conditions are met:

       •   Redistributions of source code must retain the above copyright notice, this list of conditions and
           the following disclaimer.

       •   Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
           the following disclaimer in the documentation and/or other materials provided with the distribution.

       •   Neither the name of Red Hat nor the names of its contributors may be used to endorse or promote
           products derived from this software without specific prior written permission.

       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
       INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
       INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
       ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGE.