filters/partition/nbdkit-partition-filter.pod

   1 =head1 NAME
   2
   3 nbdkit-partition-filter - nbdkit partition filter
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit --filter=partition plugin partition=PART [plugin-args...]
   8
   9 =head1 DESCRIPTION
  10
  11 C<nbdkit-partition-filter> is a filter that limits requests to a
  12 single partition within a disk image that is served by another plugin.
  13
  14 Partition numbers are specified by the required C<partition>
  15 parameter, and count from 1.
  16
  17 This works like the C<qemu-nbd -P> option.
  18
  19 The opposite of this filter is L<nbdkit-partitioning-plugin(1)> which
  20 adds a virtual partition table to a file or files.
  21
  22 =head1 PARAMETERS
  23
  24 =over 4
  25
  26 =item B<partition=>PART
  27
  28 The partition number to serve, counting from 1.
  29
  30 This parameter is required.
  31
  32 =back
  33
  34 =head1 EXAMPLE
  35
  36 F<disk.img> is a partitioned disk image (eg. a virtual machine disk
  37 image).  To serve the first partition only use:
  38
  39  nbdkit --filter=partition file disk.img partition=1
  40
  41 =head1 FILES
  42
  43 =over 4
  44
  45 =item F<$filterdir/nbdkit-partition-filter.so>
  46
  47 The filter.
  48
  49 Use C<nbdkit --dump-config> to find the location of C<$filterdir>.
  50
  51 =back
  52
  53 =head1 VERSION
  54
  55 C<nbdkit-partition-filter> first appeared in nbdkit 1.2.
  56
  57 =head1 SEE ALSO
  58
  59 L<nbdkit(1)>,
  60 L<nbdkit-file-plugin(1)>,
  61 L<nbdkit-filter(3)>,
  62 L<nbdkit-offset-filter(1)>,
  63 L<nbdkit-partitioning-plugin(1)>,
  64 L<nbdkit-protect-filter(1)>,
  65 L<nbdkit-truncate-filter(1)>,
  66 L<parted(8)>.
  67
  68 =head1 AUTHORS
  69
  70 Eric Blake
  71
  72 Richard W.M. Jones
  73
  74 =head1 COPYRIGHT
  75
  76 Copyright Red Hat