File: nbdkit-example1-plugin.pod

package info (click to toggle)
nbdkit 1.42.9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 14,696 kB
  • sloc: ansic: 59,224; sh: 16,793; makefile: 6,463; python: 1,837; cpp: 1,116; ml: 504; perl: 502; tcl: 62
file content (48 lines) | stat: -rw-r--r-- 866 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
=head1 NAME

nbdkit-example1-plugin - minimal nbdkit plugin

=head1 SYNOPSIS

 nbdkit example1

=head1 DESCRIPTION

C<nbdkit-example1-plugin> is a minimal L<nbdkit(1)> plugin.

It serves, readonly, from memory, a static blob of data which looks a
little bit like a 100 MB disk image that contains a single empty
partition.

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

=head1 FILES

=over 4

=item F<$plugindir/nbdkit-example1-plugin.so>

The plugin.

Use C<nbdkit --dump-config> to find the location of C<$plugindir>.

=back

=head1 VERSION

C<nbdkit-example1-plugin> first appeared in nbdkit 1.0.

=head1 SEE ALSO

L<https://gitlab.com/nbdkit/nbdkit/blob/master/plugins/example1/example1.c>,
L<nbdkit(1)>,
L<nbdkit-plugin(3)>

=head1 AUTHORS

Richard W.M. Jones

=head1 COPYRIGHT

Copyright Red Hat