server/crypto.c: Improve error messages in crypto_send
[nbdkit.git] / filters / noextents / nbdkit-noextents-filter.pod
blob47daf5cb3d76624cd6a1d6ef76bdd2826de44139
1 =head1 NAME
3 nbdkit-noextents-filter - disable extents in the underlying plugin
5 =head1 SYNOPSIS
7  nbdkit --filter=noextents plugin
9 =head1 DESCRIPTION
11 “Extents” are a feature of the NBD protocol / nbdkit which allow the
12 client to detect sparse regions of the underlying disk.
13 C<nbdkit-noextents-filter> disables this so that the plugin appears to
14 be fully allocated, at least to a client that requests structured
15 replies.  It is also possible to use the I<--no-sr> option to nbdkit
16 to prevent the client from using structured replies, which among its
17 other side effects will prevent the client from querying extents at
18 all.
20 This filter can be useful when combined with L<nbdkit-file-plugin(1)>
21 serving a file from a file system known to have poor C<lseek(2)>
22 performance (C<tmpfs> is known to be one such system).
24 =head1 PARAMETERS
26 There are no parameters specific to nbdkit-noextents-filter.  Any
27 parameters are passed through to and processed by the underlying
28 plugin in the normal way.
30 =head1 FILES
32 =over 4
34 =item F<$filterdir/nbdkit-noextents-filter.so>
36 The filter.
38 Use C<nbdkit --dump-config> to find the location of C<$filterdir>.
40 =back
42 =head1 VERSION
44 C<nbdkit-noextents-filter> first appeared in nbdkit 1.14.
46 =head1 SEE ALSO
48 L<nbdkit(1)>,
49 L<nbdkit-filter(3)>,
50 L<nbdkit-extentlist-filter(1)>,
51 L<nbdkit-fua-filter(1)>,
52 L<nbdkit-multi-conn-filter(1)>,
53 L<nbdkit-nocache-filter(1)>,
54 L<nbdkit-noparallel-filter(1)>,
55 L<nbdkit-nozero-filter(1)>,
56 L<nbdkit-file-plugin(1)>.
58 =head1 AUTHORS
60 Richard W.M. Jones
62 =head1 COPYRIGHT
64 Copyright Red Hat