filters/readahead/nbdkit-readahead-filter.pod

   1 =head1 NAME
   2
   3 nbdkit-readahead-filter - prefetch data when reading sequentially
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit --filter=readahead plugin
   8
   9 =head1 DESCRIPTION
  10
  11 C<nbdkit-readahead-filter> is a filter that prefetches data when the
  12 client is reading sequentially.
  13
  14 A common use for this filter is to accelerate sequential copy
  15 operations (like S<C<qemu-img convert>>) when plugin requests have a
  16 high overhead (like L<nbdkit-curl-plugin(1)>).  For example:
  17
  18  nbdkit -U - --filter=readahead curl https://example.com/disk.img \
  19         --run 'qemu-img convert $nbd disk.img'
  20
  21 If you use this filter with clients that have a random access pattern
  22 it will slow everything down.
  23
  24 =head1 PARAMETERS
  25
  26 There are no parameters specific to nbdkit-readahead-filter.  Any
  27 parameters are passed through to and processed by the underlying
  28 plugin in the normal way.
  29
  30 =head1 SEE ALSO
  31
  32 L<nbdkit(1)>,
  33 L<nbdkit-cache-filter(1)>,
  34 L<nbdkit-curl-plugin(1)>,
  35 L<nbdkit-filter(3)>,
  36 L<qemu-img(1)>.
  37
  38 =head1 AUTHORS
  39
  40 Richard W.M. Jones
  41
  42 =head1 COPYRIGHT
  43
  44 Copyright (C) 2019 Red Hat Inc.