plugins/gzip/nbdkit-gzip-plugin.pod

   1 =head1 NAME
   2
   3 nbdkit-gzip-plugin - nbdkit gzip plugin
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit gzip [file=]FILENAME.gz
   8
   9 =head1 DESCRIPTION
  10
  11 C<nbdkit-gzip-plugin> is a file serving plugin for L<nbdkit(1)>.
  12
  13 It serves the named C<FILENAME.gz> over NBD, uncompressing it on the
  14 fly.  The plugin only supports read-only connections.
  15
  16 B<Note> that gzip files are not very good for random access in large
  17 files because seeking to a position in the gzip file involves
  18 uncompressing lots of data.  A more practical method to compress large
  19 disk images is to use the L<xz(1)> format and L<nbdkit-xz-plugin(1)>.
  20
  21 =head1 PARAMETERS
  22
  23 =over 4
  24
  25 =item [B<file=>]FILENAME.gz
  26
  27 Serve the compressed file named C<FILENAME.gz>.
  28
  29 This parameter is required.
  30
  31 C<file=> is a magic config key and may be omitted in most cases.
  32 See L<nbdkit(1)/Magic parameters>.
  33
  34 =back
  35
  36 =head1 FILES
  37
  38 =over 4
  39
  40 =item F<$plugindir/nbdkit-gzip-plugin.so>
  41
  42 The plugin.
  43
  44 Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
  45
  46 =back
  47
  48 =head1 VERSION
  49
  50 C<nbdkit-gzip-plugin> first appeared in nbdkit 1.2.
  51
  52 =head1 SEE ALSO
  53
  54 L<nbdkit-xz-plugin(1)>,
  55 L<nbdkit(1)>,
  56 L<nbdkit-plugin(3)>.
  57
  58 =head1 AUTHORS
  59
  60 Richard W.M. Jones
  61
  62 =head1 COPYRIGHT
  63
  64 Copyright (C) 2013 Red Hat Inc.