docs/virshcmdref.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>Virsh Command Reference</h1>
   6
   7     <ul id="toc"></ul>
   8
   9     <h2><a id="description">Description</a></h2>
  10
  11     <p>
  12       The new <b>Virsh Command Reference</b>, for documenting the commands
  13       in virsh, has recently been started.  Only covering the Virtual
  14       Networking commands initially, it will expand to cover all virsh
  15       commands over time.
  16     </p>
  17
  18     <p>
  19       If you would like to assist, content contributions are gladly accepted.
  20       Please email <a href="mailto:jclift@redhat.com">Justin Clift</a>
  21       directly, or get in contact through any of the
  22       <a href="contact.html">official libvirt mailing lists</a>.
  23     </p>
  24
  25    <h2><a id="viewing">Viewing Online</a></h2>
  26
  27     <p>
  28       The latest version can be viewed directly online:
  29     </p>
  30
  31     <ul>
  32       <li>
  33         <a href="https://libvirt.org/sources/virshcmdref/html/">Standard HTML format, multiple pages</a>
  34       </li>
  35       <li>
  36         <a href="https://libvirt.org/sources/virshcmdref/html-single/">HTML format, one long page</a>
  37       </li>
  38     </ul>
  39
  40     <h2><a id="downloading">Downloading</a></h2>
  41
  42     <p>
  43       The latest version of the Virsh Command Reference can be downloaded:
  44     </p>
  45
  46     <ul>
  47       <li>
  48         Standard HTML format, multiple pages
  49         (<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-multi-page.tar.gz">.tar.gz</a>)
  50         (<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-multi-page.tar.bz2">.tar.bz2</a>)
  51         (<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-multi-page.zip">.zip</a>)
  52       </li>
  53       <li>
  54         HTML format, one long page
  55         (<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-single.tar.gz">.tar.gz</a>)
  56         (<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-single.tar.bz2">.tar.bz2</a>)
  57         (<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-single.zip">.zip</a>)
  58       </li>
  59       <li>
  60         <a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1.pdf">PDF format</a>
  61       </li>
  62       <li>
  63         <a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1.epub">ePub format</a>
  64       </li>
  65     </ul>
  66
  67     <h2><a id="git">DocBook source GIT repository</a></h2>
  68     <p>
  69       The DocBook source is maintained in a <a
  70       href="http://git-scm.com/">git</a> repository available on
  71       <a href="https://libvirt.org/git/">libvirt.org</a>:
  72     </p>
  73
  74 <pre>
  75 git clone https://libvirt.org/git/libvirt-virshcmdref.git
  76 </pre>
  77
  78     <p>
  79       It can also be browsed online:
  80     </p>
  81
  82 <pre>
  83 <a href="https://libvirt.org/git/?p=libvirt-virshcmdref.git">https://libvirt.org/git/?p=libvirt-virshcmdref.git</a>
  84 </pre>
  85
  86   </body>
  87 </html>