[libvirt] [PATCH] docs: added virsh command reference page.
Justin Clift
jclift at redhat.com
Fri Nov 12 16:58:39 UTC 2010
Using temporary location links for the moment, until we get a
proper place to store the files on the libvirt.org server.
---
docs/sitemap.html.in | 4 ++
docs/virshcmdref.html.in | 92 ++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 96 insertions(+), 0 deletions(-)
create mode 100644 docs/virshcmdref.html.in
diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in
index f09b2c0..692da29 100644
--- a/docs/sitemap.html.in
+++ b/docs/sitemap.html.in
@@ -266,6 +266,10 @@
<a href="devguide.html">Development Guide</a>
<span>A guide and reference for developing with libvirt</span>
</li>
+ <li>
+ <a href="virshcmdref.html">Virsh Commands</a>
+ <span>Command reference for virsh</span>
+ </li>
</ul>
</li>
<li>
diff --git a/docs/virshcmdref.html.in b/docs/virshcmdref.html.in
new file mode 100644
index 0000000..f965ba0
--- /dev/null
+++ b/docs/virshcmdref.html.in
@@ -0,0 +1,92 @@
+<?xml version="1.0"?>
+<html>
+ <body>
+ <h1>Virsh Command Reference</h1>
+
+ <ul id="toc"></ul>
+
+ <h2><a name="description">Description</a></h2>
+
+ <p>
+ The new <b>Virsh Command Reference</b>, for documenting the commands
+ in virsh, has recently been started. Only covering the Virtual
+ Networking commands initially, it will expand to cover all virsh
+ commands over time.
+ </p>
+
+ <p>
+ If you would like to assist, content contributions are gladly accepted.
+ Please email <a href="mailto:jclift at redhat.com">Justin Clift</a>
+ directly, or get in contact through any of the
+ <a href="contact.html">official libvirt mailing lists</a>.
+ </p>
+
+ <p> </p>
+
+ <h2><a name="viewing">Viewing Online</a></h2>
+
+ <p>
+ The latest version can be viewed directly online:
+ </p>
+
+ <ul>
+ <li>
+ <a href="http://justinclift.fedorapeople.org/virshcmdref/html/">Standard HTML format, multiple pages</a>
+ </li>
+ <li>
+ <a href="http://justinclift.fedorapeople.org/virshcmdref/html-single/">HTML format, one long page</a>
+ </li>
+ </ul>
+
+ <p> </p>
+
+ <h2><a name="downloading">Downloading</a></h2>
+
+ <p>
+ The latest versions of the Virsh Command Reference can be downloaded:
+ </p>
+
+ <ul>
+ <li>
+ Standard HTML format, multiple pages
+ (<a href="http://justinclift.fedorapeople.org/virshcmdref/Virsh_Command_Reference-0.8.6-0-html-multi-page.tar.gz">.tar.gz</a>)
+ (<a href="http://justinclift.fedorapeople.org/virshcmdref/Virsh_Command_Reference-0.8.6-0-html-multi-page.tar.bz2">.tar.bz2</a>)
+ (<a href="http://justinclift.fedorapeople.org/virshcmdref/Virsh_Command_Reference-0.8.6-0-html-multi-page.zip">.zip</a>)
+ </li>
+ <li>
+ HTML format, one long page
+ (<a href="http://justinclift.fedorapeople.org/virshcmdref/Virsh_Command_Reference-0.8.6-0-html-single.tar.gz">.tar.gz</a>)
+ (<a href="http://justinclift.fedorapeople.org/virshcmdref/Virsh_Command_Reference-0.8.6-0-html-single.tar.bz2">.tar.bz2</a>)
+ (<a href="http://justinclift.fedorapeople.org/virshcmdref/Virsh_Command_Reference-0.8.6-0-html-single.zip">.zip</a>)
+ </li>
+ <li>
+ <a href="http://justinclift.fedorapeople.org/virshcmdref/Virsh_Command_Reference-0.8.6-0.pdf">PDF format</a>
+ </li>
+ <li>
+ <a href="http://justinclift.fedorapeople.org/virshcmdref/Virsh_Command_Reference-0.8.6-0.epub">ePub format</a>
+ </li>
+ </ul>
+
+ <h2><a name="git">DocBook source GIT repository</a></h2>
+ <p>
+ The DocBook source is maintained in a <a
+ href="http://git-scm.com/">git</a> repository available on
+ <a href="http://libvirt.org/git/">libvirt.org</a>:
+ </p>
+
+<pre>
+git clone git://libvirt.org/libvirt-virshcmdref.git
+</pre>
+
+ <p>
+ It can also be browsed online:
+ </p>
+
+<pre>
+<a href="http://libvirt.org/git/?p=libvirt-virshcmdref.git">http://libvirt.org/git/?p=libvirt-virshcmdref.git</a>
+</pre>
+
+ <p> </p>
+
+ </body>
+</html>
--
1.7.3
More information about the libvir-list
mailing list