nbdkit-example4-plugin(1)

📦
version 1.48.0 · 11 versions
, in ubuntu stonking

💅 nbdkit-example4-plugin 💅

okay so bestie, welcome to the nbdkit-example4-plugin(1) page — it lives in the NBDKIT section of the manual, and it's genuinely the cutest little demo plugin you'll ever meet 🎀

✨ NAME ✨

nbdkit-example4-plugin — an example nbdkit plugin, written in Perl 🐪

🌸 SYNOPSIS 🌸

nbdkit example4 size=<N>

🦋 EXAMPLE 🦋

nbdkit example4 size=1048576
guestfish -a nbd://localhost

periodt. that's the whole vibe 💫

👑 DESCRIPTION 👑

nbdkit-example4-plugin is an example nbdkit(1) plugin, and it's written in Perl 🧚

The size=N parameter is required — no cap, you literally cannot skip it. It specifies the disk size in bytes. A single disk image gets created, initially all zeroes, and it can be read and written by every client. And when nbdkit shuts down? the disk image is thrown away 🗑️✨ (rip, it's giving ephemeral main character energy).

Mainly this is useful for testing, and as an example of nbdkit plugins written in Perl 🍓 You should also read nbdkit-plugin(3) and nbdkit-perl-plugin(3). also note: nbdkit plugins may be written in C or in other scripting languages — so many options, we love flexibility 💜

⭐ VERSION ⭐

nbdkit-example4-plugin first appeared in nbdkit 1.2 🎂

🌈 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.

and that's the page bestie 💅 mwah 💋 — this one's from nbdkit-1.48.0, dated 2026-08-22, and it's the nbdkit-example4-plugin(1) page, slay 🌟

📦 where this page comes from