Annotation of qemu/qemu-nbd.8, revision 1.1.1.1

1.1       root        1: .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.07)
                      2: .\"
                      3: .\" Standard preamble:
                      4: .\" ========================================================================
                      5: .de Sh \" Subsection heading
                      6: .br
                      7: .if t .Sp
                      8: .ne 5
                      9: .PP
                     10: \fB\\$1\fR
                     11: .PP
                     12: ..
                     13: .de Sp \" Vertical space (when we can't use .PP)
                     14: .if t .sp .5v
                     15: .if n .sp
                     16: ..
                     17: .de Vb \" Begin verbatim text
                     18: .ft CW
                     19: .nf
                     20: .ne \\$1
                     21: ..
                     22: .de Ve \" End verbatim text
                     23: .ft R
                     24: .fi
                     25: ..
                     26: .\" Set up some character translations and predefined strings.  \*(-- will
                     27: .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
                     28: .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
                     29: .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
                     30: .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
                     31: .\" nothing in troff, for use with C<>.
                     32: .tr \(*W-
                     33: .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
                     34: .ie n \{\
                     35: .    ds -- \(*W-
                     36: .    ds PI pi
                     37: .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
                     38: .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
                     39: .    ds L" ""
                     40: .    ds R" ""
                     41: .    ds C` ""
                     42: .    ds C' ""
                     43: 'br\}
                     44: .el\{\
                     45: .    ds -- \|\(em\|
                     46: .    ds PI \(*p
                     47: .    ds L" ``
                     48: .    ds R" ''
                     49: 'br\}
                     50: .\"
                     51: .\" Escape single quotes in literal strings from groff's Unicode transform.
                     52: .ie \n(.g .ds Aq \(aq
                     53: .el       .ds Aq '
                     54: .\"
                     55: .\" If the F register is turned on, we'll generate index entries on stderr for
                     56: .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
                     57: .\" entries marked with X<> in POD.  Of course, you'll have to process the
                     58: .\" output yourself in some meaningful fashion.
                     59: .ie \nF \{\
                     60: .    de IX
                     61: .    tm Index:\\$1\t\\n%\t"\\$2"
                     62: ..
                     63: .    nr % 0
                     64: .    rr F
                     65: .\}
                     66: .el \{\
                     67: .    de IX
                     68: ..
                     69: .\}
                     70: .\"
                     71: .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
                     72: .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
                     73: .    \" fudge factors for nroff and troff
                     74: .if n \{\
                     75: .    ds #H 0
                     76: .    ds #V .8m
                     77: .    ds #F .3m
                     78: .    ds #[ \f1
                     79: .    ds #] \fP
                     80: .\}
                     81: .if t \{\
                     82: .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
                     83: .    ds #V .6m
                     84: .    ds #F 0
                     85: .    ds #[ \&
                     86: .    ds #] \&
                     87: .\}
                     88: .    \" simple accents for nroff and troff
                     89: .if n \{\
                     90: .    ds ' \&
                     91: .    ds ` \&
                     92: .    ds ^ \&
                     93: .    ds , \&
                     94: .    ds ~ ~
                     95: .    ds /
                     96: .\}
                     97: .if t \{\
                     98: .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
                     99: .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
                    100: .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
                    101: .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
                    102: .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
                    103: .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
                    104: .\}
                    105: .    \" troff and (daisy-wheel) nroff accents
                    106: .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
                    107: .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
                    108: .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
                    109: .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
                    110: .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
                    111: .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
                    112: .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
                    113: .ds ae a\h'-(\w'a'u*4/10)'e
                    114: .ds Ae A\h'-(\w'A'u*4/10)'E
                    115: .    \" corrections for vroff
                    116: .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
                    117: .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
                    118: .    \" for low resolution devices (crt and lpr)
                    119: .if \n(.H>23 .if \n(.V>19 \
                    120: \{\
                    121: .    ds : e
                    122: .    ds 8 ss
                    123: .    ds o a
                    124: .    ds d- d\h'-1'\(ga
                    125: .    ds D- D\h'-1'\(hy
                    126: .    ds th \o'bp'
                    127: .    ds Th \o'LP'
                    128: .    ds ae ae
                    129: .    ds Ae AE
                    130: .\}
                    131: .rm #[ #] #H #V #F C
                    132: .\" ========================================================================
                    133: .\"
                    134: .IX Title "QEMU-NBD 8"
                    135: .TH QEMU-NBD 8 "2009-05-01" " " " "
                    136: .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
                    137: .\" way too many mistakes in technical documents.
                    138: .if n .ad l
                    139: .nh
                    140: .SH "NAME"
                    141: qemu\-nbd \- QEMU Disk Network Block Device Server
                    142: .SH "SYNOPSIS"
                    143: .IX Header "SYNOPSIS"
                    144: usage: qemu-nbd [\s-1OPTION\s0]...  \fIfilename\fR
                    145: .SH "DESCRIPTION"
                    146: .IX Header "DESCRIPTION"
                    147: Export Qemu disk image using \s-1NBD\s0 protocol.
                    148: .SH "OPTIONS"
                    149: .IX Header "OPTIONS"
                    150: .IP "\fIfilename\fR" 4
                    151: .IX Item "filename"
                    152: .Vb 1
                    153: \& is a disk image filename
                    154: .Ve
                    155: .IP "\fB\-p, \-\-port=\fR\fIport\fR" 4
                    156: .IX Item "-p, --port=port"
                    157: .Vb 1
                    158: \&  port to listen on (default B<1024>)
                    159: .Ve
                    160: .IP "\fB\-o, \-\-offset=\fR\fIoffset\fR" 4
                    161: .IX Item "-o, --offset=offset"
                    162: .Vb 1
                    163: \&  offset into the image
                    164: .Ve
                    165: .IP "\fB\-b, \-\-bind=\fR\fIiface\fR" 4
                    166: .IX Item "-b, --bind=iface"
                    167: .Vb 1
                    168: \&  interface to bind to (default B<0.0.0.0>)
                    169: .Ve
                    170: .IP "\fB\-k, \-\-socket=\fR\fIpath\fR" 4
                    171: .IX Item "-k, --socket=path"
                    172: .Vb 1
                    173: \&  Use a unix socket with path I<path>
                    174: .Ve
                    175: .IP "\fB\-r, \-\-read\-only\fR" 4
                    176: .IX Item "-r, --read-only"
                    177: .Vb 1
                    178: \&  export read\-only
                    179: .Ve
                    180: .IP "\fB\-P, \-\-partition=\fR\fInum\fR" 4
                    181: .IX Item "-P, --partition=num"
                    182: .Vb 1
                    183: \&  only expose partition I<num>
                    184: .Ve
                    185: .IP "\fB\-s, \-\-snapshot\fR" 4
                    186: .IX Item "-s, --snapshot"
                    187: .Vb 1
                    188: \&  use snapshot file
                    189: .Ve
                    190: .IP "\fB\-n, \-\-nocache\fR" 4
                    191: .IX Item "-n, --nocache"
                    192: .Vb 1
                    193: \&  disable host cache
                    194: .Ve
                    195: .IP "\fB\-c, \-\-connect\fR" 4
                    196: .IX Item "-c, --connect"
                    197: .Vb 1
                    198: \&  connect FILE to NBD device DEV
                    199: .Ve
                    200: .IP "\fB\-d, \-\-disconnect\fR" 4
                    201: .IX Item "-d, --disconnect"
                    202: .Vb 1
                    203: \&  disconnect the specified device
                    204: .Ve
                    205: .IP "\fB\-e, \-\-shared=\fR\fInum\fR" 4
                    206: .IX Item "-e, --shared=num"
                    207: .Vb 1
                    208: \&  device can be shared by I<num> clients (default B<1>)
                    209: .Ve
                    210: .IP "\fB\-t, \-\-persistent\fR" 4
                    211: .IX Item "-t, --persistent"
                    212: .Vb 1
                    213: \&  don\*(Aqt exit on the last connection
                    214: .Ve
                    215: .IP "\fB\-v, \-\-verbose\fR" 4
                    216: .IX Item "-v, --verbose"
                    217: .Vb 1
                    218: \&  display extra debugging information
                    219: .Ve
                    220: .IP "\fB\-h, \-\-help\fR" 4
                    221: .IX Item "-h, --help"
                    222: .Vb 1
                    223: \&  display this help and exit
                    224: .Ve
                    225: .IP "\fB\-V, \-\-version\fR" 4
                    226: .IX Item "-V, --version"
                    227: .Vb 1
                    228: \&  output version information and exit
                    229: .Ve
                    230: .SH "SEE ALSO"
                    231: .IX Header "SEE ALSO"
                    232: \&\fIqemu\-img\fR\|(1)
                    233: .SH "AUTHOR"
                    234: .IX Header "AUTHOR"
                    235: Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>.
                    236: This is free software; see the source for copying conditions.  There is \s-1NO\s0
                    237: warranty; not even for \s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.

unix.superglobalmegacorp.com