.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "nbdkit-curl-plugin 1"
.TH nbdkit-curl-plugin 1 "2016-06-21" "nbdkit" "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\-curl\-plugin \- nbdkit curl plugin (HTTP, FTP, SSH and other protocols)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& nbdkit \-r curl url=http://example.com/disk.img
\&
\& nbdkit \-r curl url=sftp://you@example.com/~/disk.img
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`nbdkit\-curl\-plugin\*(C'\fR is a plugin for \fInbdkit\fR\|(1) which turns content
served over \s-1HTTP, FTP, SSH,\s0 and more, into a Network Block Device.  It
uses a library called libcurl (also known as cURL) to read data from
URLs.  The exact list of protocols that libcurl can handle depends on
how it was compiled, but most versions will handle \s-1HTTP, HTTPS, FTP,
FTPS\s0 and \s-1SFTP \s0(see: \f(CW\*(C`curl \-V\*(C'\fR).  For more information about
libcurl, see <http://curl.haxx.se>.
.PP
\&\fBNote:\fR This plugin supports writes.  However:
.IP "\(bu" 4
For \s-1HTTP,\s0 you may not want nbdkit to issue \s-1PUT\s0 requests to the remote server
(which probably doesn't understand them).
.IP "\(bu" 4
\&\s-1SFTP\s0 helpfully truncates the target file when you open it for writing.
Not useful!
.PP
\&\fBTo force nbdkit to use a readonly connection, pass the \f(BI\-r\fB flag\fR.
.SS "\s-1EXAMPLES\s0"
.IX Subsection "EXAMPLES"
Basic usage is:
.PP
.Vb 1
\& nbdkit \-r curl url=http://example.com/disk.img
.Ve
.PP
which serves the remote disk image as a \s-1NBD\s0 on \s-1TCP\s0 port 10809 (to
control ports and protocols used to serve \s-1NBD\s0 see \fInbdkit\fR\|(1)).
.PP
You can also access \s-1SSH\s0 servers.  This uses the \s-1SFTP\s0 protocol which is
built into most \s-1SSH\s0 servers:
.PP
.Vb 1
\& nbdkit \-r curl url=sftp://example.com/~/disk.img
.Ve
.PP
You may need to specify a username and/or a password.  In this example
the password is read from stdin:
.PP
.Vb 1
\& nbdkit \-r curl url=sftp://example.com/~/disk.img username=fred password=\-
.Ve
.SH "PARAMETERS"
.IX Header "PARAMETERS"
.IP "\fBpassword=PASSWORD\fR" 4
.IX Item "password=PASSWORD"
Set the password to use when connecting to the remote server.
.Sp
Note that passing this on the command line is not secure on shared
machines.
.IP "\fBpassword=\-\fR" 4
.IX Item "password=-"
Ask for the password (interactively) when nbdkit starts up.
.IP "\fBsslverify=0\fR" 4
.IX Item "sslverify=0"
Don't verify the \s-1SSL\s0 certificate of the remote host.
.IP "\fBtimeout=SECS\fR" 4
.IX Item "timeout=SECS"
Set the timeout for requests.
.IP "\fBtimeout=0\fR" 4
.IX Item "timeout=0"
Use the default libcurl timeout for requests.
.IP "\fBurl=URL\fR" 4
.IX Item "url=URL"
The \s-1URL\s0 of the remote disk image.  This is passed to libcurl directly
via \*(L"\s-1CURLOPT_URL\*(R"\s0 in \fIcurl_easy_setopt\fR\|(3).
.Sp
This parameter is required.
.IP "\fBuser=USERNAME\fR" 4
.IX Item "user=USERNAME"
Set the username to use when connecting to the remote server.  This
may also be set in the \s-1URL \s0(eg. \f(CW\*(C`http://foo@example.com/disk.img\*(C'\fR)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIcurl\fR\|(1),
\&\fIlibcurl\fR\|(3),
\&\fInbdkit\fR\|(1),
\&\fInbdkit\-plugin\fR\|(3).
.SH "AUTHORS"
.IX Header "AUTHORS"
Richard W.M. Jones
.PP
Parts derived from Alexander Graf's \*(L"\s-1QEMU\s0 Block driver for \s-1CURL\s0 images\*(R".
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2014 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