Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
nbdkit-example3-plugin(1)	    NBDKIT	     nbdkit-example3-plugin(1)

NAME
       nbdkit-example3-plugin -	example	nbdkit plugin

SYNOPSIS
	nbdkit example3	[size=SIZE]

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

DESCRIPTION
       "nbdkit-example3-plugin"	is an example nbdkit(1)	plugin.

       On each connection, it generates	a temporary writable block device of
       size "SIZE".  The disk is thrown	away when the client disconnects.

       The "size=SIZE" parameter can use a number of common formats to specify
       the size, eg. "100M", "2G".  If the parameter is	omitted, it defaults
       to 100M.

       Mainly this is useful for testing nbdkit	and as an example for writing
       nbdkit plugins (nbdkit-plugin(3)).

FILES
       $plugindir/nbdkit-example3-plugin.so
	   The plugin.

	   Use "nbdkit --dump-config" to find the location of $plugindir.

VERSION
       "nbdkit-example3-plugin"	first appeared in nbdkit 1.0.

SEE ALSO
       https://github.com/libguestfs/nbdkit/blob/master/plugins/example3/example3.c,
       nbdkit(1), nbdkit-plugin(3)

AUTHORS
       Richard W.M. Jones

COPYRIGHT
       Copyright (C) 2013 Red Hat Inc.

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

       o   Redistributions of source code must retain the above	copyright
	   notice, this	list of	conditions and the following disclaimer.

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

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

nbdkit-1.20.4			  2021-03-01	     nbdkit-example3-plugin(1)

NAME | SYNOPSIS | EXAMPLE | DESCRIPTION | FILES | VERSION | SEE ALSO | AUTHORS | COPYRIGHT | LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=nbdkit-example3-plugin&sektion=1&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help