docs/format.html.in

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html>
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <body>
   5     <h1>XML Format</h1>
   6
   7
   8     <p>
   9       Objects in the libvirt API are configured using XML documents to allow
  10       for ease of extension in future releases. Each XML document has an
  11       associated Relax-NG schema that can be used to validate documents
  12       prior to usage.
  13     </p>
  14
  15
  16     <ul>
  17       <li><a href="formatdomain.html">Domains</a></li>
  18       <li><a href="formatnetwork.html">Networks</a></li>
  19       <li><a href="formatnwfilter.html">Network filtering</a></li>
  20       <li><a href="formatnetworkport.html">Network ports</a></li>
  21       <li><a href="formatstorage.html">Storage</a></li>
  22       <li><a href="formatstorageencryption.html">Storage encryption</a></li>
  23       <li><a href="formatcaps.html">Capabilities</a></li>
  24       <li><a href="formatdomaincaps.html">Domain capabilities</a></li>
  25       <li><a href="formatstoragecaps.html">Storage Pool capabilities</a></li>
  26       <li><a href="formatnode.html">Node devices</a></li>
  27       <li><a href="formatsecret.html">Secrets</a></li>
  28       <li><a href="formatsnapshot.html">Snapshots</a></li>
  29       <li><a href="formatcheckpoint.html">Checkpoints</a></li>
  30       <li><a href="formatbackup.html">Backup jobs</a></li>
  31     </ul>
  32
  33     <h2>Command line validation</h2>
  34
  35     <p>
  36       The <code>virt-xml-validate</code> tool provides a simple command line
  37       for validating XML documents prior to giving them to libvirt. It uses
  38       the locally instaled RNG schema documents. It will auto-detect which
  39       schema to use for validation based on the name of the top level element
  40       in the input document. Thus it merely requires the XML document filename
  41       to be passed on the command line
  42     </p>
  43
  44     <pre>
  45 $ virt-xml-validate /path/to/XML/file</pre>
  46
  47   </body>
  48 </html>