nbdkit-example1-plugin(1)

📦
version 1.48.1 · 14 versions
, in fedora 44

💅 nbdkit-example1-plugin(1) 💅

okay bestie, buckle up, we're reading the manual for nbdkit-example1-plugin from the nbdkit suite. it's tiny. it's iconic. it's literally the baby plugin. 🍼✨

✨ NAME ✨

nbdkit-example1-plugin — the absolute minimal nbdkit plugin, no cap 🫶

🎀 SYNOPSIS 🎀

nbdkit example1

🦋 DESCRIPTION 🦋

so nbdkit-example1-plugin is a minimal nbdkit(1) plugin. like, the bare minimum. the blueprint. the starter pack. 💖

it serves, readonly, straight from memory, a static blob of data that looks a little bit like a 100 MB disk image containing a single empty partition. that's it. that's the whole vibe. 🗂️✨

ngl the main reason it exists is:

  • testing nbdkit itself 🧪
  • being the example you copy from when you're writing your own nbdkit plugins (nbdkit-plugin(3)) 👑
it's giving "hello world" but make it a disk image. lowkey obsessed. 🫶

🌸 FILES 🌸

  • $plugindir/nbdkit-example1-plugin.so — the plugin itself, the whole main character 💅

to find where $plugindir actually lives, just run nbdkit --dump-config and it'll tell you fr fr 🔍

⭐ VERSION ⭐

nbdkit-example1-plugin first appeared in nbdkit 1.0 — yes she's an OG, she's been here since the beginning 🎀

🌈 SEE ALSO 🌈

go read the source bestie, it's right there, it's literally one file 😭💜

👑 AUTHORS 👑

Richard W.M. Jones — the legend, the blueprint, the moment ✨

Copyright Red Hat

📜 LICENSE 📜

okay so here's the legal bit, and I'm keeping it word for word because that's how licenses work, no editing, no vibes-based paraphrasing, periodt:

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.
bestie this is the "AS IS" part, meaning no warranty, so please don't come for anyone if it breaks, iykyk 💀

and that's the whole page!! this beauty shipped as part of nbdkit-1.48.1, dated 2026-08-29, and this manual page is nbdkit-example1-plugin(1). mwah, go forth and write plugins 🫶💅🎀

📦 where this page comes from