nbdkit-example3-plugin(1)

📦
version 1.48.1 · 14 versions
, in fedora 44

💖 nbdkit-example3-plugin(1) 💖

okay bestie, welcome to the nbdkit-example3-plugin manual page, straight out of the NBDKIT corner of the universe ✨ this is the lil page that tells you all about the example nbdkit plugin 🎀

✨ NAME ✨

nbdkit-example3-plugin — it's literally an example nbdkit plugin, that's the whole vibe 🦋

🌸 SYNOPSIS 🌸

nbdkit example3 [size=SIZE]

🍓 EXAMPLE 🍓

nbdkit example3 size=1G
guestfish --ro --format=raw -a nbd://localhost

👑 DESCRIPTION 👑

nbdkit-example3-plugin is, and I cannot stress this enough, an example nbdkit(1) plugin 💅

Every single time a connection shows up, it spins up a temporary writable block device of size SIZE. And then? The second the client disconnects, the disk is thrown away — gone, poof, no cap, absolutely zero object permanence 😭💀

The size=SIZE parameter is flexible like that and can take a bunch of common formats to say how big you want it, eg. 100M, 2G. If you just… don't pass it at all? It defaults to 100M, no questions asked 🫶

Mostly this is here for testing nbdkit and for being a little example you can peek at while writing your own nbdkit plugins (nbdkit-plugin(3)). Iconic behaviour, honestly 🌈

🎀 FILES 🎀

  • $plugindir/nbdkit-example3-plugin.so — the plugin itself, the whole main character 💖 Run nbdkit --dump-config to find out where $plugindir is living these days, iykyk.

⭐ VERSION ⭐

nbdkit-example3-plugin first appeared in nbdkit 1.0. baby's first glow-up ✨

🦋 SEE ALSO 🦋

💜 AUTHORS 💜

Richard W.M. Jones — we stan 💅

Copyright Red Hat

🔥 LICENSE 🔥

okay so legally speaking, 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.

like… that's the whole disclaimer bestie, read it, it's giving very serious legal energy 🙈

and that's the page!! this lil slice of documentation came from nbdkit-1.48.1, dated 2026-08-29, and it's the nbdkit-example3-plugin(1) page 💖 bye bestie, go write a plugin 🧚✨

📦 where this page comes from