File: nbdkit-split-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 (101 lines) | stat: -rw-r--r-- 2,048 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
=head1 NAME

nbdkit-split-plugin - nbdkit plugin to concatenate split files into one disk

=head1 SYNOPSIS

 nbdkit split [file=]file1 [[file=]file2 [file=]file3 ...]

=head1 DESCRIPTION

C<nbdkit-split-plugin> is a file plugin for L<nbdkit(1)>.  One or more
filenames may be given using the C<FILENAME> parameter.  These
files are logically concatenated into a single disk image.

If you want to add a virtual partition table, see
L<nbdkit-partitioning-plugin(1)>.

=head2 Differences from nbdkit-file-plugin

Normally to serve a single file you should use
L<nbdkit-file-plugin(1)>.  This plugin differs from nbdkit-file-plugin
as follows:

=over 4

=item *

nbdkit-file-plugin is faster and more efficient.  It has a fully
parallel implementation, and does not have to deal with the complexity
of locating the correct file to serve or splitting requests across
files.

=item *

nbdkit-file-plugin allows you to resize the underlying file
dynamically.  The underlying files must B<not> be resized when using
the split plugin.

=item *

nbdkit-file-plugin can handle block devices, but the split plugin can
only handle plain files.

=item *

nbdkit-file-plugin handles writes of blocks of zeroes efficiently, but
the split plugin cannot.

=item *

nbdkit-file-plugin can "punch holes" in the backing file in response
to a trim request from the client, but the split plugin does not
support this.

=back

=head1 PARAMETERS

=over 4

=item [B<file=>]FILENAME

One or more files to open.  They are logically concatenated in
the order they appear on the command line.

This parameter must appear at least once.

C<file=> __IS_MAGIC__

=back

=head1 FILES

=over 4

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

The plugin.

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

=back

=head1 VERSION

C<nbdkit-split-plugin> first appeared in nbdkit 1.2.

=head1 SEE ALSO

L<nbdkit(1)>,
L<nbdkit-plugin(3)>,
L<nbdkit-file-plugin(1)>,
L<nbdkit-partitioning-plugin(1)>.

=head1 AUTHORS

Richard W.M. Jones

=head1 COPYRIGHT

Copyright Red Hat