tools/virt-xml-validate.1

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.20)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "VIRT-XML-VALIDATE 1"
 136 .TH VIRT-XML-VALIDATE 1 "2013-09-18" "libvirt-1.2.5" "Virtualization Support"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 .Vb 1
 143 \&  virt\-xml\-validate \- validate libvirt XML files against a schema
 144 .Ve
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 .Vb 2
 148 \&  virt\-xml\-validate XML\-FILE [SCHEMA\-NAME]
 149 \&  virt\-xml\-validate OPTION
 150 .Ve
 151 .SH "DESCRIPTION"
 152 .IX Header "DESCRIPTION"
 153 Validates a libvirt \s-1XML\s0 for compliance with the published schema.
 154 The first compulsory argument is the path to the \s-1XML\s0 file to be
 155 validated. The optional second argument is the name of the schema
 156 to validate against. If omitted, the schema name will be inferred
 157 from the name of the root element in the \s-1XML\s0 document.
 158 .PP
 159 Valid schema names currently include
 160 .ie n .IP """domainsnapshot""" 4
 161 .el .IP "\f(CWdomainsnapshot\fR" 4
 162 .IX Item "domainsnapshot"
 163 The schema for the \s-1XML\s0 format used by domain snapshot configuration
 164 .ie n .IP """domain""" 4
 165 .el .IP "\f(CWdomain\fR" 4
 166 .IX Item "domain"
 167 The schema for the \s-1XML\s0 format used by guest domains configuration
 168 .ie n .IP """network""" 4
 169 .el .IP "\f(CWnetwork\fR" 4
 170 .IX Item "network"
 171 The schema for the \s-1XML\s0 format used by virtual network configuration
 172 .ie n .IP """storagepool""" 4
 173 .el .IP "\f(CWstoragepool\fR" 4
 174 .IX Item "storagepool"
 175 The schema for the \s-1XML\s0 format used by storage pool configuration
 176 .ie n .IP """storagevol""" 4
 177 .el .IP "\f(CWstoragevol\fR" 4
 178 .IX Item "storagevol"
 179 The schema for the \s-1XML\s0 format used by storage volume descriptions
 180 .ie n .IP """nodedev""" 4
 181 .el .IP "\f(CWnodedev\fR" 4
 182 .IX Item "nodedev"
 183 The schema for the \s-1XML\s0 format used by node device descriptions
 184 .ie n .IP """capability""" 4
 185 .el .IP "\f(CWcapability\fR" 4
 186 .IX Item "capability"
 187 The schema for the \s-1XML\s0 format used to declare driver capabilities
 188 .ie n .IP """nwfilter""" 4
 189 .el .IP "\f(CWnwfilter\fR" 4
 190 .IX Item "nwfilter"
 191 The schema for the \s-1XML\s0 format used by network traffic filters
 192 .ie n .IP """secret""" 4
 193 .el .IP "\f(CWsecret\fR" 4
 194 .IX Item "secret"
 195 The schema for the \s-1XML\s0 format used by secrets descriptions
 196 .ie n .IP """interface""" 4
 197 .el .IP "\f(CWinterface\fR" 4
 198 .IX Item "interface"
 199 The schema for the \s-1XML\s0 format used by physical host interfaces
 200 .SH "OPTIONS"
 201 .IX Header "OPTIONS"
 202 .IP "\fB\-h, \-\-help\fR" 4
 203 .IX Item "-h, --help"
 204 Display command line help usage then exit.
 205 .IP "\fB\-V, \-\-version\fR" 4
 206 .IX Item "-V, --version"
 207 Display version information then exit.
 208 .SH "EXIT STATUS"
 209 .IX Header "EXIT STATUS"
 210 Upon successful validation, an exit status of 0 will be set. Upon
 211 failure a non-zero status will be set.
 212 .SH "AUTHOR"
 213 .IX Header "AUTHOR"
 214 Daniel P.Berrange
 215 .SH "BUGS"
 216 .IX Header "BUGS"
 217 Report any bugs discovered to the libvirt community via the
 218 mailing list \f(CW\*(C`http://libvirt.org/contact.html\*(C'\fR or bug tracker \f(CW\*(C`http://libvirt.org/bugs.html\*(C'\fR.
 219 Alternatively report bugs to your software distributor / vendor.
 220 .SH "COPYRIGHT"
 221 .IX Header "COPYRIGHT"
 222 Copyright (C) 2009\-2013 by Red Hat, Inc.
 223 Copyright (C) 2009 by Daniel P. Berrange
 224 .SH "LICENSE"
 225 .IX Header "LICENSE"
 226 virt-xml-validate is distributed under the terms of the \s-1GNU GPL\s0 v2+.
 227 This is free software; see the source for copying conditions. There
 228 is \s-1NO\s0 warranty; not even for \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR
 229 PURPOSE\s0
 230 .SH "SEE ALSO"
 231 .IX Header "SEE ALSO"
 232 \&\f(CWvirsh(1)\fR, online \s-1XML\s0 format descriptions \f(CW\*(C`http://libvirt.org/format.html\*(C'\fR