File: nbdkit-ones-plugin.pod

package info (click to toggle)
nbdkit 1.46.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 15,504 kB
  • sloc: ansic: 63,658; sh: 18,717; makefile: 6,814; python: 1,848; cpp: 1,143; perl: 504; ml: 504; tcl: 62
file content (76 lines) | stat: -rw-r--r-- 1,501 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
=head1 NAME

nbdkit-ones-plugin - nbdkit plugin filled with repeated 0xff or other bytes

=head1 SYNOPSIS

 nbdkit ones [[size=]SIZE] [byte=N]

=head1 DESCRIPTION

C<nbdkit-ones-plugin> is a plugin for L<nbdkit(1)>.  Any read returns
a repeating pattern of C<0xff> (all ones) bytes, or another repeating
byte if you use the C<byte> parameter.  Everything written to the
virtual device is discarded.

Most NBD consumers will be very confused by this device.  It is mainly
useful for testing.  L<nbdkit-data-plugin(1)> can be used to create a
modifiable RAM disk initialized with fixed data.

=head1 PARAMETERS

=over 4

=item B<byte=>N

Set the repeating byte to C<N>.  The default is C<0xff> (all ones).

Instead of C<byte=0> it is more efficient to use
L<nbdkit-null-plugin(1)>.

=item [B<size=>]SIZE

Specify the virtual size of the disk image.

This parameter is optional.  If omitted then a zero-sized device is
created.

C<size=> __IS_MAGIC__

=back

=head1 FILES

=over 4

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

The plugin.

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

=back

=head1 VERSION

C<nbdkit-ones-plugin> first appeared in nbdkit 1.36.

=head1 SEE ALSO

L<nbdkit(1)>,
L<nbdkit-plugin(3)>,
L<nbdkit-data-plugin(1)>,
L<nbdkit-full-plugin(1)>,
L<nbdkit-null-plugin(1)>,
L<nbdkit-pattern-plugin(1)>,
L<nbdkit-random-plugin(1)>.
L<nbdkit-sparse-random-plugin(1)>,
L<nbdkit-zero-plugin(1)>.

=head1 AUTHORS

Richard W.M. Jones

=head1 COPYRIGHT

Copyright Red Hat