~ubuntu-branches/ubuntu/trusty/nbdkit/trusty-proposed

« back to all changes in this revision

Viewing changes to plugins/example1/nbdkit-example1-plugin.pod

  • Committer: Package Import Robot
  • Author(s): Hilko Bengen
  • Date: 2013-08-02 22:09:57 UTC
  • Revision ID: package-import@ubuntu.com-20130802220957-ccjs88t5jka0zqkl
Tags: upstream-1.1.2
ImportĀ upstreamĀ versionĀ 1.1.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
=encoding utf8
 
2
 
 
3
=head1 NAME
 
4
 
 
5
nbdkit-example1-plugin - A minimal nbdkit plugin
 
6
 
 
7
=head1 SYNOPSIS
 
8
 
 
9
 nbdkit .../plugins/nbdkit-example1-plugin.so
 
10
 
 
11
=head1 DESCRIPTION
 
12
 
 
13
C<nbdkit-example1-plugin> is a minimal L<nbdkit(1)> plugin.
 
14
 
 
15
It serves, readonly, from memory, a static blob of data which looks a
 
16
little bit like a 100 MB disk image that contains a single empty
 
17
partition.
 
18
 
 
19
Mainly this is useful for testing nbdkit and as an example for writing
 
20
nbdkit plugins (L<nbdkit-plugin(3)>).
 
21
 
 
22
=head1 SEE ALSO
 
23
 
 
24
L<example1.c> in the nbdkit source tree,
 
25
L<nbdkit(1)>,
 
26
L<nbdkit-plugin(3)>
 
27
 
 
28
=head1 AUTHORS
 
29
 
 
30
Richard W.M. Jones
 
31
 
 
32
=head1 COPYRIGHT
 
33
 
 
34
Copyright (C) 2013 Red Hat Inc.
 
35
 
 
36
=head1 LICENSE
 
37
 
 
38
Redistribution and use in source and binary forms, with or without
 
39
modification, are permitted provided that the following conditions are
 
40
met:
 
41
 
 
42
=over 4
 
43
 
 
44
=item *
 
45
 
 
46
Redistributions of source code must retain the above copyright
 
47
notice, this list of conditions and the following disclaimer.
 
48
 
 
49
=item *
 
50
 
 
51
Redistributions in binary form must reproduce the above copyright
 
52
notice, this list of conditions and the following disclaimer in the
 
53
documentation and/or other materials provided with the distribution.
 
54
 
 
55
=item *
 
56
 
 
57
Neither the name of Red Hat nor the names of its contributors may be
 
58
used to endorse or promote products derived from this software without
 
59
specific prior written permission.
 
60
 
 
61
=back
 
62
 
 
63
THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
 
64
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 
65
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 
66
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
 
67
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 
68
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 
69
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 
70
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 
71
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 
72
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 
73
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 
74
SUCH DAMAGE.