.\" Automatically generated by Podwrapper::Man 1.10.3 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "nbdkit-file-plugin 1" .TH nbdkit-file-plugin 1 "2019-01-26" "nbdkit-1.10.3" "NBDKIT" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" nbdkit\-file\-plugin \- nbdkit file plugin .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& nbdkit file [file=]FILENAME .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`nbdkit\-file\-plugin\*(C'\fR is a file serving plugin for \fBnbdkit\fR\|(1). .PP It serves the named \f(CW\*(C`FILENAME\*(C'\fR over \s-1NBD.\s0 Local block devices (eg. \fI/dev/sda\fR) may also be served. .PP To concatenate multiple files, use \fBnbdkit\-split\-plugin\fR\|(1). .SH "PARAMETERS" .IX Header "PARAMETERS" .IP "\fBfile=\fR\s-1FILENAME\s0" 4 .IX Item "file=FILENAME" Serve the file named \f(CW\*(C`FILENAME\*(C'\fR. A local block device name can also be used here. .Sp This parameter is required. .Sp In nbdkit ≥ 1.8, \f(CW\*(C`file=\*(C'\fR may be omitted. To ensure that the filename does not end up being parsed accidentally as \f(CW\*(C`key=value\*(C'\fR, prefix relative paths with \f(CW\*(C`./\*(C'\fR (absolute paths do not need modification). .IP "\fBrdelay\fR" 4 .IX Item "rdelay" .PD 0 .IP "\fBwdelay\fR" 4 .IX Item "wdelay" .PD These plugin parameters have been moved to the \&\fBnbdkit\-delay\-filter\fR\|(1) filter. Modify the command line to add \&\fI\-\-filter=delay\fR in order to use these parameters. .SH "DUMP-PLUGIN OUTPUT" .IX Header "DUMP-PLUGIN OUTPUT" You can obtain extra information about how the file plugin was compiled by doing: .PP .Vb 1 \& nbdkit file \-\-dump\-plugin .Ve .PP Some of the fields which may appear are listed below. Note these are for information only and may be changed or removed at any time in the future. .ie n .IP """file_blksszget=yes""" 4 .el .IP "\f(CWfile_blksszget=yes\fR" 4 .IX Item "file_blksszget=yes" .PD 0 .ie n .IP """file_blkzeroout=yes""" 4 .el .IP "\f(CWfile_blkzeroout=yes\fR" 4 .IX Item "file_blkzeroout=yes" .PD If both set, the plugin may be able to efficiently zero ranges of block devices, where the driver and block device itself supports this. .ie n .IP """file_falloc_fl_punch_hole=yes""" 4 .el .IP "\f(CWfile_falloc_fl_punch_hole=yes\fR" 4 .IX Item "file_falloc_fl_punch_hole=yes" If set, the plugin may be able to punch holes (make sparse) files and block devices. .ie n .IP """file_falloc_fl_zero_range=yes""" 4 .el .IP "\f(CWfile_falloc_fl_zero_range=yes\fR" 4 .IX Item "file_falloc_fl_zero_range=yes" If set, the plugin may be able to efficiently zero ranges of files and block devices. .SH "DEBUG FLAG" .IX Header "DEBUG FLAG" .IP "\fB\-D file.zero=1\fR" 4 .IX Item "-D file.zero=1" This enables very verbose debugging of the \s-1NBD\s0 zero request. This can be used to tell if the file plugin is able to zero ranges in the file or block device efficiently or not. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBnbdkit\fR\|(1), \&\fBnbdkit\-plugin\fR\|(3), \&\fBnbdkit\-split\-plugin\fR\|(1), \&\fBnbdkit\-partitioning\-plugin\fR\|(1). .SH "AUTHORS" .IX Header "AUTHORS" Eric Blake .PP Nir Soffer .PP Richard W.M. Jones .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2013\-2018 Red Hat Inc. .SH "LICENSE" .IX Header "LICENSE" Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: .IP "\(bu" 4 Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. .IP "\(bu" 4 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. .IP "\(bu" 4 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. .PP \&\s-1THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS\s0 ''\s-1AS IS\s0'' \s-1AND 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\s0 (\s-1INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES\s0; \s-1LOSS OF USE, DATA, OR PROFITS\s0; \s-1OR BUSINESS INTERRUPTION\s0) \s-1HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\s0 (\s-1INCLUDING NEGLIGENCE OR OTHERWISE\s0) \s-1ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\s0