nbdkit-example2-plugin(1)

📦
version 1.48.1 · 14 versions
, in fedora 44

✨ nbdkit-example2-plugin(1) ✨

okay bestie, welcome to the nbdkit manual, page for nbdkit-example2-plugin 💖

🌸 NAME 🌸

nbdkit-example2-plugin — the example-est example nbdkit plugin, fr fr 🦋

✨ SYNOPSIS ✨

nbdkit example2 file=FILENAME

💅 DESCRIPTION 💅

So "nbdkit-example2-plugin" is, like, literally an example plugin for nbdkit(1). No cap.

It serves the file you name as FILENAME over NBD, and it's readonly — like, don't even try to write to it, it's not that kind of girl 🙈

Mainly this is useful for testing nbdkit, and as an example for writing your own nbdkit plugins (nbdkit-plugin(3)). It's giving reference implementation, and honestly? Iconic 👑

There are two variations of this plugin, and you can find both in the source directory:

  • example2.c — the regular plugin, for Linux and other Unix-like systems 🐧
  • winexample2.c — the same plugin but written for Windows, using Win32 APIs to access the file 🪟

same energy, different platform, we love to see it 💜

🎀 DEBUG FLAGS 🎀

For extra debugging — which is only useful for developers, so if that's not you, this is not your moment bestie — use:

-D example2.extra=1

🦋 FILES 🦋

  • $plugindir/nbdkit-example2-plugin.so — the plugin itself ✨

Use nbdkit --dump-config to find the location of $plugindir. that's the move 🫶

⭐ VERSION ⭐

"nbdkit-example2-plugin" first appeared in nbdkit 1.0. an og, basically 🌈

🔥 SEE ALSO 🔥

👑 AUTHORS 👑

Richard W.M. Jones 💖

Copyright Red Hat

💜 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.
⚠️ bestie this is the legal bit — the all-caps is doing the most on purpose, it's a disclaimer, don't skip it 💀

okay that's the whole page!! this was nbdkit-1.48.1, dated 2026-08-29, and it lives in the nbdkit-example2-plugin(1) manual section. thanks for reading, you ate that 💅✨ go write a plugin, ily 🫶

📦 where this page comes from