.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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 "QEMU-NBD 8"
.TH QEMU-NBD 8 "2016-05-08" " " " "
.\" 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"
qemu\-nbd \- QEMU Disk Network Block Device Server
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
usage: qemu-nbd [\s-1OPTION\s0]...  \fIfilename\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Export \s-1QEMU\s0 disk image using \s-1NBD\s0 protocol.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fIfilename\fR" 4
.IX Item "filename"
.Vb 1
\& is a disk image filename
.Ve
.IP "\fB\-p, \-\-port=\fR\fIport\fR" 4
.IX Item "-p, --port=port"
.Vb 1
\&  port to listen on (default B<10809>)
.Ve
.IP "\fB\-o, \-\-offset=\fR\fIoffset\fR" 4
.IX Item "-o, --offset=offset"
.Vb 1
\&  offset into the image
.Ve
.IP "\fB\-b, \-\-bind=\fR\fIiface\fR" 4
.IX Item "-b, --bind=iface"
.Vb 1
\&  interface to bind to (default B<0.0.0.0>)
.Ve
.IP "\fB\-k, \-\-socket=\fR\fIpath\fR" 4
.IX Item "-k, --socket=path"
.Vb 1
\&  Use a unix socket with path I<path>
.Ve
.IP "\fB\-f, \-\-format=\fR\fIformat\fR" 4
.IX Item "-f, --format=format"
.Vb 1
\&  Set image format as I<format>
.Ve
.IP "\fB\-r, \-\-read\-only\fR" 4
.IX Item "-r, --read-only"
.Vb 1
\&  export read\-only
.Ve
.IP "\fB\-P, \-\-partition=\fR\fInum\fR" 4
.IX Item "-P, --partition=num"
.Vb 1
\&  only expose partition I<num>
.Ve
.IP "\fB\-s, \-\-snapshot\fR" 4
.IX Item "-s, --snapshot"
.Vb 3
\&  use I<filename> as an external snapshot, create a temporary
\&  file with backing_file=I<filename>, redirect the write to
\&  the temporary one
.Ve
.IP "\fB\-l, \-\-load\-snapshot=\fR\fIsnapshot_param\fR" 4
.IX Item "-l, --load-snapshot=snapshot_param"
.Vb 3
\&  load an internal snapshot inside I<filename> and export it
\&  as an read\-only device, I<snapshot_param> format is
\&  \*(Aqsnapshot.id=[ID],snapshot.name=[NAME]\*(Aq or \*(Aq[ID_OR_NAME]\*(Aq
.Ve
.IP "\fB\-n, \-\-nocache\fR" 4
.IX Item "-n, --nocache"
.PD 0
.IP "\fB\-\-cache=\fR\fIcache\fR" 4
.IX Item "--cache=cache"
.PD
.Vb 2
\&  set cache mode to be used with the file.  See the documentation of
\&  the emulator\*(Aqs C<\-drive cache=...> option for allowed values.
.Ve
.IP "\fB\-\-aio=\fR\fIaio\fR" 4
.IX Item "--aio=aio"
.Vb 2
\&  choose asynchronous I/O mode between B<threads> (the default)
\&  and B<native> (Linux only).
.Ve
.IP "\fB\-\-discard=\fR\fIdiscard\fR" 4
.IX Item "--discard=discard"
.Vb 3
\&  toggles whether I<discard> (also known as I<trim> or I<unmap>)
\&  requests are ignored or passed to the filesystem.  The default is no
\&  (B<\-\-discard=ignore>).
.Ve
.IP "\fB\-c, \-\-connect=\fR\fIdev\fR" 4
.IX Item "-c, --connect=dev"
.Vb 1
\&  connect I<filename> to NBD device I<dev>
.Ve
.IP "\fB\-d, \-\-disconnect\fR" 4
.IX Item "-d, --disconnect"
.Vb 1
\&  disconnect the specified device
.Ve
.IP "\fB\-e, \-\-shared=\fR\fInum\fR" 4
.IX Item "-e, --shared=num"
.Vb 1
\&  device can be shared by I<num> clients (default B<1>)
.Ve
.IP "\fB\-f, \-\-format=\fR\fIfmt\fR" 4
.IX Item "-f, --format=fmt"
.Vb 1
\&  force block driver for format I<fmt> instead of auto\-detecting
.Ve
.IP "\fB\-t, \-\-persistent\fR" 4
.IX Item "-t, --persistent"
.Vb 1
\&  don\*(Aqt exit on the last connection
.Ve
.IP "\fB\-v, \-\-verbose\fR" 4
.IX Item "-v, --verbose"
.Vb 1
\&  display extra debugging information
.Ve
.IP "\fB\-h, \-\-help\fR" 4
.IX Item "-h, --help"
.Vb 1
\&  display this help and exit
.Ve
.IP "\fB\-V, \-\-version\fR" 4
.IX Item "-V, --version"
.Vb 1
\&  output version information and exit
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIqemu\-img\fR\|(1)
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>.
This is free software; see the source for copying conditions.  There is \s-1NO\s0
warranty; not even for \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0