plugins/gzip/nbdkit-gzip-plugin.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 nbdkit-gzip-plugin - nbdkit gzip plugin
   6
   7 =head1 SYNOPSIS
   8
   9  nbdkit gzip file=FILENAME.gz
  10
  11 =head1 DESCRIPTION
  12
  13 C<nbdkit-gzip-plugin> is a file serving plugin for L<nbdkit(1)>.
  14
  15 It serves the named C<FILENAME.gz> over NBD, uncompressing it on the
  16 fly.  The plugin only supports read-only connections.
  17
  18 B<Note> that gzip files are not very good for random access in large
  19 files because seeking to a position in the gzip file involves
  20 uncompressing lots of data.  A more practical method to compress large
  21 disk images is to use the L<xz(1)> format and L<nbdkit-xz-plugin(1)>.
  22
  23 =head1 SEE ALSO
  24
  25 L<nbdkit-xz-plugin(1)>,
  26 L<nbdkit(1)>,
  27 L<nbdkit-plugin(3)>.
  28
  29 =head1 AUTHORS
  30
  31 Richard W.M. Jones
  32
  33 =head1 COPYRIGHT
  34
  35 Copyright (C) 2013 Red Hat Inc.
  36
  37 =head1 LICENSE
  38
  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 =over 4
  44
  45 =item *
  46
  47 Redistributions of source code must retain the above copyright
  48 notice, this list of conditions and the following disclaimer.
  49
  50 =item *
  51
  52 Redistributions in binary form must reproduce the above copyright
  53 notice, this list of conditions and the following disclaimer in the
  54 documentation and/or other materials provided with the distribution.
  55
  56 =item *
  57
  58 Neither the name of Red Hat nor the names of its contributors may be
  59 used to endorse or promote products derived from this software without
  60 specific prior written permission.
  61
  62 =back
  63
  64 THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
  65 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  66 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  67 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
  68 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  69 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  70 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  71 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  72 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  73 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  74 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  75 SUCH DAMAGE.