nbdkit-ddrescue-filter(1)

📦
version 1.48.1 · 14 versions
, in fedora 44

💾 nbdkit-ddrescue-filter(1) — bestie edition

okay so this is the manual for nbdkit-ddrescue-filter</p>, living in the NBDKIT manual family. buckle up, it's a short one but it's got ✨lore✨

🌸 NAME 🌸

nbdkit-ddrescue-filter</p> — an nbdkit filter for serving from a ddrescue dump 🦋

✨ SYNOPSIS ✨

nbdkit --filter=ddrescue plugin [plugin-args...]
                                ddrescue-mapfile=file.map

nbdkit --filter=ddrescue file file=file.img ddrescue-mapfile=file.map
                              [plugin-args...]

💅 DESCRIPTION 💅

so nbdkit-ddrescue-filter</p> is a filter for nbdkit(1) that overlays bad blocks according to a GNU ddrescue(1) mapfile. it's giving "detective mode for your cursed disk image" 🔍

what's it for? mainly testing disk images that got recovered with ddrescue — so you can figure out which files or filesystem structures are impacted, or attempt fsck on them. iconic recovery-girl behavior, no cap.

heads up bestie: the current implementation is read-only. no writing, no editing, we only look 💀

🔥 EXAMPLES 🔥

expose a rescued disk image with detected bad sectors:

nbdkit --filter=ddrescue file file=disk.img ddrescue-mapfile=disk.map

the above command serves the disk image disk.img and maps the bad sectors listed in disk.img so that read attempts on them do not return a valid block full of zeroes. periodt. 🎀

🌈 PARAMETERS 🌈

  • ddrescue-mapfile</p> — must point to a valid GNU ddrescue mapfile. that's the whole parameter list. short king 👑

🦋 DATA FORMAT 🦋

the file pointed to by the ddrescue-mapfile</p> parameter should conform to the format of a GNU ddrescue(1) mapfile. iykyk 💜

🎀 FILES 🎀

  • $filterdir/nbdkit-ddrescue-filter.so</p> — the filter itself, the main character 💅
    • use nbdkit --dump-config</p> to find the location of $filterdir. yes literally just run that, it'll tell you where your filterdir lives ✨

⭐ VERSION ⭐

nbdkit-ddrescue-filter</p> first appeared in nbdkit 1.22. a baby in nbdkit years 🍼

👑 SEE ALSO 👑

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

go read those too, bestie, they're the whole friend group 🫶

💖 AUTHORS 💖

François Revol 🌟

Copyright (C) 2020 François Revol

🧚 LICENSE 🧚

redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of Red Hat nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

okay that's the whole page, you ate it, congrats 🎉

this little bundle of joy comes to you from nbdkit-1.48.1, dated 2026-08-29, and it is officially nbdkit-ddrescue-filter(1). mwah 💋 bye bestie!! 🌸🦋💜

📦 where this page comes from