1nbdkit-ddrescue-filter(1)           NBDKIT           nbdkit-ddrescue-filter(1)
2
3
4

NAME

6       nbdkit-ddrescue-filter - nbdkit filter for serving from ddrescue dump
7

SYNOPSIS

9        nbdkit --filter=ddrescue plugin [plugin-args...]
10                                        ddrescue-mapfile=file.map
11
12        nbdkit --filter=ddrescue file file=file.img ddrescue-mapfile=file.map
13                                      [plugin-args...]
14

DESCRIPTION

16       "nbdkit-ddrescue-filter" is a filter for nbdkit(1) which overlays bad
17       blocks according to a GNU ddrescue(1) mapfile.  This is mainly useful
18       for testing disk images recovered with ddrescue, to detect which files
19       or filesystem structures are impacted, or attempting fsck on them.
20
21       Note that the current implementation is read-only.
22

EXAMPLES

24       Expose a rescued disk image with detected bad sectors:
25            nbdkit --filter=ddrescue file file=disk.img ddrescue-mapfile=disk.map
26
27           The above command serves the disk image disk.img and maps the bad
28           sectors listed in disk.img so that read attempts on them do not
29           return a valid block full of zeroes.
30

PARAMETERS

32       The "ddrescue-mapfile" parameter must point to a valid GNU ddrescue
33       mapfile.
34

DATA FORMAT

36       The file pointed to by the "ddrescue-mapfile" parameter should conform
37       to the format of a GNU ddrescue(1) mapfile.
38

FILES

40       $filterdir/nbdkit-ddrescue-filter.so
41           The filter.
42
43           Use "nbdkit --dump-config" to find the location of $filterdir.
44

VERSION

46       "nbdkit-ddrescue-filter" first appeared in nbdkit 1.22.
47

SEE ALSO

49       nbdkit(1), nbdkit-file-plugin(1), nbdkit-filter(3), ddrescue(1),
50       https://www.gnu.org/software/ddrescue/manual/ddrescue_manual.html.
51

AUTHORS

53       François Revol
54

56       Copyright (C) 2020 François Revol
57

LICENSE

59       Redistribution and use in source and binary forms, with or without
60       modification, are permitted provided that the following conditions are
61       met:
62
63       •   Redistributions of source code must retain the above copyright
64           notice, this list of conditions and the following disclaimer.
65
66       •   Redistributions in binary form must reproduce the above copyright
67           notice, this list of conditions and the following disclaimer in the
68           documentation and/or other materials provided with the
69           distribution.
70
71       •   Neither the name of Red Hat nor the names of its contributors may
72           be used to endorse or promote products derived from this software
73           without specific prior written permission.
74
75       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
76       EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
77       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
78       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
79       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
80       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
81       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
82       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
83       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
84       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
85       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
86
87
88
89nbdkit-1.32.5                     2023-01-03         nbdkit-ddrescue-filter(1)
Impressum