release of 0.5.1

* src/libvirt_sym.version.in configure.in NEWS docs/*: release
  of 0.5.1
* po/*: updated and regenerated
daniel

.cvsignore

@@ -1,31 +1,37 @@
+*.a
+*.o
+*.orig
+*.rej
+*~
 .git
+ABOUT-NLS
+COPYING
+INSTALL
 Makefile
+Makefile.in
 aclocal.m4
 autom4te.cache
-stamp-h.in
-Makefile.in
-configure
 config.cache
+config.guess
 config.h
 config.h.in
 config.log
-config.status
-config.guess
-config.sub
 config.rpath
-stamp-h
-stamp-h1
+config.status
+config.sub
+configure
+coverage
 libtool
-ltconfig
-update.log
+libvirt-*.tar.gz
 libvirt.pc
 libvirt.spec
-COPYING
-m4
-ABOUT-NLS
-coverage
-results.log
-libvirt-*.tar.gz
-INSTALL
+ltconfig
 ltmain.sh
+m4
+mingw32-libvirt.spec
 mkinstalldirs
+results.log
+stamp-h
+stamp-h.in
+stamp-h1
+update.log

.gitignore

@@ -0,0 +1,37 @@
+*.a
+*.o
+*.orig
+*.rej
+*~
+.git
+ABOUT-NLS
+COPYING
+INSTALL
+Makefile
+Makefile.in
+aclocal.m4
+autom4te.cache
+config.cache
+config.guess
+config.h
+config.h.in
+config.log
+config.rpath
+config.status
+config.sub
+configure
+coverage
+libtool
+libvirt-*.tar.gz
+libvirt.pc
+libvirt.spec
+ltconfig
+ltmain.sh
+m4
+mingw32-libvirt.spec
+mkinstalldirs
+results.log
+stamp-h
+stamp-h.in
+stamp-h1
+update.log

.x-sc_avoid_ctype_macros

@@ -0,0 +1 @@
+^gnulib/.*

.x-sc_avoid_write

@@ -1,3 +1,4 @@
 ^src/util\.c$
 ^src/xend_internal\.c$
 ^src/util-lib\.c$
+^gnulib/

.x-sc_prohibit_strcmp

@@ -0,0 +1 @@
+^gnulib/

.x-sc_trailing_blank

@@ -1,6 +1,7 @@
-\.png$
 \.fig$
 \.gif$
-^NEWS$
+\.ico$
+\.png$
 ^ChangeLog$
+^NEWS$
 ^docs/.*

AUTHORS

@@ -5,28 +5,32 @@ The libvirt project was initiated by:
 
   Daniel Veillard      <veillard@redhat.com> or <daniel@veillard.com>
 
-The primary maintainers for various code sub-systems / drivers
-are:
+The primary maintainers and people with commit access rights:
 
-  Daniel Veillard      <veillard@redhat.com>   (xen & everything else)
-  Karel Zak            <kzak@redhat.com>       (virsh tool)
-  Daniel Berrange      <berrange@redhat.com>   (test & qemu drivers)
-  Mark McLoughlin      <markmc@redhat.com>     (network driver)
-  Richard W.M. Jones   <rjones@redhat.com>     (remote driver)
+  Daniel Veillard      <veillard@redhat.com>
+  Daniel Berrange      <berrange@redhat.com>
+  Richard W.M. Jones   <rjones@redhat.com>
+  Karel Zak            <kzak@redhat.com>
+  Mark McLoughlin      <markmc@redhat.com>
+  Anthony Liguori      <aliguori@us.ibm.com>
+  Jim Meyering         <meyering@redhat.com>
+  Jim Fehlig           <jfehlig@novell.com>
+  Chris Lalancette     <clalance@redhat.com>
+  Atsushi SAKAI        <sakaia@jp.fujitsu.com>
+  Dave Leskovec        <dlesko@linux.vnet.ibm.com>
+  Cole Robinson        <crobinso@redhat.com>
+  Dan Smith            <danms@us.ibm.com>
+  Guido Guenther       <agx@sigxcpu.org>
 
 Patches have also been contributed by:
 
   David Lutterkort     <dlutter@redhat.com>
-  Anthony Liguori      <aliguori@us.ibm.com>
-  Jim Meyering         <meyering@redhat.com>
   Andrew Puch          <apuch@redhat.com>
-  Jim Fehlig           <jfehlig@novell.com>
   Philippe Berthault   <philippe.berthault@Bull.net>
   Hugh Brock           <hbrock@redhat.com>
   Michel Ponceau       <michel.ponceau@bull.net>
   Jeremy Katz          <katzj@redhat.com>
   Pete Vetere          <pvetere@redhat.com>
-  Atsushi SAKAI        <sakaia@jp.fujitsu.com>
   Kazuki Mizushima     <mizushima.kazuk@jp.fujitsu.com>
   Saori Fukuta         <fukuta.saori@jp.fujitsu.com>
   Tatsuro Enokura      <fj7716hz@aa.jp.fujitsu.com>
@@ -37,13 +41,24 @@ Patches have also been contributed by:
   Christian Ehrhardt   <ehrhardt@linux.vnet.ibm.com>
   Shuveb Hussain       <shuveb@binarykarma.com>
   Jim Paris            <jim@jtan.com>
-  Chris Lalancette     <clalance@redhat.com>
-  Guido Guenther       <agx@sigxcpu.org>
   Daniel Hokka Zakrisson <daniel@hozac.com>
   Mads Chr. Olesen     <shiyee@shiyee.dk>
-  Cole Robinson        <crobinso@redhat.com>
+  Anton Protopopov     <aspsk2@gmail.com>
+  Stefan de Konink     <dekonink@kinkrsoftware.nl>
+  Kaitlin Rupert       <kaitlin@linux.vnet.ibm.com>
+  Evgeniy Sokolov      <evg@openvz.org>
+  John Levon           <john.levon@sun.com>
+  David Lively         <dlively@virtualiron.com>
+  Charles Duffy        <Charles_Duffy@messageone.com>
+  Nguyen Anh Quynh     <aquynh@gmail.com>
+  James Morris         <jmorris@namei.org>
+  Chris Wrigh          <chrisw@redhat.com>
+  Ben Guthro           <bguthro@virtualiron.com>
+  Shigeki Sakamoto     <fj0588di@aa.jp.fujitsu.com>
+  Gerd von Egidy       <lists@egidy.de>
 
   [....send patches to get your name here....]
 
+The libvirt Logo was designed by Diana Fong
 
 -- End

HACKING

@@ -0,0 +1,279 @@
+                    Libvirt contributor guidelines
+                    ==============================
+
+
+General tips for contributing patches
+=====================================
+
+(1) Discuss any large changes on the mailing list first.  Post patches
+early and listen to feedback.
+
+(2) Post patches in unified diff format.  A command similar to this
+should work:
+
+  diff -urp libvirt.orig/ libvirt.modified/ > libvirt-myfeature.patch
+
+or:
+
+  cvs diff -up > libvirt-myfeature.patch
+
+(3) Split large changes into a series of smaller patches, self-contained
+if possible, with an explanation of each patch and an explanation of how
+the sequence of patches fits together.
+
+(4) Make sure your patches apply against libvirt CVS.  Developers
+only follow CVS and don't care much about released versions.
+
+(5) Run the automated tests on your code before submitting any changes.
+In particular, configure with compile warnings set to -Werror:
+
+  ./configure --enable-compile-warnings=error
+
+and run the tests:
+
+  make check
+  make syntax-check
+  make -C tests valgrind
+
+The latter test checks for memory leaks.
+
+(6) Update tests and/or documentation, particularly if you are adding
+a new feature or changing the output of a program.
+
+
+There is more on this subject, including lots of links to background
+reading on the subject, on this page:
+
+  http://et.redhat.com/~rjones/how-to-supply-code-to-open-source-projects/
+
+
+
+Code indentation
+================
+Libvirt's C source code generally adheres to some basic code-formatting
+conventions.  The existing code base is not totally consistent on this
+front, but we do prefer that contributed code be formatted similarly.
+In short, use spaces-not-TABs for indentation, use 4 spaces for each
+indentation level, and other than that, follow the K&R style.
+
+If you use Emacs, add the following to one of one of your start-up files
+(e.g., ~/.emacs), to help ensure that you get indentation right:
+
+  ;;; When editing C sources in libvirt, use this style.
+  (defun libvirt-c-mode ()
+    "C mode with adjusted defaults for use with libvirt."
+    (interactive)
+    (c-set-style "K&R")
+    (setq indent-tabs-mode nil) ; indent using spaces, not TABs
+    (setq c-indent-level 4)
+    (setq c-basic-offset 4))
+  (add-hook 'c-mode-hook
+	    '(lambda () (if (string-match "/libvirt" (buffer-file-name))
+			    (libvirt-c-mode))))
+
+Code formatting (especially for new code)
+=========================================
+With new code, we can be even more strict.
+Please apply the following function (using GNU indent) to any new code.
+Note that this also gives you an idea of the type of spacing we prefer
+around operators and keywords:
+
+  indent-libvirt()
+  {
+    indent -bad -bap -bbb -bli4 -br -ce -brs -cs -i4 -l75 -lc75 \
+      -sbi4 -psl -saf -sai -saw -sbi4 -ss -sc -cdw -cli4 -npcs -nbc \
+      --no-tabs "$@"
+  }
+
+Note that sometimes you'll have to postprocess that output further, by
+piping it through "expand -i", since some leading TABs can get through.
+Usually they're in macro definitions or strings, and should be converted
+anyhow.
+
+
+Low level memory management
+===========================
+
+Use of the malloc/free/realloc/calloc APIs is deprecated in the libvirt
+codebase, because they encourage a number of serious coding bugs and do
+not enable compile time verification of checks for NULL. Instead of these
+routines, use the macros from memory.h
+
+  - eg to allocate  a single object:
+
+      virDomainPtr domain;
+
+      if (VIR_ALLOC(domain) < 0) {
+         __virRaiseError(VIR_ERROR_NO_MEMORY)
+         return NULL;
+      }
+
+
+  - eg to allocate an array of objects
+
+       virDomainPtr domains;
+       int ndomains = 10;
+
+       if (VIR_ALLOC_N(domains, ndomains) < 0) {
+         __virRaiseError(VIR_ERROR_NO_MEMORY)
+         return NULL;
+       }
+
+  - eg to allocate an array of object pointers
+
+       virDomainPtr *domains;
+       int ndomains = 10;
+
+       if (VIR_ALLOC_N(domains, ndomains) < 0) {
+         __virRaiseError(VIR_ERROR_NO_MEMORY)
+         return NULL;
+       }
+
+   - eg to re-allocate the array of domains to be longer
+
+       ndomains = 20
+
+       if (VIR_REALLOC_N(domains, ndomains) < 0) {
+         __virRaiseError(VIR_ERROR_NO_MEMORY)
+         return NULL;
+       }
+
+   - eg to free the domain
+
+       VIR_FREE(domain);
+
+
+
+String comparisons
+==================
+
+Do not use the strcmp, strncmp, etc functions directly. Instead use
+one of the following semantically named macros
+
+  - For strict equality:
+
+     STREQ(a,b)
+     STRNEQ(a,b)
+
+  - For case sensitive equality:
+     STRCASEEQ(a,b)
+     STRCASENEQ(a,b)
+
+  - For strict equality of a substring:
+
+     STREQLEN(a,b,n)
+     STRNEQLEN(a,b,n)
+
+  - For case sensitive equality of a substring:
+
+     STRCASEEQLEN(a,b,n)
+     STRCASENEQLEN(a,b,n)
+
+  - For strict equality of a prefix:
+
+     STRPREFIX(a,b)
+
+
+
+Variable length string buffer
+=============================
+
+If there is a need for complex string concatenations, avoid using
+the usual sequence of malloc/strcpy/strcat/snprintf functions and
+make use of the virBuffer API described in buf.h
+
+eg typical usage is as follows:
+
+  char *
+  somefunction(...) {
+     virBuffer buf = VIR_BUFFER_INITIALIZER;
+
+     ...
+
+     virBufferAddLit(&buf, "<domain>\n");
+     virBufferVSprint(&buf, "  <memory>%d</memory>\n", memory);
+     ...
+     virBufferAddLit(&buf, "</domain>\n");
+
+     ....
+
+     if (virBufferError(&buf)) {
+         __virRaiseError(...);
+         return NULL;
+     }
+
+     return virBufferContentAndReset(&buf);
+  }
+
+
+Include files
+=============
+
+There are now quite a large number of include files, both libvirt
+internal and external, and system includes.  To manage all this
+complexity it's best to stick to the following general plan for all
+*.c source files:
+
+  /*
+   * Copyright notice
+   * ....
+   * ....
+   * ....
+   *
+   */
+
+  #include <config.h>             Must come first in every file.
+
+  #include <stdio.h>              Any system includes you need.
+  #include <string.h>
+  #include <limits.h>
+
+  #if HAVE_NUMACTL                Some system includes aren't supported
+  #include <numa.h>               everywhere so need these #if defences.
+  #endif
+
+  #include "internal.h"           Include this first, after system includes.
+
+  #include "util.h"               Any libvirt internal header files.
+  #include "buf.h"
+
+  static myInternalFunc ()        The actual code.
+  {
+    ...
+
+Of particular note: *DO NOT* include libvirt/libvirt.h or
+libvirt/virterror.h.  It is included by "internal.h" already and there
+are some special reasons why you cannot include these files
+explicitly.
+
+
+
+                Libvirt commiters guidelines
+                ============================
+
+The AUTHORS files indicates the list of people with commit acces right
+who can actually merge the patches.
+
+The general rule for commiting patches is to make sure it has been reviewed
+properly in the mailing-list first, usually if a couple of persons gave an
+ACK or +1 to a patch and nobody raised an objection on the list it should
+be good to go. If the patch touches a part of the code where you're not the
+main maintainer or not have a very clear idea of how things work, it's better
+to wait for a more authoritative feedback though. Before commiting please
+also rebuild locally and run 'make check syntax-check' and make sure they
+don't raise error. Try to look for warnings too for example configure with
+   --enable-compile-warnings=error
+which adds -Werror to compile flags, so no warnings get missed
+
+Exceptions to that 'review and approval on the list first' is fixing failures
+to build:
+  - if a recently commited patch breaks compilation on a platform
+    or for a given driver then it's fine to commit a minimal fix
+    directly without getting the review feedback first
+  - similary if make check or make syntax-chek breaks, if there is
+    an obvious fix, it's fine to commit immediately
+The patch should still be sent to the list (or tell what the fix was if
+trivial) and 'make check syntax-check' should pass too before commiting
+anything
+Similary fixes for documentation and code comments can be managed
+in the same way, but still make sure they get reviewed if non-trivial.

Makefile.am

@@ -1,16 +1,22 @@
 ## Process this file with automake to produce Makefile.in
 
+LCOV = lcov
+GENHTML = genhtml
+
 SUBDIRS = gnulib/lib include src qemud proxy docs gnulib/tests \
-  python tests po scripts
+  python tests po examples/domain-events/events-c
 
 ACLOCAL_AMFLAGS = -I m4 -I gnulib/m4
 
 EXTRA_DIST = \
   libvirt.spec libvirt.spec.in \
+  mingw32-libvirt.spec.in \
   libvirt.pc libvirt.pc.in \
   $(man_MANS) autobuild.sh \
   .x-sc_avoid_if_before_free \
-  .x-sc_require_config_h
+  .x-sc_prohibit_strcmp \
+  .x-sc_require_config_h \
+  autogen.sh
 
 man_MANS = virsh.1
 
@@ -27,24 +33,15 @@ tests:
 	@(if [ "$(pythondir)" != "" ] ; then cd python ; \
 	  $(MAKE) MAKEFLAGS+=--silent tests ; fi)
 
-cov: cov-recursive cov-am
+cov: clean-cov
+	mkdir $(top_builddir)/coverage
+	$(LCOV) -c -o $(top_builddir)/coverage/libvirt.info.tmp -d $(top_srcdir)/src  -d $(top_srcdir)/qemud -d $(top_srcdir)/tests
+	$(LCOV) -r $(top_builddir)/coverage/libvirt.info.tmp -o $(top_builddir)/coverage/libvirt.info *usr*
+	rm $(top_builddir)/coverage/libvirt.info.tmp
+	$(GENHTML) -s -t "libvirt" -o $(top_builddir)/coverage --legend $(top_builddir)/coverage/libvirt.info
 
 clean-cov:
 	rm -rf $(top_builddir)/coverage
-	cd src && $(MAKE) $(AM_MAKEFLAGS) clean-cov
-
-cov-recursive:
-	cd src && $(MAKE) $(AM_MAKEFLAGS) cov
-
-cov-am:
-	rm -rf $(top_builddir)/coverage
-	mkdir $(top_builddir)/coverage
-	perl $(srcdir)/scripts/coverage-report.pl src/*.cov > $(top_builddir)/coverage/index.xml
-	xsltproc $(srcdir)/scripts/coverage-report.xsl \
-	  $(top_builddir)/coverage/index.xml \
-	  > $(top_builddir)/coverage/index.html
-	for i in $(top_builddir)/src/*.gcov ; do o=`echo $$i | sed -e 's,$(top_builddir)/src,coverage,'` ; \
-	  perl $(srcdir)/scripts/coverage-report-entry.pl $$i > $$o.html ; done
 
 # disable this check
 distuninstallcheck:

Makefile.cfg

@@ -32,7 +32,6 @@ local-checks-to-skip =			\
   sc_GPL_version			\
   sc_always_defined_macros		\
   sc_cast_of_alloca_return_value	\
-  sc_changelog				\
   sc_dd_max_sym_length			\
   sc_error_exit_success			\
   sc_file_system			\
@@ -41,7 +40,6 @@ local-checks-to-skip =			\
   sc_prohibit_jm_in_m4			\
   sc_prohibit_quote_without_use		\
   sc_prohibit_quotearg_without_use	\
-  sc_prohibit_strcmp			\
   sc_root_tests				\
   sc_space_tab				\
   sc_sun_os_names			\
@@ -54,5 +52,6 @@ local-checks-to-skip =			\
 
 useless_free_options =		\
   --name=sexpr_free		\
+  --name=xmlFree		\
   --name=xmlXPathFreeContext	\
   --name=xmlXPathFreeObject

Makefile.maint

@@ -90,8 +90,9 @@ sc_prohibit_atoi_atof:
 		1>&2; exit 1; } || :
 
 # Use STREQ rather than comparing strcmp == 0, or != 0.
+# Similarly, use STREQLEN or STRPREFIX rather than strncmp.
 sc_prohibit_strcmp:
-	@grep -nE '! *str''cmp \(|\<str''cmp \([^)]+\) *=='		\
+	@grep -nE '! *str''n?cmp *\(|\<str''n?cmp *\([^)]+\) *=='	\
 	    $$($(VC_LIST_EXCEPT)) &&					\
 	  { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
 		1>&2; exit 1; } || :
@@ -157,6 +158,16 @@ sc_prohibit_quotearg_without_use:
 sc_prohibit_quote_without_use:
 	@h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
 
+# Prohibit the inclusion of c-ctype.h without an actual use.
+sc_prohibit_c_ctype_without_use:
+	@h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
+
+# Prohibit the inclusion of <ctype.h>.
+sc_prohibit_ctype_h:
+	@grep -E '^# *include  *<ctype\.h>' $$($(VC_LIST_EXCEPT)) &&	\
+	  { echo "$(ME): don't use ctype.h; instead, use c-ctype.h"	\
+		1>&2; exit 1; } || :
+
 sc_obsolete_symbols:
 	@grep -nE '\<(HAVE''_FCNTL_H|O''_NDELAY)\>'			\
 	     $$($(VC_LIST_EXCEPT)) &&					\
@@ -166,8 +177,12 @@ sc_obsolete_symbols:
 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
 
 # Each nonempty line must start with a year number, or a TAB.
+# Or day-of-week+space.
+changelog_entry_header_regexp = \
+  ([12][0-9][0-9][0-9]|	.|(Mon|Tue|Wed|Thu|Fri|Sat|Sun) )
 sc_changelog:
-	@grep -n '^[^12	]' $$(find . -maxdepth 2 -name ChangeLog) &&	\
+	@grep -Evn '(^$$|^$(changelog_entry_header_regexp))'		\
+	  $$(find . -maxdepth 2 -name ChangeLog) &&			\
 	  { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2;	\
 	    exit 1; } || :
 
@@ -287,6 +302,26 @@ sc_trailing_blank:
 	  { echo '$(ME): found trailing blank(s)'			\
 		1>&2; exit 1; } || :
 
+# Ensure that no C source file uses TABs for indentation.
+# Also match *.h.in files, to get libvirt.h.in.
+# Exclude files in gnulib, since they're imported.
+sc_TAB_in_indentation:
+	@grep -lE '^ *	' /dev/null					\
+	     $$($(VC_LIST_EXCEPT)					\
+	        | grep -E '\.[ch](\.in)?$$'				\
+	        | grep -v '^gnulib/') &&				\
+	  { echo '$(ME): found TAB(s) use for indentation; use spaces'	\
+		1>&2; exit 1; } || :
+
+ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
+|isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
+
+sc_avoid_ctype_macros:
+	@grep -E '\b($(ctype_re)) *\(' /dev/null			\
+	     $$($(VC_LIST_EXCEPT)) &&					\
+	  { echo "$(ME): don't use ctype macros (use c-ctype.h)"	\
+		1>&2; exit 1; } || :
+
 # Match lines like the following, but where there is only one space
 # between the options and the description:
 #   -D, --all-repeated[=delimit-method]  print all duplicate lines\n
@@ -316,6 +351,10 @@ msg_gen_function += xenXMError
 msg_gen_function += ReportError
 msg_gen_function += qemudReportError
 msg_gen_function += openvzLog
+msg_gen_function += openvzError
+msg_gen_function += virDomainReportError
+msg_gen_function += virReportErrorHelper
+msg_gen_function += lxcError
 
 # Uncomment the following and run "make syntax-check" to see diagnostics
 # that are not yet marked for translation, but that need to be rewritten
@@ -323,7 +362,6 @@ msg_gen_function += openvzLog
 # msg_gen_function += error
 # msg_gen_function += virXenError
 # msg_gen_function += testError
-# msg_gen_function += lxcError
 
 func_or := $(shell printf '$(msg_gen_function)'|tr -s '[[:space:]]' '|')
 func_re := ($(func_or))
@@ -385,7 +423,7 @@ patch-check:
 # which date accepts but GNU strftime does not.
 extract_char = sed 's/^[^%][^%]*%\(.\).*/\1/'
 strftime-check:
-	if test -f $(srcdir)/src/date.c; then				\
+	@if test -f $(srcdir)/src/date.c; then				\
 	  grep '^  %.  ' $(srcdir)/src/date.c | sort			\
 	    | $(extract_char) > $@-src;					\
 	  { echo N;							\
@@ -429,10 +467,14 @@ m4-check:
 	  && { echo 'Makefile.maint: quote the first arg to AC_DEFUN' 1>&2; \
 	       exit 1; } || :
 
+fix_po_file_diag = \
+'you have changed the set of files with translatable diagnostics;\n\
+apply the above patch\n'
+
 # Verify that all source files using _() are listed in po/POTFILES.in.
-# FIXME: don't hard-code file names below; use a more general mechanism.
+po_file = po/POTFILES.in
 po-check:
-	if test -f po/POTFILES.in; then					\
+	@if test -f po/POTFILES.in; then					\
 	  grep -E -v '^(#|$$)' po/POTFILES.in				\
 	    | grep -v '^src/false\.c$$' | sort > $@-1;			\
 	  files=;							\
@@ -445,13 +487,14 @@ po-check:
 	    *.[ch])							\
 	      base=`expr " $$file" : ' \(.*\)\..'`;			\
 	      { test -f $$base.l || test -f $$base.y; } && continue;;	\
-	    *) continue;;				\
+	    *) continue;;						\
 	    esac;							\
 	    files="$$files $$file";					\
 	  done;								\
 	  grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files		\
 	    | sort -u > $@-2;						\
-	  diff -u $@-1 $@-2 || exit 1;					\
+	  diff -u -L $(po_file) -L $(po_file) $@-1 $@-2			\
+	    || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; };	\
 	  rm -f $@-1 $@-2;						\
 	fi
 
@@ -565,3 +608,28 @@ my-distcheck: $(local-check) check
 	@echo "========================"; \
 	echo "$(distdir).tar.gz is ready for distribution"; \
 	echo "========================"
+
+cvs-to-git = '\#!/usr/bin/perl\n\
+use warnings;\n\
+use strict;\n\
+use File::Find;\n\
+use File::Copy;\n\
+\n\
+find ({wanted =>\n\
+       sub {$$_ eq q/.cvsignore/ or return;\n\
+	    my $$gi = q/.gitignore/;\n\
+	    unlink $$gi;\n\
+	    copy($$_, $$gi) or die qq/copy failed: $$_->$$gi: $$!\\n/;\n\
+	    chmod 0444, $$gi;\n\
+	    }},\n\
+      q!.!);\n'
+
+.PHONY: sync-vcs-ignore-files
+c2g = cvs-to-git
+sync-vcs-ignore-files:
+	rm -f $(c2g)-t $(c2g)
+	printf $(cvs-to-git) > $(c2g)-t
+	chmod a+x-w $(c2g)-t
+	mv $(c2g)-t $(c2g)
+	perl $(c2g)
+	rm -f $(c2g)

NEWS

@@ -4,7 +4,262 @@
   Note that this is automatically generated from the news webpage at:
        http://libvirt.org/news.html
 
-Releases
+
+0.5.1: Dec  4 2008:
+   - Portability: fix missing dep in spec file, fix compilation with new
+          NUMA libraries (Daniel Berrange), udev compatibility for RHEL (Chris
+          Lalancette), 
+   - Documentation: documentation copy and paste errors and typo (Cole
+          Robinson)
+   - Bug fixes: add a delay in storage backend for disks to show up
+          (Chris Lalancette), fix parsing for CDRom device with no source
+          (Daniel Berrange), use xenstore to list domains to avoid some
+          bugs (Guido G<>nther), remove a leak in xen inotify code (Daniel
+          Berrange), UML driver freeing of uninitialialized variable (Ron
+          Yorston), fix UML inotify code (Daniel Berrange), crash when
+          adding storage without a format (Cole Robinson)
+   - Improvements: use xend preferably to hypervisor call to set Xen
+          max memory (Jim Fehlig), allow remote://hostname/ URI for automatic
+          probe of hypervisors (Daniel Berrange), fix daemon configuration
+          regression testing (Jim Meyering ), check /usr/bin/kvm for QEmu
+          driver init (Guido G<>nther), proper active vs. inactive
+          differentiation (Guido G<>nther), improve MTU setting on tap
+          interfaces (Eduardo Habkost), increase timeout for initial QEmu
+          monitor poll (Cole Robinson)
+   - Cleanups:fix improper initialisations (Jim Meyering)
+
+
+0.5.0: Nov 25 2008:
+   - New features: CPU and scheduler support for LXC (Dan Smith), SDL display configuration (Daniel Berrange), domain lifecycle event support for QEmu and Xen with python bindings (Ben Guthro and Daniel Berrange), KVM/QEmu migration support (Rich Jones and Chris Lalancette), User Mode Linux driver (Daniel Berrange), API for node device enumeration using HAL and DeviceKit with python bindings (David Lively), 
+   - Portability: RHEL build fixes, VPATH build (Guido Gunther), many MinGW related cleanups and fixes (Richard Jones), compilation without libvirtd (Richard Jones), Add a Windows icon (Richard Jones), sys/poll.h portability fixes (Daniel Berrange), gnulib and mingw cleanups (Jim Meyering), 
+   - Documentation: virsh man page cleanups (Mark McLoughlin), doc for NIC model selection (Richard Jones), monitoring section, link to AMQP bindings, inew APIs, UML driver docs (Daniel Berrange), 
+   - Bug fixes: Xen interfaces ordering (Jim Fehlig), startup timeout with multiple pty (Cole Robinson), segfault if QEmu without active virtual network (Cole Robinson), qemu small leak (Eduardo Habkost), index creation for more than 26 disks (Sanjay Rao and Chris Wright), virRealloc handling of 0 (Daniel Berrange), missing pointer initialization (Chris Lalancette), bus device index bug (Guido G<>nther), avoid crash in some error patch (Chris Lalancette), fix a problem in storage back-end (Chris Lalancette), minimum domain memory size check for Xen (Shigeki Sakamoto), switch off QEmu cache if device is shared (Charles Duffy), logical volume definition before scan bug (Chris Lalancette), a couple of memory leaks on QEmu vnc (Jim Meyering), lvs parsing fixes (Cole Robinson),  
+   - Improvements: LXC resources control and internal cgroup API (Dan Smith), virDomainCreateLinux renamed virDomainDefineXML, network driver modularization (Daniel Berrange), change the way domain and net are reported in errors (Jim Meyering), partition table scan on iSCSI (Chris Lalancette), qemudDiskDeviceName to handle normal disks (Guido G<>nther), qemudDomainBlockStats improvement (Guido G<>nther), scsi/virtio hotplug support for KVM (Guido G<>nther), USB hot addition in QEmu (Guido G<>nther), logical pool and storage backend XML dump improvement (Chris Lalancette), MAC addresses prefix per driver (Daniel Berrange), OpenVZ getVersion support (Daniel Berrange), hot removal of scsi/virtio disks for KVM (Guido G<>nther), test storage driver (Cole Robinson), iSCSI and disk storage driver improvement on path handling (Chris Lalancette), UUID and ID support for Xenner (Daniel Berrange), better logging when when executing commands (Cole Robinson), bridged network for OpenVZ (Daniel Berrange), OpenVZ config file params (Evgeniy Sokolov), allow to build drivers as libtool convenience libs (Daniel Berrange), fully versioned linker script for exported ABI (Daniel Berrange), Push URI probing down into drivers open (Daniel Berrange), move all stateful drivers into the daemon binary (Daniel Berrange), improve domain event with a detail field (Daniel Berrange), domain events for QEMU driver (Daniel Berrange), event unregister callback crash (David Lively), plug a few leaks (Daniel Berrange), internal APIs for handling node device XML config (David Lively), tweaks to node device implementation (Daniel Berrange), OpenVZ vCPUs values init (Evgeniy Sokolov)
+   - Cleanups: C99 initializers (Guido Gunther), test output (Cole Robinson), debug macro centralization (Cole Robinson), various error handling (Guido G<>nther), safewrite use cleanup (Jim Meyering), centralize error reporting logic (Cole Robinson), avoid printf warnings (Daniel Berrange), use arrays instead of list for internal APIs (Daniel Berrange), remove many format string warnings Jim Meyering), avoid syntax check warnings (Chris Lalancette), improve po-check and list generation (Jim Meyering), .gitignore generation and handling (Jim Meyering), use ARRAY_CARDINALITY (Jim Meyering), gnulib updates and switch to use netdb.h (Jim Meyering), drop usage of socket_errno (Jim Meyering), remove socketcompat.h (Jim Meyering), more tests (Jim Meyering), drop virStringList (Daniel Berrange), reformatting and isolation of the error APIs (Daniel Berrange), cleanup internal.h and move internal APIs in specific headers (Daniel Berrange), move domain events helpers into domain_events.c (Daniel Berrange), cleanup the way optional modules are compiled (Daniel Berrange), add new logging module, optional dlopen of drivers (Daniel Berrange), various new tests (Jim Meyering), cleanups when Xen is not configured in (Daniel Berrange), add some missing functions comments (Jim Meyering), 
+
+
+0.4.6: Sep 23 2008:
+   - Documentation: fix some comments in API (Anton Protopopov),
+          cleanup and extension of bindings and windows pages (Richard Jones)
+   - Portability: missing include file (Richard Jones)
+   - Bug fixes: avoid a segfault if missing qemu emulator (Cole Robinson),
+          reading vncdisplay from xend domain (Cole Robinson), segfault in
+          OpenVZ (Evgeniy Sokolov), fix parsing of pool without a source
+          (Chris Lalancette and Daniel Berrange)
+   - Improvements: add storage disk volume delete (Cole Robinson),
+          KVM dynamic max CPU detection (Guido G<>nther), spec file improvement
+          for minimal builds (Ben Guthro), improved error message in XM
+          configuration module (Richard Jones), network config in OpenVZ
+          support (Evgeniy Sokolov), enable stopping a pool in logical
+          storage backend and cleanup deletion of pool (Chris Lalancette)
+   - Cleanups: deadcode removal (Nguyen Anh Quynh), fix one test
+          case (Daniel Berrange), various strings and space cleanups (Daniel
+          Berrange), structure initialization cleanup (Chris Lalancette)
+
+
+0.4.5: Sep 8 2008:
+   - New features: NETNS support for Linux containers (Dan Smith),
+          unified XML domain and network parsing for all drivers (Daniel
+          Berrange), OpenVZ features improvements (Evgeniy Sokolov),
+          OpenVZ and Linux containers support now default, USB device
+          passthrough for QEmu/KVM (Guido G<>nther), storage pool source
+          discovery (David Lively)
+   - Portability: fixes for MinGW (Atsushi SAKAI and Daniel Berrange),
+          detection of xen lib improvement (David Lively),
+          storage backend portability for SLES (David Lively),
+          fix make distclean and distcheck (Jim Meyering),
+          fix build failures on RHEL4, lot of MinGW portability fixes (Atsushi
+          SAKAI and Daniel Berrange), HTML generation fix, -lpthread explicit
+          linking when needed (Jim Meyering)
+   - Documentation: various typo fixes (Anton Protopopov, Toth
+          Istv<74>n, Atsushi SAKAI, Nguyen Anh Quynh),
+          Java bindings docs, remove Xen centric
+          comments (Guido G<>nther), various typo in comments (Chris
+          Lalancette), docs and API comments fixes (Charles Duffy),
+          how to contribute to open source link (Richard Jones),
+          memory unit fixups (matthew chan)
+   - Bug fixes: memory leaks and testing for OOM (Daniel Berrange),
+          do_open driver bug(Evgeniy Sokolov), don't use polkit auth when
+          running as non-root (Daniel Berrange), boot of CDRom devices
+          in QEmu/KVM (Daniel Berrange), fix OpenVZ probe function (Evgeniy
+          Sokolov), ID related lookup fixes in OpenVZ (Evgeniy Sokolov),
+          pool cration for netfs (Cole Robinson), check for migrate support
+          with QEmu (Guido G<>nther), check against double create with QEmu
+          (Guido G<>nther), broken open failure detection in QEmu (Guido
+          G<>nther), UUID string conversions in QEmu (Guido G<>nther),
+          various small cleanup and bug fixes (Daniel Berrange), ID
+          related fixes in the test driver (Daniel Berrange), better error
+          reporting on XML parsing (Daniel Berrange), empty CD-ROM source
+          device section (Chris Lalancette), avoid crashes for interface
+          without a name in QEmu (Guido G<>nther), provide the real
+          vncport (Charles Duffy), fix forward delay (Daniel Berrange),
+          new VM state is initialized to be SHUTOFF (Daniel Berrange),
+          virsh attach-disk bug fixes (Chris Lalancette), veth clash
+          of device names (Dan Smith), connection lookup fixes on
+          storage creation (Cole Robinson), parted call fix (Cole Robinson),
+          use "server" option when using serial/telnet with QEmu (Mark
+          McLoughlin), duplicate virInitialize calls (Nguyen Anh Quynh),
+          many fixes to virExec and related functions (Daniel Berrange),
+          size of disk without partitions (Cole Robinson), creating and
+          cleaning up logical volumes with target path (Cole Robinson),
+          fix reporting of virConnectOpen problems (Daniel Berrange),
+          veth cleanup at shutdown (Dan Smith), lookup of Xen VMs after define
+          (Cole Robinson), fix emulator reported capabilities (Cole Robinson),
+          avoid segfault on KVM CD eject (Cole Robinson), fix disk ordering
+          and avoid duplicate in QEmu XML parsing (Cole Robinson), update
+          domain XML after device hotplug (Cole Robinson), use poweroff instead
+          of halt when shutting down a Xen domain (John Levon), don't dump core
+          of Xen domain live by default (John Levon), vgcreate command line
+          size bug (Jim Fehlig),  signed/unsigned issue in probing file
+          (Cole Robinson), Fix Xen domains without PVFB console (Daniel
+          Berrange), OpenVZ config read bug fix (Evgeniy Sokolov).
+          
+   - Improvements: improved failure diagnostic for TAP (Jim Meyering),
+          better exec and error diagnostic for OpenVZ commands (Evgeniy
+          Sokolov), OpenVZ auto start and stop of domains (Evgeniy Sokolov),
+          OpenVZ domain cpu time consumption (Evgeniy Sokolov), virsh
+          shutdown improvements and test (Jim Meyering), better report of
+          XML well formedness errors (Richard Jones), new XML elements
+          (Daniel Berrange), virsh "edit" command (Richard Jones), save
+          UUID of OpenVZ domains (Evgeniy Sokolov), improve xen blocks
+          statistics (Chris Lalancette), gnulib updates (Jim Meyering),
+          allow to add disk as USB devices (Guido G<>nther), LXC container
+          process should survive libvirtd restarts (Daniel Berrange), allow
+          to define static host domain configs, number of CPU used by
+          OpenVZ domains (Evgeniy Sokolov), private root fs for LXC (Daniel
+          Berrange), storage source information in storage pools (David Lively),
+          virsh reports attach and detach success (Cole Robinson), detect
+          failure in QEmu eject command (Cole Robinson), add support for
+          eect on floppy and SCSI cdroms for QEmu (Cole Robinson), LXC
+          hypervisor version extraction (Dan Smith), Augeas config file support
+          (Daniel Berrange), support for a domain name in network
+          config (JJ Reynolds).
+   - Cleanups: Python verbosity cleanup (Ryan Scott),
+          space and tabs cleanups (Atsushi SAKAI), OpenVZ and LXC drivers
+          cleanup and unification of XML handling (Daniel Berrange), updates
+          to Relax-NG XML schemas (John Levon and Daniel Berrange), more
+          printf format checkings (Jim Meyering), VIR_FREE related cleanups
+          (Jim Meyering), integer string parsing cleanup (Evgeniy Sokolov),
+          initial OpenVZ xml refactoring (Evgeniy Sokolov), better error
+          message on domain redefine (Charles Duffy), check XML files against
+          the RNG Schemas (Daniel Berrange), const-correctness in virsh
+          (Richard Jones and Jim Meyering), const-correctness and cleanups
+          in LXC and OpenVZ drivers (Daniel Berrange), virFileLinkPointsTo
+          rewrite (Jim Meyering), cleanup of the conditional compilation
+          of C files (Daniel Berrange), shell quoting fixes (Jim Meyering),
+          parallel build support (James Morris and Jim Meyering), new
+          convenenience virFileReadLimFD function (Jim Meyering).  
+
+
+0.4.4: Jun 25 2008:
+   - Bug fixes: QEmu network serialization (Kaitlin Rupert), internal
+          memory allocation fixes (Chris Lalancette Jim Meyering), virsh
+	  large file config problem (Jim Meyering), xen list APIs when
+	  max is zero, string escape problems in the xm driver 
+   - Improvements: add autogen to tarballs, improve iSCSI support
+          (Chris Lalancette), localization updates 
+   - Cleanups: const-ness fixed (Daniel P. Berrange), string helpers
+          for enumeations (Daniel P. Berrange)
+
+
+0.4.3: Jun 12 2008:
+   - New features: Linux Container start and stop (Dave Leskovec),
+          Network interface model settings (Daniel Berrange),serial and parallel
+	  device support for QEmu and Xen (Daniel Berrange),
+          Sound support for QEmu and Xen (Cole Robinson), vCPU settings for
+	  QEmu (Cole Robinson), support for NUMA and vCPU pinning in QEmu
+	  (Daniel Berrange), new virDomainBlockPeek API (Richard Jones)
+   - Documentation: coding guidelines (Jim Meyering and Richard Jones),
+          small man page missing entries and cleanup,
+	  Web site revamp (Daniel Berrange),
+	  typo fixes (Atsushi SAKAI), more docs on network XML format
+	  (Daniel Berrange), libvirt Wiki (Daniel Berrange),
+	  policykit config docs (Cole Robinson), XML domain docs revamp
+	  (Daniel Berrange), docs for remote listen-tls/tcp fixes (Kenneth
+	  Nagin),  
+   - Bug fixes: save change to config file for Xen (Ryan Scott),
+          fix /var/run/libvirt/ group ownership (Anton Protopopov),
+	  ancient libparted workaround (Soren Hansen), out of bount
+	  array access (Daniel Berrange), remote check bug (Dave Leskovec),
+	  LXC signal and daemon restart problems (Dave Leskovec), bus selection
+	  logic fix in the daemon config (Daniel Berrange), 2 memory leaks
+	  in the daemon (Jim Meyering), daemon pid file logic bug fix
+	  (Daniel Berrange), python generator fixes (Daniel Berrange),
+	  ivarious leaks and memory problem pointed by valgrind (Daniel
+	  Berrange), iptables forwarding cleanup (Daniel Berrange),
+	  Xen cpuset value checking (Hiroyuki Kaguchi), container process
+	  checks for LXC (Dave Leskovec), let xend check block device syntax
+	  (Hiroyuki Kaguchi), UUIDString for python fixes (Cole Robinson)
+   - Improvements: fixes for MinGW compilation (Richard Jones),
+          autostart for running Xen domains (Cole Robinson),
+	  control of listening IP for daemon (Stefan de Konink),
+	  various Xenner related fixes and improvements (Daniel Berrange)
+	  autostart status printed in virsh domainfo (Shigeki Sakamoto),
+	  better error messages for xend driver (Richard Jones)
+   - Code cleanups: OpenVZ compilation (Richard Jones), conn dom and
+          net fields deprecation in error structures (Richard Jones),
+	  Xen-ism on UUID (Richard Jones), add missing .pod to dist (Richard
+	  Jones), tab cleanup from sources (Jim Meyering), remove unused field
+	  in virsh control structure (Richard Jones), compilation without
+	  pthread.h (Jim Meyering), cleanup of tests (Daniel Berrange),
+	  syntax-check improvements (Jim Meyering), python cleanup,
+	  remove dependancy on libc is_* character tests (Jim Meyering),
+	  format related cleanups (Jim Meyering), cleanup of the buffer
+	  internal APIs (Daniel Berrange), conversion to the new memory
+	  allocation API (Daniel Berrange), lcov coverage testing
+	  (Daniel Berrange), gnulib updates (Jim Meyering), compatibility
+	  fix with RHEL 5 (Daniel Berrange), SuSE compatibility fix (Jim
+	  Fehlig), const'ification of a number of structures (Jim Meyering),
+	  string comparison macro cleanups (Daniel Berrange), character
+	  range testing cleanups and assorted bug fixes (Jim Meyering),
+	  QEmu test fixes (Daniel Berrange), configure macro cleanup (Daniel
+	  Berrange), refactor QEmu command line building code (Daniel Berrange),
+	  type punning warning in remote code (Richard Jones), refactoring
+	  of internal headers (Richard Jones), generic out of memory
+	  testing and associated bug fixes (Daniel Berrange), don't raise
+	  internal error for unsupported features (Kaitlin Rupert),
+	  missing driver entry points (Daniel Berrange)
+
+
+0.4.2: Apr 8 2008:
+   - New features: memory operation for QEmu/KVM driver (Cole Robinson),
+      new routed networking schemas (Mads Olesen)
+   - Documentation: storage documentation fixes (Atsushi Sakai), many
+      typo cleanups (Atsushi Sakai), string fixes (Francesco Tombolini)
+   - Bug fixes: pointer errors in qemu (Jim Meyering), iSCSI login fix
+      (Chris Lalancette), well formedness error in test driver capabilities
+      (Cole Robinson), fixes cleanup code when daemon exits (Daniel Berrange),
+      CD Rom change on live QEmu/KVM domains (Cole Robinson), setting scheduler
+      parameter is forbidden for read-only (Saori Fukuta)i, fixes for TAP
+      devices (Daniel Berrange), assorted storage driver fixes (Daniel
+      Berrange), Makefile fixes (Jim Meyering), Xen-3.2 hypercall fix,
+      fix iptables rules to avoid blocking traffic within virtual network
+      (Daniel Berrange), XML output fix for directory pools (Daniel Berrange),
+      remove dandling domain/net/conn pointers from error data, do not
+      ask polkit auth when root (Daniel Berrange), handling of fork and
+      pipe errors when starting the daemon (Richard Jones)
+   - Improvements: better validation of MAC addresses (Jim Meyering and
+      Hiroyuki Kaguchi),
+      virsh vcpupin error report (Shigeki Sakamoto), keep boot tag on
+      HVM domains (Cole Robinson), virsh non-root should not be limited to read
+      only anymore (Daniel Berrange), switch to polkit-auth from polkit-grant
+      (Daniel Berrange), better handling of missing SElinux data (Daniel
+      Berrange and Jim Meyering), cleanup of the connection opening logic
+      (Daniel Berrange), first bits of Linux Containers support (Dave Leskovec),
+      scheduler API support via xend (Saori Fukuta), improvement of the
+      testing framework and first tests (Jim Meyering), missing error
+      messages from virsh parameters validation (Shigeki Sakamoto),
+      improve support of older iscsiadm command (Chris Lalancette),
+      move linux container support in the daemon (Dan Berrange), older
+      awk implementation support (Mike Gerdts), NUMA support in test
+      driver (Cole Robinson), xen and hvm added to test driver capabilities
+      (Cole Robinson)
+   - Code cleanup: remove unused getopt header (Jim Meyering), mark more
+      strings as translatable (Guido G<>nther and Jim Meyering), convert
+      error strings to something meaningful and translatable (Jim Meyering),
+      Linux Containers code cleanup, last error initializer (Guido G<>nther)
+
+
 0.4.1: Mar 3 2008:
    - New features: build on MacOSX (Richard Jones), storage management
       (Daniel Berrange), Xenner - Xen on KVM - support (Daniel Berrange)

autobuild.sh

@@ -5,7 +5,7 @@ set -v
 
 # Make things clean.
 
-test -n "$1" && RESULTS="$1" || RESULTS="results.log"
+test -n "$1" && RESULTS=$1 || RESULTS=results.log
 
 test -f Makefile && make -k distclean || :
 rm -rf coverage
@@ -14,27 +14,78 @@ rm -rf coverage
 #mkdir build
 #cd build
 
-./autogen.sh --prefix=$AUTOBUILD_INSTALL_ROOT \
+./autogen.sh --prefix="$AUTOBUILD_INSTALL_ROOT" \
   --enable-test-coverage \
-  --enable-compile-warnings=error
+  --enable-compile-warnings=error \
+  --with-xen-proxy
+
+# If the MAKEFLAGS envvar does not yet include a -j option,
+# add -jN where N depends on the number of processors.
+case $MAKEFLAGS in
+  *-j*) ;;
+  *) n=$(getconf _NPROCESSORS_ONLN 2> /dev/null)
+    test "$n" -gt 0 || n=1
+    n=$(expr $n + 1)
+    MAKEFLAGS="$MAKEFLAGS -j$n"
+    export MAKEFLAGS
+    ;;
+esac
 
 make
 make install
 
 set -o pipefail
-make check 2>&1 | tee $RESULTS
-make syntax-check 2>&1 | tee -a $RESULTS
-make cov
+make check 2>&1 | tee "$RESULTS"
+make syntax-check 2>&1 | tee -a "$RESULTS"
+test -x /usr/bin/lcov && make cov
 
 rm -f *.tar.gz
 make dist
 
-if [ -f /usr/bin/rpmbuild ]; then
-  if [ -n "$AUTOBUILD_COUNTER" ]; then
-    EXTRA_RELEASE=".auto$AUTOBUILD_COUNTER"
-  else
-    NOW=`date +"%s"`
-    EXTRA_RELEASE=".$USER$NOW"
-  fi
-  rpmbuild --nodeps --define "extra_release $EXTRA_RELEASE" -ta --clean *.tar.gz
+if [ -n "$AUTOBUILD_COUNTER" ]; then
+  EXTRA_RELEASE=".auto$AUTOBUILD_COUNTER"
+else
+  NOW=`date +"%s"`
+  EXTRA_RELEASE=".$USER$NOW"
+fi
+
+if [ -f /usr/bin/rpmbuild ]; then
+  rpmbuild --nodeps \
+     --define "extra_release $EXTRA_RELEASE" \
+     --define "_sourcedir `pwd`" \
+     -ba --clean libvirt.spec
+fi
+
+if [ -x /usr/bin/i686-pc-mingw32-gcc ]; then
+  make distclean
+
+  PKG_CONFIG_PATH="$AUTOBUILD_INSTALL_ROOT/i686-pc-mingw32/sys-root/mingw/lib/pkgconfig" \
+  CC="i686-pc-mingw32-gcc" \
+  ./configure \
+    --build=$(uname -m)-pc-linux \
+    --host=i686-pc-mingw32 \
+    --prefix="$AUTOBUILD_INSTALL_ROOT/i686-pc-mingw32/sys-root/mingw" \
+    --without-sasl \
+    --without-avahi \
+    --without-polkit \
+    --without-python \
+    --without-xen \
+    --without-qemu \
+    --without-lxc \
+    --without-uml \
+    --without-openvz \
+    --without-libvirtd
+
+  make
+  make install
+
+  #set -o pipefail
+  #make check 2>&1 | tee "$RESULTS"
+
+  if [ -f /usr/bin/rpmbuild ]; then
+    rpmbuild --nodeps \
+       --define "extra_release $EXTRA_RELEASE" \
+       --define "_sourcedir `pwd`" \
+       -ba --clean mingw32-libvirt.spec
+  fi
 fi

bootstrap

@@ -48,7 +48,7 @@ cleanup_gnulib() {
 
 case ${GNULIB_SRCDIR--} in
 -)
-  if [ ! -d gnulib ]; then
+  if [ ! -d .gnulib ]; then
     echo "$0: getting gnulib files..."
 
     trap cleanup_gnulib 1 2 13 15
@@ -64,6 +64,35 @@ esac
 gnulib_tool=$GNULIB_SRCDIR/gnulib-tool
 <$gnulib_tool || exit
 
+modules='
+c-ctype
+close
+connect
+getaddrinfo
+gethostname
+getpass
+gettext
+inet_pton
+mkstemp
+mktempd
+perror
+physmem
+poll
+posix-shell
+recv
+send
+setsockopt
+socket
+strndup
+strerror
+strsep
+sys_stat
+useless-if-before-free
+vasprintf
+verify
+vc-list-files
+'
+
 # Tell gnulib to:
 #   require LGPLv2+
 #   put *.m4 files in new gnulib/m4/ dir
@@ -75,13 +104,7 @@ $gnulib_tool			\
   --m4-base=gnulib/m4		\
   --source-base=gnulib/lib	\
   --tests-base=gnulib/tests	\
-  --import physmem getaddrinfo  \
-    sys_stat vasprintf strndup  \
-    strsep poll gettext getpass \
-    useless-if-before-free      \
-    posix-shell                 \
-    mktempd                     \
-    vc-list-files
+  --import $modules
 
 rm -f				\
     .gitignore			\

build-aux/.gitignore

@@ -0,0 +1,10 @@
+compile
+config.guess
+config.rpath
+config.sub
+depcomp
+install-sh
+ltmain.sh
+missing
+mkinstalldirs
+mktempd

build-aux/mktempd

@@ -44,7 +44,7 @@ rand_bytes()
   dev_rand=/dev/urandom
   if test -r "$dev_rand"; then
     # Note: 256-length($chars) == 194; 3 copies of $chars is 186 + 8 = 194.
-    head -c$n "$dev_rand" | tr -c $chars 01234567$chars$chars$chars
+    dd ibs=$n count=1 if="$dev_rand" | tr -c $chars 01234567$chars$chars$chars
     return
   fi
 
@@ -114,7 +114,9 @@ mktempd()
   base_template=`echo "$template"|sed 's/XX*$//'`
 
   # Calculate how many X's we've just removed.
-  nx=`expr length "$template" - length "$base_template"`
+  template_length=`echo "$template" | wc -c`
+  nx=`echo "$base_template" | wc -c`
+  nx=`expr $template_length - $nx`
 
   err=
   i=1

build-aux/useless-if-before-free

@@ -2,7 +2,7 @@
 # Detect instances of "if (p) free (p);".
 # Likewise for "if (p != NULL) free (p);".  And with braces.
 
-my $VERSION = '2008-03-12 13:06'; # UTC
+my $VERSION = '2008-05-25 17:36'; # UTC
 # The definition above must lie within the first 8 lines in order
 # for the Emacs time-stamp write hook (at end) to update it.
 # If you change this file with Emacs, please let the write hook
@@ -68,8 +68,8 @@ OPTIONS:
 
 Exit status:
 
-  0   no match
-  1   one or more matches
+  0   one or more matches
+  1   no match
   2   an error
 
 EXAMPLE:
@@ -121,15 +121,23 @@ EOF
           $err = EXIT_ERROR, next;
       while (defined (my $line = <FH>))
         {
-          if ($line =~
-              /\b(if\s*\(\s*(\S+?)(?:\s*!=\s*NULL)?\s*\)
-               (?:   \s*$regexp\s*\((?:\s*\([^)]+\))\s*\2\s*\)|
-                \s*\{\s*$regexp\s*\((?:\s*\([^)]+\))\s*\2\s*\)\s*;\s*\}))/sx)
+          while ($line =~
+              /\b(if\s*\(\s*([^)]+?)(?:\s*!=\s*NULL)?\s*\)
+               (?:   \s*$regexp\s*\((?:\s*\([^)]+\))?\s*([^)]+)\)|
+                \s*\{\s*$regexp\s*\((?:\s*\([^)]+\))?\s*([^)]+)\)\s*;\s*\}))/sxg)
             {
-              $found_match = 1;
-              $list
-                and (print "$file\0"), next FILE;
-              print "$file: $1\n";
+              # Compare "if" expression and free'd expression,
+              # without regard to white space.
+              (my $e1 = $2) =~ tr/ \t//d;
+              my $e2 = defined $3 ? $3 : $4;
+              $e2 =~ tr/ \t//d;
+              if ($e1 eq $e2)
+                {
+                  $found_match = 1;
+                  $list
+                    and (print "$file\0"), next FILE;
+                  print "$file: $1\n";
+                }
             }
         }
     }
@@ -149,12 +157,12 @@ my $foo = <<'EOF';
 # This adjusts them, removing the unnecessary "if (p)" part.
 
 # FIXME: do something like this as an option (doesn't do braces):
-git ls-files -z |xargs -0 \
-perl -0x3b -pi -e 's/\bif\s*\(\s*(\S+?)(?:\s*!=\s*NULL)?\s*\)\s+(k?free\s*\(\s*\1\s*\))/$2/s'
-
 useless-if-before-free -l $(lid -knone free) | xargs -0 \
   perl -0x3b -pi -e \
-   's/\bif\s*\(\s*(\S+?)(?:\s*!=\s*NULL)?\s*\)\s+(free\s*\(\s*\1\s*\))/$2/s'
+   's/\bif\s*\(\s*(\S+?)(?:\s*!=\s*NULL)?\s*\)\s+(free\s*\((?:\s*\([^)]+\))?\s*\1\s*\))/$2/s'
+
+# Or, with git:
+git ls-files -z |xargs -0 perl -0x3b -pi -e '...'
 
 Be careful that the result of the above transformation is valid.
 If the matched string is followed by "else", then obviously, it won't be.

build-aux/vc-list-files

@@ -1,6 +1,9 @@
 #!/bin/sh
 # List version-controlled file names.
 
+# Print a version string.
+scriptversion=2008-07-11.19
+
 # Copyright (C) 2006-2008 Free Software Foundation, Inc.
 
 # This program is free software: you can redistribute it and/or modify
@@ -20,38 +23,85 @@
 # List the specified version-controlled files.
 # With no argument, list them all.  With a single DIRECTORY argument,
 # list the version-controlled files in that directory.
-# This script must be run solely from the top of a $srcdir build directory.
 
 # If there's an argument, it must be a single, "."-relative directory name.
 # cvsu is part of the cvsutils package: http://www.red-bean.com/cvsutils/
 
+postprocess=
+case $1 in
+  --help) cat <<EOF
+Usage: $0 [-C SRCDIR] [DIR]
+
+Output a list of version-controlled files in DIR (default .), relative to
+SRCDIR (default .).  SRCDIR must be the top directory of a checkout.
+
+Options:
+  --help     print this help, then exit
+  --version  print version number, then exit
+  -C SRCDIR  change directory to SRCDIR before generating list
+
+Report bugs and patches to <bug-gnulib@gnu.org>.
+EOF
+    exit ;;
+
+  --version)
+    year=`echo "$scriptversion" | sed 's/[^0-9].*//'`
+    cat <<EOF
+vc-list-files $scriptversion
+Copyright (C) $year Free Software Foundation, Inc,
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+EOF
+    exit ;;
+
+  -C)
+    test "$2" = . || postprocess="| sed 's|^|$2/|'"
+    cd "$2" || exit 1
+    shift; shift ;;
+esac
+
 dir=
 case $# in
   0) ;;
   1) dir=$1 ;;
   *) echo "$0: too many arguments" 1>&2
-     echo "Usage: $0 [DIR]" 1>&2; exit 1;;
+     echo "Usage: $0 [-C srcdir] [DIR]" 1>&2; exit 1;;
 esac
 
 test "x$dir" = x && dir=.
 
 if test -d .git; then
-  exec git ls-files "$dir"
+  eval exec git ls-files '"$dir"' $postprocess
 elif test -d .hg; then
-  exec hg locate "$dir/*"
+  eval exec hg locate '"$dir/*"' $postprocess
+elif test -d .bzr; then
+  test "$postprocess" = '' && postprocess="| sed 's|^\./||'"
+  eval exec bzr ls --versioned '"$dir"' $postprocess
 elif test -d CVS; then
+  test "$postprocess" = '' && postprocess="| sed 's|^\./||'"
   if test -x build-aux/cvsu; then
-    build-aux/cvsu --find --types=AFGM "$dir"
+    eval build-aux/cvsu --find --types=AFGM '"$dir"' $postprocess
+  elif (cvsu --help) >/dev/null 2>&1; then
+    eval cvsu --find --types=AFGM '"$dir"' $postprocess
   else
-    awk -F/ '{				\
+    eval awk -F/ \''{			\
 	if (!$1 && $3 !~ /^-/) {	\
 	  f=FILENAME;			\
-	  sub(/CVS\/Entries/, "", f);	\
+	  if (f ~ /CVS\/Entries$/)	\
+	    f = substr(f, 0, length(f)-11); \
 	  print f $2;			\
-	}}'				\
-      $(find ${*-*} -name Entries -print) /dev/null;
+	}}'\''				\
+      `find "$dir" -name Entries -print` /dev/null' $postprocess
   fi
 else
-  echo "$0: Failed to determine type of version control used in "`pwd` 1>&2
+  echo "$0: Failed to determine type of version control used in `pwd`" 1>&2
   exit 1
 fi
+
+# Local variables:
+# eval: (add-hook 'write-file-hooks 'time-stamp)
+# time-stamp-start: "scriptversion="
+# time-stamp-format: "%:y-%02m-%02d.%02H"
+# time-stamp-end: "$"
+# End:

docs/.cvsignore

@@ -1,3 +1,4 @@
 Makefile
 Makefile.in
 .memdump
+apibuild.pyc

docs/.gitignore

@@ -0,0 +1,4 @@
+Makefile
+Makefile.in
+.memdump
+apibuild.pyc

docs/ChangeLog.xsl

@@ -3,83 +3,35 @@
 <xsl:stylesheet version="1.0"
   xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
 
-  <!-- Import the rest of the site stylesheets -->
-  <xsl:import href="site.xsl"/>
-
   <!-- Generate XHTML-1.0 transitional -->
   <xsl:output method="xml" encoding="ISO-8859-1" indent="yes"
-      doctype-public="-//W3C//DTD XHTML 1.0 Transitional//EN"
-      doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"/>
-
-  <xsl:param name="module">libvirt</xsl:param>
-
-  <!-- The table of content for the HTML page -->
-  <xsl:variable name="menu_name">API Menu</xsl:variable>
-  <xsl:variable name="develtoc">
-    <form action="../search.php"
-          enctype="application/x-www-form-urlencoded" method="get">
-      <input name="query" type="text" size="20" value=""/>
-      <input name="submit" type="submit" value="Search ..."/>
-    </form>
-    <ul><!-- style="margin-left: -1em" -->
-      <li><a style="font-weight:bold"
-             href="{$href_base}index.html">Main Menu</a></li>
-      <li><a style="font-weight:bold"
-             href="{$href_base}html/index.html">Modules Index</a></li>
-      <li><a style="font-weight:bold"
-             href="index.html">API Menu</a></li>
-    </ul>
-  </xsl:variable>
-
-  <xsl:template match="bug">
-    <a href="https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id={@number}">
-    <xsl:value-of select="@number"/></a>
-  </xsl:template>
+      doctype-public="-//W3C//DTD XHTML 1.0//EN"
+      doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"/>
 
   <xsl:template match="item">
     <li><xsl:apply-templates/></li>
   </xsl:template>
 
   <xsl:template match="entry">
-
     <p>
-    <b><xsl:value-of select="@who"/></b>
-       <xsl:text> </xsl:text>
-       <xsl:value-of select="@date"/>
-       <xsl:text> </xsl:text>
-       <xsl:value-of select="@timezone"/>
+      <span class="author"><xsl:value-of select="@who"/> </span>
+      <span class="date"><xsl:value-of select="@date"/> </span>
+      <span class="timezone"><xsl:value-of select="@timezone"/> </span>
+    </p>
     <ul>
       <xsl:apply-templates select="item"/>
     </ul>
-    </p>
   </xsl:template>
 
   <xsl:template match="log">
-    <xsl:variable name="title">ChangeLog last entries of <xsl:value-of select="$module"/></xsl:variable>
-      <html>
-        <head>
-          <xsl:call-template name="style"/>
-          <xsl:element name="title">
-            <xsl:value-of select="$title"/>
-          </xsl:element>
-        </head>
-	<body>
-	<div id="container">
-	  <div id="intro">
-	    <div id="adjustments"/>
-	    <div id="pageHeader"/>
-	    <div id="content2">
-	      <xsl:call-template name="titlebox">
-		<xsl:with-param name="title" select="$title"/>
-	      </xsl:call-template>
-	      <xsl:apply-templates select="entry"/>
-	    </div>
-	  </div>
-	  <xsl:call-template name="linkList2"/>
-	  <xsl:call-template name="bottom"/>
-	</div>
-	</body>
-      </html>
+    <html>
+      <body>
+        <h1>Log of recent changes to libvirt</h1>
+        <div id="changelog">
+          <xsl:apply-templates select="entry"/>
+        </div>
+      </body>
+    </html>
   </xsl:template>
 
 </xsl:stylesheet>

docs/FAQ.html

@@ -1,80 +1,198 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>FAQ</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">FAQ</h1><p>Table of Contents:</p><ul><li><a href="FAQ.html#License">License(s)</a></li>
-  <li><a href="FAQ.html#Installati">Installation</a></li>
-  <li><a href="FAQ.html#Compilatio">Compilation</a></li>
-  <li><a href="FAQ.html#Developer">Developer corner</a></li>
-</ul><h3><a name="License" id="License">License</a>(s)</h3><ol><li><em>Licensing Terms for libvirt</em>
-    <p>libvirt is released under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU Lesser
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from FAQ.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: FAQ</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <span class="active">FAQ</span>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>FAQ</h1>
+        <p>Table of Contents:</p>
+        <ul><li>
+        <a href="FAQ.html#License">License(s)</a>
+      </li><li>
+        <a href="FAQ.html#Installati">Installation</a>
+      </li><li>
+        <a href="FAQ.html#Compilatio">Compilation</a>
+      </li><li>
+        <a href="FAQ.html#Developer">Developer corner</a>
+      </li></ul>
+        <h3><a name="License" id="License">License</a>(s)</h3>
+        <ol><li>
+        <em>Licensing Terms for libvirt</em>
+        <p>libvirt is released under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU Lesser
     General Public License</a>, see the file COPYING.LIB in the distribution
     for the precise wording. The only library that libvirt depends upon is
     the Xen store access library which is also licenced under the LGPL.</p>
-  </li>
-  <li><em>Can I embed libvirt in a proprietary application ?</em>
-    <p>Yes. The LGPL allows you to embed libvirt into a proprietary
+      </li><li>
+        <em>Can I embed libvirt in a proprietary application ?</em>
+        <p>Yes. The LGPL allows you to embed libvirt into a proprietary
     application. It would be graceful to send-back bug fixes and improvements
     as patches for possible incorporation in the main development tree. It
     will decrease your maintenance costs anyway if you do so.</p>
-  </li>
-</ol><h3><a name="Installati" id="Installati">Installation</a></h3><ol><li><em>Where can I get libvirt</em> ?
+      </li></ol>
+        <h3>
+      <a name="Installati" id="Installati">Installation</a>
+    </h3>
+        <ol><li><em>Where can I get libvirt</em> ?
     <p>The original distribution comes from <a href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/</a>.</p>
-  </li>
-  <li><em>I can't install the libvirt/libvirt-devel RPM packages due to
+  </li><li>
+        <em>I can't install the libvirt/libvirt-devel RPM packages due to
     failed dependencies</em>
-    <p>The most generic solution is to re-fetch the latest src.rpm , and
+        <p>The most generic solution is to re-fetch the latest src.rpm , and
     rebuild it locally with</p>
-    <p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p>
-    <p>If everything goes well it will generate two binary rpm packages (one
+        <p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p>
+        <p>If everything goes well it will generate two binary rpm packages (one
     providing the shared libs and virsh, and the other one, the -devel
     package, providing includes, static libraries and scripts needed to build
     applications with libvirt that you can install locally.</p>
-    <p>One can also rebuild the RPMs from a tarball:</p>
-    <p><code>rpmbuild -ta libdir-xxx.tar.gz</code></p>
-    <p>Or from a configured tree with:</p>
-    <p><code>make rpm</code></p>
-  </li>
-  <li><em>Failure to use the API for non-root users</em>
-    <p>Large parts of the API may only be accessible with root privileges,
+        <p>One can also rebuild the RPMs from a tarball:</p>
+        <p>
+          <code>rpmbuild -ta libdir-xxx.tar.gz</code>
+        </p>
+        <p>Or from a configured tree with:</p>
+        <p>
+          <code>make rpm</code>
+        </p>
+      </li><li>
+        <em>Failure to use the API for non-root users</em>
+        <p>Large parts of the API may only be accessible with root privileges,
     however the read only access to the xenstore data doesnot have to be
     forbidden to user, at least for monitoring purposes. If "virsh dominfo"
     fails to run as an user, change the mode of the xenstore read-only socket
     with:</p>
-    <p><code>chmod 666 /var/run/xenstored/socket_ro</code></p>
-    <p>and also make sure that the Xen Daemon is running correctly with local
+        <p>
+          <code>chmod 666 /var/run/xenstored/socket_ro</code>
+        </p>
+        <p>and also make sure that the Xen Daemon is running correctly with local
     HTTP server enabled, this is defined in
     <code>/etc/xen/xend-config.sxp</code> which need the following line to be
     enabled:</p>
-    <p><code>(xend-http-server yes)</code></p>
-    <p>If needed restart the xend daemon after making the change with the
+        <p>
+          <code>(xend-http-server yes)</code>
+        </p>
+        <p>If needed restart the xend daemon after making the change with the
     following command run as root:</p>
-    <p><code>service xend restart</code></p>
-  </li>
-</ol><h3><a name="Compilatio" id="Compilatio">Compilation</a></h3><ol><li><em>What is the process to compile libvirt ?</em>
-    <p>As most UNIX libraries libvirt follows the "standard":</p>
-    <p><code>gunzip -c libvirt-xxx.tar.gz | tar xvf -</code></p>
-    <p><code>cd libvirt-xxxx</code></p>
-    <p><code>./configure --help</code></p>
-    <p>to see the options, then the compilation/installation proper</p>
-    <p><code>./configure [possible options]</code></p>
-    <p><code>make</code></p>
-    <p><code>make install</code></p>
-    <p>At that point you may have to rerun ldconfig or a similar utility to
+        <p>
+          <code>service xend restart</code>
+        </p>
+      </li></ol>
+        <h3>
+      <a name="Compilatio" id="Compilatio">Compilation</a>
+    </h3>
+        <ol><li>
+        <em>What is the process to compile libvirt ?</em>
+        <p>As most UNIX libraries libvirt follows the "standard":</p>
+        <p>
+          <code>gunzip -c libvirt-xxx.tar.gz | tar xvf -</code>
+        </p>
+        <p>
+          <code>cd libvirt-xxxx</code>
+        </p>
+        <p>
+          <code>./configure --help</code>
+        </p>
+        <p>to see the options, then the compilation/installation proper</p>
+        <p>
+          <code>./configure [possible options]</code>
+        </p>
+        <p>
+          <code>make</code>
+        </p>
+        <p>
+          <code>make install</code>
+        </p>
+        <p>At that point you may have to rerun ldconfig or a similar utility to
     update your list of installed shared libs.</p>
-  </li>
-  <li><em>What other libraries are needed to compile/install libvirt ?</em>
-    <p>Libvirt requires libxenstore, which is usually provided by the xen
+      </li><li>
+        <em>What other libraries are needed to compile/install libvirt ?</em>
+        <p>Libvirt requires libxenstore, which is usually provided by the xen
     packages as well as the public headers to compile against libxenstore.</p>
-  </li>
-  <li><em>I use the CVS version and there is no configure script</em>
-    <p>The configure script (and other Makefiles) are generated. Use the
+      </li><li>
+        <em>I use the CVS version and there is no configure script</em>
+        <p>The configure script (and other Makefiles) are generated. Use the
     autogen.sh script to regenerate the configure script and Makefiles,
     like:</p>
-    <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
-  </li>
-</ol><h3><a name="Developer" id="Developer">Developer</a> corner</h3><ol><li><em>Troubles compiling or linking programs using libvirt</em>
-    <p>To simplify the process of reusing the library, libvirt comes with
+        <p>
+          <code>./autogen.sh --prefix=/usr --disable-shared</code>
+        </p>
+      </li></ol>
+        <h3><a name="Developer" id="Developer">Developer</a> corner</h3>
+        <ol><li>
+        <em>Troubles compiling or linking programs using libvirt</em>
+        <p>To simplify the process of reusing the library, libvirt comes with
     pkgconfig support, which can be used directly from autoconf support or
     via the pkg-config command line tool, like:</p>
-    <p><code>pkg-config libvirt --libs</code></p>
-  </li>
-</ol></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+        <p>
+          <code>pkg-config libvirt --libs</code>
+        </p>
+      </li></ol>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/FAQ.html.in

@@ -0,0 +1,144 @@
+<?xml version="1.0"?>
+<html>
+  <body>
+    <h1 >FAQ</h1>
+    <p>Table of Contents:</p>
+    <ul>
+      <li>
+        <a href="FAQ.html#License">License(s)</a>
+      </li>
+      <li>
+        <a href="FAQ.html#Installati">Installation</a>
+      </li>
+      <li>
+        <a href="FAQ.html#Compilatio">Compilation</a>
+      </li>
+      <li>
+        <a href="FAQ.html#Developer">Developer corner</a>
+      </li>
+    </ul>
+    <h3><a name="License" id="License">License</a>(s)</h3>
+    <ol>
+      <li>
+        <em>Licensing Terms for libvirt</em>
+        <p>libvirt is released under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU Lesser
+    General Public License</a>, see the file COPYING.LIB in the distribution
+    for the precise wording. The only library that libvirt depends upon is
+    the Xen store access library which is also licenced under the LGPL.</p>
+      </li>
+      <li>
+        <em>Can I embed libvirt in a proprietary application ?</em>
+        <p>Yes. The LGPL allows you to embed libvirt into a proprietary
+    application. It would be graceful to send-back bug fixes and improvements
+    as patches for possible incorporation in the main development tree. It
+    will decrease your maintenance costs anyway if you do so.</p>
+      </li>
+    </ol>
+    <h3>
+      <a name="Installati" id="Installati">Installation</a>
+    </h3>
+    <ol>
+      <li><em>Where can I get libvirt</em> ?
+    <p>The original distribution comes from <a href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/</a>.</p>
+  </li>
+      <li>
+        <em>I can't install the libvirt/libvirt-devel RPM packages due to
+    failed dependencies</em>
+        <p>The most generic solution is to re-fetch the latest src.rpm , and
+    rebuild it locally with</p>
+        <p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p>
+        <p>If everything goes well it will generate two binary rpm packages (one
+    providing the shared libs and virsh, and the other one, the -devel
+    package, providing includes, static libraries and scripts needed to build
+    applications with libvirt that you can install locally.</p>
+        <p>One can also rebuild the RPMs from a tarball:</p>
+        <p>
+          <code>rpmbuild -ta libdir-xxx.tar.gz</code>
+        </p>
+        <p>Or from a configured tree with:</p>
+        <p>
+          <code>make rpm</code>
+        </p>
+      </li>
+      <li>
+        <em>Failure to use the API for non-root users</em>
+        <p>Large parts of the API may only be accessible with root privileges,
+    however the read only access to the xenstore data doesnot have to be
+    forbidden to user, at least for monitoring purposes. If "virsh dominfo"
+    fails to run as an user, change the mode of the xenstore read-only socket
+    with:</p>
+        <p>
+          <code>chmod 666 /var/run/xenstored/socket_ro</code>
+        </p>
+        <p>and also make sure that the Xen Daemon is running correctly with local
+    HTTP server enabled, this is defined in
+    <code>/etc/xen/xend-config.sxp</code> which need the following line to be
+    enabled:</p>
+        <p>
+          <code>(xend-http-server yes)</code>
+        </p>
+        <p>If needed restart the xend daemon after making the change with the
+    following command run as root:</p>
+        <p>
+          <code>service xend restart</code>
+        </p>
+      </li>
+    </ol>
+    <h3>
+      <a name="Compilatio" id="Compilatio">Compilation</a>
+    </h3>
+    <ol>
+      <li>
+        <em>What is the process to compile libvirt ?</em>
+        <p>As most UNIX libraries libvirt follows the "standard":</p>
+        <p>
+          <code>gunzip -c libvirt-xxx.tar.gz | tar xvf -</code>
+        </p>
+        <p>
+          <code>cd libvirt-xxxx</code>
+        </p>
+        <p>
+          <code>./configure --help</code>
+        </p>
+        <p>to see the options, then the compilation/installation proper</p>
+        <p>
+          <code>./configure [possible options]</code>
+        </p>
+        <p>
+          <code>make</code>
+        </p>
+        <p>
+          <code>make install</code>
+        </p>
+        <p>At that point you may have to rerun ldconfig or a similar utility to
+    update your list of installed shared libs.</p>
+      </li>
+      <li>
+        <em>What other libraries are needed to compile/install libvirt ?</em>
+        <p>Libvirt requires libxenstore, which is usually provided by the xen
+    packages as well as the public headers to compile against libxenstore.</p>
+      </li>
+      <li>
+        <em>I use the CVS version and there is no configure script</em>
+        <p>The configure script (and other Makefiles) are generated. Use the
+    autogen.sh script to regenerate the configure script and Makefiles,
+    like:</p>
+        <p>
+          <code>./autogen.sh --prefix=/usr --disable-shared</code>
+        </p>
+      </li>
+    </ol>
+    <h3><a name="Developer" id="Developer">Developer</a> corner</h3>
+    <ol>
+      <li>
+        <em>Troubles compiling or linking programs using libvirt</em>
+        <p>To simplify the process of reusing the library, libvirt comes with
+    pkgconfig support, which can be used directly from autoconf support or
+    via the pkg-config command line tool, like:</p>
+        <p>
+          <code>pkg-config libvirt --libs</code>
+        </p>
+      </li>
+    </ol>
+  </body>
+</html>

docs/Makefile.am

@@ -4,45 +4,44 @@ SUBDIRS= . examples devhelp
 # The directory containing the source code (if it contains documentation).
 DOC_SOURCE_DIR=../src
 
-PAGES= index.html bugs.html FAQ.html remote.html
-
 man_MANS=
 
-html =			\
-  book1.html		\
-  index.html		\
-  libvirt-conf.html	\
-  libvirt-lib.html	\
-  libvirt-libvirt.html	\
-  libvirt-virterror.html
+apihtml =			\
+  html/index.html		\
+  html/libvirt-libvirt.html	\
+  html/libvirt-virterror.html
 
-png =		\
-  left.png	\
-  up.png	\
-  home.png	\
-  right.png
+apipng =	\
+  html/left.png	\
+  html/up.png	\
+  html/home.png	\
+  html/right.png
+
+png = \
+  16favicon.png \
+  32favicon.png \
+  footer_corner.png \
+  footer_pattern.png \
+  libvirHeader.png \
+  libvirLogo.png \
+  libvirt-header-bg.png \
+  libvirt-header-logo.png \
+  libvirtLogo.png \
+  libvirt-net-logical.png \
+  libvirt-net-physical.png \
+  madeWith.png \
+  windows-cygwin-1.png \
+  windows-cygwin-2.png \
+  windows-cygwin-3.png \
+  et.png
 
 gif = \
   Libxml2-Logo-90x34.gif \
   architecture.gif \
-  node.gif \
-  redhat.gif
+  node.gif
 
-dot_html = \
-  FAQ.html \
-  architecture.html \
-  bugs.html \
-  downloads.html \
-  errors.html \
-  format.html \
-  hvsupport.html \
-  index.html \
-  intro.html \
-  libvir.html \
-  news.html \
-  python.html \
-  remote.html \
-  uri.html
+dot_html_in = $(wildcard *.html.in)
+dot_html = $(dot_html_in:%.html.in=%.html)
 
 xml = \
   libvirt-api.xml \
@@ -57,11 +56,16 @@ rng = \
   libvirt.rng \
   network.rng
 
+fig = \
+  libvirt-net-logical.fig \
+  libvirt-net-physical.fig
+
 EXTRA_DIST=					\
   libvirt-api.xml libvirt-refs.xml apibuild.py	\
-  site.xsl newapi.xsl news.xsl		\
-  $(dot_html) $(gif) html			\
-  $(xml) $(rng)
+  site.xsl newapi.xsl news.xsl page.xsl	ChangeLog.xsl	\
+  $(dot_html) $(dot_html_in) $(gif) $(apihtml) $(apipng) \
+  $(xml) $(rng) $(fig) $(png) \
+  virsh.pod ChangeLog.awk
 
 all: web $(top_builddir)/NEWS $(man_MANS)
 
@@ -72,33 +76,49 @@ virsh.1: virsh.pod
 
 api: libvirt-api.xml libvirt-refs.xml $(srcdir)/html/index.html
 
-web: $(PAGES)
+web: $(dot_html)
 
-$(PAGES): libvir.html site.xsl
-	-@(if [ -x $(XSLTPROC) ] ; then \
-	  echo "Rebuilding the HTML Web pages from libvir.html" ; \
-	  $(XSLTPROC) --nonet --html $(top_srcdir)/docs/site.xsl $(top_srcdir)/docs/libvir.html > index.html ; fi );
-	-@(if [ -x $(XMLLINT) ] ; then \
-	  echo "Validating the HTML Web pages" ; \
-	  $(XMLLINT) --nonet --valid --noout $(PAGES) ; fi );
+ChangeLog.xml: ../ChangeLog ChangeLog.awk
+	awk -f ChangeLog.awk < $< > $@
+
+ChangeLog.html.in: ChangeLog.xml ChangeLog.xsl
+	@(if [ -x $(XSLTPROC) ] ; then \
+	  echo "Generating $@"; \
+	  name=`echo $@ | sed -e 's/.tmp//'`; \
+	  $(XSLTPROC) --nonet $(top_srcdir)/docs/ChangeLog.xsl $< > $@ || (rm $@ && exit 1) ; fi )
+
+%.html.tmp: %.html.in site.xsl page.xsl sitemap.html.in
+	@(if [ -x $(XSLTPROC) ] ; then \
+	  echo "Generating $@"; \
+	  name=`echo $@ | sed -e 's/.tmp//'`; \
+	  $(XSLTPROC) --stringparam pagename $$name --nonet --html $(top_srcdir)/docs/site.xsl $< > $@ || (rm $@ && exit 1) ; fi )
+
+%.html: %.html.tmp
+	@(if [ -x $(XMLLINT) -a -x $(XMLCATALOG) ] ; then \
+	  if $(XMLCATALOG) /etc/xml/catalog "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" > /dev/null ; then \
+	  echo "Validating $@" ; \
+	  $(XMLLINT) --nonet --format --valid $< > $@ || : ; \
+	  else echo "missing XHTML1 DTD" ; fi ; fi );
 
 
-$(srcdir)/html/index.html: libvirt-api.xml $(srcdir)/newapi.xsl
+$(srcdir)/html/index.html: libvirt-api.xml newapi.xsl page.xsl sitemap.html.in
 	-@(if [ -x $(XSLTPROC) ] ; then \
 	  echo "Rebuilding the HTML pages from the XML API" ; \
 	  $(XSLTPROC) --nonet $(srcdir)/newapi.xsl libvirt-api.xml ; fi )
-	-@(if [ -x $(XMLLINT) ] ; then \
+	-@(if [ -x $(XMLLINT) -a -x $(XMLCATALOG) ] ; then \
+	  if $(XMLCATALOG) /etc/xml/catalog "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" > /dev/null ; then \
 	  echo "Validating the resulting XHTML pages" ; \
-	  $(XMLLINT) --nonet --valid --noout html/*.html ; fi );
+	  $(XMLLINT) --nonet --valid --noout html/*.html ; \
+	  else echo "missing XHTML1 DTD" ; fi ; fi );
 
 libvirt-api.xml libvirt-refs.xml: apibuild.py \
 		$(srcdir)/../include/libvirt/*.h \
 		$(srcdir)/../src/*.h $(srcdir)/../src/*.c
 	-(./apibuild.py)
 
-$(top_builddir)/NEWS: $(top_srcdir)/docs/news.xsl $(top_srcdir)/docs/news.html
+$(top_builddir)/NEWS: $(top_srcdir)/docs/news.xsl $(top_srcdir)/docs/news.html.in
 	-@(if [ -x $(XSLTPROC) ] ; then \
-	  $(XSLTPROC) --nonet $(top_srcdir)/docs/news.xsl $(top_srcdir)/docs/news.html > $(top_builddir)/NEWS ; fi );
+	  $(XSLTPROC) --nonet $(top_srcdir)/docs/news.xsl $(top_srcdir)/docs/news.html.in > $(top_builddir)/NEWS ; fi );
 
 clean-local:
 	rm -f *~ *.bak *.hierarchy *.signals *-unused.txt
@@ -114,11 +134,11 @@ install-data-local:
 	    $(srcdir)/redhat.gif $(srcdir)/Libxml2-Logo-90x34.gif \
 	  $(DESTDIR)$(HTML_DIR)
 	$(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/html
-	for h in $(html); do \
-	  $(INSTALL) -m 0644 $(srcdir)/html/$$h $(DESTDIR)$(HTML_DIR)/html; done
-	for p in $(png); do \
-	  $(INSTALL) -m 0644 $(srcdir)/html/$$p $(DESTDIR)$(HTML_DIR)/html; done
+	for h in $(apihtml); do \
+	  $(INSTALL) -m 0644 $(srcdir)/$$h $(DESTDIR)$(HTML_DIR)/html; done
+	for p in $(apipng); do \
+	  $(INSTALL) -m 0644 $(srcdir)/$$p $(DESTDIR)$(HTML_DIR)/html; done
 
 uninstall-local:
-	for h in $(html); do rm $(DESTDIR)$(HTML_DIR)/html/$$h; done
-	for p in $(png); do rm $(DESTDIR)$(HTML_DIR)/html/$$p; done
+	for h in $(apihtml); do rm $(DESTDIR)$(HTML_DIR)/$$h; done
+	for p in $(apipng); do rm $(DESTDIR)$(HTML_DIR)/$$p; done

docs/apibuild.py

@@ -26,6 +26,16 @@ included_files = {
 
 ignored_words = {
   "ATTRIBUTE_UNUSED": (0, "macro keyword"),
+  "VIR_DEPRECATED": (0, "macro keyword"),
+}
+
+ignored_functions = {
+  "virDomainMigrateFinish": "private function for migration",
+  "virDomainMigrateFinish2": "private function for migration",
+  "virDomainMigratePerform": "private function for migration",
+  "virDomainMigratePrepare": "private function for migration",
+  "virDomainMigratePrepare2": "private function for migration",
+  "virDrvSupportsFeature": "private function for remote access",
 }
 
 def escape(raw):
@@ -757,10 +767,14 @@ class CParser:
      # as possible
      #
     def mergeFunctionComment(self, name, description, quiet = 0):
+        global ignored_functions
+
         if name == 'main':
 	    quiet = 1
         if name[0:2] == '__':
 	    quiet = 1
+        if ignored_functions.has_key(name):
+            quiet = 1
 
 	(ret, args) = description
 	desc = ""

docs/apps.html

@@ -0,0 +1,168 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from apps.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Applications using libvirt</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="active" href="relatedlinks.html">Related Links</a>
+              <ul class="l1"><li>
+                  <div>
+                    <span class="active">Applications</span>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Applications using <strong>libvirt</strong></h1>
+        <p>
+      This page provides an illustration of the wide variety of
+      applications using the libvirt management API. If you know
+      of interesting applications not listed on this page, send
+      a message to the <a href="contact.html">mailing list</a>
+      to request that it be added here. If your application uses
+      libvirt as its API, the following graphic is available for
+      your website to advertise support for libvirt:
+    </p>
+        <p class="image">
+      <img src="madeWith.png" alt="Made with libvirt" /></p>
+        <h2>Command line tools</h2>
+        <dl><dt>virsh</dt><dd>
+	An interactive shell, and batch scriptable tool for performing
+	management tasks on all libvirt managed domains, networks and
+	storage. This is part of the libvirt core distribution.
+      </dd><dt><a href="http://virt-manager.org/">virt-install</a></dt><dd>
+	Provides a way to provision new virtual machines from a
+	OS distribution install tree. It supports provisioning from
+	local CD images, and the network over NFS, HTTP and FTP.
+      </dd><dt><a href="http://virt-manager.org/">virt-clone</a></dt><dd>
+	Allows the disk image(s) and configuration for an existing
+	virtual machine to be cloned to form a new virtual machine.
+	It automates copying of data across to new disk images, and
+	updates the UUID, Mac address and name in the configuration
+      </dd><dt><a href="http://virt-manager.org/">virt-image</a></dt><dd>
+	Provides a way to deploy virtual appliances. It defines a
+	simplified portable XML format describing the pre-requisites
+	of a virtual machine. At time of deployment this is translated
+	into the domain XML format for execution under any libvirt
+	hypervisor meeting the pre-requisites.
+      </dd><dt><a href="http://et.redhat.com/~rjones/virt-df/">virt-df</a></dt><dd>
+	Examine the utilization of each filesystem in a virtual machine
+	from the comfort of the host machine. This tool peeks into the
+	guest disks and determines how much space is used. It can cope
+	with common Linux filesystems and LVM volumes.
+      </dd><dt><a href="http://et.redhat.com/~rjones/virt-top/">virt-top</a></dt><dd>
+	Watch the CPU, memory, network and disk utilization of all
+	virtual machines running on a host.
+      </dd></dl>
+        <h2>Desktop applications</h2>
+        <dl><dt><a href="http://virt-manager.org/">virt-manager</a></dt><dd>
+	A general purpose desktop management tool, able to manage
+	virtual machines across both local and remotely accessed
+	hypervisors. It is targeted at home and small office usage
+	upto managing 10-20 hosts and their VMs.
+      </dd><dt><a href="http://virt-manager.org/">virt-viewer</a></dt><dd>
+	A lightweight tool for accessing the graphical console
+	associated with a virtual machine. It can securely connect
+	to remote consoles supporting the VNC protocol. Also provides
+	an optional mozilla browser plugin.
+      </dd></dl>
+        <h2>Web applications</h2>
+        <dl><dt><a href="http://ovirt.org/">oVirt</a></dt><dd>
+	oVirt provides the ability to manage large numbers of virtual
+	machines across an entire data center of hosts. It integrates
+	with FreeIPA for Kerberos authentication, and in the future,
+	certificate management.
+      </dd></dl>
+        <h2>LiveCD / Appliances</h2>
+        <dl><dt><a href="http://et.redhat.com/~rjones/virt-p2v/">virt-p2v</a></dt><dd>
+	A tool for converting a physical machine into a virtual machine. It
+	is a LiveCD which is booted on the machine to be converted. It collects
+	a little information from the user and then copies the disks over to
+	a remote machine and defines the XML for a domain to run the guest.
+      </dd></dl>
+        <h2>Monitoring plugins</h2>
+        <dl><dt><a href="http://honk.sigxcpu.org/projects/libvirt/#munin">for munin</a></dt><dd>
+	The plugins provided by Guido Günther allows to monitor various things
+        like network and block I/O with
+        <a href="http://munin.projects.linpro.no/">Munin</a>.
+      </dd><dt><a href="http://collectd.org/plugins/libvirt.shtml">for collectd</a></dt><dd>
+	The libvirt-plugin is part of <a href="http://collectd.org/">collectd</a>
+        and gather statistics about virtualized guests on a system. This
+        way, you can collect CPU, network interface and block device usage
+        for each guest without installing collectd on the guest systems.
+        or a full description of available please refer to the libvirt section
+        in the collectd.conf(5) manual page.
+      </dd><dt><a href="http://et.redhat.com/~rjones/nagios-virt/">nagios-virt</a></dt><dd>
+	Nagios-virt is a configuration tool for adding monitoring of your
+	virtualised domains to <a href="http://www.nagios.org/">Nagios</a>.
+        You can use this tool to either set up a new Nagios installation for
+        your Xen or QEMU/KVM guests, or to integrate with your existing Nagios
+        installation.
+      </dd></dl>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/apps.html.in

@@ -0,0 +1,134 @@
+<html>
+  <body>
+    <h1>Applications using <strong>libvirt</strong></h1>
+
+    <p>
+      This page provides an illustration of the wide variety of
+      applications using the libvirt management API. If you know
+      of interesting applications not listed on this page, send
+      a message to the <a href="contact.html">mailing list</a>
+      to request that it be added here. If your application uses
+      libvirt as its API, the following graphic is available for
+      your website to advertise support for libvirt:
+    </p>
+
+    <p class="image">
+      <img src="madeWith.png" alt="Made with libvirt"/>
+    </p>
+
+    <h2>Command line tools</h2>
+
+    <dl>
+      <dt>virsh</dt>
+      <dd>
+	An interactive shell, and batch scriptable tool for performing
+	management tasks on all libvirt managed domains, networks and
+	storage. This is part of the libvirt core distribution.
+      </dd>
+      <dt><a href="http://virt-manager.org/">virt-install</a></dt>
+      <dd>
+	Provides a way to provision new virtual machines from a
+	OS distribution install tree. It supports provisioning from
+	local CD images, and the network over NFS, HTTP and FTP.
+      </dd>
+      <dt><a href="http://virt-manager.org/">virt-clone</a></dt>
+      <dd>
+	Allows the disk image(s) and configuration for an existing
+	virtual machine to be cloned to form a new virtual machine.
+	It automates copying of data across to new disk images, and
+	updates the UUID, Mac address and name in the configuration
+      </dd>
+      <dt><a href="http://virt-manager.org/">virt-image</a></dt>
+      <dd>
+	Provides a way to deploy virtual appliances. It defines a
+	simplified portable XML format describing the pre-requisites
+	of a virtual machine. At time of deployment this is translated
+	into the domain XML format for execution under any libvirt
+	hypervisor meeting the pre-requisites.
+      </dd>
+      <dt><a href="http://et.redhat.com/~rjones/virt-df/">virt-df</a></dt>
+      <dd>
+	Examine the utilization of each filesystem in a virtual machine
+	from the comfort of the host machine. This tool peeks into the
+	guest disks and determines how much space is used. It can cope
+	with common Linux filesystems and LVM volumes.
+      </dd>
+      <dt><a href="http://et.redhat.com/~rjones/virt-top/">virt-top</a></dt>
+      <dd>
+	Watch the CPU, memory, network and disk utilization of all
+	virtual machines running on a host.
+      </dd>
+    </dl>
+
+    <h2>Desktop applications</h2>
+
+    <dl>
+      <dt><a href="http://virt-manager.org/">virt-manager</a></dt>
+      <dd>
+	A general purpose desktop management tool, able to manage
+	virtual machines across both local and remotely accessed
+	hypervisors. It is targeted at home and small office usage
+	upto managing 10-20 hosts and their VMs.
+      </dd>
+      <dt><a href="http://virt-manager.org/">virt-viewer</a></dt>
+      <dd>
+	A lightweight tool for accessing the graphical console
+	associated with a virtual machine. It can securely connect
+	to remote consoles supporting the VNC protocol. Also provides
+	an optional mozilla browser plugin.
+      </dd>
+    </dl>
+
+    <h2>Web applications</h2>
+
+    <dl>
+      <dt><a href="http://ovirt.org/">oVirt</a></dt>
+      <dd>
+	oVirt provides the ability to manage large numbers of virtual
+	machines across an entire data center of hosts. It integrates
+	with FreeIPA for Kerberos authentication, and in the future,
+	certificate management.
+      </dd>
+    </dl>
+
+    <h2>LiveCD / Appliances</h2>
+
+    <dl>
+      <dt><a href="http://et.redhat.com/~rjones/virt-p2v/">virt-p2v</a></dt>
+      <dd>
+	A tool for converting a physical machine into a virtual machine. It
+	is a LiveCD which is booted on the machine to be converted. It collects
+	a little information from the user and then copies the disks over to
+	a remote machine and defines the XML for a domain to run the guest.
+      </dd>
+    </dl>
+
+    <h2>Monitoring plugins</h2>
+    <dl>
+      <dt><a href="http://honk.sigxcpu.org/projects/libvirt/#munin">for munin</a></dt>
+      <dd>
+	The plugins provided by Guido Günther allows to monitor various things
+        like network and block I/O with
+        <a href="http://munin.projects.linpro.no/">Munin</a>.
+      </dd>
+      <dt><a href="http://collectd.org/plugins/libvirt.shtml">for collectd</a></dt>
+      <dd>
+	The libvirt-plugin is part of <a href="http://collectd.org/">collectd</a>
+        and gather statistics about virtualized guests on a system. This
+        way, you can collect CPU, network interface and block device usage
+        for each guest without installing collectd on the guest systems.
+        or a full description of available please refer to the libvirt section
+        in the collectd.conf(5) manual page.
+      </dd>
+      <dt><a href="http://et.redhat.com/~rjones/nagios-virt/">nagios-virt</a></dt>
+      <dd>
+	Nagios-virt is a configuration tool for adding monitoring of your
+	virtualised domains to <a href="http://www.nagios.org/">Nagios</a>.
+        You can use this tool to either set up a new Nagios installation for
+        your Xen or QEMU/KVM guests, or to integrate with your existing Nagios
+        installation.
+      </dd>
+    </dl>
+
+  </body>
+</html>

docs/archdomain.html

@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from archdomain.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Domain management architecture</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="active" href="intro.html">Architecture</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <span class="active">Domains</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Providing isolated networks and NAT based network connectivity" class="inactive" href="archnetwork.html">Network</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Managing storage pools and volumes" class="inactive" href="archstorage.html">Storage</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Enumerating host node devices" class="inactive" href="archnode.html">Node Devices</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Domain management architecture</h1>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/archdomain.html.in

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <h1>Domain management architecture</h1>
+  </body>
+</html>

docs/architecture.html

@@ -1,11 +1,87 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>libvirt architecture</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">libvirt architecture</h1><p>Currently libvirt supports 2 kind of virtualization, and its
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from architecture.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: libvirt architecture</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>libvirt architecture</h1>
+        <p>Currently libvirt supports 2 kind of virtualization, and its
 internal structure is based on a driver model which simplifies adding new
-engines:</p><ul><li><a href="#Xen">Xen hypervisor</a></li>
-  <li><a href="#QEmu">QEmu and KVM based virtualization</a></li>
-  <li><a href="#drivers">the driver architecture</a></li>
-</ul><h3><a name="Xen" id="Xen">Libvirt Xen support</a></h3><p>When running in a Xen environment, programs using libvirt have to execute
+engines:</p>
+        <ul><li>
+        <a href="#Xen">Xen hypervisor</a>
+      </li><li>
+        <a href="#QEmu">QEmu and KVM based virtualization</a>
+      </li><li>
+        <a href="#drivers">the driver architecture</a>
+      </li></ul>
+        <h3>
+      <a name="Xen" id="Xen">Libvirt Xen support</a>
+    </h3>
+        <p>When running in a Xen environment, programs using libvirt have to execute
 in "Domain 0", which is the primary Linux OS loaded on the machine. That OS
 kernel provides most if not all of the actual drivers used by the set of
 domains. It also runs the Xen Store, a database of information shared by the
@@ -13,22 +89,27 @@ hypervisor, the kernels, the drivers and the xen daemon. Xend. The xen daemon
 supervise the control and execution of the sets of domains. The hypervisor,
 drivers, kernels and daemons communicate though a shared system bus
 implemented in the hypervisor. The figure below tries to provide a view of
-this environment:</p><img src="architecture.gif" alt="The Xen architecture" /><p>The library can be initialized in 2 ways depending on the level of
+this environment:</p>
+        <img src="architecture.gif" alt="The Xen architecture" />
+        <p>The library can be initialized in 2 ways depending on the level of
 privilege of the embedding program. If it runs with root access,
 virConnectOpen() can be used, it will use three different ways to connect to
-the Xen infrastructure:</p><ul><li>a connection to the Xen Daemon though an HTTP RPC layer</li>
-  <li>a read/write connection to the Xen Store</li>
-  <li>use Xen Hypervisor calls</li>
-  <li>when used as non-root libvirt connect to a proxy daemon running
-      as root and providing read-only support</li>
-</ul><p>The library will usually interact with the Xen daemon for any operation
+the Xen infrastructure:</p>
+        <ul><li>a connection to the Xen Daemon though an HTTP RPC layer</li><li>a read/write connection to the Xen Store</li><li>use Xen Hypervisor calls</li><li>when used as non-root libvirt connect to a proxy daemon running
+      as root and providing read-only support</li></ul>
+        <p>The library will usually interact with the Xen daemon for any operation
 changing the state of the system, but for performance and accuracy reasons
 may talk directly to the hypervisor when gathering state information at
 least when possible (i.e. when the running program using libvirt has root
-privilege access).</p><p>If it runs without root access virConnectOpenReadOnly() should be used to
+privilege access).</p>
+        <p>If it runs without root access virConnectOpenReadOnly() should be used to
 connect to initialize the library. It will then fork a libvirt_proxy
 program running as root and providing read_only access to the API, this is
-then only useful for reporting and monitoring.</p><h3><a name="QEmu" id="QEmu">Libvirt QEmu and KVM support</a></h3><p>The model for QEmu and KVM is completely similar, basically KVM is based
+then only useful for reporting and monitoring.</p>
+        <h3>
+      <a name="QEmu" id="QEmu">Libvirt QEmu and KVM support</a>
+    </h3>
+        <p>The model for QEmu and KVM is completely similar, basically KVM is based
 on QEmu for the process controlling a new domain, only small details differs
 between the two. In both case the libvirt API is provided by a controlling
 process forked by libvirt in the background and which launch and control the
@@ -36,8 +117,13 @@ QEmu or KVM process. That program called libvirt_qemud talks though a specific
 protocol to the library, and connects to the console of the QEmu process in
 order to control and report on its status. Libvirt tries to expose all the
 emulations models of QEmu, the selection is done when creating the new
-domain, by specifying the architecture and machine type targeted.</p><p>The code controlling the QEmu process is available in the
-<code>qemud/</code> directory.</p><h3><a name="drivers" id="drivers">the driver based architecture</a></h3><p>As the previous section explains, libvirt can communicate using different
+domain, by specifying the architecture and machine type targeted.</p>
+        <p>The code controlling the QEmu process is available in the
+<code>qemud/</code> directory.</p>
+        <h3>
+      <a name="drivers" id="drivers">the driver based architecture</a>
+    </h3>
+        <p>As the previous section explains, libvirt can communicate using different
 channels with the current hypervisor, and should also be able to use
 different kind of hypervisor. To simplify the internal design, code, ease
 maintenance and simplify the support of other virtualization engine the
@@ -46,22 +132,26 @@ acting as a front-end for the library API and a set of hypervisor drivers
 defining a common set of routines. That way the Xen Daemon access, the Xen
 Store one, the Hypervisor hypercall are all isolated in separate C modules
 implementing at least a subset of the common operations defined by the
-drivers present in driver.h:</p><ul><li>xend_internal: implements the driver functions though the Xen
-  Daemon</li>
-  <li>xs_internal: implements the subset of the driver available though the
-    Xen Store</li>
-  <li>xen_internal: provide the implementation of the functions possible via
-    direct hypervisor access</li>
-  <li>proxy_internal: provide read-only Xen access via a proxy, the proxy code
-    is in the <code>proxy/</code>directory.</li>
-  <li>xm_internal: provide support for Xen defined but not running
-    domains.</li>
-  <li>qemu_internal: implement the driver functions for QEmu and
+drivers present in driver.h:</p>
+        <ul><li>xend_internal: implements the driver functions though the Xen
+  Daemon</li><li>xs_internal: implements the subset of the driver available though the
+    Xen Store</li><li>xen_internal: provide the implementation of the functions possible via
+    direct hypervisor access</li><li>proxy_internal: provide read-only Xen access via a proxy, the proxy code
+    is in the <code>proxy/</code>directory.</li><li>xm_internal: provide support for Xen defined but not running
+    domains.</li><li>qemu_internal: implement the driver functions for QEmu and
     KVM virtualization engines. It also uses a qemud/ specific daemon
-    which interacts with the QEmu process to implement libvirt API.</li>
-  <li>test: this is a test driver useful for regression tests of the
-    front-end part of libvirt.</li>
-</ul><p>Note that a given driver may only implement a subset of those functions,
+    which interacts with the QEmu process to implement libvirt API.</li><li>test: this is a test driver useful for regression tests of the
+    front-end part of libvirt.</li></ul>
+        <p>Note that a given driver may only implement a subset of those functions,
 (for example saving a Xen domain state to disk and restoring it is only
 possible though the Xen Daemon), in that case the driver entry points for
-unsupported functions are initialized to NULL.</p><p></p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+unsupported functions are initialized to NULL.</p>
+        <p></p>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/architecture.html.in

@@ -0,0 +1,101 @@
+<html>
+  <body>
+    <h1 >libvirt architecture</h1>
+    <p>Currently libvirt supports 2 kind of virtualization, and its
+internal structure is based on a driver model which simplifies adding new
+engines:</p>
+    <ul>
+      <li>
+        <a href="#Xen">Xen hypervisor</a>
+      </li>
+      <li>
+        <a href="#QEmu">QEmu and KVM based virtualization</a>
+      </li>
+      <li>
+        <a href="#drivers">the driver architecture</a>
+      </li>
+    </ul>
+    <h3>
+      <a name="Xen" id="Xen">Libvirt Xen support</a>
+    </h3>
+    <p>When running in a Xen environment, programs using libvirt have to execute
+in "Domain 0", which is the primary Linux OS loaded on the machine. That OS
+kernel provides most if not all of the actual drivers used by the set of
+domains. It also runs the Xen Store, a database of information shared by the
+hypervisor, the kernels, the drivers and the xen daemon. Xend. The xen daemon
+supervise the control and execution of the sets of domains. The hypervisor,
+drivers, kernels and daemons communicate though a shared system bus
+implemented in the hypervisor. The figure below tries to provide a view of
+this environment:</p>
+    <img src="architecture.gif" alt="The Xen architecture" />
+    <p>The library can be initialized in 2 ways depending on the level of
+privilege of the embedding program. If it runs with root access,
+virConnectOpen() can be used, it will use three different ways to connect to
+the Xen infrastructure:</p>
+    <ul>
+      <li>a connection to the Xen Daemon though an HTTP RPC layer</li>
+      <li>a read/write connection to the Xen Store</li>
+      <li>use Xen Hypervisor calls</li>
+      <li>when used as non-root libvirt connect to a proxy daemon running
+      as root and providing read-only support</li>
+    </ul>
+    <p>The library will usually interact with the Xen daemon for any operation
+changing the state of the system, but for performance and accuracy reasons
+may talk directly to the hypervisor when gathering state information at
+least when possible (i.e. when the running program using libvirt has root
+privilege access).</p>
+    <p>If it runs without root access virConnectOpenReadOnly() should be used to
+connect to initialize the library. It will then fork a libvirt_proxy
+program running as root and providing read_only access to the API, this is
+then only useful for reporting and monitoring.</p>
+    <h3>
+      <a name="QEmu" id="QEmu">Libvirt QEmu and KVM support</a>
+    </h3>
+    <p>The model for QEmu and KVM is completely similar, basically KVM is based
+on QEmu for the process controlling a new domain, only small details differs
+between the two. In both case the libvirt API is provided by a controlling
+process forked by libvirt in the background and which launch and control the
+QEmu or KVM process. That program called libvirt_qemud talks though a specific
+protocol to the library, and connects to the console of the QEmu process in
+order to control and report on its status. Libvirt tries to expose all the
+emulations models of QEmu, the selection is done when creating the new
+domain, by specifying the architecture and machine type targeted.</p>
+    <p>The code controlling the QEmu process is available in the
+<code>qemud/</code> directory.</p>
+    <h3>
+      <a name="drivers" id="drivers">the driver based architecture</a>
+    </h3>
+    <p>As the previous section explains, libvirt can communicate using different
+channels with the current hypervisor, and should also be able to use
+different kind of hypervisor. To simplify the internal design, code, ease
+maintenance and simplify the support of other virtualization engine the
+internals have been structured as one core component, the libvirt.c module
+acting as a front-end for the library API and a set of hypervisor drivers
+defining a common set of routines. That way the Xen Daemon access, the Xen
+Store one, the Hypervisor hypercall are all isolated in separate C modules
+implementing at least a subset of the common operations defined by the
+drivers present in driver.h:</p>
+    <ul>
+      <li>xend_internal: implements the driver functions though the Xen
+  Daemon</li>
+      <li>xs_internal: implements the subset of the driver available though the
+    Xen Store</li>
+      <li>xen_internal: provide the implementation of the functions possible via
+    direct hypervisor access</li>
+      <li>proxy_internal: provide read-only Xen access via a proxy, the proxy code
+    is in the <code>proxy/</code>directory.</li>
+      <li>xm_internal: provide support for Xen defined but not running
+    domains.</li>
+      <li>qemu_internal: implement the driver functions for QEmu and
+    KVM virtualization engines. It also uses a qemud/ specific daemon
+    which interacts with the QEmu process to implement libvirt API.</li>
+      <li>test: this is a test driver useful for regression tests of the
+    front-end part of libvirt.</li>
+    </ul>
+    <p>Note that a given driver may only implement a subset of those functions,
+(for example saving a Xen domain state to disk and restoring it is only
+possible though the Xen Daemon), in that case the driver entry points for
+unsupported functions are initialized to NULL.</p>
+    <p></p>
+  </body>
+</html>

docs/archnetwork.html

@@ -0,0 +1,149 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from archnetwork.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Network management architecture</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="active" href="intro.html">Architecture</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="Managing virtual machines" class="inactive" href="archdomain.html">Domains</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Network</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Managing storage pools and volumes" class="inactive" href="archstorage.html">Storage</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Enumerating host node devices" class="inactive" href="archnode.html">Node Devices</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Network management architecture</h1>
+        <h2>Architecture illustration</h2>
+        <p>
+      The diagrams below illustrate some of the network configurations
+      enabled by the libvirt networking APIs
+    </p>
+        <ul><li><strong>VLAN 1</strong>. This virtual network has connectivity
+	to <code>LAN 2</code> with traffic forwarded and NATed.
+      </li><li><strong>VLAN 2</strong>. This virtual network is completely
+	isolated from any physical LAN.
+      </li><li><strong>Guest A</strong>. The first network interface is bridged
+	to the physical <code>LAN 1</code>. The second interface is connected
+	to a virtual network <code>VLAN 1</code>.
+      </li><li><strong>Guest B</strong>. The first network interface is connected
+	to a virtual network <code>VLAN 1</code>, giving it limited NAT
+	based connectivity to LAN2. It has a second network interface
+	connected to <code>VLAN 2</code>. It acts a router allowing limited
+	traffic between the two VLANs, thus giving <code>Guest C</code>
+	connectivity to the physical <code>LAN 2</code>.
+	</li><li><strong>Guest C</strong>. The only network interface is connected
+	to a virtual network <code>VLAN 2</code>. It has no direct connectivity
+	to a physical LAN, relying on <code>Guest B</code> to route traffic
+	on its behalf.
+      </li></ul>
+        <h3>Logical diagram</h3>
+        <p class="image">
+      <img src="libvirt-net-logical.png" alt="Logical network architecture" /></p>
+        <h3>Physical diagram</h3>
+        <p class="image">
+      <img src="libvirt-net-physical.png" alt="Physical network architecture" /></p>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/archnetwork.html.in

@@ -0,0 +1,50 @@
+<html>
+  <body>
+    <h1>Network management architecture</h1>
+
+    <h2>Architecture illustration</h2>
+
+    <p>
+      The diagrams below illustrate some of the network configurations
+      enabled by the libvirt networking APIs
+    </p>
+
+    <ul>
+      <li><strong>VLAN 1</strong>. This virtual network has connectivity
+	to <code>LAN 2</code> with traffic forwarded and NATed.
+      </li>
+      <li><strong>VLAN 2</strong>. This virtual network is completely
+	isolated from any physical LAN.
+      </li>
+      <li><strong>Guest A</strong>. The first network interface is bridged
+	to the physical <code>LAN 1</code>. The second interface is connected
+	to a virtual network <code>VLAN 1</code>.
+      </li>
+      <li><strong>Guest B</strong>. The first network interface is connected
+	to a virtual network <code>VLAN 1</code>, giving it limited NAT
+	based connectivity to LAN2. It has a second network interface
+	connected to <code>VLAN 2</code>. It acts a router allowing limited
+	traffic between the two VLANs, thus giving <code>Guest C</code>
+	connectivity to the physical <code>LAN 2</code>.
+	</li>
+      <li><strong>Guest C</strong>. The only network interface is connected
+	to a virtual network <code>VLAN 2</code>. It has no direct connectivity
+	to a physical LAN, relying on <code>Guest B</codE> to route traffic
+	on its behalf.
+      </li>
+    </ul>
+
+    <h3>Logical diagram</h3>
+
+    <p class="image">
+      <img src="libvirt-net-logical.png" alt="Logical network architecture"/>
+    </p>
+
+    <h3>Physical diagram</h3>
+
+    <p class="image">
+      <img src="libvirt-net-physical.png" alt="Physical network architecture"/>
+    </p>
+
+  </body>
+</html>

docs/archnode.html

@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from archnode.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Node device management architecture</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="active" href="intro.html">Architecture</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="Managing virtual machines" class="inactive" href="archdomain.html">Domains</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Providing isolated networks and NAT based network connectivity" class="inactive" href="archnetwork.html">Network</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Managing storage pools and volumes" class="inactive" href="archstorage.html">Storage</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Node Devices</span>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Node device management architecture</h1>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/archnode.html.in

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <h1>Node device management architecture</h1>
+  </body>
+</html>

docs/archstorage.html

@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from archstorage.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Storage management architecture</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="active" href="intro.html">Architecture</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="Managing virtual machines" class="inactive" href="archdomain.html">Domains</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Providing isolated networks and NAT based network connectivity" class="inactive" href="archnetwork.html">Network</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Storage</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Enumerating host node devices" class="inactive" href="archnode.html">Node Devices</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Storage management architecture</h1>
+        <p>
+      The storage management APIs are based around 2 core concepts
+    </p>
+        <ol><li>
+	<strong>Volume</strong> - a single storage volume which can
+	be assigned to a guest, or used for creating further pools. A
+	volume is either a block device, a raw file, or a special format
+	file.
+      </li><li>
+	<strong>Pool</strong> - provides a means for taking a chunk
+	of storage and carving it up into volumes. A pool can be used to
+	manage things such as a physical disk, a NFS server, a iSCSI target,
+	a host adapter, an LVM group.
+      </li></ol>
+        <p>
+      These two concepts are mapped through to two libvirt objects, a
+      <code>virStorageVolPtr</code> and a <code>virStoragePoolPtr</code>,
+      each with a collection of APIs for their management.
+    </p>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/archstorage.html.in

@@ -0,0 +1,30 @@
+<html>
+  <body>
+    <h1>Storage management architecture</h1>
+
+    <p>
+      The storage management APIs are based around 2 core concepts
+    </p>
+    <ol>
+      <li>
+	<strong>Volume</strong> - a single storage volume which can
+	be assigned to a guest, or used for creating further pools. A
+	volume is either a block device, a raw file, or a special format
+	file.
+      </li>
+      <li>
+	<strong>Pool</strong> - provides a means for taking a chunk
+	of storage and carving it up into volumes. A pool can be used to
+	manage things such as a physical disk, a NFS server, a iSCSI target,
+	a host adapter, an LVM group.
+      </li>
+    </ol>
+
+    <p>
+      These two concepts are mapped through to two libvirt objects, a
+      <code>virStorageVolPtr</code> and a <code>virStoragePoolPtr</code>,
+      each with a collection of APIs for their management.
+    </p>
+
+  </body>
+</html>

docs/auth.html

@@ -1,16 +1,136 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Access control</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Access control</h1><p>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from auth.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Access control</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="active" href="deployment.html">Deployment</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="The URI formats used for connecting to libvirt" class="inactive" href="uri.html">URI format</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Enable remote access over TCP" class="inactive" href="remote.html">Remote access</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Authentication</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Access the libvirt daemon from a native Windows client" class="inactive" href="windows.html">Windows port</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Access control</h1>
+        <p>
 When connecting to libvirt, some connections may require client
 authentication before allowing use of the APIs. The set of possible
 authentication mechanisms is administrator controlled, independent
 of applications using libvirt.
-</p><ul><li><a href="#ACL_server_config">Server configuration</a></li>
- <li><a href="#ACL_server_unix_perms">UNIX socket permissions/group</a></li>
- <li><a href="#ACL_server_polkit">UNIX socket PolicyKit auth</a></li>
- <li><a href="#ACL_server_username">Username/password auth</a></li>
- <li><a href="#ACL_server_kerberos">Kerberos auth</a></li>
-</ul><h3 name="ACL_server_config">Server configuration</h3><p>
+</p>
+        <ul><li>
+        <a href="#ACL_server_config">Server configuration</a>
+      </li><li>
+        <a href="#ACL_server_unix_perms">UNIX socket permissions/group</a>
+      </li><li>
+        <a href="#ACL_server_polkit">UNIX socket PolicyKit auth</a>
+      </li><li>
+        <a href="#ACL_server_username">Username/password auth</a>
+      </li><li>
+        <a href="#ACL_server_kerberos">Kerberos auth</a>
+      </li></ul>
+        <h3>
+          <a name="ACL_server_config" id="ACL_server_config">Server configuration</a>
+        </h3>
+        <p>
 The libvirt daemon allows the administrator to choose the authentication
 mechanisms used for client connections on each network socket independently.
 This is primarily controlled via the libvirt daemon master config file in
@@ -19,21 +139,30 @@ have its authentication mechanism configured independently. There is
 currently a choice of <code>none</code>, <code>polkit</code>, and <code>sasl</code>.
 The SASL scheme can be further configured to choose between a large
 number of different mechanisms.
-</p><h3 name="ACL_server_unix_perms">UNIX socket permissions/group</h3><p>
+</p>
+        <h3>
+          <a name="ACL_server_unix_perms" id="ACL_server_unix_perms">UNIX socket permissions/group</a>
+        </h3>
+        <p>
 If libvirt does not contain support for PolicyKit, then access control for
 the UNIX domain socket is done using traditional file user/group ownership
 and permissions. There are 2 sockets, one for full read-write access, the
 other for read-only access. The RW socket will be restricted (mode 0700) to
 only allow the <code>root</code> user to connect. The read-only socket will
 be open access (mode 0777) to allow any user to connect.
-</p><p>
+</p>
+        <p>
 To allow non-root users greater access, the <code>libvirtd.conf</code> file
 can be edited to change the permissions via the <code>unix_sock_rw_perms</code>,
 config parameter and to set a user group via the <code>unix_sock_group</code>
 parameter. For example, setting the former to mode <code>0770</code> and the
 latter <code>wheel</code> would let any user in the wheel group connect to
 the libvirt daemon.
-</p><h3 name="ACL_server_polkit">UNIX socket PolicyKit auth</h3><p>
+</p>
+        <h3>
+          <a name="ACL_server_polkit" id="ACL_server_polkit">UNIX socket PolicyKit auth</a>
+        </h3>
+        <p>
 If libvirt contains support for PolicyKit, then access control options are
 more advanced. The <code>unix_sock_auth</code> parameter will default to
 <code>polkit</code>, and the file permissions will default to <code>0777</code>
@@ -43,24 +172,35 @@ RW daemon socket will require any application running in the current desktop
 session to authenticate using the user's password. This is akin to <code>sudo</code>
 auth, but does not require that the client application ultimately run as root.
 Default policy will still allow any application to connect to the RO socket.
-</p><p>
+</p>
+        <p>
 The default policy can be overridden by the administrator using the PolicyKit
 master configuration file in <code>/etc/PolicyKit/PolicyKit.conf</code>. The
 <code>PolicyKit.conf(5)</code> manual page provides details on the syntax
 available. The two libvirt daemon actions available are named <code>org.libvirt.unix.monitor</code>
 for the RO socket, and <code>org.libvirt.unix.manage</code> for the RW socket.
-</p><p>
+</p>
+        <p>
 As an example, to allow a user <code>fred</code>full access to the RW socket,
 while requiring <code>joe</code> to authenticate with the admin password,
 would require adding the following snippet to <code>PolicyKit.conf</code>.
-</p><pre>
-  &lt;match action="org.libvirt.unix.manage" user="fred"&gt;
-    &lt;return result="yes"/&gt;
+</p>
+        <pre>
+  &lt;match action="org.libvirt.unix.manage"&gt;
+    &lt;match user="fred"&gt;
+      &lt;return result="yes"/&gt;
+    &lt;/match&gt;
   &lt;/match&gt;
-  &lt;match action="org.libvirt.unix.manage" user="joe"&gt;
-    &lt;return result="auth_admin"/&gt;
+  &lt;match action="org.libvirt.unix.manage"&gt;
+    &lt;match user="joe"&gt;
+      &lt;return result="auth_admin"/&gt;
+    &lt;/match&gt;
   &lt;/match&gt;
-</pre><h3 name="ACL_server_username">Username/password auth</h3><p>
+</pre>
+        <h3>
+          <a name="ACL_server_username" id="ACL_server_username">Username/password auth</a>
+        </h3>
+        <p>
 The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
 The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
 username+password style authentication. It also provides for encryption of the data
@@ -68,28 +208,38 @@ stream, so the security of the plain TCP socket is on a par with that of the TLS
 socket. If desired the UNIX socket and TLS socket can also have SASL enabled by
 setting the <code>auth_unix_ro</code>, <code>auth_unix_rw</code>, <code>auth_tls</code>
 config params in <code>libvirt.conf</code>.
-</p><p>
+</p>
+        <p>
 Out of the box, no user accounts are defined, so no clients will be able to authenticate
 on the TCP socket. Adding users and setting their passwords is done with the <code>saslpasswd2</code>
 command. When running this command it is important to tell it that the appname is <code>libvirt</code>.
 As an example, to add a user <code>fred</code>, run
-</p><pre>
+</p>
+        <pre>
 # saslpasswd2 -a libvirt fred
 Password: xxxxxx
 Again (for verification): xxxxxx
-</pre><p>
+</pre>
+        <p>
 To see a list of all accounts the <code>sasldblistusers2</code> command can be used.
 This command expects to be given the path to the libvirt user database, which is kept
 in <code>/etc/libvirt/passwd.db</code>
-</p><pre>
+</p>
+        <pre>
 # sasldblistusers2 -f /etc/libvirt/passwd.db
 fred@t60wlan.home.berrange.com: userPassword
-</pre><p>
+</pre>
+        <p>
 Finally, to disable a user's access, the <code>saslpasswd2</code> command can be used
 again:
-</p><pre>
+</p>
+        <pre>
 # saslpasswd2 -a libvirt -d fred
-</pre><h3 name="ACL_server_kerberos">Kerberos auth</h3><p>
+</pre>
+        <h3>
+          <a name="ACL_server_kerberos" id="ACL_server_kerberos">Kerberos auth</a>
+        </h3>
+        <p>
 The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
 The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
 username+password style authentication. To enable Kerberos single-sign-on instead,
@@ -98,19 +248,22 @@ The <code>mech_list</code> parameter must first be changed to <code>gssapi</code
 instead of the default <code>digest-md5</code>. If SASL is enabled on the UNIX
 and/or TLS sockets, Kerberos will also be used for them. Like DIGEST-MD5, the Kerberos
 mechanism provides data encryption of the session.
-</p><p>
+</p>
+        <p>
 Some operating systems do not install the SASL kerberos plugin by default. It
 may be necessary to install a sub-package such as <code>cyrus-sasl-gssapi</code>.
 To check whether the Kerberos plugin is installed run the <code>pluginviewer</code>
 program and verify that <code>gssapi</code> is listed,eg:
-</p><pre>
+</p>
+        <pre>
 # pluginviewer
 ...snip...
 Plugin "gssapiv2" [loaded],     API version: 4
         SASL mechanism: GSSAPI, best SSF: 56
         security flags: NO_ANONYMOUS|NO_PLAINTEXT|NO_ACTIVE|PASS_CREDENTIALS|MUTUAL_AUTH
         features: WANT_CLIENT_FIRST|PROXY_AUTHENTICATION|NEED_SERVER_FQDN
-</pre><p>
+</pre>
+        <p>
 Next is is necessary for the administrator of the Kerberos realm to issue a principle
 for the libvirt server. There needs to be one principle per host running the libvirt
 daemon. The principle should be named <code>libvirt/full.hostname@KERBEROS.REALM</code>.
@@ -118,7 +271,8 @@ This is typically done by running the <code>kadmin.local</code> command on the K
 server, though some Kerberos servers have alternate ways of setting up service principles.
 Once created, the principle should be exported to a keytab, copied to the host running
 the libvirt daemon and placed in <code>/etc/libvirt/krb5.tab</code>
-</p><pre>
+</p>
+        <pre>
 # kadmin.local
 kadmin.local: add_principal libvirt/foo.example.com
 Enter password for principal "libvirt/foo.example.com@EXAMPLE.COM":
@@ -135,9 +289,18 @@ kadmin.local: quit
 
 # scp /root/libvirt-foo-example.tab root@foo.example.com:/etc/libvirt/krb5.tab
 # rm /root/libvirt-foo-example.tab
-</pre><p>
+</pre>
+        <p>
 Any client application wishing to connect to a Kerberos enabled libvirt server
 merely needs to run <code>kinit</code> to gain a user principle. This may well
 be done automatically when a user logs into a desktop session, if PAM is setup
 to authenticate against Kerberos.
-</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+</p>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/auth.html.in

@@ -0,0 +1,187 @@
+<html>
+  <body>
+    <h1 >Access control</h1>
+    <p>
+When connecting to libvirt, some connections may require client
+authentication before allowing use of the APIs. The set of possible
+authentication mechanisms is administrator controlled, independent
+of applications using libvirt.
+</p>
+    <ul>
+      <li>
+        <a href="#ACL_server_config">Server configuration</a>
+      </li>
+      <li>
+        <a href="#ACL_server_unix_perms">UNIX socket permissions/group</a>
+      </li>
+      <li>
+        <a href="#ACL_server_polkit">UNIX socket PolicyKit auth</a>
+      </li>
+      <li>
+        <a href="#ACL_server_username">Username/password auth</a>
+      </li>
+      <li>
+        <a href="#ACL_server_kerberos">Kerberos auth</a>
+      </li>
+    </ul>
+    <h3><a name="ACL_server_config">Server configuration</a></h3>
+    <p>
+The libvirt daemon allows the administrator to choose the authentication
+mechanisms used for client connections on each network socket independently.
+This is primarily controlled via the libvirt daemon master config file in
+<code>/etc/libvirt/libvirtd.conf</code>. Each of the libvirt sockets can
+have its authentication mechanism configured independently. There is
+currently a choice of <code>none</code>, <code>polkit</code>, and <code>sasl</code>.
+The SASL scheme can be further configured to choose between a large
+number of different mechanisms.
+</p>
+    <h3><a name="ACL_server_unix_perms">UNIX socket permissions/group</a></h3>
+    <p>
+If libvirt does not contain support for PolicyKit, then access control for
+the UNIX domain socket is done using traditional file user/group ownership
+and permissions. There are 2 sockets, one for full read-write access, the
+other for read-only access. The RW socket will be restricted (mode 0700) to
+only allow the <code>root</code> user to connect. The read-only socket will
+be open access (mode 0777) to allow any user to connect.
+</p>
+    <p>
+To allow non-root users greater access, the <code>libvirtd.conf</code> file
+can be edited to change the permissions via the <code>unix_sock_rw_perms</code>,
+config parameter and to set a user group via the <code>unix_sock_group</code>
+parameter. For example, setting the former to mode <code>0770</code> and the
+latter <code>wheel</code> would let any user in the wheel group connect to
+the libvirt daemon.
+</p>
+    <h3><a name="ACL_server_polkit">UNIX socket PolicyKit auth</a></h3>
+    <p>
+If libvirt contains support for PolicyKit, then access control options are
+more advanced. The <code>unix_sock_auth</code> parameter will default to
+<code>polkit</code>, and the file permissions will default to <code>0777</code>
+even on the RW socket. Upon connecting to the socket, the client application
+will be required to identify itself with PolicyKit. The default policy for the
+RW daemon socket will require any application running in the current desktop
+session to authenticate using the user's password. This is akin to <code>sudo</code>
+auth, but does not require that the client application ultimately run as root.
+Default policy will still allow any application to connect to the RO socket.
+</p>
+    <p>
+The default policy can be overridden by the administrator using the PolicyKit
+master configuration file in <code>/etc/PolicyKit/PolicyKit.conf</code>. The
+<code>PolicyKit.conf(5)</code> manual page provides details on the syntax
+available. The two libvirt daemon actions available are named <code>org.libvirt.unix.monitor</code>
+for the RO socket, and <code>org.libvirt.unix.manage</code> for the RW socket.
+</p>
+    <p>
+As an example, to allow a user <code>fred</code>full access to the RW socket,
+while requiring <code>joe</code> to authenticate with the admin password,
+would require adding the following snippet to <code>PolicyKit.conf</code>.
+</p>
+    <pre>
+  &lt;match action="org.libvirt.unix.manage"&gt;
+    &lt;match user="fred"&gt;
+      &lt;return result="yes"/&gt;
+    &lt;/match&gt;
+  &lt;/match&gt;
+  &lt;match action="org.libvirt.unix.manage"&gt;
+    &lt;match user="joe"&gt;
+      &lt;return result="auth_admin"/&gt;
+    &lt;/match&gt;
+  &lt;/match&gt;
+</pre>
+    <h3><a name="ACL_server_username">Username/password auth</a></h3>
+    <p>
+The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
+The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
+username+password style authentication. It also provides for encryption of the data
+stream, so the security of the plain TCP socket is on a par with that of the TLS
+socket. If desired the UNIX socket and TLS socket can also have SASL enabled by
+setting the <code>auth_unix_ro</code>, <code>auth_unix_rw</code>, <code>auth_tls</code>
+config params in <code>libvirt.conf</code>.
+</p>
+    <p>
+Out of the box, no user accounts are defined, so no clients will be able to authenticate
+on the TCP socket. Adding users and setting their passwords is done with the <code>saslpasswd2</code>
+command. When running this command it is important to tell it that the appname is <code>libvirt</code>.
+As an example, to add a user <code>fred</code>, run
+</p>
+    <pre>
+# saslpasswd2 -a libvirt fred
+Password: xxxxxx
+Again (for verification): xxxxxx
+</pre>
+    <p>
+To see a list of all accounts the <code>sasldblistusers2</code> command can be used.
+This command expects to be given the path to the libvirt user database, which is kept
+in <code>/etc/libvirt/passwd.db</code>
+</p>
+    <pre>
+# sasldblistusers2 -f /etc/libvirt/passwd.db
+fred@t60wlan.home.berrange.com: userPassword
+</pre>
+    <p>
+Finally, to disable a user's access, the <code>saslpasswd2</code> command can be used
+again:
+</p>
+    <pre>
+# saslpasswd2 -a libvirt -d fred
+</pre>
+    <h3><a name="ACL_server_kerberos">Kerberos auth</a></h3>
+    <p>
+The plain TCP socket of the libvirt daemon defaults to using SASL for authentication.
+The SASL mechanism configured by default is DIGEST-MD5, which provides a basic
+username+password style authentication. To enable Kerberos single-sign-on instead,
+the libvirt SASL configuration file must be changed. This is <code>/etc/sasl2/libvirt.conf</code>.
+The <code>mech_list</code> parameter must first be changed to <code>gssapi</code>
+instead of the default <code>digest-md5</code>. If SASL is enabled on the UNIX
+and/or TLS sockets, Kerberos will also be used for them. Like DIGEST-MD5, the Kerberos
+mechanism provides data encryption of the session.
+</p>
+    <p>
+Some operating systems do not install the SASL kerberos plugin by default. It
+may be necessary to install a sub-package such as <code>cyrus-sasl-gssapi</code>.
+To check whether the Kerberos plugin is installed run the <code>pluginviewer</code>
+program and verify that <code>gssapi</code> is listed,eg:
+</p>
+    <pre>
+# pluginviewer
+...snip...
+Plugin "gssapiv2" [loaded],     API version: 4
+        SASL mechanism: GSSAPI, best SSF: 56
+        security flags: NO_ANONYMOUS|NO_PLAINTEXT|NO_ACTIVE|PASS_CREDENTIALS|MUTUAL_AUTH
+        features: WANT_CLIENT_FIRST|PROXY_AUTHENTICATION|NEED_SERVER_FQDN
+</pre>
+    <p>
+Next is is necessary for the administrator of the Kerberos realm to issue a principle
+for the libvirt server. There needs to be one principle per host running the libvirt
+daemon. The principle should be named <code>libvirt/full.hostname@KERBEROS.REALM</code>.
+This is typically done by running the <code>kadmin.local</code> command on the Kerberos
+server, though some Kerberos servers have alternate ways of setting up service principles.
+Once created, the principle should be exported to a keytab, copied to the host running
+the libvirt daemon and placed in <code>/etc/libvirt/krb5.tab</code>
+</p>
+    <pre>
+# kadmin.local
+kadmin.local: add_principal libvirt/foo.example.com
+Enter password for principal "libvirt/foo.example.com@EXAMPLE.COM":
+Re-enter password for principal "libvirt/foo.example.com@EXAMPLE.COM":
+Principal "libvirt/foo.example.com@EXAMPLE.COM" created.
+
+kadmin.local:  ktadd -k /root/libvirt-foo-example.tab libvirt/foo.example.com@EXAMPLE.COM
+Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type Triple DES cbc mode with HMAC/sha1 added to keytab WRFILE:/root/libvirt-foo-example.tab.
+Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type ArcFour with HMAC/md5 added to keytab WRFILE:/root/libvirt-foo-example.tab.
+Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type DES with HMAC/sha1 added to keytab WRFILE:/root/libvirt-foo-example.tab.
+Entry for principal libvirt/foo.example.com@EXAMPLE.COM with kvno 4, encryption type DES cbc mode with RSA-MD5 added to keytab WRFILE:/root/libvirt-foo-example.tab.
+
+kadmin.local: quit
+
+# scp /root/libvirt-foo-example.tab root@foo.example.com:/etc/libvirt/krb5.tab
+# rm /root/libvirt-foo-example.tab
+</pre>
+    <p>
+Any client application wishing to connect to a Kerberos enabled libvirt server
+merely needs to run <code>kinit</code> to gain a user principle. This may well
+be done automatically when a user logs into a desktop session, if PAM is setup
+to authenticate against Kerberos.
+</p>
+  </body>
+</html>

docs/bindings.html

@@ -0,0 +1,130 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from bindings.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Bindings for other languages</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <span class="active">Language bindings</span>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="overview of the python API bindings" class="inactive" href="python.html">Python</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="overview of the Java API bindings" class="inactive" href="java.html">Java</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Bindings for other languages</h1>
+        <p>Libvirt comes with bindings to support other languages than
+pure <strong>C</strong>. First the headers embeds the necessary declarations to
+allow direct access from <strong>C++</strong> code, but also we have bindings for
+higher level kind of languages:</p>
+        <ul><li><strong>Python</strong>: Libvirt comes with direct support for the Python language
+     (just make sure you installed the libvirt-python package if not
+     compiling from sources). See below for more information about
+     using libvirt with python</li><li><strong>Perl</strong>: Daniel Berrange provides <a href="http://search.cpan.org/dist/Sys-Virt/">bindings for
+     Perl</a>.</li><li><strong>OCaml</strong>: Richard Jones supplies <a href="http://libvirt.org/ocaml/">bindings for OCaml</a>.</li><li><strong>Ruby</strong>: David Lutterkort provides <a href="http://libvirt.org/ruby/">bindings for Ruby</a>.</li><li><strong>Java</strong>: Daniel Veillard maintains <a href="java.html">Java bindings</a>.</li><li><strong>C#</strong>: Richard Jones wrote about <a href="https://www.redhat.com/archives/libvir-list/2008-September/msg00283.html">calling libvirt from C# on the mailing list</a>.</li></ul>
+        <p>For information on using libvirt on <strong>Windows</strong>
+      <a href="windows.html">please see the Windows
+        support page</a>.
+    </p>
+        <p>Support, requests or help for libvirt bindings are welcome on
+the <a href="https://www.redhat.com/mailman/listinfo/libvir-list/">mailing
+list</a>, as usual try to provide enough background information
+and make sure you use recent version, see the <a href="bugs.html">help
+page</a>.</p>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/bindings.html.in

@@ -0,0 +1,30 @@
+<html>
+  <body>
+    <h1 >Bindings for other languages</h1>
+    <p>Libvirt comes with bindings to support other languages than
+pure <strong>C</strong>. First the headers embeds the necessary declarations to
+allow direct access from <strong>C++</strong> code, but also we have bindings for
+higher level kind of languages:</p>
+    <ul>
+      <li><strong>Python</strong>: Libvirt comes with direct support for the Python language
+     (just make sure you installed the libvirt-python package if not
+     compiling from sources). See below for more information about
+     using libvirt with python</li>
+      <li><strong>Perl</strong>: Daniel Berrange provides <a href="http://search.cpan.org/dist/Sys-Virt/">bindings for
+     Perl</a>.</li>
+      <li><strong>OCaml</strong>: Richard Jones supplies <a href="http://libvirt.org/ocaml/">bindings for OCaml</a>.</li>
+      <li><strong>Ruby</strong>: David Lutterkort provides <a href="http://libvirt.org/ruby/">bindings for Ruby</a>.</li>
+      <li><strong>Java</strong>: Daniel Veillard maintains <a href="java.html">Java bindings</a>.</li>
+      <li><strong>C#</strong>: Richard Jones wrote about <a href="https://www.redhat.com/archives/libvir-list/2008-September/msg00283.html">calling libvirt from C# on the mailing list</a>.</li>
+    </ul>
+    <p>For information on using libvirt on <strong>Windows</strong>
+      <a href="windows.html">please see the Windows
+        support page</a>.
+    </p>
+    <p>Support, requests or help for libvirt bindings are welcome on
+the <a href="https://www.redhat.com/mailman/listinfo/libvir-list/">mailing
+list</a>, as usual try to provide enough background information
+and make sure you use recent version, see the <a href="bugs.html">help
+page</a>.</p>
+  </body>
+</html>

docs/bugs.html

@@ -1,20 +1,120 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reporting bugs and getting help</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reporting bugs and getting help</h1><p>There is a mailing-list <a href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a> for libvirt,
-with an  <a href="https://www.redhat.com/archives/libvir-list/">on-line
-archive</a>. Please subscribe to this list before posting by visiting the <a href="https://www.redhat.com/mailman/listinfo/libvir-list">associated Web</a>
-page and follow the instructions. Patches with explanations and provided as
-attachments are really appreciated and will be discussed on the mailing list.
-If possible generate the patches by using cvs diff -u in a CVS checkout.</p><p>We use Red Hat Bugzilla to track bugs and new feature requests to libvirt.
-If you want to report a bug or ask for a feature, please check <a href="http://bugzilla.redhat.com/bugzilla/buglist.cgi?component=libvirt&amp;component=libvirt-devel&amp;component=libvirt-python&amp;bug_status=ASSIGNED&amp;bug_status=INVESTIGATE&amp;bug_status=NEW&amp;bug_status=REOPENED&amp;bug_status=VERIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr&amp;long_desc=&amp;Search=Search">the existing open bugs</a>, then if yours isn't a duplicate of
-an existing bug:</p><ul><li>If you are using official binaries from Fedora: <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&amp;component=libvirt">log a new bug for Fedora</a></li>
-<li>If you are using official binaries from Red Hat Enterprise Linux 5: <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&amp;component=Red%20Hat%20Enterprise%20Linux%205">log a new bug for RHEL</a></li>
-<li>Otherwise: <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&amp;component=Virtualization%20Tools">log a new bug here</a></li>
-</ul><p> Don't forget to attach any patch or extra data that you may have available. It is always a good idea to also
-to post to the <a href="mailto:libvir-list@redhat.com">mailing-list</a>
-too, so that everybody working on the project can see it, thanks !</p><p>Some of the libvirt developers may be found on IRC on the OFTC
-network. Use the settings:</p><ul><li>server: irc.oftc.net</li>
-  <li>port: 6667 (the usual IRC port)</li>
-  <li>channel: #virt</li>
-</ul><p> But there is no guarantee that someone will be watching or able to reply,
-use the mailing-list if you don't get an answer there.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from bugs.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Bug reporting</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <span class="active">Bug reports</span>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Bug reporting</h1>
+        <p>
+      The <a href="http://bugzilla.redhat.com">Red Hat Bugzilla Server</a>
+      should be used to report bugs and request features against libvirt.
+      Before submitting a ticket, check the existing tickets to see if
+      the bug/feature is already tracked.
+    </p>
+        <h2>General libvirt bug reports</h2>
+        <p>
+      If you are using official libvirt binaries from a Linux distribution
+      check below for distribution specific bug reporting policies first.
+      For general libvirt bug reports, from self-built releases, CVS snapshots
+      and any other non-distribution supported builds, enter tickets under
+      the <code>Virtualization Tools</code> product and the <code>libvirt</code>
+      component.
+    </p>
+        <ul><li><a href="">View libvirt tickets</a></li><li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Virtualization%20Tools&amp;component=libvirt">New libvirt ticket</a></li></ul>
+        <h2>Linux Distribution specific bug reports</h2>
+        <ul><li>
+	If you are using official binaries from a <strong>Fedora distribution</strong>, enter
+	tickets against the <code>Fedora</code> product and the <code>libvirt</code>
+	component.
+	<ul><li><a href="">View Fedora libvirt tickets</a></li><li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&amp;component=libvirt">New Fedora libvirt ticket</a></li></ul></li><li>
+	If you are using official binaries from <strong>Red Hat Enterprise Linux distribution</strong>,
+	tickets against the <code>Red Hat Enterprise Linux 5</code> product and
+	the <code>libvirt</code> component.
+	<ul><li><a href="">View Red Hat Enterprise Linux libvirt tickets</a></li><li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Red%20Hat%20Enterprise%20Linux%205&amp;component=libvirt">New Red Hat Enterprise Linux libvirt ticket</a></li></ul></li><li>
+	If you are using official binaries from another Linux distribution first
+	follow their own bug reporting guidelines.
+      </li></ul>
+        <h2>How to file high quality bug reports</h2>
+        <p>
+      To increase the likelihood of your bug report being addressed it is
+      important to provide as much information as possible. When filing
+      libvirt bugs use this checklist to see if you are providing enough
+      information:
+    </p>
+        <ul><li>The version number of the libvirt build, or date of the CVS
+	checkout</li><li>The hardware architecture being used</li><li>The name of the hypervisor (Xen, QEMU, KVM)</li><li>The XML config of the guest domain if relevant</li><li>For Xen hypervisor, the XenD logfile from /var/log/xen</li><li>For QEMU/KVM, the domain logfile from /var/log/libvirt/qemu</li></ul>
+        <p>
+      If requesting a new feature attach any available patch to the ticket
+      and also email the patch to the libvirt mailing list for discussion
+    </p>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/bugs.html.in

@@ -0,0 +1,82 @@
+<?xml version="1.0"?>
+<html>
+  <body>
+
+    <h1>Bug reporting</h1>
+
+    <p>
+      The <a href="http://bugzilla.redhat.com">Red Hat Bugzilla Server</a>
+      should be used to report bugs and request features against libvirt.
+      Before submitting a ticket, check the existing tickets to see if
+      the bug/feature is already tracked.
+    </p>
+
+    <h2>General libvirt bug reports</h2>
+
+    <p>
+      If you are using official libvirt binaries from a Linux distribution
+      check below for distribution specific bug reporting policies first.
+      For general libvirt bug reports, from self-built releases, CVS snapshots
+      and any other non-distribution supported builds, enter tickets under
+      the <code>Virtualization Tools</code> product and the <code>libvirt</code>
+      component.
+    </p>
+
+    <ul>
+      <li><a href="">View libvirt tickets</a></li>
+      <li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Virtualization%20Tools&amp;component=libvirt">New libvirt ticket</a></li>
+    </ul>
+
+    <h2>Linux Distribution specific bug reports</h2>
+    <ul>
+      <li>
+	If you are using official binaries from a <strong>Fedora distribution</strong>, enter
+	tickets against the <code>Fedora</code> product and the <code>libvirt</code>
+	component.
+	<ul>
+	  <li><a href="">View Fedora libvirt tickets</a></li>
+	  <li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&amp;component=libvirt">New Fedora libvirt ticket</a></li>
+	</ul>
+      </li>
+      <li>
+	If you are using official binaries from <strong>Red Hat Enterprise Linux distribution</strong>,
+	tickets against the <code>Red Hat Enterprise Linux 5</code> product and
+	the <code>libvirt</code> component.
+	<ul>
+	  <li><a href="">View Red Hat Enterprise Linux libvirt tickets</a></li>
+	  <li><a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Red%20Hat%20Enterprise%20Linux%205&amp;component=libvirt">New Red Hat Enterprise Linux libvirt ticket</a></li>
+	</ul>
+      </li>
+      <li>
+	If you are using official binaries from another Linux distribution first
+	follow their own bug reporting guidelines.
+      </li>
+    </ul>
+
+
+    <h2>How to file high quality bug reports</h2>
+
+    <p>
+      To increase the likelihood of your bug report being addressed it is
+      important to provide as much information as possible. When filing
+      libvirt bugs use this checklist to see if you are providing enough
+      information:
+    </p>
+
+    <ul>
+      <li>The version number of the libvirt build, or date of the CVS
+	checkout</li>
+      <li>The hardware architecture being used</li>
+      <li>The name of the hypervisor (Xen, QEMU, KVM)</li>
+      <li>The XML config of the guest domain if relevant</li>
+      <li>For Xen hypervisor, the XenD logfile from /var/log/xen</li>
+      <li>For QEMU/KVM, the domain logfile from /var/log/libvirt/qemu</li>
+    </ul>
+
+    <p>
+      If requesting a new feature attach any available patch to the ticket
+      and also email the patch to the libvirt mailing list for discussion
+    </p>
+
+  </body>
+</html>

docs/contact.html

@@ -0,0 +1,100 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from contact.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Contacting the development team</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <span class="active">Contact</span>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Contacting the development team</h1>
+        <h2>Mailing list</h2>
+        <p>
+      There is a mailing-list <a href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a> for libvirt,
+      with an  <a href="https://www.redhat.com/archives/libvir-list/">on-line archive</a>.
+      Please subscribe to this list before posting by visiting the
+      <a href="https://www.redhat.com/mailman/listinfo/libvir-list">associated Web</a>
+      page and follow the instructions. Patches with explanations and provided as
+      attachments are really appreciated and will be discussed on the mailing list.
+      If possible generate the patches by using <code>cvs diff -up</code> in a CVS
+      checkout.
+    </p>
+        <h2>IRC discussion</h2>
+        <p>
+      Some of the libvirt developers may be found on IRC on the <a href="http://oftc.net">OFTC IRC</a>
+      network. Use the settings:
+    </p>
+        <ul><li>server: irc.oftc.net</li><li>port: 6667 (the usual IRC port)</li><li>channel: #virt</li></ul>
+        <p>
+      NB There is no guarantee that someone will be watching or able to reply
+      promptly, so use the mailing-list if you don't get an answer on the IRC
+      channel.
+    </p>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/contact.html.in

@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<html>
+  <body>
+    <h1>Contacting the development team</h1>
+
+    <h2>Mailing list</h2>
+
+    <p>
+      There is a mailing-list <a href="mailto:libvir-list@redhat.com">libvir-list@redhat.com</a> for libvirt,
+      with an  <a href="https://www.redhat.com/archives/libvir-list/">on-line archive</a>.
+      Please subscribe to this list before posting by visiting the
+      <a href="https://www.redhat.com/mailman/listinfo/libvir-list">associated Web</a>
+      page and follow the instructions. Patches with explanations and provided as
+      attachments are really appreciated and will be discussed on the mailing list.
+      If possible generate the patches by using <code>cvs diff -up</code> in a CVS
+      checkout.
+    </p>
+
+    <h2>IRC discussion</h2>
+
+    <p>
+      Some of the libvirt developers may be found on IRC on the <a href="http://oftc.net">OFTC IRC</a>
+      network. Use the settings:
+    </p>
+    <ul>
+      <li>server: irc.oftc.net</li>
+      <li>port: 6667 (the usual IRC port)</li>
+      <li>channel: #virt</li>
+    </ul>
+    <p>
+      NB There is no guarantee that someone will be watching or able to reply
+      promptly, so use the mailing-list if you don't get an answer on the IRC
+      channel.
+    </p>
+
+  </body>
+</html>

docs/deployment.html

@@ -0,0 +1,152 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from deployment.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Deployment</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <span class="active">Deployment</span>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="The URI formats used for connecting to libvirt" class="inactive" href="uri.html">URI format</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Enable remote access over TCP" class="inactive" href="remote.html">Remote access</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Configure authentication for the libvirt daemon" class="inactive" href="auth.html">Authentication</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Access the libvirt daemon from a native Windows client" class="inactive" href="windows.html">Windows port</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Deployment</h1>
+        <h2>Pre-packaged releases</h2>
+        <p>
+      The libvirt API is now available in all major Linux distributions
+      so the simplest deployment approach is to use your distributions'
+      package management software to install the <code>libvirt</code>
+      module.
+    </p>
+        <h2>Self-built releases</h2>
+        <p>
+      libvirt uses GNU autotools for its build system, so deployment
+      follows the usual process of <code>configure; make ; make install</code>
+    </p>
+        <pre>
+
+      # ./configure --prefix=$HOME/usr
+      # make
+      # make install
+    </pre>
+        <h2>Built from CVS / GIT</h2>
+        <p>
+      When building from CVS it is necessary to generate the autotools
+      support files. This requires having <code>autoconf</code>,
+      <code>automake</code>, <code>libtool</code> and <code>intltool</code>
+      installed. The process can be automated with the <code>autogen.sh</code>
+      script.
+    </p>
+        <pre>
+
+      # ./autogen.sh --prefix=$HOME/usr
+      # make
+      # make install
+    </pre>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/deployment.html.in

@@ -0,0 +1,46 @@
+<html>
+  <body>
+    <h1>Deployment</h1>
+
+    <h2>Pre-packaged releases</h2>
+
+    <p>
+      The libvirt API is now available in all major Linux distributions
+      so the simplest deployment approach is to use your distributions'
+      package management software to install the <code>libvirt</code>
+      module.
+    </p>
+
+    <h2>Self-built releases</h2>
+
+    <p>
+      libvirt uses GNU autotools for its build system, so deployment
+      follows the usual process of <code>configure; make ; make install</code>
+    </p>
+
+    <pre>
+
+      # ./configure --prefix=$HOME/usr
+      # make
+      # make install
+    </pre>
+
+    <h2>Built from CVS / GIT</h2>
+
+    <p>
+      When building from CVS it is necessary to generate the autotools
+      support files. This requires having <code>autoconf</code>,
+      <code>automake</code>, <code>libtool</code> and <code>intltool</code>
+      installed. The process can be automated with the <code>autogen.sh</code>
+      script.
+    </p>
+
+    <pre>
+
+      # ./autogen.sh --prefix=$HOME/usr
+      # make
+      # make install
+    </pre>
+
+  </body>
+</html>

docs/devhelp/.gitignore

@@ -0,0 +1,3 @@
+Makefile
+Makefile.in
+libvirt.devhelp

docs/devhelp/libvirt-libvirt.html

@@ -34,7 +34,7 @@
       <span class="refentrytitle">libvirt</span>
     </h2>
     <p>libvirt - core interfaces for the libvirt library</p>
-    <p>Provides the interfaces of the libvirt library to handle Xen domains from a process running in domain 0 </p>
+    <p>Provides the interfaces of the libvirt library to handle virtualized domains </p>
     <p>Author(s): Daniel Veillard &lt;veillard@redhat.com&gt; </p>
     <div class="refsynopsisdiv">
       <h2>Synopsis</h2>
@@ -53,13 +53,15 @@ typedef struct _virDomainBlockStats <a href="#virDomainBlockStatsStruct">virDoma
 typedef enum <a href="#virDomainMigrateFlags">virDomainMigrateFlags</a>;
 typedef struct _virNodeInfo <a href="#virNodeInfo">virNodeInfo</a>;
 typedef struct _virNetwork <a href="#virNetwork">virNetwork</a>;
+typedef enum <a href="#virDomainEventResumedDetailType">virDomainEventResumedDetailType</a>;
 typedef <a href="libvirt-libvirt.html#virDomainBlockStatsStruct">virDomainBlockStatsStruct</a> * <a href="#virDomainBlockStatsPtr">virDomainBlockStatsPtr</a>;
 typedef struct _virConnect <a href="#virConnect">virConnect</a>;
-typedef struct _virVcpuInfo <a href="#virVcpuInfo">virVcpuInfo</a>;
+typedef enum <a href="#virDomainEventStartedDetailType">virDomainEventStartedDetailType</a>;
 typedef struct _virDomainInfo <a href="#virDomainInfo">virDomainInfo</a>;
 typedef enum <a href="#virStoragePoolDeleteFlags">virStoragePoolDeleteFlags</a>;
+typedef enum <a href="#virEventHandleType">virEventHandleType</a>;
 typedef struct _virStoragePool <a href="#virStoragePool">virStoragePool</a>;
-typedef <a href="libvirt-libvirt.html#virStoragePool">virStoragePool</a> * <a href="#virStoragePoolPtr">virStoragePoolPtr</a>;
+typedef enum <a href="#virDomainEventType">virDomainEventType</a>;
 typedef struct _virDomainInterfaceStats <a href="#virDomainInterfaceStatsStruct">virDomainInterfaceStatsStruct</a>;
 typedef struct _virStoragePoolInfo <a href="#virStoragePoolInfo">virStoragePoolInfo</a>;
 typedef enum <a href="#virDomainState">virDomainState</a>;
@@ -68,25 +70,34 @@ typedef <a href="libvirt-libvirt.html#virDomainInterfaceStatsStruct">virDomainIn
 typedef <a href="libvirt-libvirt.html#virConnectAuth">virConnectAuth</a> * <a href="#virConnectAuthPtr">virConnectAuthPtr</a>;
 typedef struct _virStorageVolInfo <a href="#virStorageVolInfo">virStorageVolInfo</a>;
 typedef enum <a href="#virSchedParameterType">virSchedParameterType</a>;
+typedef <a href="libvirt-libvirt.html#virStorageVolInfo">virStorageVolInfo</a> * <a href="#virStorageVolInfoPtr">virStorageVolInfoPtr</a>;
 typedef <a href="libvirt-libvirt.html#virConnectCredential">virConnectCredential</a> * <a href="#virConnectCredentialPtr">virConnectCredentialPtr</a>;
+typedef <a href="libvirt-libvirt.html#virStoragePool">virStoragePool</a> * <a href="#virStoragePoolPtr">virStoragePoolPtr</a>;
 typedef <a href="libvirt-libvirt.html#virNodeInfo">virNodeInfo</a> * <a href="#virNodeInfoPtr">virNodeInfoPtr</a>;
 typedef <a href="libvirt-libvirt.html#virNetwork">virNetwork</a> * <a href="#virNetworkPtr">virNetworkPtr</a>;
 typedef <a href="libvirt-libvirt.html#virDomainInfo">virDomainInfo</a> * <a href="#virDomainInfoPtr">virDomainInfoPtr</a>;
+typedef struct _virNodeDevice <a href="#virNodeDevice">virNodeDevice</a>;
 typedef <a href="libvirt-libvirt.html#virConnect">virConnect</a> * <a href="#virConnectPtr">virConnectPtr</a>;
 typedef struct _virStorageVol <a href="#virStorageVol">virStorageVol</a>;
-typedef <a href="libvirt-libvirt.html#virStorageVolInfo">virStorageVolInfo</a> * <a href="#virStorageVolInfoPtr">virStorageVolInfoPtr</a>;
+typedef <a href="libvirt-libvirt.html#virNodeDevice">virNodeDevice</a> * <a href="#virNodeDevicePtr">virNodeDevicePtr</a>;
 typedef struct _virSchedParameter <a href="#virSchedParameter">virSchedParameter</a>;
 typedef enum <a href="#virConnectFlags">virConnectFlags</a>;
-typedef <a href="libvirt-libvirt.html#virSchedParameter">virSchedParameter</a> * <a href="#virSchedParameterPtr">virSchedParameterPtr</a>;
+typedef enum <a href="#virDomainEventDefinedDetailType">virDomainEventDefinedDetailType</a>;
+typedef enum <a href="#virDomainMemoryFlags">virDomainMemoryFlags</a>;
+typedef enum <a href="#virDomainEventStoppedDetailType">virDomainEventStoppedDetailType</a>;
 typedef <a href="libvirt-libvirt.html#virStorageVol">virStorageVol</a> * <a href="#virStorageVolPtr">virStorageVolPtr</a>;
 typedef enum <a href="#virVcpuState">virVcpuState</a>;
 typedef enum <a href="#virStorageVolDeleteFlags">virStorageVolDeleteFlags</a>;
+typedef struct _virVcpuInfo <a href="#virVcpuInfo">virVcpuInfo</a>;
+typedef <a href="libvirt-libvirt.html#virSchedParameter">virSchedParameter</a> * <a href="#virSchedParameterPtr">virSchedParameterPtr</a>;
 typedef struct _virConnectAuth <a href="#virConnectAuth">virConnectAuth</a>;
 typedef struct _virConnectCredential <a href="#virConnectCredential">virConnectCredential</a>;
+typedef enum <a href="#virDomainEventSuspendedDetailType">virDomainEventSuspendedDetailType</a>;
 typedef <a href="libvirt-libvirt.html#virVcpuInfo">virVcpuInfo</a> * <a href="#virVcpuInfoPtr">virVcpuInfoPtr</a>;
 typedef enum <a href="#virStoragePoolBuildFlags">virStoragePoolBuildFlags</a>;
 typedef enum <a href="#virDomainXMLFlags">virDomainXMLFlags</a>;
 typedef enum <a href="#virStorageVolType">virStorageVolType</a>;
+typedef enum <a href="#virDomainEventUndefinedDetailType">virDomainEventUndefinedDetailType</a>;
 typedef <a href="libvirt-libvirt.html#virDomain">virDomain</a> * <a href="#virDomainPtr">virDomainPtr</a>;
 typedef enum <a href="#virConnectCredentialType">virConnectCredentialType</a>;
 typedef enum <a href="#virStoragePoolState">virStoragePoolState</a>;
@@ -94,14 +105,18 @@ typedef <a href="libvirt-libvirt.html#virStoragePoolInfo">virStoragePoolInfo</a>
 typedef enum <a href="#virDomainCreateFlags">virDomainCreateFlags</a>;
 char *	<a href="#virStoragePoolGetXMLDesc">virStoragePoolGetXMLDesc</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned int flags);
 const char *	<a href="#virStorageVolGetKey">virStorageVolGetKey</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol);
+typedef void <a href="#virEventUpdateTimeoutFunc">virEventUpdateTimeoutFunc</a>	(int timer, <br/>					 int timeout);
 int	<a href="#virConnectClose">virConnectClose</a>			(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn);
 <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	<a href="#virDomainDefineXML">virDomainDefineXML</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * xml);
 int	<a href="#virDomainShutdown">virDomainShutdown</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain);
 int	<a href="#virConnectListStoragePools">virConnectListStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 char ** const names, <br/>					 int maxnames);
 int	<a href="#virGetVersion">virGetVersion</a>			(unsigned long * libVer, <br/>					 const char * type, <br/>					 unsigned long * typeVer);
 int	<a href="#virNodeGetCellsFreeMemory">virNodeGetCellsFreeMemory</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 unsigned long long * freeMems, <br/>					 int startCell, <br/>					 int maxCells);
+int	<a href="#virInitialize">virInitialize</a>			(void);
+const char *	<a href="#virNodeDeviceGetName">virNodeDeviceGetName</a>	(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev);
 int	<a href="#virStoragePoolSetAutostart">virStoragePoolSetAutostart</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 int autostart);
 <a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	<a href="#virStorageVolCreateXML">virStorageVolCreateXML</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>						 const char * xmldesc, <br/>						 unsigned int flags);
+int	<a href="#virConnectDomainEventDeregister">virConnectDomainEventDeregister</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 <a href="libvirt-libvirt.html#virConnectDomainEventCallback">virConnectDomainEventCallback</a> cb);
 int	<a href="#virDomainGetSchedulerParameters">virDomainGetSchedulerParameters</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br/>					 int * nparams);
 <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	<a href="#virDomainLookupByUUIDString">virDomainLookupByUUIDString</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>						 const char * uuidstr);
 int	<a href="#virConnectNumOfDefinedNetworks">virConnectNumOfDefinedNetworks</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn);
@@ -117,19 +132,23 @@ int	<a href="#virDomainSetAutostart">virDomainSetAutostart</a>		(<a href="libvir
 <a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	<a href="#virStorageVolLookupByName">virStorageVolLookupByName</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>							 const char * name);
 <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	<a href="#virDomainCreateLinux">virDomainCreateLinux</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * xmlDesc, <br/>					 unsigned int flags);
 int	<a href="#virDomainSetMaxMemory">virDomainSetMaxMemory</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned long memory);
-int	<a href="#virInitialize">virInitialize</a>			(void);
+void	<a href="#virEventRegisterImpl">virEventRegisterImpl</a>		(<a href="libvirt-libvirt.html#virEventAddHandleFunc">virEventAddHandleFunc</a> addHandle, <br/>					 <a href="libvirt-libvirt.html#virEventUpdateHandleFunc">virEventUpdateHandleFunc</a> updateHandle, <br/>					 <a href="libvirt-libvirt.html#virEventRemoveHandleFunc">virEventRemoveHandleFunc</a> removeHandle, <br/>					 <a href="libvirt-libvirt.html#virEventAddTimeoutFunc">virEventAddTimeoutFunc</a> addTimeout, <br/>					 <a href="libvirt-libvirt.html#virEventUpdateTimeoutFunc">virEventUpdateTimeoutFunc</a> updateTimeout, <br/>					 <a href="libvirt-libvirt.html#virEventRemoveTimeoutFunc">virEventRemoveTimeoutFunc</a> removeTimeout);
 <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	<a href="#virDomainMigrate">virDomainMigrate</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> dconn, <br/>					 unsigned long flags, <br/>					 const char * dname, <br/>					 const char * uri, <br/>					 unsigned long bandwidth);
 int	<a href="#virDomainSuspend">virDomainSuspend</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain);
 int	<a href="#virNetworkCreate">virNetworkCreate</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network);
+char *	<a href="#virNodeDeviceGetXMLDesc">virNodeDeviceGetXMLDesc</a>		(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev, <br/>					 unsigned int flags);
+typedef void <a href="#virEventUpdateHandleFunc">virEventUpdateHandleFunc</a>	(int watch, <br/>					 int event);
 int	<a href="#virDomainDestroy">virDomainDestroy</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain);
 int	<a href="#virConnectNumOfNetworks">virConnectNumOfNetworks</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn);
 <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	<a href="#virStoragePoolLookupByUUIDString">virStoragePoolLookupByUUIDString</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>							 const char * uuidstr);
 char *	<a href="#virDomainGetXMLDesc">virDomainGetXMLDesc</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 int flags);
 int	<a href="#virStoragePoolGetUUID">virStoragePoolGetUUID</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned char * uuid);
+int	<a href="#virNodeDeviceFree">virNodeDeviceFree</a>		(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev);
 int	<a href="#virStorageVolGetInfo">virStorageVolGetInfo</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br/>					 <a href="libvirt-libvirt.html#virStorageVolInfoPtr">virStorageVolInfoPtr</a> info);
-const char *	<a href="#virNetworkGetName">virNetworkGetName</a>	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network);
+int	<a href="#virDomainGetInfo">virDomainGetInfo</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 <a href="libvirt-libvirt.html#virDomainInfoPtr">virDomainInfoPtr</a> info);
 int	<a href="#virNetworkDestroy">virNetworkDestroy</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network);
 <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	<a href="#virStoragePoolLookupByName">virStoragePoolLookupByName</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>							 const char * name);
+<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	<a href="#virStoragePoolCreateXML">virStoragePoolCreateXML</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>						 const char * xmlDesc, <br/>						 unsigned int flags);
 int	<a href="#virNetworkGetAutostart">virNetworkGetAutostart</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br/>					 int * autostart);
 char *	<a href="#virNetworkGetBridgeName">virNetworkGetBridgeName</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network);
 char *	<a href="#virStorageVolGetXMLDesc">virStorageVolGetXMLDesc</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br/>					 unsigned int flags);
@@ -140,40 +159,50 @@ int	<a href="#virDomainCreate">virDomainCreate</a>			(<a href="libvirt-libvirt.h
 int	<a href="#virConnectListDomains">virConnectListDomains</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 int * ids, <br/>					 int maxids);
 int	<a href="#virDomainCoreDump">virDomainCoreDump</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 const char * to, <br/>					 int flags);
 int	<a href="#virDomainSetMemory">virDomainSetMemory</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned long memory);
+int	<a href="#virStoragePoolCreate">virStoragePoolCreate</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned int flags);
 int	<a href="#virNodeGetInfo">virNodeGetInfo</a>			(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 <a href="libvirt-libvirt.html#virNodeInfoPtr">virNodeInfoPtr</a> info);
 int	<a href="#virNetworkSetAutostart">virNetworkSetAutostart</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br/>					 int autostart);
 unsigned long	<a href="#virDomainGetMaxMemory">virDomainGetMaxMemory</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain);
 int	<a href="#virStoragePoolFree">virStoragePoolFree</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool);
+typedef void <a href="#virFreeCallback">virFreeCallback</a>			(void * opaque);
 <a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	<a href="#virNetworkDefineXML">virNetworkDefineXML</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * xml);
+int	<a href="#virNodeDeviceListCaps">virNodeDeviceListCaps</a>		(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev, <br/>					 char ** const names, <br/>					 int maxnames);
 int	<a href="#virDomainBlockStats">virDomainBlockStats</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br/>					 const char * path, <br/>					 <a href="libvirt-libvirt.html#virDomainBlockStatsPtr">virDomainBlockStatsPtr</a> stats, <br/>					 size_t size);
 <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virConnectOpenAuth">virConnectOpenAuth</a>	(const char * name, <br/>					 <a href="libvirt-libvirt.html#virConnectAuthPtr">virConnectAuthPtr</a> auth, <br/>					 int flags);
 int	<a href="#virStoragePoolDelete">virStoragePoolDelete</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned int flags);
-int	<a href="#virDomainResume">virDomainResume</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain);
+typedef int <a href="#virEventRemoveHandleFunc">virEventRemoveHandleFunc</a>	(int watch);
 const char *	<a href="#virStorageVolGetName">virStorageVolGetName</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol);
 int	<a href="#virStoragePoolGetAutostart">virStoragePoolGetAutostart</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 int * autostart);
 int	<a href="#virDomainGetAutostart">virDomainGetAutostart</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 int * autostart);
 int	<a href="#virStoragePoolListVolumes">virStoragePoolListVolumes</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 char ** const names, <br/>					 int maxnames);
 char *	<a href="#virConnectGetHostname">virConnectGetHostname</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn);
+typedef int <a href="#virEventRemoveTimeoutFunc">virEventRemoveTimeoutFunc</a>	(int timer);
 const char *	<a href="#virDomainGetName">virDomainGetName</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain);
 char *	<a href="#virNetworkGetXMLDesc">virNetworkGetXMLDesc</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br/>					 int flags);
 int	<a href="#virConnectNumOfStoragePools">virConnectNumOfStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn);
-int	<a href="#virDomainGetInfo">virDomainGetInfo</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 <a href="libvirt-libvirt.html#virDomainInfoPtr">virDomainInfoPtr</a> info);
+const char *	<a href="#virNetworkGetName">virNetworkGetName</a>	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network);
 int	<a href="#virConnectListDefinedDomains">virConnectListDefinedDomains</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 char ** const names, <br/>					 int maxnames);
 char *	<a href="#virConnectGetCapabilities">virConnectGetCapabilities</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn);
 <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	<a href="#virDomainLookupByName">virDomainLookupByName</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * name);
+char *	<a href="#virConnectFindStoragePoolSources">virConnectFindStoragePoolSources</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>						 const char * type, <br/>						 const char * srcSpec, <br/>						 unsigned int flags);
 int	<a href="#virDomainPinVcpu">virDomainPinVcpu</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned int vcpu, <br/>					 unsigned char * cpumap, <br/>					 int maplen);
 int	<a href="#virDomainRestore">virDomainRestore</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * from);
 char *	<a href="#virStorageVolGetPath">virStorageVolGetPath</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol);
 <a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	<a href="#virNetworkLookupByUUIDString">virNetworkLookupByUUIDString</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>						 const char * uuidstr);
+typedef int <a href="#virConnectDomainEventCallback">virConnectDomainEventCallback</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br/>					 int event, <br/>					 int detail, <br/>					 void * opaque);
 <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	<a href="#virDomainLookupByID">virDomainLookupByID</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 int id);
+int	<a href="#virStorageVolDelete">virStorageVolDelete</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br/>					 unsigned int flags);
 int	<a href="#virStorageVolFree">virStorageVolFree</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol);
+int	<a href="#virDomainMemoryPeek">virDomainMemoryPeek</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br/>					 unsigned long long start, <br/>					 size_t size, <br/>					 void * buffer, <br/>					 unsigned int flags);
 <a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	<a href="#virNetworkLookupByUUID">virNetworkLookupByUUID</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const unsigned char * uuid);
 int	<a href="#virConnectListDefinedNetworks">virConnectListDefinedNetworks</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 char ** const names, <br/>					 int maxnames);
 int	<a href="#virDomainGetUUID">virDomainGetUUID</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned char * uuid);
 <a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	<a href="#virNetworkCreateXML">virNetworkCreateXML</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * xmlDesc);
 int	<a href="#virDomainGetVcpus">virDomainGetVcpus</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 <a href="libvirt-libvirt.html#virVcpuInfoPtr">virVcpuInfoPtr</a> info, <br/>					 int maxinfo, <br/>					 unsigned char * cpumaps, <br/>					 int maplen);
-<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	<a href="#virStoragePoolCreateXML">virStoragePoolCreateXML</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>						 const char * xmlDesc, <br/>						 unsigned int flags);
+<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a>	<a href="#virNodeDeviceLookupByName">virNodeDeviceLookupByName</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>							 const char * name);
 int	<a href="#virStoragePoolGetInfo">virStoragePoolGetInfo</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 <a href="libvirt-libvirt.html#virStoragePoolInfoPtr">virStoragePoolInfoPtr</a> info);
+int	<a href="#virDomainResume">virDomainResume</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain);
+int	<a href="#virNodeListDevices">virNodeListDevices</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * cap, <br/>					 char ** const names, <br/>					 int maxnames, <br/>					 unsigned int flags);
 int	<a href="#virStoragePoolRefresh">virStoragePoolRefresh</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned int flags);
 int	<a href="#virConnectNumOfDefinedDomains">virConnectNumOfDefinedDomains</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn);
 <a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	<a href="#virStorageVolLookupByKey">virStorageVolLookupByKey</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>							 const char * key);
@@ -182,6 +211,7 @@ int	<a href="#virDomainReboot">virDomainReboot</a>			(<a href="libvirt-libvirt.h
 int	<a href="#virNetworkGetUUIDString">virNetworkGetUUIDString</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br/>					 char * buf);
 <a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	<a href="#virNetworkLookupByName">virNetworkLookupByName</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * name);
 int	<a href="#virDomainGetMaxVcpus">virDomainGetMaxVcpus</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain);
+typedef void <a href="#virEventHandleCallback">virEventHandleCallback</a>		(int watch, <br/>					 int fd, <br/>					 int events, <br/>					 void * opaque);
 char *	<a href="#virDomainGetSchedulerType">virDomainGetSchedulerType</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 int * nparams);
 int	<a href="#virDomainDetachDevice">virDomainDetachDevice</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 const char * xml);
 int	<a href="#virStoragePoolNumOfVolumes">virStoragePoolNumOfVolumes</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool);
@@ -193,12 +223,15 @@ char *	<a href="#virConnectGetURI">virConnectGetURI</a>		(<a href="libvirt-libvi
 <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virConnectOpenReadOnly">virConnectOpenReadOnly</a>	(const char * name);
 int	<a href="#virNetworkFree">virNetworkFree</a>			(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network);
 <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	<a href="#virStoragePoolLookupByUUID">virStoragePoolLookupByUUID</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>							 const unsigned char * uuid);
-int	<a href="#virStorageVolDelete">virStorageVolDelete</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br/>					 unsigned int flags);
+typedef int <a href="#virEventAddHandleFunc">virEventAddHandleFunc</a>		(int fd, <br/>					 int event, <br/>					 <a href="libvirt-libvirt.html#virEventHandleCallback">virEventHandleCallback</a> cb, <br/>					 void * opaque, <br/>					 <a href="libvirt-libvirt.html#virFreeCallback">virFreeCallback</a> ff);
 int	<a href="#virNetworkUndefine">virNetworkUndefine</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network);
 int	<a href="#virConnectListDefinedStoragePools">virConnectListDefinedStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>						 char ** const names, <br/>						 int maxnames);
+typedef void <a href="#virEventTimeoutCallback">virEventTimeoutCallback</a>		(int timer, <br/>					 void * opaque);
+int	<a href="#virNodeDeviceNumOfCaps">virNodeDeviceNumOfCaps</a>		(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev);
 <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virNetworkGetConnect">virNetworkGetConnect</a>	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net);
 unsigned long long	<a href="#virNodeGetFreeMemory">virNodeGetFreeMemory</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn);
 <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virStorageVolGetConnect">virStorageVolGetConnect</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol);
+int	<a href="#virNodeNumOfDevices">virNodeNumOfDevices</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * cap, <br/>					 unsigned int flags);
 int	<a href="#virStoragePoolDestroy">virStoragePoolDestroy</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool);
 <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	<a href="#virStoragePoolLookupByVolume">virStoragePoolLookupByVolume</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol);
 <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	<a href="#virDomainLookupByUUID">virDomainLookupByUUID</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const unsigned char * uuid);
@@ -208,10 +241,14 @@ int	<a href="#virConnectGetMaxVcpus">virConnectGetMaxVcpus</a>		(<a href="libvir
 int	<a href="#virDomainGetUUIDString">virDomainGetUUIDString</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 char * buf);
 <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virDomainGetConnect">virDomainGetConnect</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom);
 int	<a href="#virConnectNumOfDefinedStoragePools">virConnectNumOfDefinedStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn);
+const char *	<a href="#virNodeDeviceGetParent">virNodeDeviceGetParent</a>	(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev);
 <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virConnectOpen">virConnectOpen</a>		(const char * name);
-int	<a href="#virStoragePoolCreate">virStoragePoolCreate</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned int flags);
+<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	<a href="#virDomainCreateXML">virDomainCreateXML</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * xmlDesc, <br/>					 unsigned int flags);
 int	<a href="#virDomainSetVcpus">virDomainSetVcpus</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned int nvcpus);
+int	<a href="#virConnectDomainEventRegister">virConnectDomainEventRegister</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 <a href="libvirt-libvirt.html#virConnectDomainEventCallback">virConnectDomainEventCallback</a> cb, <br/>					 void * opaque, <br/>					 <a href="libvirt-libvirt.html#virFreeCallback">virFreeCallback</a> freecb);
 unsigned int	<a href="#virDomainGetID">virDomainGetID</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain);
+int	<a href="#virDomainBlockPeek">virDomainBlockPeek</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br/>					 const char * path, <br/>					 unsigned long long offset, <br/>					 size_t size, <br/>					 void * buffer, <br/>					 unsigned int flags);
+typedef int <a href="#virEventAddTimeoutFunc">virEventAddTimeoutFunc</a>		(int timeout, <br/>					 <a href="libvirt-libvirt.html#virEventTimeoutCallback">virEventTimeoutCallback</a> cb, <br/>					 void * opaque, <br/>					 <a href="libvirt-libvirt.html#virFreeCallback">virFreeCallback</a> ff);
 int	<a href="#virDomainInterfaceStats">virDomainInterfaceStats</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br/>					 const char * path, <br/>					 <a href="libvirt-libvirt.html#virDomainInterfaceStatsPtr">virDomainInterfaceStatsPtr</a> stats, <br/>					 size_t size);
 int	<a href="#virConnectListNetworks">virConnectListNetworks</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 char ** const names, <br/>					 int maxnames);
 </pre>
@@ -321,7 +358,7 @@ The content of this structure is not made public by the API.
 </div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConnectPtr">Typedef </a>virConnectPtr</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnect">virConnect</a> * virConnectPtr;
-</pre><p>a <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> is pointer to a <a href="libvirt-libvirt.html#virConnect">virConnect</a> private structure, this is the type used to reference a connection to the Xen Hypervisor in the API.</p>
+</pre><p>a <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> is pointer to a <a href="libvirt-libvirt.html#virConnect">virConnect</a> private structure, this is the type used to reference a connection to the Hypervisor in the API.</p>
 </div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomain">Structure </a>virDomain</h3><pre class="programlisting">struct _virDomain {
@@ -348,10 +385,67 @@ The content of this structure is not made public by the API.
     <a name="VIR_DOMAIN_NONE">VIR_DOMAIN_NONE</a> = 0
 };
 </pre><p/>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainEventDefinedDetailType">Enum </a>virDomainEventDefinedDetailType</h3><pre class="programlisting">enum <a href="#virDomainEventDefinedDetailType">virDomainEventDefinedDetailType</a> {
+    <a name="VIR_DOMAIN_EVENT_DEFINED_ADDED">VIR_DOMAIN_EVENT_DEFINED_ADDED</a> = 0 /* Newly created config file */
+    <a name="VIR_DOMAIN_EVENT_DEFINED_UPDATED">VIR_DOMAIN_EVENT_DEFINED_UPDATED</a> = 1 /*  Changed config file */
+};
+</pre><p/>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainEventResumedDetailType">Enum </a>virDomainEventResumedDetailType</h3><pre class="programlisting">enum <a href="#virDomainEventResumedDetailType">virDomainEventResumedDetailType</a> {
+    <a name="VIR_DOMAIN_EVENT_RESUMED_UNPAUSED">VIR_DOMAIN_EVENT_RESUMED_UNPAUSED</a> = 0 /* Normal resume due to admin unpause */
+    <a name="VIR_DOMAIN_EVENT_RESUMED_MIGRATED">VIR_DOMAIN_EVENT_RESUMED_MIGRATED</a> = 1 /*  Resumed for completion of migration */
+};
+</pre><p/>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainEventStartedDetailType">Enum </a>virDomainEventStartedDetailType</h3><pre class="programlisting">enum <a href="#virDomainEventStartedDetailType">virDomainEventStartedDetailType</a> {
+    <a name="VIR_DOMAIN_EVENT_STARTED_BOOTED">VIR_DOMAIN_EVENT_STARTED_BOOTED</a> = 0 /* Normal startup from boot */
+    <a name="VIR_DOMAIN_EVENT_STARTED_MIGRATED">VIR_DOMAIN_EVENT_STARTED_MIGRATED</a> = 1 /* Incoming migration from another host */
+    <a name="VIR_DOMAIN_EVENT_STARTED_RESTORED">VIR_DOMAIN_EVENT_STARTED_RESTORED</a> = 2 /*  Restored from a state file */
+};
+</pre><p/>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainEventStoppedDetailType">Enum </a>virDomainEventStoppedDetailType</h3><pre class="programlisting">enum <a href="#virDomainEventStoppedDetailType">virDomainEventStoppedDetailType</a> {
+    <a name="VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN">VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN</a> = 0 /* Normal shutdown */
+    <a name="VIR_DOMAIN_EVENT_STOPPED_DESTROYED">VIR_DOMAIN_EVENT_STOPPED_DESTROYED</a> = 1 /* Forced poweroff from host */
+    <a name="VIR_DOMAIN_EVENT_STOPPED_CRASHED">VIR_DOMAIN_EVENT_STOPPED_CRASHED</a> = 2 /* Guest crashed */
+    <a name="VIR_DOMAIN_EVENT_STOPPED_MIGRATED">VIR_DOMAIN_EVENT_STOPPED_MIGRATED</a> = 3 /* Migrated off to another host */
+    <a name="VIR_DOMAIN_EVENT_STOPPED_SAVED">VIR_DOMAIN_EVENT_STOPPED_SAVED</a> = 4 /* Saved to a state file */
+    <a name="VIR_DOMAIN_EVENT_STOPPED_FAILED">VIR_DOMAIN_EVENT_STOPPED_FAILED</a> = 5 /*  Host emulator/mgmt failed */
+};
+</pre><p/>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainEventSuspendedDetailType">Enum </a>virDomainEventSuspendedDetailType</h3><pre class="programlisting">enum <a href="#virDomainEventSuspendedDetailType">virDomainEventSuspendedDetailType</a> {
+    <a name="VIR_DOMAIN_EVENT_SUSPENDED_PAUSED">VIR_DOMAIN_EVENT_SUSPENDED_PAUSED</a> = 0 /* Normal suspend due to admin pause */
+    <a name="VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED">VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED</a> = 1 /*  Suspended for offline migration */
+};
+</pre><p/>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainEventType">Enum </a>virDomainEventType</h3><pre class="programlisting">enum <a href="#virDomainEventType">virDomainEventType</a> {
+    <a name="VIR_DOMAIN_EVENT_DEFINED">VIR_DOMAIN_EVENT_DEFINED</a> = 0
+    <a name="VIR_DOMAIN_EVENT_UNDEFINED">VIR_DOMAIN_EVENT_UNDEFINED</a> = 1
+    <a name="VIR_DOMAIN_EVENT_STARTED">VIR_DOMAIN_EVENT_STARTED</a> = 2
+    <a name="VIR_DOMAIN_EVENT_SUSPENDED">VIR_DOMAIN_EVENT_SUSPENDED</a> = 3
+    <a name="VIR_DOMAIN_EVENT_RESUMED">VIR_DOMAIN_EVENT_RESUMED</a> = 4
+    <a name="VIR_DOMAIN_EVENT_STOPPED">VIR_DOMAIN_EVENT_STOPPED</a> = 5
+};
+</pre><p/>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainEventUndefinedDetailType">Enum </a>virDomainEventUndefinedDetailType</h3><pre class="programlisting">enum <a href="#virDomainEventUndefinedDetailType">virDomainEventUndefinedDetailType</a> {
+    <a name="VIR_DOMAIN_EVENT_UNDEFINED_REMOVED">VIR_DOMAIN_EVENT_UNDEFINED_REMOVED</a> = 0 /*  Deleted the config file */
+};
+</pre><p/>
 </div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainInfo">Structure </a>virDomainInfo</h3><pre class="programlisting">struct _virDomainInfo {
-    unsigned char	state	: the running state, one of virDomainFlags
+    unsigned char	state	: the running state, one of <a href="libvirt-libvirt.html#virDomainState">virDomainState</a>
     unsigned long	maxMem	: the maximum memory in KBytes allowed
     unsigned long	memory	: the memory in KBytes used by the domain
     unsigned short	nrVirtCpu	: the number of virtual CPUs for the domain
@@ -379,6 +473,12 @@ The content of this structure is not made public by the API.
     long long	tx_drop
 } virDomainInterfaceStatsStruct;
 </pre><p/>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainMemoryFlags">Enum </a>virDomainMemoryFlags</h3><pre class="programlisting">enum <a href="#virDomainMemoryFlags">virDomainMemoryFlags</a> {
+    <a name="VIR_MEMORY_VIRTUAL">VIR_MEMORY_VIRTUAL</a> = 1 /*  addresses are virtual addresses */
+};
+</pre><p/>
 </div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainMigrateFlags">Enum </a>virDomainMigrateFlags</h3><pre class="programlisting">enum <a href="#virDomainMigrateFlags">virDomainMigrateFlags</a> {
@@ -388,7 +488,7 @@ The content of this structure is not made public by the API.
 </div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainPtr">Typedef </a>virDomainPtr</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomain">virDomain</a> * virDomainPtr;
-</pre><p>a <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> is pointer to a <a href="libvirt-libvirt.html#virDomain">virDomain</a> private structure, this is the type used to reference a Xen domain in the API.</p>
+</pre><p>a <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> is pointer to a <a href="libvirt-libvirt.html#virDomain">virDomain</a> private structure, this is the type used to reference a domain in the API.</p>
 </div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainState">Enum </a>virDomainState</h3><pre class="programlisting">enum <a href="#virDomainState">virDomainState</a> {
@@ -408,6 +508,15 @@ The content of this structure is not made public by the API.
     <a name="VIR_DOMAIN_XML_INACTIVE">VIR_DOMAIN_XML_INACTIVE</a> = 2 /*  dump inactive domain information */
 };
 </pre><p/>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virEventHandleType">Enum </a>virEventHandleType</h3><pre class="programlisting">enum <a href="#virEventHandleType">virEventHandleType</a> {
+    <a name="VIR_EVENT_HANDLE_READABLE">VIR_EVENT_HANDLE_READABLE</a> = 1
+    <a name="VIR_EVENT_HANDLE_WRITABLE">VIR_EVENT_HANDLE_WRITABLE</a> = 2
+    <a name="VIR_EVENT_HANDLE_ERROR">VIR_EVENT_HANDLE_ERROR</a> = 4
+    <a name="VIR_EVENT_HANDLE_HANGUP">VIR_EVENT_HANDLE_HANGUP</a> = 8
+};
+</pre><p/>
 </div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virNetwork">Structure </a>virNetwork</h3><pre class="programlisting">struct _virNetwork {
@@ -418,6 +527,16 @@ The content of this structure is not made public by the API.
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virNetworkPtr">Typedef </a>virNetworkPtr</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetwork">virNetwork</a> * virNetworkPtr;
 </pre><p>a <a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> is pointer to a <a href="libvirt-libvirt.html#virNetwork">virNetwork</a> private structure, this is the type used to reference a virtual network in the API.</p>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeDevice">Structure </a>virNodeDevice</h3><pre class="programlisting">struct _virNodeDevice {
+The content of this structure is not made public by the API.
+} virNodeDevice;
+</pre><p/>
+</div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeDevicePtr">Typedef </a>virNodeDevicePtr</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNodeDevice">virNodeDevice</a> * virNodeDevicePtr;
+</pre><p>A <a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> is a pointer to a <a href="libvirt-libvirt.html#virNodeDevice">virNodeDevice</a> structure. Get one via virNodeDeviceLookupByKey, virNodeDeviceLookupByName, or virNodeDeviceCreate. Be sure to Call <a href="libvirt-libvirt.html#virNodeDeviceFree">virNodeDeviceFree</a> when done using a <a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> obtained from any of the above functions to avoid leaking memory.</p>
 </div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virNodeInfo">Structure </a>virNodeInfo</h3><pre class="programlisting">struct _virNodeInfo {
@@ -566,6 +685,46 @@ The content of this structure is not made public by the API.
         <div class="refsect2" lang="en"><h3><a name="virConnectAuthCallbackPtr"/>Function type virConnectAuthCallbackPtr</h3><pre class="programlisting">int	virConnectAuthCallbackPtr	(<a href="libvirt-libvirt.html#virConnectCredentialPtr">virConnectCredentialPtr</a> cred, <br/>					 unsigned int ncred, <br/>					 void * cbdata)<br/>
 </pre><p/>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>cred</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>ncred</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>cbdata</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td/></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virConnectDomainEventCallback"/>Function type virConnectDomainEventCallback</h3><pre class="programlisting">int	virConnectDomainEventCallback	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br/>					 int event, <br/>					 int detail, <br/>					 void * opaque)<br/>
+</pre><p>A callback function to be registered, and called when a domain event occurs</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td><a href="libvirt-libvirt.html#virConnect">virConnect</a> connection</td></tr><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>The domain on which the event occured</td></tr><tr><td><span class="term"><i><tt>event</tt></i>:</span></td><td>The specfic <a href="libvirt-libvirt.html#virDomainEventType">virDomainEventType</a> which occured</td></tr><tr><td><span class="term"><i><tt>detail</tt></i>:</span></td><td>event specific detail information</td></tr><tr><td><span class="term"><i><tt>opaque</tt></i>:</span></td><td>opaque user data</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td/></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virEventAddHandleFunc"/>Function type virEventAddHandleFunc</h3><pre class="programlisting">int	virEventAddHandleFunc		(int fd, <br/>					 int event, <br/>					 <a href="libvirt-libvirt.html#virEventHandleCallback">virEventHandleCallback</a> cb, <br/>					 void * opaque, <br/>					 <a href="libvirt-libvirt.html#virFreeCallback">virFreeCallback</a> ff)<br/>
+</pre><p>Part of the EventImpl, this callback Adds a file handle callback to listen for specific events. The same file handle can be registered multiple times provided the requested event sets are non-overlapping If the opaque user data requires free'ing when the handle is unregistered, then a 2nd callback can be supplied for this purpose.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>fd</tt></i>:</span></td><td>file descriptor to listen on</td></tr><tr><td><span class="term"><i><tt>event</tt></i>:</span></td><td>bitset of events on which to fire the callback</td></tr><tr><td><span class="term"><i><tt>cb</tt></i>:</span></td><td>the callback to be called when an event occurrs</td></tr><tr><td><span class="term"><i><tt>opaque</tt></i>:</span></td><td>user data to pass to the callback</td></tr><tr><td><span class="term"><i><tt>ff</tt></i>:</span></td><td>the callback invoked to free opaque data blob</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a handle watch number to be used for updating and unregistering for events</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virEventAddTimeoutFunc"/>Function type virEventAddTimeoutFunc</h3><pre class="programlisting">int	virEventAddTimeoutFunc		(int timeout, <br/>					 <a href="libvirt-libvirt.html#virEventTimeoutCallback">virEventTimeoutCallback</a> cb, <br/>					 void * opaque, <br/>					 <a href="libvirt-libvirt.html#virFreeCallback">virFreeCallback</a> ff)<br/>
+</pre><p>Part of the EventImpl, this user-defined callback handles adding an event timeout. If the opaque user data requires free'ing when the handle is unregistered, then a 2nd callback can be supplied for this purpose.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>timeout</tt></i>:</span></td><td>The timeout to monitor</td></tr><tr><td><span class="term"><i><tt>cb</tt></i>:</span></td><td>the callback to call when timeout has expired</td></tr><tr><td><span class="term"><i><tt>opaque</tt></i>:</span></td><td>user data to pass to the callback</td></tr><tr><td><span class="term"><i><tt>ff</tt></i>:</span></td><td>the callback invoked to free opaque data blob</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a timer value</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virEventHandleCallback"/>Function type virEventHandleCallback</h3><pre class="programlisting">void	virEventHandleCallback		(int watch, <br/>					 int fd, <br/>					 int events, <br/>					 void * opaque)<br/>
+</pre><p>Callback for receiving file handle events. The callback will be invoked once for each event which is pending.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>watch</tt></i>:</span></td><td>watch on which the event occurred</td></tr><tr><td><span class="term"><i><tt>fd</tt></i>:</span></td><td>file handle on which the event occurred</td></tr><tr><td><span class="term"><i><tt>events</tt></i>:</span></td><td>bitset of events from <a href="libvirt-libvirt.html#virEventHandleType">virEventHandleType</a> constants</td></tr><tr><td><span class="term"><i><tt>opaque</tt></i>:</span></td><td>user data registered with handle</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virEventRemoveHandleFunc"/>Function type virEventRemoveHandleFunc</h3><pre class="programlisting">int	virEventRemoveHandleFunc	(int watch)<br/>
+</pre><p>Part of the EventImpl, this user-provided callback is notified when an fd is no longer being listened on. If a virEventHandleFreeFunc was supplied when the handle was registered, it will be invoked some time during, or after this function call, when it is safe to release the user data.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>watch</tt></i>:</span></td><td>file descriptor watch to stop listening on</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td/></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virEventRemoveTimeoutFunc"/>Function type virEventRemoveTimeoutFunc</h3><pre class="programlisting">int	virEventRemoveTimeoutFunc	(int timer)<br/>
+</pre><p>Part of the EventImpl, this user-defined callback removes a timer If a virEventTimeoutFreeFunc was supplied when the handle was registered, it will be invoked some time during, or after this function call, when it is safe to release the user data.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>timer</tt></i>:</span></td><td>the timer to remove</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on failure</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virEventTimeoutCallback"/>Function type virEventTimeoutCallback</h3><pre class="programlisting">void	virEventTimeoutCallback		(int timer, <br/>					 void * opaque)<br/>
+</pre><p>callback for receiving timer events</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>timer</tt></i>:</span></td><td>timer id emitting the event</td></tr><tr><td><span class="term"><i><tt>opaque</tt></i>:</span></td><td>user data registered with handle</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virEventUpdateHandleFunc"/>Function type virEventUpdateHandleFunc</h3><pre class="programlisting">void	virEventUpdateHandleFunc	(int watch, <br/>					 int event)<br/>
+</pre><p>Part of the EventImpl, this user-provided callback is notified when events to listen on change</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>watch</tt></i>:</span></td><td>file descriptor watch to modify</td></tr><tr><td><span class="term"><i><tt>event</tt></i>:</span></td><td>new events to listen on</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virEventUpdateTimeoutFunc"/>Function type virEventUpdateTimeoutFunc</h3><pre class="programlisting">void	virEventUpdateTimeoutFunc	(int timer, <br/>					 int timeout)<br/>
+</pre><p>Part of the EventImpl, this user-defined callback updates an event timeout.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>timer</tt></i>:</span></td><td>the timer to modify</td></tr><tr><td><span class="term"><i><tt>timeout</tt></i>:</span></td><td>the new timeout value</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virFreeCallback"/>Function type virFreeCallback</h3><pre class="programlisting">void	virFreeCallback			(void * opaque)<br/>
+</pre><p/>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>opaque</tt></i>:</span></td><td/></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConnectAuthPtrDefault">Variable </a>virConnectAuthPtrDefault</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectAuthPtr">virConnectAuthPtr</a> virConnectAuthPtrDefault;
 </pre><p/>
@@ -574,6 +733,18 @@ The content of this structure is not made public by the API.
         <div class="refsect2" lang="en"><h3><a name="virConnectClose"/>virConnectClose ()</h3><pre class="programlisting">int	virConnectClose			(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br/>
 </pre><p>This function closes the connection to the Hypervisor. This should not be called if further interaction with the Hypervisor are needed especially if there is running domain which need further monitoring by the application.</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of error.</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virConnectDomainEventDeregister"/>virConnectDomainEventDeregister ()</h3><pre class="programlisting">int	virConnectDomainEventDeregister	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 <a href="libvirt-libvirt.html#virConnectDomainEventCallback">virConnectDomainEventCallback</a> cb)<br/>
+</pre><p>Removes a Domain Event Callback. De-registering for a domain callback will disable delivery of this event type</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the connection</td></tr><tr><td><span class="term"><i><tt>cb</tt></i>:</span></td><td>callback to the function handling domain events</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on failure</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virConnectDomainEventRegister"/>virConnectDomainEventRegister ()</h3><pre class="programlisting">int	virConnectDomainEventRegister	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 <a href="libvirt-libvirt.html#virConnectDomainEventCallback">virConnectDomainEventCallback</a> cb, <br/>					 void * opaque, <br/>					 <a href="libvirt-libvirt.html#virFreeCallback">virFreeCallback</a> freecb)<br/>
+</pre><p>Adds a Domain Event Callback. Registering for a domain callback will enable delivery of the events</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the connection</td></tr><tr><td><span class="term"><i><tt>cb</tt></i>:</span></td><td>callback to the function handling domain events</td></tr><tr><td><span class="term"><i><tt>opaque</tt></i>:</span></td><td>opaque data to pass on to the callback</td></tr><tr><td><span class="term"><i><tt>freecb</tt></i>:</span></td><td>optional function to deallocate opaque when not used anymore</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on failure</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virConnectFindStoragePoolSources"/>virConnectFindStoragePoolSources ()</h3><pre class="programlisting">char *	virConnectFindStoragePoolSources	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>						 const char * type, <br/>						 const char * srcSpec, <br/>						 unsigned int flags)<br/>
+</pre><p>Talks to a storage backend and attempts to auto-discover the set of available storage pool sources. e.g. For iSCSI this would be a set of iSCSI targets. For NFS this would be a list of exported paths. The srcSpec (optional for some storage pool types, e.g. local ones) is an instance of the storage pool's source element specifying where to look for the pools. srcSpec is not required for some types (e.g., those querying local storage resources only)</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to hypervisor connection</td></tr><tr><td><span class="term"><i><tt>type</tt></i>:</span></td><td>type of storage pool sources to discover</td></tr><tr><td><span class="term"><i><tt>srcSpec</tt></i>:</span></td><td>XML document specifying discovery source</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for discovery (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>an xml document consisting of a SourceList element containing a source document appropriate to the given pool type for each discovered source.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConnectGetCapabilities"/>virConnectGetCapabilities ()</h3><pre class="programlisting">char *	virConnectGetCapabilities	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br/>
 </pre><p>Provides capabilities of the hypervisor / driver.</p>
@@ -662,6 +833,10 @@ The content of this structure is not made public by the API.
         <div class="refsect2" lang="en"><h3><a name="virDomainAttachDevice"/>virDomainAttachDevice ()</h3><pre class="programlisting">int	virDomainAttachDevice		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 const char * xml)<br/>
 </pre><p>Create a virtual device attachment to backend.</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>pointer to XML description of one device</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainBlockPeek"/>virDomainBlockPeek ()</h3><pre class="programlisting">int	virDomainBlockPeek		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br/>					 const char * path, <br/>					 unsigned long long offset, <br/>					 size_t size, <br/>					 void * buffer, <br/>					 unsigned int flags)<br/>
+</pre><p>This function allows you to read the contents of a domain's disk device. Typical uses for this are to determine if the domain has written a Master Boot Record (indicating that the domain has completed installation), or to try to work out the state of the domain's filesystems. (Note that in the local case you might try to open the block device or file directly, but that won't work in the remote case, nor if you don't have sufficient permission. Hence the need for this call). 'path' must be a device or file corresponding to the domain. In other words it must be the precise string returned in a &lt;disk&gt;&lt;source dev='...'/&gt;&lt;/disk&gt; from virDomainGetXMLDesc. 'offset' and 'size' represent an area which must lie entirely within the device or file. 'size' may be 0 to test if the call would succeed. 'buffer' is the return buffer and must be at least 'size' bytes. NB. The remote driver imposes a 64K byte limit on 'size'. For your program to be able to work reliably over a remote connection you should split large requests to &lt;= 65536 bytes.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to the domain object</td></tr><tr><td><span class="term"><i><tt>path</tt></i>:</span></td><td>path to the block device</td></tr><tr><td><span class="term"><i><tt>offset</tt></i>:</span></td><td>offset within block device</td></tr><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td>size to read</td></tr><tr><td><span class="term"><i><tt>buffer</tt></i>:</span></td><td>return buffer (must be at least size bytes)</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>unused, always pass 0</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of failure. really 64 bits</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainBlockStats"/>virDomainBlockStats ()</h3><pre class="programlisting">int	virDomainBlockStats		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br/>					 const char * path, <br/>					 <a href="libvirt-libvirt.html#virDomainBlockStatsPtr">virDomainBlockStatsPtr</a> stats, <br/>					 size_t size)<br/>
 </pre><p>This function returns block device (disk) stats for block devices attached to the domain. The path parameter is the name of the block device. Get this by calling <a href="libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a> and finding the &lt;target dev='...'&gt; attribute within //domain/devices/disk. (For example, "xvda"). Domains may have more than one block device. To get stats for each you should make multiple calls to this function. Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.</p>
@@ -676,15 +851,19 @@ The content of this structure is not made public by the API.
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainCreateLinux"/>virDomainCreateLinux ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	virDomainCreateLinux	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * xmlDesc, <br/>					 unsigned int flags)<br/>
-</pre><p>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.</p>
-<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>string containing an XML description of the domain</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>an optional set of virDomainFlags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure</td></tr></tbody></table></div></div>
+</pre><p>Deprecated after 0.4.6. Renamed to virDomainCreateXML() providing identical functionality. This existing name will left indefinitely for API compatability.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>string containing an XML description of the domain</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>callers should always pass 0</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainCreateXML"/>virDomainCreateXML ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	virDomainCreateXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * xmlDesc, <br/>					 unsigned int flags)<br/>
+</pre><p>Launch a new guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor. The domain is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted (see virDomainDefineXML() to define persistent domains).</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>string containing an XML description of the domain</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>callers should always pass 0</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainDefineXML"/>virDomainDefineXML ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	virDomainDefineXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * xml)<br/>
-</pre><p>define a domain, but does not start it</p>
+</pre><p>Define a domain, but does not start it. This definition is persistent, until explicitly undefined with virDomainUndefine().</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>the XML description for the domain, preferably in UTF-8</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a pointer to the domain otherwise</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainDestroy"/>virDomainDestroy ()</h3><pre class="programlisting">int	virDomainDestroy		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br/>
-</pre><p>Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires privileged access</p>
+</pre><p>Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> object. This function may require privileged access</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainDetachDevice"/>virDomainDetachDevice ()</h3><pre class="programlisting">int	virDomainDetachDevice		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 const char * xml)<br/>
@@ -748,7 +927,7 @@ The content of this structure is not made public by the API.
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer to an array of <a href="libvirt-libvirt.html#virVcpuInfo">virVcpuInfo</a> structures (OUT)</td></tr><tr><td><span class="term"><i><tt>maxinfo</tt></i>:</span></td><td>number of structures in info array</td></tr><tr><td><span class="term"><i><tt>cpumaps</tt></i>:</span></td><td>pointer to an bit map of real CPUs for all vcpus of this domain (in 8-bit bytes) (OUT) If cpumaps is NULL, then no cpumap information is returned by the API. It's assumed there is &lt;maxinfo&gt; cpumap in cpumaps array. The memory allocated to cpumaps must be (maxinfo * maplen) bytes (ie: calloc(maxinfo, maplen)). One cpumap inside cpumaps has the format described in virDomainPinVcpu() API.</td></tr><tr><td><span class="term"><i><tt>maplen</tt></i>:</span></td><td>number of bytes in one cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...).</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of info filled in case of success, -1 in case of failure.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainGetXMLDesc"/>virDomainGetXMLDesc ()</h3><pre class="programlisting">char *	virDomainGetXMLDesc		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 int flags)<br/>
-</pre><p>Provide an XML description of the domain. The description may be reused later to relaunch the domain with virDomainCreateLinux().</p>
+</pre><p>Provide an XML description of the domain. The description may be reused later to relaunch the domain with virDomainCreateXML().</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>an OR'ed set of <a href="libvirt-libvirt.html#virDomainXMLFlags">virDomainXMLFlags</a></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainInterfaceStats"/>virDomainInterfaceStats ()</h3><pre class="programlisting">int	virDomainInterfaceStats		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br/>					 const char * path, <br/>					 <a href="libvirt-libvirt.html#virDomainInterfaceStatsPtr">virDomainInterfaceStatsPtr</a> stats, <br/>					 size_t size)<br/>
@@ -756,7 +935,7 @@ The content of this structure is not made public by the API.
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to the domain object</td></tr><tr><td><span class="term"><i><tt>path</tt></i>:</span></td><td>path to the interface</td></tr><tr><td><span class="term"><i><tt>stats</tt></i>:</span></td><td>network interface stats (returned)</td></tr><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td>size of stats structure</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of failure.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainLookupByID"/>virDomainLookupByID ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	virDomainLookupByID	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 int id)<br/>
-</pre><p>Try to find a domain based on the hypervisor ID number</p>
+</pre><p>Try to find a domain based on the hypervisor ID number Note that this won't work for inactive domains which have an ID of -1, in that case a lookup based on the Name or UUId need to be done instead.</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>id</tt></i>:</span></td><td>the domain ID number</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure. If the domain cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> error is raised.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainLookupByName"/>virDomainLookupByName ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	virDomainLookupByName	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * name)<br/>
@@ -770,6 +949,10 @@ The content of this structure is not made public by the API.
         <div class="refsect2" lang="en"><h3><a name="virDomainLookupByUUIDString"/>virDomainLookupByUUIDString ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	virDomainLookupByUUIDString	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>						 const char * uuidstr)<br/>
 </pre><p>Try to lookup a domain on the given hypervisor based on its UUID.</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>uuidstr</tt></i>:</span></td><td>the string UUID for the domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure. If the domain cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_DOMAIN">VIR_ERR_NO_DOMAIN</a> error is raised.</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virDomainMemoryPeek"/>virDomainMemoryPeek ()</h3><pre class="programlisting">int	virDomainMemoryPeek		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom, <br/>					 unsigned long long start, <br/>					 size_t size, <br/>					 void * buffer, <br/>					 unsigned int flags)<br/>
+</pre><p>This function allows you to read the contents of a domain's memory. The memory which is read is controlled by the 'start', 'size' and 'flags' parameters. If 'flags' is <a href="libvirt-libvirt.html#VIR_MEMORY_VIRTUAL">VIR_MEMORY_VIRTUAL</a> then the 'start' and 'size' parameters are interpreted as virtual memory addresses for whichever task happens to be running on the domain at the moment. Although this sounds haphazard it is in fact what you want in order to read Linux kernel state, because it ensures that pointers in the kernel image can be interpreted coherently. 'buffer' is the return buffer and must be at least 'size' bytes. 'size' may be 0 to test if the call would succeed. NB. The remote driver imposes a 64K byte limit on 'size'. For your program to be able to work reliably over a remote connection you should split large requests to &lt;= 65536 bytes.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to the domain object</td></tr><tr><td><span class="term"><i><tt>start</tt></i>:</span></td><td>start of memory to peek</td></tr><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td>size of memory to peek</td></tr><tr><td><span class="term"><i><tt>buffer</tt></i>:</span></td><td>return buffer (must be at least size bytes)</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags, see below</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of failure. really 64 bits</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainMigrate"/>virDomainMigrate ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	virDomainMigrate	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> dconn, <br/>					 unsigned long flags, <br/>					 const char * dname, <br/>					 const char * uri, <br/>					 unsigned long bandwidth)<br/>
 </pre><p>Migrate the domain object from its current host to the destination host given by dconn (a connection to the destination host). Flags may be one of more of the following: <a href="libvirt-libvirt.html#VIR_MIGRATE_LIVE">VIR_MIGRATE_LIVE</a> Attempt a live migration. If a hypervisor supports renaming domains during migration, then you may set the dname parameter to the new name (otherwise it keeps the same name). If this is not supported by the hypervisor, dname must be NULL or else you will get an error. Since typically the two hypervisors connect directly to each other in order to perform the migration, you may need to specify a path from the source to the destination. This is the purpose of the uri parameter. If uri is NULL, then libvirt will try to find the best method. Uri may specify the hostname or IP address of the destination host as seen from the source. Or uri may be a URI giving transport, hostname, user, port, etc. in the usual form. Refer to driver documentation for the particular URIs supported. The maximum bandwidth (in Mbps) that will be used to do migration can be specified with the bandwidth parameter. If set to 0, libvirt will choose a suitable default. Some hypervisors do not support this feature and will return an error if bandwidth is not 0. To see which features are supported by the current hypervisor, see virConnectGetCapabilities, /capabilities/host/migration_features. There are many limitations on migration imposed by the underlying technology - for example it may not be possible to migrate between different processors even with the same architecture, or between different types of hypervisor.</p>
@@ -824,8 +1007,12 @@ The content of this structure is not made public by the API.
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainUndefine"/>virDomainUndefine ()</h3><pre class="programlisting">int	virDomainUndefine		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br/>
-</pre><p>undefine a domain but does not stop it if it is running</p>
+</pre><p>Undefine a domain but does not stop it if it is running</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virEventRegisterImpl"/>virEventRegisterImpl ()</h3><pre class="programlisting">void	virEventRegisterImpl		(<a href="libvirt-libvirt.html#virEventAddHandleFunc">virEventAddHandleFunc</a> addHandle, <br/>					 <a href="libvirt-libvirt.html#virEventUpdateHandleFunc">virEventUpdateHandleFunc</a> updateHandle, <br/>					 <a href="libvirt-libvirt.html#virEventRemoveHandleFunc">virEventRemoveHandleFunc</a> removeHandle, <br/>					 <a href="libvirt-libvirt.html#virEventAddTimeoutFunc">virEventAddTimeoutFunc</a> addTimeout, <br/>					 <a href="libvirt-libvirt.html#virEventUpdateTimeoutFunc">virEventUpdateTimeoutFunc</a> updateTimeout, <br/>					 <a href="libvirt-libvirt.html#virEventRemoveTimeoutFunc">virEventRemoveTimeoutFunc</a> removeTimeout)<br/>
+</pre><p/>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>addHandle</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>updateHandle</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>removeHandle</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>addTimeout</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>updateTimeout</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>removeTimeout</tt></i>:</span></td><td/></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virGetVersion"/>virGetVersion ()</h3><pre class="programlisting">int	virGetVersion			(unsigned long * libVer, <br/>					 const char * type, <br/>					 unsigned long * typeVer)<br/>
 </pre><p>Provides two information back, @libVer is the version of the library while @typeVer will be the version of the hypervisor type @type against which the library was compiled. If @type is NULL, "Xen" is assumed, if @type is unknown or not available, an error code will be returned and @typeVer will be 0.</p>
@@ -848,7 +1035,7 @@ The content of this structure is not made public by the API.
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>the XML description for the network, preferably in UTF-8</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a pointer to the network otherwise</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virNetworkDestroy"/>virNetworkDestroy ()</h3><pre class="programlisting">int	virNetworkDestroy		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br/>
-</pre><p>Destroy the network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires privileged access</p>
+</pre><p>Destroy the network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated <a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> object. This function may require privileged access</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>a network object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virNetworkFree"/>virNetworkFree ()</h3><pre class="programlisting">int	virNetworkFree			(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br/>
@@ -902,6 +1089,34 @@ The content of this structure is not made public by the API.
         <div class="refsect2" lang="en"><h3><a name="virNetworkUndefine"/>virNetworkUndefine ()</h3><pre class="programlisting">int	virNetworkUndefine		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br/>
 </pre><p>Undefine a network but does not stop it if it is running</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>pointer to a defined network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeDeviceFree"/>virNodeDeviceFree ()</h3><pre class="programlisting">int	virNodeDeviceFree		(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev)<br/>
+</pre><p>Drops a reference to the node device, freeing it if this was the last reference.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dev</tt></i>:</span></td><td>pointer to the node device</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the 0 for success, -1 for error.</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeDeviceGetName"/>virNodeDeviceGetName ()</h3><pre class="programlisting">const char *	virNodeDeviceGetName	(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev)<br/>
+</pre><p>Just return the device name</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dev</tt></i>:</span></td><td>the device</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the device name or NULL in case of error</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeDeviceGetParent"/>virNodeDeviceGetParent ()</h3><pre class="programlisting">const char *	virNodeDeviceGetParent	(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev)<br/>
+</pre><p>Accessor for the parent of the device</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dev</tt></i>:</span></td><td>the device</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the name of the device's parent, or NULL if the device has no parent.</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeDeviceGetXMLDesc"/>virNodeDeviceGetXMLDesc ()</h3><pre class="programlisting">char *	virNodeDeviceGetXMLDesc		(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev, <br/>					 unsigned int flags)<br/>
+</pre><p>Fetch an XML document describing all aspects of the device.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dev</tt></i>:</span></td><td>pointer to the node device</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML generation (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the XML document, or NULL on error</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeDeviceListCaps"/>virNodeDeviceListCaps ()</h3><pre class="programlisting">int	virNodeDeviceListCaps		(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev, <br/>					 char ** const names, <br/>					 int maxnames)<br/>
+</pre><p>Lists the names of the capabilities supported by the device.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dev</tt></i>:</span></td><td>the device</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array to collect the list of capability names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of @names</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of capability names listed in @names.</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeDeviceLookupByName"/>virNodeDeviceLookupByName ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a>	virNodeDeviceLookupByName	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>							 const char * name)<br/>
+</pre><p>Lookup a node device by its name.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>unique device name</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> if found, NULL otherwise.</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeDeviceNumOfCaps"/>virNodeDeviceNumOfCaps ()</h3><pre class="programlisting">int	virNodeDeviceNumOfCaps		(<a href="libvirt-libvirt.html#virNodeDevicePtr">virNodeDevicePtr</a> dev)<br/>
+</pre><p>Accessor for the number of capabilities supported by the device.</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>dev</tt></i>:</span></td><td>the device</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of capabilities supported by the device.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virNodeGetCellsFreeMemory"/>virNodeGetCellsFreeMemory ()</h3><pre class="programlisting">int	virNodeGetCellsFreeMemory	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 unsigned long long * freeMems, <br/>					 int startCell, <br/>					 int maxCells)<br/>
 </pre><p>This call returns the amount of free memory in one or more NUMA cells. The @freeMems array must be allocated by the caller and will be filled with the amount of free memory in kilobytes for each cell requested, starting with startCell (in freeMems[0]), up to either (startCell + maxCells), or the number of additional cells in the node, whichever is smaller.</p>
@@ -914,6 +1129,14 @@ The content of this structure is not made public by the API.
         <div class="refsect2" lang="en"><h3><a name="virNodeGetInfo"/>virNodeGetInfo ()</h3><pre class="programlisting">int	virNodeGetInfo			(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 <a href="libvirt-libvirt.html#virNodeInfoPtr">virNodeInfoPtr</a> info)<br/>
 </pre><p>Extract hardware information about the node.</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#virNodeInfo">virNodeInfo</a> structure allocated by the user</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeListDevices"/>virNodeListDevices ()</h3><pre class="programlisting">int	virNodeListDevices		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * cap, <br/>					 char ** const names, <br/>					 int maxnames, <br/>					 unsigned int flags)<br/>
+</pre><p>Collect the list of node devices, and store their names in @names If the optional 'cap' argument is non-NULL, then the count will be restricted to devices with the specified capability</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>cap</tt></i>:</span></td><td>capability name</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array to collect the list of node device names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of @names</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of node devices found or -1 in case of error</td></tr></tbody></table></div></div>
+        <hr/>
+        <div class="refsect2" lang="en"><h3><a name="virNodeNumOfDevices"/>virNodeNumOfDevices ()</h3><pre class="programlisting">int	virNodeNumOfDevices		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 const char * cap, <br/>					 unsigned int flags)<br/>
+</pre><p>Provides the number of node devices. If the optional 'cap' argument is non-NULL, then the count will be restricted to devices with the specified capability</p>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>cap</tt></i>:</span></td><td>capability name</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of node devices or -1 in case of error</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStoragePoolBuild"/>virStoragePoolBuild ()</h3><pre class="programlisting">int	virStoragePoolBuild		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned int flags)<br/>
 </pre><p>Build the underlying storage pool</p>

docs/devhelp/libvirt-virterror.html

@@ -67,14 +67,14 @@ void	<a href="#virConnResetLastError">virConnResetLastError</a>		(<a href="libvi
     int	domain	: What part of the library raised this error
     char *	message	: human-readable informative error message
     <a href="libvirt-virterror.html#virErrorLevel">virErrorLevel</a>	level	: how consequent is the error
-    <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	conn	: the connection if available
-    <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	dom	: the domain if available
+    <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	conn	: connection if available, deprecated see note above
+    <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	dom	: domain if available, deprecated see note above
     char *	str1	: extra string information
     char *	str2	: extra string information
     char *	str3	: extra string information
     int	int1	: extra number information
     int	int2	: extra number information
-    <a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	net	: the network if available
+    <a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	net	: network if available, deprecated see note above
 } virError;
 </pre><p/>
 </div>
@@ -98,7 +98,12 @@ void	<a href="#virConnResetLastError">virConnResetLastError</a>		(<a href="libvi
     <a name="VIR_FROM_XENXM">VIR_FROM_XENXM</a> = 15 /* Error at Xen XM layer */
     <a name="VIR_FROM_STATS_LINUX">VIR_FROM_STATS_LINUX</a> = 16 /* Error in the Linux Stats code */
     <a name="VIR_FROM_LXC">VIR_FROM_LXC</a> = 17 /* Error from Linux Container driver */
-    <a name="VIR_FROM_STORAGE">VIR_FROM_STORAGE</a> = 18 /*  Error from storage driver */
+    <a name="VIR_FROM_STORAGE">VIR_FROM_STORAGE</a> = 18 /* Error from storage driver */
+    <a name="VIR_FROM_NETWORK">VIR_FROM_NETWORK</a> = 19 /* Error from network config */
+    <a name="VIR_FROM_DOMAIN">VIR_FROM_DOMAIN</a> = 20 /* Error from domain config */
+    <a name="VIR_FROM_UML">VIR_FROM_UML</a> = 21 /* Error at the UML driver */
+    <a name="VIR_FROM_NODEDEV">VIR_FROM_NODEDEV</a> = 22 /* Error from node device monitor */
+    <a name="VIR_FROM_XEN_INOTIFY">VIR_FROM_XEN_INOTIFY</a> = 23 /*  Error from xen inotify layer */
 };
 </pre><p/>
 </div>
@@ -162,7 +167,10 @@ void	<a href="#virConnResetLastError">virConnResetLastError</a>		(<a href="libvi
     <a name="VIR_ERR_INVALID_STORAGE_VOL">VIR_ERR_INVALID_STORAGE_VOL</a> = 47 /* invalid storage vol object */
     <a name="VIR_WAR_NO_STORAGE">VIR_WAR_NO_STORAGE</a> = 48 /* failed to start storage */
     <a name="VIR_ERR_NO_STORAGE_POOL">VIR_ERR_NO_STORAGE_POOL</a> = 49 /* storage pool not found */
-    <a name="VIR_ERR_NO_STORAGE_VOL">VIR_ERR_NO_STORAGE_VOL</a> = 50 /*  storage pool not found */
+    <a name="VIR_ERR_NO_STORAGE_VOL">VIR_ERR_NO_STORAGE_VOL</a> = 50 /* storage pool not found */
+    <a name="VIR_WAR_NO_NODE">VIR_WAR_NO_NODE</a> = 51 /* failed to start node driver */
+    <a name="VIR_ERR_INVALID_NODE_DEVICE">VIR_ERR_INVALID_NODE_DEVICE</a> = 52 /* invalid node device object */
+    <a name="VIR_ERR_NO_NODE_DEVICE">VIR_ERR_NO_NODE_DEVICE</a> = 53 /*  node device not found */
 };
 </pre><p/>
 </div>

docs/docs.html

@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from docs.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Documentation</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <span class="active">Documentation</span>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Documentation</h1>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/docs.html.in

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <h1>Documentation</h1>
+  </body>
+</html>

docs/downloads.html

@@ -1,10 +1,136 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Downloads</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Downloads</h1><p>The latest versions of libvirt can be found on the  <a href="ftp://libvirt.org/libvirt/">libvirt.org</a> server ( <a href="http://libvirt.org/sources/">HTTP</a>, <a href="ftp://libvirt.org/libvirt/">FTP</a>). You will find there the released
-versions as well as <a href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">snapshot
-tarballs</a> updated from CVS head every hour</p><p>Anonymous <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a> is also
-available, first register onto the server:</p><p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login</code></p><p>it will request a password, enter <strong>anoncvs</strong>. Then you can
-checkout the development tree with:</p><p><code>cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co
-libvirt</code></p><p>Use ./autogen.sh to configure the local checkout, then <code>make</code>
-and <code>make install</code>, as usual. All normal cvs commands are now
-available except commiting to the base.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from downloads.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Downloads</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <span class="active">Downloads</span>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Downloads</h1>
+        <h2>Official Releases</h2>
+        <p>
+      The latest versions of the libvirt C library can be downloaded from:
+    </p>
+        <ul><li><a href="ftp://libvirt.org/libvirt/">libvirt.org FTP server</a></li><li><a href="http://libvirt.org/sources/">libvirt.org HTTP server</a></li></ul>
+        <h2>Hourly development snapshots</h2>
+        <p>
+      Once an hour, an automated snapshot is made from the latest CVS server
+      source tree. These snapshots should be usable, but we make no guarantees
+      about their stability:
+    </p>
+        <ul><li><a href="ftp://libvirt.org/libvirt/libvirt-cvs-snapshot.tar.gz">libvirt.org FTP server</a></li><li><a href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">libvirt.org HTTP server</a></li></ul>
+        <h2>CVS repository access</h2>
+        <p>
+      The master source repository uses <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a>
+      and anonymous access is provided. Prior to accessing the server is it necessary
+      to authenticate using the password <code>anoncvs</code>. This can be accomplished with the
+      <code>cvs login</code> command:
+    </p>
+        <pre>
+
+      # cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login
+    </pre>
+        <p>
+      Once authenticated, a checkout can be obtained using
+    </p>
+        <pre>
+
+      # cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co libvirt
+    </pre>
+        <p>
+      The libvirt build process uses GNU autotools, so after obtaining a checkout
+      it is necessary to generate the configure script and Makefile.in templates
+      using the <code>autogen.sh</code> command. As an example, to do a complete
+      build and install it into your home directory run:
+    </p>
+        <pre>
+
+      ./autogen.sh --prefix=$HOME/usr
+      make
+      make install
+    </pre>
+        <h2>GIT repository mirror</h2>
+        <p>
+      The CVS source repository is also mirrored using GIT, and is available
+      for anonymous access via:
+    </p>
+        <pre>
+
+      git clone git://git.et.redhat.com/libvirt.git
+    </pre>
+        <p>
+      It can also be browsed at
+    </p>
+        <pre>
+
+      <a href="http://git.et.redhat.com/?p=libvirt.git;a=summary">http://git.et.redhat.com/?p=libvirt.git;a=summary</a>
+    </pre>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/downloads.html.in

@@ -0,0 +1,89 @@
+<?xml version="1.0"?>
+<html>
+  <body>
+    <h1 >Downloads</h1>
+
+    <h2>Official Releases</h2>
+
+    <p>
+      The latest versions of the libvirt C library can be downloaded from:
+    </p>
+
+    <ul>
+      <li><a href="ftp://libvirt.org/libvirt/">libvirt.org FTP server</a></li>
+      <li><a href="http://libvirt.org/sources/">libvirt.org HTTP server</a></li>
+    </ul>
+
+    <h2>Hourly development snapshots</h2>
+
+    <p>
+      Once an hour, an automated snapshot is made from the latest CVS server
+      source tree. These snapshots should be usable, but we make no guarantees
+      about their stability:
+    </p>
+
+    <ul>
+      <li><a href="ftp://libvirt.org/libvirt/libvirt-cvs-snapshot.tar.gz">libvirt.org FTP server</a></li>
+      <li><a href="http://libvirt.org/sources/libvirt-cvs-snapshot.tar.gz">libvirt.org HTTP server</a></li>
+    </ul>
+
+    <h2>CVS repository access</h2>
+
+    <p>
+      The master source repository uses <a href="http://ximbiot.com/cvs/cvshome/docs/">CVS</a>
+      and anonymous access is provided. Prior to accessing the server is it necessary
+      to authenticate using the password <code>anoncvs</code>. This can be accomplished with the
+      <code>cvs login</code> command:
+    </p>
+
+    <pre>
+
+      # cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs login
+    </pre>
+
+    <p>
+      Once authenticated, a checkout can be obtained using
+    </p>
+
+    <pre>
+
+      # cvs -d :pserver:anoncvs@libvirt.org:2401/data/cvs co libvirt
+    </pre>
+
+    <p>
+      The libvirt build process uses GNU autotools, so after obtaining a checkout
+      it is necessary to generate the configure script and Makefile.in templates
+      using the <code>autogen.sh</code> command. As an example, to do a complete
+      build and install it into your home directory run:
+    </p>
+
+    <pre>
+
+      ./autogen.sh --prefix=$HOME/usr
+      make
+      make install
+    </pre>
+
+    <h2>GIT repository mirror</h2>
+
+    <p>
+      The CVS source repository is also mirrored using GIT, and is available
+      for anonymous access via:
+    </p>
+
+    <pre>
+
+      git clone git://git.et.redhat.com/libvirt.git
+    </pre>
+
+    <p>
+      It can also be browsed at
+    </p>
+
+    <pre>
+
+      <a href="http://git.et.redhat.com/?p=libvirt.git;a=summary">http://git.et.redhat.com/?p=libvirt.git;a=summary</a>
+    </pre>
+
+  </body>
+</html>

docs/drivers.html

@@ -0,0 +1,148 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from drivers.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Internal drivers</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <span class="active">Drivers</span>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the User Mode Linux technology" class="inactive" href="drvuml.html">UML</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Internal drivers</h1>
+        <p>
+      The libvirt public API delegates its implementation to one or
+      more internal drivers, depending on the <a href="uri.html">connection URI</a>
+      passed when initializing the library. There is always a hypervisor driver
+      active, and if the libvirt daemon is available there will usually be a
+      network and storage driver active.
+    </p>
+        <h2>Hypervisor drivers</h2>
+        <p>
+      The hypervisor drivers currently supported by libvirt are:
+    </p>
+        <ul><li><strong><a href="drvxen.html">Xen</a></strong></li><li><strong><a href="drvqemu.html">QEMU</a></strong></li><li><strong><a href="drvlxc.html">LXC</a></strong></li><li><strong><a href="drvtest.html">Test</a></strong></li><li><strong><a href="drvopenvz.html">OpenVZ</a></strong></li></ul>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/drivers.html.in

@@ -0,0 +1,27 @@
+<html>
+  <body>
+    <h1>Internal drivers</h1>
+
+    <p>
+      The libvirt public API delegates its implementation to one or
+      more internal drivers, depending on the <a href="uri.html">connection URI</a>
+      passed when initializing the library. There is always a hypervisor driver
+      active, and if the libvirt daemon is available there will usually be a
+      network and storage driver active.
+    </p>
+
+    <h2>Hypervisor drivers</h2>
+
+    <p>
+      The hypervisor drivers currently supported by libvirt are:
+    </p>
+
+    <ul>
+      <li><strong><a href="drvxen.html">Xen</a></strong></li>
+      <li><strong><a href="drvqemu.html">QEMU</a></strong></li>
+      <li><strong><a href="drvlxc.html">LXC</a></strong></li>
+      <li><strong><a href="drvtest.html">Test</a></strong></li>
+      <li><strong><a href="drvopenvz.html">OpenVZ</a></strong></li>
+    </ul>
+  </body>
+</html>

docs/drvlxc.html

@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from drvlxc.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: LXC container driver</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Linux Container</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the User Mode Linux technology" class="inactive" href="drvuml.html">UML</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>LXC container driver</h1>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/drvlxc.html.in

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <h1>LXC container driver</h1>
+  </body>
+</html>

docs/drvopenvz.html

@@ -0,0 +1,223 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from drvopenvz.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: OpenVZ container driver</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">OpenVZ</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the User Mode Linux technology" class="inactive" href="drvuml.html">UML</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>OpenVZ container driver</h1>
+        <p>
+    The OpenVZ driver for libvirt allows use and management of container
+    based virtualization on a Linux host OS. Prior to using the OpenVZ
+    driver, the OpenVZ enabled kernel must be installed &amp; booted, and the
+    OpenVZ userspace tools installed. The libvirt driver has been tested
+    with OpenVZ 3.0.22, but other 3.0.x versions should also work without
+    undue trouble.
+    </p>
+        <h2>Connections to OpenVZ driver</h2>
+        <p>
+    The libvirt OpenVZ driver is a single-instance privileged driver,
+    with a driver name of 'openvz'. Some example conection URIs for
+    the libvirt driver are:
+    </p>
+        <pre>
+    openvz:///system                     (local access)
+    openvz://example.com/system          (remote access, TLS/x509)
+    openvz+tcp://example.com/system      (remote access, SASl/Kerberos)
+    openvz+ssh://root@example.com/system (remote access, SSH tunnelled)
+    </pre>
+        <h2>Notes on bridged networking</h2>
+        <p>
+    Bridged networking enables a guest domain (ie container) to have its
+    network interface connected directly to the host's physical LAN. Before
+    this can be used there are a couple of configuration pre-requisites for
+    the host OS.
+    </p>
+        <h3>Host network devices</h3>
+        <p>
+    One or more of the physical devices must be attached to a bridge. The
+    process for this varies according to the operating system in use, so
+    for up to date notes consult the <a href="http://wiki.libvirt.org">Wiki</a>
+    or your operating system's networking documentation. The basic idea is
+    that the host OS should end up with a bridge device "br0" containing a
+    physical device "eth0", or a bonding device "bond0".
+    </p>
+        <h3>OpenVZ tools configuration</h3>
+        <p>
+    OpenVZ releases later than 3.0.23 ship with a standard network device
+    setup script that is able to setup bridging, named
+    <code>/usr/sbin/vznetaddbr</code>. For releases prior to 3.0.23, this
+    script must be created manually by the host OS adminstrator. The
+    simplest way is to just download the latest version of this script
+    from a newer OpenVZ release, or upstream source repository. Then
+    a generic configuration file <code>/etc/vz/vznetctl.conf</code>
+    must be created containing
+    </p>
+        <pre>
+#!/bin/bash
+EXTERNAL_SCRIPT="/usr/sbin/vznetaddbr"
+    </pre>
+        <p>
+    The host OS is now ready to allow bridging of guest containers, which
+    will work whether the container is started with libvirt, or OpenVZ
+    tools.
+    </p>
+        <h2>Example guest domain XML configuration</h2>
+        <p>
+    The current libvirt OpenVZ driver has a restriction that the
+    domain names must match the OpenVZ container VEID, which by
+    convention start at 100, and are incremented from there. The
+    choice of OS template to use inside the container is determined
+    by the <code>filesystem</code> tag, and the template source name
+    matches the templates known to OpenVZ tools.
+    </p>
+        <pre>
+&lt;domain type='openvz' id='104'&gt;
+  &lt;name&gt;104&lt;/name&gt;
+  &lt;uuid&gt;86c12009-e591-a159-6e9f-91d18b85ef78&lt;/uuid&gt;
+  &lt;vcpu&gt;3&lt;/vcpu&gt;
+  &lt;os&gt;
+    &lt;type&gt;exe&lt;/type&gt;
+    &lt;init&gt;/sbin/init&lt;/init&gt;
+  &lt;/os&gt;
+  &lt;devices&gt;
+    &lt;filesystem type='template'&gt;
+      &lt;source name='fedora-9-i386-minimal'/&gt;
+      &lt;target dir='/'/&gt;
+    &lt;/filesystem&gt;
+    &lt;interface type='bridge'&gt;
+      &lt;mac address='00:18:51:5b:ea:bf'/&gt;
+      &lt;source bridge='br0'/&gt;
+      &lt;target dev='veth101.0'/&gt;
+    &lt;/interface&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;
+    </pre>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/drvopenvz.html.in

@@ -0,0 +1,109 @@
+<html> <!-- -*- html -*- -->
+  <body>
+    <h1>OpenVZ container driver</h1>
+
+    <p>
+    The OpenVZ driver for libvirt allows use and management of container
+    based virtualization on a Linux host OS. Prior to using the OpenVZ
+    driver, the OpenVZ enabled kernel must be installed &amp; booted, and the
+    OpenVZ userspace tools installed. The libvirt driver has been tested
+    with OpenVZ 3.0.22, but other 3.0.x versions should also work without
+    undue trouble.
+    </p>
+
+    <h2>Connections to OpenVZ driver</h2>
+
+    <p>
+    The libvirt OpenVZ driver is a single-instance privileged driver,
+    with a driver name of 'openvz'. Some example conection URIs for
+    the libvirt driver are:
+    </p>
+
+    <pre>
+    openvz:///system                     (local access)
+    openvz://example.com/system          (remote access, TLS/x509)
+    openvz+tcp://example.com/system      (remote access, SASl/Kerberos)
+    openvz+ssh://root@example.com/system (remote access, SSH tunnelled)
+    </pre>
+
+    <h2>Notes on bridged networking</h2>
+
+    <p>
+    Bridged networking enables a guest domain (ie container) to have its
+    network interface connected directly to the host's physical LAN. Before
+    this can be used there are a couple of configuration pre-requisites for
+    the host OS.
+    </p>
+
+    <h3>Host network devices</h3>
+
+    <p>
+    One or more of the physical devices must be attached to a bridge. The
+    process for this varies according to the operating system in use, so
+    for up to date notes consult the <a href="http://wiki.libvirt.org">Wiki</a>
+    or your operating system's networking documentation. The basic idea is
+    that the host OS should end up with a bridge device "br0" containing a
+    physical device "eth0", or a bonding device "bond0".
+    </p>
+
+    <h3>OpenVZ tools configuration</h3>
+
+    <p>
+    OpenVZ releases later than 3.0.23 ship with a standard network device
+    setup script that is able to setup bridging, named
+    <code>/usr/sbin/vznetaddbr</code>. For releases prior to 3.0.23, this
+    script must be created manually by the host OS adminstrator. The
+    simplest way is to just download the latest version of this script
+    from a newer OpenVZ release, or upstream source repository. Then
+    a generic configuration file <code>/etc/vz/vznetctl.conf</code>
+    must be created containing
+    </p>
+
+    <pre>
+#!/bin/bash
+EXTERNAL_SCRIPT="/usr/sbin/vznetaddbr"
+    </pre>
+
+    <p>
+    The host OS is now ready to allow bridging of guest containers, which
+    will work whether the container is started with libvirt, or OpenVZ
+    tools.
+    </p>
+
+
+    <h2>Example guest domain XML configuration</h2>
+
+    <p>
+    The current libvirt OpenVZ driver has a restriction that the
+    domain names must match the OpenVZ container VEID, which by
+    convention start at 100, and are incremented from there. The
+    choice of OS template to use inside the container is determined
+    by the <code>filesystem</code> tag, and the template source name
+    matches the templates known to OpenVZ tools.
+    </p>
+
+    <pre>
+&lt;domain type='openvz' id='104'&gt;
+  &lt;name&gt;104&lt;/name&gt;
+  &lt;uuid&gt;86c12009-e591-a159-6e9f-91d18b85ef78&lt;/uuid&gt;
+  &lt;vcpu&gt;3&lt;/vcpu&gt;
+  &lt;os&gt;
+    &lt;type&gt;exe&lt;/type&gt;
+    &lt;init&gt;/sbin/init&lt;/init&gt;
+  &lt;/os&gt;
+  &lt;devices&gt;
+    &lt;filesystem type='template'&gt;
+      &lt;source name='fedora-9-i386-minimal'/&gt;
+      &lt;target dir='/'/&gt;
+    &lt;/filesystem&gt;
+    &lt;interface type='bridge'&gt;
+      &lt;mac address='00:18:51:5b:ea:bf'/&gt;
+      &lt;source bridge='br0'/&gt;
+      &lt;target dev='veth101.0'/&gt;
+    &lt;/interface&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;
+    </pre>
+
+  </body>
+</html>

docs/drvqemu.html

@@ -0,0 +1,214 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from drvqemu.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: QEMU/KVM hypervisor driver</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">QEMU / KVM</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the User Mode Linux technology" class="inactive" href="drvuml.html">UML</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>QEMU/KVM hypervisor driver</h1>
+        <p>
+      The libvirt QEMU driver can manage any QEMU emulator from version 0.8.1
+      or later. It can also manage anything that provides the same QEMU command
+      line syntax and monitor interaction. This includes KVM, and Xenner.
+    </p>
+        <h2>Deployment pre-requisites</h2>
+        <ul><li>
+	<strong>QEMU emulators</strong>: The driver will probe <code>/usr/bin</code>
+	for the presence of <code>qemu</code>, <code>qemu-system-x86_64</code>,
+	<code>qemu-system-mips</code>,<code>qemu-system-mipsel</code>,
+	<code>qemu-system-sparc</code>,<code>qemu-system-ppc</code>. The results
+	of this can be seen from the capabilities XML output.
+      </li><li>
+	<strong>KVM hypervisor</strong>: The driver will probe <code>/usr/bin</code>
+	for the presence of <code>qemu-kvm</code> and <code>/dev/kvm</code> device
+	node. If both are found, then KVM fullyvirtualized, hardware accelerated
+	guests will be available.
+      </li><li>
+	<strong>Xenner hypervisor</strong>: The driver will probe <code>/usr/bin</code>
+	for the presence of <code>xenner</code> and <code>/dev/kvm</code> device
+	node. If both are found, then Xen paravirtualized guests can be run using
+	the KVM hardware acceleration.
+      </li></ul>
+        <h2>
+          <a name="xmlconfig" id="xmlconfig">Example domain XML config</a>
+        </h2>
+        <h3>QEMU emulated guest on x86_64</h3>
+        <pre>&lt;domain type='qemu'&gt;
+  &lt;name&gt;QEmu-fedora-i686&lt;/name&gt;
+  &lt;uuid&gt;c7a5fdbd-cdaf-9455-926a-d65c16db1809&lt;/uuid&gt;
+  &lt;memory&gt;219200&lt;/memory&gt;
+  &lt;currentMemory&gt;219200&lt;/currentMemory&gt;
+  &lt;vcpu&gt;2&lt;/vcpu&gt;
+  &lt;os&gt;
+    &lt;type arch='i686' machine='pc'&gt;hvm&lt;/type&gt;
+    &lt;boot dev='cdrom'/&gt;
+  &lt;/os&gt;
+  &lt;devices&gt;
+    &lt;emulator&gt;/usr/bin/qemu-system-x86_64&lt;/emulator&gt;
+    &lt;disk type='file' device='cdrom'&gt;
+      &lt;source file='/home/user/boot.iso'/&gt;
+      &lt;target dev='hdc'/&gt;
+      &lt;readonly/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' device='disk'&gt;
+      &lt;source file='/home/user/fedora.img'/&gt;
+      &lt;target dev='hda'/&gt;
+    &lt;/disk&gt;
+    &lt;interface type='network'&gt;
+      &lt;source network='default'/&gt;
+    &lt;/interface&gt;
+    &lt;graphics type='vnc' port='-1'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+        <h3>KVM hardware accelerated guest on i686</h3>
+        <pre>&lt;domain type='kvm'&gt;
+  &lt;name&gt;demo2&lt;/name&gt;
+  &lt;uuid&gt;4dea24b3-1d52-d8f3-2516-782e98a23fa0&lt;/uuid&gt;
+  &lt;memory&gt;131072&lt;/memory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;os&gt;
+    &lt;type arch="i686"&gt;hvm&lt;/type&gt;
+  &lt;/os&gt;
+  &lt;clock sync="localtime"/&gt;
+  &lt;devices&gt;
+    &lt;emulator&gt;/usr/bin/qemu-kvm&lt;/emulator&gt;
+    &lt;disk type='file' device='disk'&gt;
+      &lt;source file='/var/lib/libvirt/images/demo2.img'/&gt;
+      &lt;target dev='hda'/&gt;
+    &lt;/disk&gt;
+    &lt;interface type='network'&gt;
+      &lt;source network='default'/&gt;
+      &lt;mac address='24:42:53:21:52:45'/&gt;
+    &lt;/interface&gt;
+    &lt;graphics type='vnc' port='-1'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+        <h3>Xen paravirtualized guests with hardware acceleration</h3>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/drvqemu.html.in

@@ -0,0 +1,97 @@
+<html>
+  <body>
+    <h1>QEMU/KVM hypervisor driver</h1>
+
+    <p>
+      The libvirt QEMU driver can manage any QEMU emulator from version 0.8.1
+      or later. It can also manage anything that provides the same QEMU command
+      line syntax and monitor interaction. This includes KVM, and Xenner.
+    </p>
+
+    <h2>Deployment pre-requisites</h2>
+
+    <ul>
+      <li>
+	<strong>QEMU emulators</strong>: The driver will probe <code>/usr/bin</code>
+	for the presence of <code>qemu</code>, <code>qemu-system-x86_64</code>,
+	<code>qemu-system-mips</code>,<code>qemu-system-mipsel</code>,
+	<code>qemu-system-sparc</code>,<code>qemu-system-ppc</code>. The results
+	of this can be seen from the capabilities XML output.
+      </li>
+      <li>
+	<strong>KVM hypervisor</strong>: The driver will probe <code>/usr/bin</code>
+	for the presence of <code>qemu-kvm</code> and <code>/dev/kvm</code> device
+	node. If both are found, then KVM fullyvirtualized, hardware accelerated
+	guests will be available.
+      </li>
+      <li>
+	<strong>Xenner hypervisor</strong>: The driver will probe <code>/usr/bin</code>
+	for the presence of <code>xenner</code> and <code>/dev/kvm</code> device
+	node. If both are found, then Xen paravirtualized guests can be run using
+	the KVM hardware acceleration.
+      </li>
+    </ul>
+
+    <h2><a name="xmlconfig">Example domain XML config</a></h2>
+
+    <h3>QEMU emulated guest on x86_64</h3>
+
+        <pre>&lt;domain type='qemu'&gt;
+  &lt;name&gt;QEmu-fedora-i686&lt;/name&gt;
+  &lt;uuid&gt;c7a5fdbd-cdaf-9455-926a-d65c16db1809&lt;/uuid&gt;
+  &lt;memory&gt;219200&lt;/memory&gt;
+  &lt;currentMemory&gt;219200&lt;/currentMemory&gt;
+  &lt;vcpu&gt;2&lt;/vcpu&gt;
+  &lt;os&gt;
+    &lt;type arch='i686' machine='pc'&gt;hvm&lt;/type&gt;
+    &lt;boot dev='cdrom'/&gt;
+  &lt;/os&gt;
+  &lt;devices&gt;
+    &lt;emulator&gt;/usr/bin/qemu-system-x86_64&lt;/emulator&gt;
+    &lt;disk type='file' device='cdrom'&gt;
+      &lt;source file='/home/user/boot.iso'/&gt;
+      &lt;target dev='hdc'/&gt;
+      &lt;readonly/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' device='disk'&gt;
+      &lt;source file='/home/user/fedora.img'/&gt;
+      &lt;target dev='hda'/&gt;
+    &lt;/disk&gt;
+    &lt;interface type='network'&gt;
+      &lt;source network='default'/&gt;
+    &lt;/interface&gt;
+    &lt;graphics type='vnc' port='-1'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+
+    <h3>KVM hardware accelerated guest on i686</h3>
+
+        <pre>&lt;domain type='kvm'&gt;
+  &lt;name&gt;demo2&lt;/name&gt;
+  &lt;uuid&gt;4dea24b3-1d52-d8f3-2516-782e98a23fa0&lt;/uuid&gt;
+  &lt;memory&gt;131072&lt;/memory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;os&gt;
+    &lt;type arch="i686"&gt;hvm&lt;/type&gt;
+  &lt;/os&gt;
+  &lt;clock sync="localtime"/&gt;
+  &lt;devices&gt;
+    &lt;emulator&gt;/usr/bin/qemu-kvm&lt;/emulator&gt;
+    &lt;disk type='file' device='disk'&gt;
+      &lt;source file='/var/lib/libvirt/images/demo2.img'/&gt;
+      &lt;target dev='hda'/&gt;
+    &lt;/disk&gt;
+    &lt;interface type='network'&gt;
+      &lt;source network='default'/&gt;
+      &lt;mac address='24:42:53:21:52:45'/&gt;
+    &lt;/interface&gt;
+    &lt;graphics type='vnc' port='-1'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+
+    <h3>Xen paravirtualized guests with hardware acceleration</h3>
+
+    
+
+  </body>
+</html>

docs/drvremote.html

@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from drvremote.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Remote management driver</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Remote</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the User Mode Linux technology" class="inactive" href="drvuml.html">UML</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Remote management driver</h1>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/drvremote.html.in

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <h1>Remote management driver</h1>
+  </body>
+</html>

docs/drvtest.html

@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from drvtest.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Test "mock" driver</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Test</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the User Mode Linux technology" class="inactive" href="drvuml.html">UML</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Test "mock" driver</h1>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/drvtest.html.in

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <h1>Test "mock" driver</h1>
+  </body>
+</html>

docs/drvuml.html

@@ -0,0 +1,201 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from drvuml.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: User Mode Linux driver</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">UML</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>User Mode Linux driver</h1>
+        <p>
+    The UML driver for libvirt allows use and management of paravirtualized
+    guests built for User Mode Linux. UML requires no special support in
+    the host kernel, so can be used by any user of any linux system, provided
+    they have enough free RAM for their guest's needs, though there are
+    certain restrictions on network connectivity unless the adminstrator
+    has pre-created TAP devices.
+    </p>
+        <h2>Connections to UML driver</h2>
+        <p>
+    The libvirt UML driver follows the QEMU driver in providing two
+    types of connection. There is one privileged instance per host,
+    which runs as root. This is called the "system" instance, and allows
+    full use of all host resources. Then, there is a per-user unprivileged
+    "session", instance. This has more restricted capabilities, and may
+    require the host administrator to setup certain resources ahead of
+    time to allow full integration with the network. Example connection
+    URIs are
+    </p>
+        <pre>
+    uml:///system                        (local access, system instance)
+    uml:///session                       (local access, session instance)
+    uml://example.com/system             (remote access, TLS/x509)
+    uml+tcp://example.com/system         (remote access, SASl/Kerberos)
+    uml+ssh://root@example.com/system    (remote access, SSH tunnelled)
+    </pre>
+        <h2>Example XML configuration</h2>
+        <p>
+      User mode Linux driver only supports directly kernel boot at
+      this time. A future driver enhancement may allow a paravirt
+      bootloader in a similar style to Xen's pygrub. For now though,
+      the UML kernel must be stored on the host and referenced
+      explicitly in the "os" element. Since UML is a paravirtualized
+      technology, the kernel "type" is set to "uml"
+    </p>
+        <p>
+      There is not yet support for networking in the driver, but
+      disks can be specified in the usual libvirt manner. The main
+      variation is the target device naming scheme "ubd0", and
+      bus type of "uml".
+    </p>
+        <p>
+      Once booted the primary console is connected toa PTY, and
+      thus accessible with "virsh console" or equivalent tools
+    </p>
+        <pre>
+&lt;domain type='uml'&gt;
+  &lt;name&gt;demo&lt;/name&gt;
+  &lt;uuid&gt;b4433fc2-a22e-ffb3-0a3d-9c173b395800&lt;/uuid&gt;
+  &lt;memory&gt;500000&lt;/memory&gt;
+  &lt;currentMemory&gt;500000&lt;/currentMemory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;os&gt;
+    &lt;type arch='x86_64'&gt;uml&lt;/type&gt;
+    &lt;kernel&gt;/home/berrange/linux-uml-2.6.26-x86_64&lt;/kernel&gt;
+  &lt;/os&gt;
+  &lt;devices&gt;
+    &lt;disk type='file' device='disk'&gt;
+      &lt;source file='/home/berrange/FedoraCore6-AMD64-root_fs'/&gt;
+      &lt;target dev='ubd0' bus='uml'/&gt;
+    &lt;/disk&gt;
+    &lt;console type='pty'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;
+    </pre>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/drvuml.html.in

@@ -0,0 +1,79 @@
+<html>
+  <body>
+    <h1>User Mode Linux driver</h1>
+
+    <p>
+    The UML driver for libvirt allows use and management of paravirtualized
+    guests built for User Mode Linux. UML requires no special support in
+    the host kernel, so can be used by any user of any linux system, provided
+    they have enough free RAM for their guest's needs, though there are
+    certain restrictions on network connectivity unless the adminstrator
+    has pre-created TAP devices.
+    </p>
+
+    <h2>Connections to UML driver</h2>
+
+    <p>
+    The libvirt UML driver follows the QEMU driver in providing two
+    types of connection. There is one privileged instance per host,
+    which runs as root. This is called the "system" instance, and allows
+    full use of all host resources. Then, there is a per-user unprivileged
+    "session", instance. This has more restricted capabilities, and may
+    require the host administrator to setup certain resources ahead of
+    time to allow full integration with the network. Example connection
+    URIs are
+    </p>
+
+    <pre>
+    uml:///system                        (local access, system instance)
+    uml:///session                       (local access, session instance)
+    uml://example.com/system             (remote access, TLS/x509)
+    uml+tcp://example.com/system         (remote access, SASl/Kerberos)
+    uml+ssh://root@example.com/system    (remote access, SSH tunnelled)
+    </pre>
+
+    <h2>Example XML configuration</h2>
+
+    <p>
+      User mode Linux driver only supports directly kernel boot at
+      this time. A future driver enhancement may allow a paravirt
+      bootloader in a similar style to Xen's pygrub. For now though,
+      the UML kernel must be stored on the host and referenced
+      explicitly in the "os" element. Since UML is a paravirtualized
+      technology, the kernel "type" is set to "uml"
+    </p>
+
+    <p>
+      There is not yet support for networking in the driver, but
+      disks can be specified in the usual libvirt manner. The main
+      variation is the target device naming scheme "ubd0", and
+      bus type of "uml".
+    </p>
+
+    <p>
+      Once booted the primary console is connected toa PTY, and
+      thus accessible with "virsh console" or equivalent tools
+    </p>
+
+    <pre>
+&lt;domain type='uml'&gt;
+  &lt;name&gt;demo&lt;/name&gt;
+  &lt;uuid&gt;b4433fc2-a22e-ffb3-0a3d-9c173b395800&lt;/uuid&gt;
+  &lt;memory&gt;500000&lt;/memory&gt;
+  &lt;currentMemory&gt;500000&lt;/currentMemory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;os&gt;
+    &lt;type arch='x86_64'&gt;uml&lt;/type&gt;
+    &lt;kernel&gt;/home/berrange/linux-uml-2.6.26-x86_64&lt;/kernel&gt;
+  &lt;/os&gt;
+  &lt;devices&gt;
+    &lt;disk type='file' device='disk'&gt;
+      &lt;source file='/home/berrange/FedoraCore6-AMD64-root_fs'/&gt;
+      &lt;target dev='ubd0' bus='uml'/&gt;
+    &lt;/disk&gt;
+    &lt;console type='pty'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;
+    </pre>
+  </body>
+</html>

docs/drvxen.html

@@ -0,0 +1,330 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from drvxen.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Xen hypervisor driver</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <span class="active">Xen</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Psuedo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the User Mode Linux technology" class="inactive" href="drvuml.html">UML</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Xen hypervisor driver</h1>
+        <p>
+      The libvirt Xen driver provides the ability to manage virtual machines
+      on any Xen release from 3.0.1 onwards.
+    </p>
+        <h2>Deployment pre-requisites</h2>
+        <p>
+      The libvirt Xen driver uses a combination of channels to manage Xen
+      virtual machines.
+    </p>
+        <ul><li>
+	<strong>XenD</strong>: Access to the Xen daemon is a mandatory
+	requirement for the libvirt Xen driver. It requires that the UNIX
+	socket interface be enabled in the <code>/etc/xen/xend-config.sxp</code>
+	configuration file. Specifically the config settings
+	<code>(xend-unix-server yes)</code>. This path is usually restricted
+	to only allow the <code>root</code> user access. As an alternative,
+	the HTTP interface can be used, however, this has significant security
+	implications.
+      </li><li>
+	<strong>XenStoreD</strong>: Access to the Xenstore daemon enables
+	more efficient codepaths for looking up domain information which
+	lowers the CPU overhead of management.
+      </li><li>
+	<strong>Hypercalls</strong>: The ability to make direct hypercalls
+	allows the most efficient codepaths in the driver to be used for
+	monitoring domain status.
+      </li><li>
+	<strong>XM config</strong>: When using Xen releases prior to 3.0.4,
+	there is no inactive domain management in XenD. For such releases,
+	libvirt will automatically process XM configuration files kept in
+	the <code>/etc/xen</code> directory. It is important not to place
+	any other non-config files in this directory.
+      </li></ul>
+        <h2>
+          <a name="xmlconfig" id="xmlconfig">Example domain XML config</a>
+        </h2>
+        <p>
+      Below are some example XML configurations for Xen guest domains.
+      For full details of the available options, consult the <a href="formatdomain.html">domain XML format</a>
+      guide.
+    </p>
+        <h3>Paravirtualized guest bootloader</h3>
+        <p>
+      Using a bootloader allows a paravirtualized guest to be booted using
+      a kernel stored inside its virtual disk image
+    </p>
+        <pre>&lt;domain type='xen' &gt;
+  &lt;name&gt;fc8&lt;/name&gt;
+  &lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
+  &lt;os&gt;
+    &lt;type&gt;linux&lt;/type&gt;
+  &lt;/os&gt;
+  &lt;memory&gt;131072&lt;/memory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;devices&gt;
+    &lt;disk type='file'&gt;
+      &lt;source file='/var/lib/xen/images/fc4.img'/&gt;
+      &lt;target dev='sda1'/&gt;
+    &lt;/disk&gt;
+    &lt;interface type='bridge'&gt;
+      &lt;source bridge='xenbr0'/&gt;
+      &lt;mac address='aa:00:00:00:00:11'/&gt;
+      &lt;script path='/etc/xen/scripts/vif-bridge'/&gt;
+    &lt;/interface&gt;
+    &lt;console tty='/dev/pts/5'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+        <h3>Paravirtualized guest direct kernel boot</h3>
+        <p>
+      For installation of paravirtualized guests it is typical to boot the
+      domain using a kernel and initrd stored in the host OS
+    </p>
+        <pre>&lt;domain type='xen' &gt;
+  &lt;name&gt;fc8&lt;/name&gt;
+  &lt;os&gt;
+    &lt;type&gt;linux&lt;/type&gt;
+    &lt;kernel&gt;/var/lib/xen/install/vmlinuz-fedora8-x86_64&lt;/kernel&gt;
+    &lt;initrd&gt;/var/lib/xen/install/initrd-vmlinuz-fedora8-x86_64&lt;/initrd&gt;
+    &lt;cmdline&gt; kickstart=http://example.com/myguest.ks &lt;/cmdline&gt;
+  &lt;/os&gt;
+  &lt;memory&gt;131072&lt;/memory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;devices&gt;
+    &lt;disk type='file'&gt;
+      &lt;source file='/var/lib/xen/images/fc4.img'/&gt;
+      &lt;target dev='sda1'/&gt;
+    &lt;/disk&gt;
+    &lt;interface type='bridge'&gt;
+      &lt;source bridge='xenbr0'/&gt;
+      &lt;mac address='aa:00:00:00:00:11'/&gt;
+      &lt;script path='/etc/xen/scripts/vif-bridge'/&gt;
+    &lt;/interface&gt;
+    &lt;graphics type='vnc' port='-1'/&gt;
+    &lt;console tty='/dev/pts/5'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+        <h3>Fullyvirtualized guest BIOS boot</h3>
+        <p>
+      Fullyvirtualized guests use the emulated BIOS to boot off the primary
+      harddisk, CDROM or Network PXE ROM.
+    </p>
+        <pre>&lt;domain type='xen' id='3'&gt;
+  &lt;name&gt;fv0&lt;/name&gt;
+  &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
+  &lt;os&gt;
+    &lt;type&gt;hvm&lt;/type&gt;
+    &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
+    &lt;boot dev='hd'/&gt;
+  &lt;/os&gt;
+  &lt;memory&gt;524288&lt;/memory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
+  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
+  &lt;on_crash&gt;restart&lt;/on_crash&gt;
+  &lt;features&gt;
+     &lt;pae/&gt;
+     &lt;acpi/&gt;
+     &lt;apic/&gt;
+  &lt;/features&gt;
+  &lt;clock sync="localtime"/&gt;
+  &lt;devices&gt;
+    &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
+    &lt;interface type='bridge'&gt;
+      &lt;source bridge='xenbr0'/&gt;
+      &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
+      &lt;script path='vif-bridge'/&gt;
+    &lt;/interface&gt;
+    &lt;disk type='file'&gt;
+      &lt;source file='/var/lib/xen/images/fv0'/&gt;
+      &lt;target dev='hda'/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' device='cdrom'&gt;
+      &lt;source file='/var/lib/xen/images/fc5-x86_64-boot.iso'/&gt;
+      &lt;target dev='hdc'/&gt;
+      &lt;readonly/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' device='floppy'&gt;
+      &lt;source file='/root/fd.img'/&gt;
+      &lt;target dev='fda'/&gt;
+    &lt;/disk&gt;
+    &lt;graphics type='vnc' port='5904'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+        <h3>Fullyvirtualized guest direct kernel boot</h3>
+        <p>
+      With Xen 3.2.0 or later it is possible to bypass the BIOS and directly
+      boot a Linux kernel and initrd as a fullyvirtualized domain. This allows
+      for complete automation of OS installation, for example using the Anaconda
+      kickstart support.
+    </p>
+        <pre>&lt;domain type='xen' id='3'&gt;
+  &lt;name&gt;fv0&lt;/name&gt;
+  &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
+  &lt;os&gt;
+    &lt;type&gt;hvm&lt;/type&gt;
+    &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
+    &lt;kernel&gt;/var/lib/xen/install/vmlinuz-fedora8-x86_64&lt;/kernel&gt;
+    &lt;initrd&gt;/var/lib/xen/install/initrd-vmlinuz-fedora8-x86_64&lt;/initrd&gt;
+    &lt;cmdline&gt; kickstart=http://example.com/myguest.ks &lt;/cmdline&gt;
+  &lt;/os&gt;
+  &lt;memory&gt;524288&lt;/memory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
+  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
+  &lt;on_crash&gt;restart&lt;/on_crash&gt;
+  &lt;features&gt;
+     &lt;pae/&gt;
+     &lt;acpi/&gt;
+     &lt;apic/&gt;
+  &lt;/features&gt;
+  &lt;clock sync="localtime"/&gt;
+  &lt;devices&gt;
+    &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
+    &lt;interface type='bridge'&gt;
+      &lt;source bridge='xenbr0'/&gt;
+      &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
+      &lt;script path='vif-bridge'/&gt;
+    &lt;/interface&gt;
+    &lt;disk type='file'&gt;
+      &lt;source file='/var/lib/xen/images/fv0'/&gt;
+      &lt;target dev='hda'/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' device='cdrom'&gt;
+      &lt;source file='/var/lib/xen/images/fc5-x86_64-boot.iso'/&gt;
+      &lt;target dev='hdc'/&gt;
+      &lt;readonly/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' device='floppy'&gt;
+      &lt;source file='/root/fd.img'/&gt;
+      &lt;target dev='fda'/&gt;
+    &lt;/disk&gt;
+    &lt;graphics type='vnc' port='5904'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/drvxen.html.in

@@ -0,0 +1,221 @@
+<html>
+  <body>
+    <h1>Xen hypervisor driver</h1>
+
+    <p>
+      The libvirt Xen driver provides the ability to manage virtual machines
+      on any Xen release from 3.0.1 onwards.
+    </p>
+
+    <h2>Deployment pre-requisites</h2>
+
+    <p>
+      The libvirt Xen driver uses a combination of channels to manage Xen
+      virtual machines.
+    </p>
+
+    <ul>
+      <li>
+	<strong>XenD</strong>: Access to the Xen daemon is a mandatory
+	requirement for the libvirt Xen driver. It requires that the UNIX
+	socket interface be enabled in the <code>/etc/xen/xend-config.sxp</code>
+	configuration file. Specifically the config settings
+	<code>(xend-unix-server yes)</code>. This path is usually restricted
+	to only allow the <code>root</code> user access. As an alternative,
+	the HTTP interface can be used, however, this has significant security
+	implications.
+      </li>
+      <li>
+	<strong>XenStoreD</strong>: Access to the Xenstore daemon enables
+	more efficient codepaths for looking up domain information which
+	lowers the CPU overhead of management.
+      </li>
+      <li>
+	<strong>Hypercalls</strong>: The ability to make direct hypercalls
+	allows the most efficient codepaths in the driver to be used for
+	monitoring domain status.
+      </li>
+      <li>
+	<strong>XM config</strong>: When using Xen releases prior to 3.0.4,
+	there is no inactive domain management in XenD. For such releases,
+	libvirt will automatically process XM configuration files kept in
+	the <code>/etc/xen</code> directory. It is important not to place
+	any other non-config files in this directory.
+      </li>
+    </ul>
+
+    <h2><a name="xmlconfig">Example domain XML config</a></h2>
+
+    <p>
+      Below are some example XML configurations for Xen guest domains.
+      For full details of the available options, consult the <a href="formatdomain.html">domain XML format</a>
+      guide.
+    </p>
+
+    <h3>Paravirtualized guest bootloader</h3>
+
+    <p>
+      Using a bootloader allows a paravirtualized guest to be booted using
+      a kernel stored inside its virtual disk image
+    </p>
+
+        <pre>&lt;domain type='xen' &gt;
+  &lt;name&gt;fc8&lt;/name&gt;
+  &lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
+  &lt;os&gt;
+    &lt;type&gt;linux&lt;/type&gt;
+  &lt;/os&gt;
+  &lt;memory&gt;131072&lt;/memory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;devices&gt;
+    &lt;disk type='file'&gt;
+      &lt;source file='/var/lib/xen/images/fc4.img'/&gt;
+      &lt;target dev='sda1'/&gt;
+    &lt;/disk&gt;
+    &lt;interface type='bridge'&gt;
+      &lt;source bridge='xenbr0'/&gt;
+      &lt;mac address='aa:00:00:00:00:11'/&gt;
+      &lt;script path='/etc/xen/scripts/vif-bridge'/&gt;
+    &lt;/interface&gt;
+    &lt;console tty='/dev/pts/5'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+
+    <h3>Paravirtualized guest direct kernel boot</h3>
+
+    <p>
+      For installation of paravirtualized guests it is typical to boot the
+      domain using a kernel and initrd stored in the host OS
+    </p>
+
+        <pre>&lt;domain type='xen' &gt;
+  &lt;name&gt;fc8&lt;/name&gt;
+  &lt;os&gt;
+    &lt;type&gt;linux&lt;/type&gt;
+    &lt;kernel&gt;/var/lib/xen/install/vmlinuz-fedora8-x86_64&lt;/kernel&gt;
+    &lt;initrd&gt;/var/lib/xen/install/initrd-vmlinuz-fedora8-x86_64&lt;/initrd&gt;
+    &lt;cmdline&gt; kickstart=http://example.com/myguest.ks &lt;/cmdline&gt;
+  &lt;/os&gt;
+  &lt;memory&gt;131072&lt;/memory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;devices&gt;
+    &lt;disk type='file'&gt;
+      &lt;source file='/var/lib/xen/images/fc4.img'/&gt;
+      &lt;target dev='sda1'/&gt;
+    &lt;/disk&gt;
+    &lt;interface type='bridge'&gt;
+      &lt;source bridge='xenbr0'/&gt;
+      &lt;mac address='aa:00:00:00:00:11'/&gt;
+      &lt;script path='/etc/xen/scripts/vif-bridge'/&gt;
+    &lt;/interface&gt;
+    &lt;graphics type='vnc' port='-1'/&gt;
+    &lt;console tty='/dev/pts/5'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+
+    <h3>Fullyvirtualized guest BIOS boot</h3>
+
+    <p>
+      Fullyvirtualized guests use the emulated BIOS to boot off the primary
+      harddisk, CDROM or Network PXE ROM.
+    </p>
+
+        <pre>&lt;domain type='xen' id='3'&gt;
+  &lt;name&gt;fv0&lt;/name&gt;
+  &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
+  &lt;os&gt;
+    &lt;type&gt;hvm&lt;/type&gt;
+    &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
+    &lt;boot dev='hd'/&gt;
+  &lt;/os&gt;
+  &lt;memory&gt;524288&lt;/memory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
+  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
+  &lt;on_crash&gt;restart&lt;/on_crash&gt;
+  &lt;features&gt;
+     &lt;pae/&gt;
+     &lt;acpi/&gt;
+     &lt;apic/&gt;
+  &lt;/features&gt;
+  &lt;clock sync="localtime"/&gt;
+  &lt;devices&gt;
+    &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
+    &lt;interface type='bridge'&gt;
+      &lt;source bridge='xenbr0'/&gt;
+      &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
+      &lt;script path='vif-bridge'/&gt;
+    &lt;/interface&gt;
+    &lt;disk type='file'&gt;
+      &lt;source file='/var/lib/xen/images/fv0'/&gt;
+      &lt;target dev='hda'/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' device='cdrom'&gt;
+      &lt;source file='/var/lib/xen/images/fc5-x86_64-boot.iso'/&gt;
+      &lt;target dev='hdc'/&gt;
+      &lt;readonly/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' device='floppy'&gt;
+      &lt;source file='/root/fd.img'/&gt;
+      &lt;target dev='fda'/&gt;
+    &lt;/disk&gt;
+    &lt;graphics type='vnc' port='5904'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+
+    <h3>Fullyvirtualized guest direct kernel boot</h3>
+
+    <p>
+      With Xen 3.2.0 or later it is possible to bypass the BIOS and directly
+      boot a Linux kernel and initrd as a fullyvirtualized domain. This allows
+      for complete automation of OS installation, for example using the Anaconda
+      kickstart support.
+    </p>
+
+        <pre>&lt;domain type='xen' id='3'&gt;
+  &lt;name&gt;fv0&lt;/name&gt;
+  &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
+  &lt;os&gt;
+    &lt;type&gt;hvm&lt;/type&gt;
+    &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
+    &lt;kernel&gt;/var/lib/xen/install/vmlinuz-fedora8-x86_64&lt;/kernel&gt;
+    &lt;initrd&gt;/var/lib/xen/install/initrd-vmlinuz-fedora8-x86_64&lt;/initrd&gt;
+    &lt;cmdline&gt; kickstart=http://example.com/myguest.ks &lt;/cmdline&gt;
+  &lt;/os&gt;
+  &lt;memory&gt;524288&lt;/memory&gt;
+  &lt;vcpu&gt;1&lt;/vcpu&gt;
+  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
+  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
+  &lt;on_crash&gt;restart&lt;/on_crash&gt;
+  &lt;features&gt;
+     &lt;pae/&gt;
+     &lt;acpi/&gt;
+     &lt;apic/&gt;
+  &lt;/features&gt;
+  &lt;clock sync="localtime"/&gt;
+  &lt;devices&gt;
+    &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
+    &lt;interface type='bridge'&gt;
+      &lt;source bridge='xenbr0'/&gt;
+      &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
+      &lt;script path='vif-bridge'/&gt;
+    &lt;/interface&gt;
+    &lt;disk type='file'&gt;
+      &lt;source file='/var/lib/xen/images/fv0'/&gt;
+      &lt;target dev='hda'/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' device='cdrom'&gt;
+      &lt;source file='/var/lib/xen/images/fc5-x86_64-boot.iso'/&gt;
+      &lt;target dev='hdc'/&gt;
+      &lt;readonly/&gt;
+    &lt;/disk&gt;
+    &lt;disk type='file' device='floppy'&gt;
+      &lt;source file='/root/fd.img'/&gt;
+      &lt;target dev='fda'/&gt;
+    &lt;/disk&gt;
+    &lt;graphics type='vnc' port='5904'/&gt;
+  &lt;/devices&gt;
+&lt;/domain&gt;</pre>
+
+  </body>
+</html>

docs/errors.html

@@ -1,54 +1,112 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Handling of errors</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Handling of errors</h1><p>The main goals of libvirt when it comes to error handling are:</p><ul><li>provide as much detail as possible</li>
-  <li>provide the information as soon as possible</li>
-  <li>dont force the library user into one style of error handling</li>
-</ul><p>As result the library provide both synchronous, callback based and
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from errors.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Handling of errors</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="inactive" href="docs.html">Documentation</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Handling of errors</h1>
+        <p>The main goals of libvirt when it comes to error handling are:</p>
+        <ul><li>provide as much detail as possible</li><li>provide the information as soon as possible</li><li>dont force the library user into one style of error handling</li></ul>
+        <p>As result the library provide both synchronous, callback based and
 asynchronous error reporting. When an error happens in the library code the
 error is logged, allowing to retrieve it later and if the user registered an
 error callback it will be called synchronously. Once the call to libvirt ends
 the error can be detected by the return value and the full information for
-the last logged error can be retrieved.</p><p>To avoid as much as possible troubles with a global variable in a
+the last logged error can be retrieved.</p>
+        <p>To avoid as much as possible troubles with a global variable in a
 multithreaded environment, libvirt will associate when possible the errors to
 the current connection they are related to, that way the error is stored in a
 dynamic structure which can be made thread specific. Error callback can be
-set specifically to a connection with</p><p>So error handling in the code is the following:</p><ol><li>if the error can be associated to a connection for example when failing
+set specifically to a connection with</p>
+        <p>So error handling in the code is the following:</p>
+        <ol><li>if the error can be associated to a connection for example when failing
     to look up a domain
     <ol><li>if there is a callback associated to the connection set with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
-        call it with the error information</li>
-      <li>otherwise if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
-        call it with the error information</li>
-      <li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
+        call it with the error information</li><li>otherwise if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
+        call it with the error information</li><li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
         which is the default error function of the library issuing the error
-        on stderr</li>
-      <li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li>
-    </ol></li>
-  <li>otherwise like when failing to create an hypervisor connection:
+        on stderr</li><li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li></ol></li><li>otherwise like when failing to create an hypervisor connection:
     <ol><li>if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
-        call it with the error information</li>
-      <li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
+        call it with the error information</li><li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
         which is the default error function of the library issuing the error
-        on stderr</li>
-      <li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li>
-    </ol></li>
-</ol><p>In all cases the error information is provided as a <a href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a> pointer to
+        on stderr</li><li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li></ol></li></ol>
+        <p>In all cases the error information is provided as a <a href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a> pointer to
 read-only structure <a href="html/libvirt-virterror.html#virError">virError</a> containing the
-following fields:</p><ul><li>code: an error number from the <a href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>
-  enum</li>
-  <li>domain: an enum indicating which part of libvirt raised the error see
-    <a href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li>
-  <li>level: the error level, usually VIR_ERR_ERROR, though there is room for
-    warnings like VIR_ERR_WARNING</li>
-  <li>message: the full human-readable formatted string of the error</li>
-  <li>conn: if available a pointer to the <a href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>
-    connection to the hypervisor where this happened</li>
-  <li>dom: if available a pointer to the <a href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain
-    targeted in the operation</li>
-</ul><p>and then extra raw information about the error which may be initialized
-to 0 or NULL if unused</p><ul><li>str1, str2, str3: string information, usually str1 is the error
-    message format</li>
-  <li>int1, int2: integer information</li>
-</ul><p>So usually, setting up specific error handling with libvirt consist of
+following fields:</p>
+        <ul><li>code: an error number from the <a href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>
+  enum</li><li>domain: an enum indicating which part of libvirt raised the error see
+    <a href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li><li>level: the error level, usually VIR_ERR_ERROR, though there is room for
+    warnings like VIR_ERR_WARNING</li><li>message: the full human-readable formatted string of the error</li><li>conn: if available a pointer to the <a href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>
+    connection to the hypervisor where this happened</li><li>dom: if available a pointer to the <a href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain
+    targeted in the operation</li></ul>
+        <p>and then extra raw information about the error which may be initialized
+to 0 or NULL if unused</p>
+        <ul><li>str1, str2, str3: string information, usually str1 is the error
+    message format</li><li>int1, int2: integer information</li></ul>
+        <p>So usually, setting up specific error handling with libvirt consist of
 registering an handler with with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a> or
 with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
 check the value of the code value, take appropriate action, if needed let
@@ -57,13 +115,24 @@ For asynchronous error handing, set such a function doing nothing to avoid
 the error being reported on stderr, and call virConnGetLastError or
 virGetLastError when an API call returned an error value. It can be a good
 idea to use <a href="html/libvirt-virterror.html#virResetLastError">virResetError</a> or <a href="html/libvirt-virterror.html#virConnResetLastError">virConnResetLastError</a>
-once an error has been processed fully.</p><p>At the python level, there only a global reporting callback function at
-this point, see the error.py example about it:</p><pre>def handler(ctxt, err):
+once an error has been processed fully.</p>
+        <p>At the python level, there only a global reporting callback function at
+this point, see the error.py example about it:</p>
+        <pre>def handler(ctxt, err):
     global errno
 
     #print "handler(%s, %s)" % (ctxt, err)
     errno = err
 
-libvirt.registerErrorHandler(handler, 'context') </pre><p>the second argument to the registerErrorHandler function is passed as the
+libvirt.registerErrorHandler(handler, 'context') </pre>
+        <p>the second argument to the registerErrorHandler function is passed as the
 first argument of the callback like in the C version. The error is a tuple
-containing the same field as a virError in C, but cast to Python.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+containing the same field as a virError in C, but cast to Python.</p>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/errors.html.in

@@ -0,0 +1,83 @@
+<?xml version="1.0"?>
+<html>
+  <body>
+    <h1 >Handling of errors</h1>
+    <p>The main goals of libvirt when it comes to error handling are:</p>
+    <ul>
+      <li>provide as much detail as possible</li>
+      <li>provide the information as soon as possible</li>
+      <li>dont force the library user into one style of error handling</li>
+    </ul>
+    <p>As result the library provide both synchronous, callback based and
+asynchronous error reporting. When an error happens in the library code the
+error is logged, allowing to retrieve it later and if the user registered an
+error callback it will be called synchronously. Once the call to libvirt ends
+the error can be detected by the return value and the full information for
+the last logged error can be retrieved.</p>
+    <p>To avoid as much as possible troubles with a global variable in a
+multithreaded environment, libvirt will associate when possible the errors to
+the current connection they are related to, that way the error is stored in a
+dynamic structure which can be made thread specific. Error callback can be
+set specifically to a connection with</p>
+    <p>So error handling in the code is the following:</p>
+    <ol>
+      <li>if the error can be associated to a connection for example when failing
+    to look up a domain
+    <ol><li>if there is a callback associated to the connection set with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
+        call it with the error information</li><li>otherwise if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
+        call it with the error information</li><li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
+        which is the default error function of the library issuing the error
+        on stderr</li><li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virConnGetLastError">virConnGetLastError</a></li></ol></li>
+      <li>otherwise like when failing to create an hypervisor connection:
+    <ol><li>if there is a global callback set with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a>,
+        call it with the error information</li><li>otherwise call <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>
+        which is the default error function of the library issuing the error
+        on stderr</li><li>save the error in the connection for later retrieval with <a href="html/libvirt-virterror.html#virGetLastError">virGetLastError</a></li></ol></li>
+    </ol>
+    <p>In all cases the error information is provided as a <a href="html/libvirt-virterror.html#virErrorPtr">virErrorPtr</a> pointer to
+read-only structure <a href="html/libvirt-virterror.html#virError">virError</a> containing the
+following fields:</p>
+    <ul>
+      <li>code: an error number from the <a href="html/libvirt-virterror.html#virErrorNumber">virErrorNumber</a>
+  enum</li>
+      <li>domain: an enum indicating which part of libvirt raised the error see
+    <a href="html/libvirt-virterror.html#virErrorDomain">virErrorDomain</a></li>
+      <li>level: the error level, usually VIR_ERR_ERROR, though there is room for
+    warnings like VIR_ERR_WARNING</li>
+      <li>message: the full human-readable formatted string of the error</li>
+      <li>conn: if available a pointer to the <a href="html/libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>
+    connection to the hypervisor where this happened</li>
+      <li>dom: if available a pointer to the <a href="html/libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain
+    targeted in the operation</li>
+    </ul>
+    <p>and then extra raw information about the error which may be initialized
+to 0 or NULL if unused</p>
+    <ul>
+      <li>str1, str2, str3: string information, usually str1 is the error
+    message format</li>
+      <li>int1, int2: integer information</li>
+    </ul>
+    <p>So usually, setting up specific error handling with libvirt consist of
+registering an handler with with <a href="html/libvirt-virterror.html#virSetErrorFunc">virSetErrorFunc</a> or
+with <a href="html/libvirt-virterror.html#virConnSetErrorFunc">virConnSetErrorFunc</a>,
+check the value of the code value, take appropriate action, if needed let
+libvirt print the error on stderr by calling <a href="html/libvirt-virterror.html#virDefaultErrorFunc">virDefaultErrorFunc</a>.
+For asynchronous error handing, set such a function doing nothing to avoid
+the error being reported on stderr, and call virConnGetLastError or
+virGetLastError when an API call returned an error value. It can be a good
+idea to use <a href="html/libvirt-virterror.html#virResetLastError">virResetError</a> or <a href="html/libvirt-virterror.html#virConnResetLastError">virConnResetLastError</a>
+once an error has been processed fully.</p>
+    <p>At the python level, there only a global reporting callback function at
+this point, see the error.py example about it:</p>
+    <pre>def handler(ctxt, err):
+    global errno
+
+    #print "handler(%s, %s)" % (ctxt, err)
+    errno = err
+
+libvirt.registerErrorHandler(handler, 'context') </pre>
+    <p>the second argument to the registerErrorHandler function is passed as the
+first argument of the callback like in the C version. The error is a tuple
+containing the same field as a virError in C, but cast to Python.</p>
+  </body>
+</html>

docs/examples/.cvsignore

@@ -1,3 +1,4 @@
+*.exe
 .memdump
 Makefile.in
 Makefile

docs/examples/.gitignore

@@ -0,0 +1,8 @@
+*.exe
+.memdump
+Makefile.in
+Makefile
+.deps
+.libs
+info1
+suspend

docs/examples/info1.c

@@ -29,21 +29,21 @@ getDomainInfo(int id) {
     conn = virConnectOpenReadOnly(NULL);
     if (conn == NULL) {
         fprintf(stderr, "Failed to connect to hypervisor\n");
-	goto error;
+        goto error;
     }
 
     /* Find the domain of the given id */
     dom = virDomainLookupByID(conn, id);
     if (dom == NULL) {
         fprintf(stderr, "Failed to find Domain %d\n", id);
-	goto error;
+        goto error;
     }
 
     /* Get the information */
     ret = virDomainGetInfo(dom, &info);
     if (ret < 0) {
         fprintf(stderr, "Failed to get information for Domain %d\n", id);
-	goto error;
+        goto error;
     }
 
     printf("Domains %d: %d CPUs\n", id, info.nrVirtCpu);
@@ -52,7 +52,7 @@ error:
     if (dom != NULL)
         virDomainFree(dom);
     if (conn != NULL)
-	virConnectClose(conn);
+        virConnectClose(conn);
 }
 
 int main() {

docs/examples/suspend.c

@@ -30,7 +30,7 @@ checkDomainState(virDomainPtr dom) {
 
     ret = virDomainGetInfo(dom, &info);
     if (ret < 0) {
-	return(-1);
+        return(-1);
     }
     return(info.state);
 }
@@ -50,42 +50,42 @@ SuspendAndResumeDomain(int id) {
     dom = virDomainLookupByID(conn, id);
     if (dom == NULL) {
         fprintf(stderr, "Failed to find Domain %d\n", id);
-	goto error;
+        goto error;
     }
 
     /* Check state */
     state = checkDomainState(dom);
     if ((state == VIR_DOMAIN_RUNNING) ||
         (state == VIR_DOMAIN_NOSTATE) ||
-	(state == VIR_DOMAIN_BLOCKED)) {
-	printf("Suspending domain...\n");
-	ret = virDomainSuspend(dom);
-	if (ret < 0) {
-	    fprintf(stderr, "Failed to suspend Domain %d\n", id);
-	    goto error;
-	}
-	state = checkDomainState(dom);
-	if (state != VIR_DOMAIN_PAUSED) {
-	    fprintf(stderr, "Domain %d state is not suspended\n", id);
-	} else {
-	    printf("Domain suspended, resuming it...\n");
-	}
-	ret = virDomainResume(dom);
-	if (ret < 0) {
-	    fprintf(stderr, "Failed to resume Domain %d\n", id);
-	    goto error;
-	}
-	state = checkDomainState(dom);
-	if ((state == VIR_DOMAIN_RUNNING) ||
-	    (state == VIR_DOMAIN_NOSTATE) ||
-	    (state == VIR_DOMAIN_BLOCKED)) {
-	    printf("Domain resumed\n");
-	} else {
-	    fprintf(stderr, "Domain %d state indicate it is not resumed\n", id);
-	}
+        (state == VIR_DOMAIN_BLOCKED)) {
+        printf("Suspending domain...\n");
+        ret = virDomainSuspend(dom);
+        if (ret < 0) {
+            fprintf(stderr, "Failed to suspend Domain %d\n", id);
+            goto error;
+        }
+        state = checkDomainState(dom);
+        if (state != VIR_DOMAIN_PAUSED) {
+            fprintf(stderr, "Domain %d state is not suspended\n", id);
+        } else {
+            printf("Domain suspended, resuming it...\n");
+        }
+        ret = virDomainResume(dom);
+        if (ret < 0) {
+            fprintf(stderr, "Failed to resume Domain %d\n", id);
+            goto error;
+        }
+        state = checkDomainState(dom);
+        if ((state == VIR_DOMAIN_RUNNING) ||
+            (state == VIR_DOMAIN_NOSTATE) ||
+            (state == VIR_DOMAIN_BLOCKED)) {
+            printf("Domain resumed\n");
+        } else {
+            fprintf(stderr, "Domain %d state indicate it is not resumed\n", id);
+        }
     } else {
         fprintf(stderr, "Domain %d is not in a state where it should be suspended\n", id);
-	goto error;
+        goto error;
     }
 
 error:
@@ -100,7 +100,7 @@ int main(int argc, char **argv) {
     conn = virConnectOpenReadOnly(NULL);
     if (conn == NULL) {
         fprintf(stderr, "Failed to connect to hypervisor\n");
-	goto error;
+        goto error;
     }
 
     if (argc > 1) {
@@ -108,27 +108,27 @@ int main(int argc, char **argv) {
     }
     if (id == 0) {
         int i, j, ids[10];
-	i = virConnectListDomains(conn, &ids[0], 10);
-	if (i < 0) {
-	    fprintf(stderr, "Failed to list the domains\n");
-	    goto error;
-	}
-	for (j = 0;j < i;j++) {
-	    if (ids[j] != 0) {
-	        id = ids[j];
-		break;
-	    }
-	}
+        i = virConnectListDomains(conn, &ids[0], 10);
+        if (i < 0) {
+            fprintf(stderr, "Failed to list the domains\n");
+            goto error;
+        }
+        for (j = 0;j < i;j++) {
+            if (ids[j] != 0) {
+                id = ids[j];
+                break;
+            }
+        }
     }
     if (id == 0) {
-	fprintf(stderr, "Failed find a running guest domain\n");
-	goto error;
+        fprintf(stderr, "Failed find a running guest domain\n");
+        goto error;
     }
 
     SuspendAndResumeDomain(id);
 
 error:
     if (conn != NULL)
-	virConnectClose(conn);
+        virConnectClose(conn);
     return(0);
 }

docs/format.html

@@ -1,421 +1,124 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>XML Format</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">XML Format</h1><p>This section describes the XML format used to represent domains, there are
-variations on the format based on the kind of domains run and the options
-used to launch them:</p><ul><li><a href="#Normal1">Normal paravirtualized Xen domains</a></li>
-  <li><a href="#Fully1">Fully virtualized Xen domains</a></li>
-  <li><a href="#KVM1">KVM domains</a></li>
-  <li><a href="#Net1">Networking options for QEmu and KVM</a></li>
-  <li><a href="#QEmu1">QEmu domains</a></li>
-  <li><a href="#Capa1">Discovering virtualization capabilities</a></li>
-</ul><p>The formats try as much as possible to follow the same structure and reuse
-elements and attributes where it makes sense.</p><h3 id="Normal"><a name="Normal1" id="Normal1">Normal paravirtualized Xen
-guests</a>:</h3><p>The library use an XML format to describe domains, as input to <a href="html/libvirt-libvirt.html#virDomainCreateLinux">virDomainCreateLinux()</a>
-and as the output of <a href="html/libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc()</a>,
-the following is an example of the format as returned by the shell command
-<code>virsh xmldump fc4</code> , where fc4 was one of the running domains:</p><pre>&lt;domain type='xen' <span style="color: #0071FF; background-color: #FFFFFF">id='18'</span>&gt;
-  &lt;name&gt;fc4&lt;/name&gt;
-  <span style="color: #00B200; background-color: #FFFFFF">&lt;os&gt;
-    &lt;type&gt;linux&lt;/type&gt;
-    &lt;kernel&gt;/boot/vmlinuz-2.6.15-1.43_FC5guest&lt;/kernel&gt;
-    &lt;initrd&gt;/boot/initrd-2.6.15-1.43_FC5guest.img&lt;/initrd&gt;
-    &lt;root&gt;/dev/sda1&lt;/root&gt;
-    &lt;cmdline&gt; ro selinux=0 3&lt;/cmdline&gt;
-  &lt;/os&gt;</span>
-  &lt;memory&gt;131072&lt;/memory&gt;
-  &lt;vcpu&gt;1&lt;/vcpu&gt;
-  &lt;devices&gt;
-    <span style="color: #FF0080; background-color: #FFFFFF">&lt;disk type='file'&gt;
-      &lt;source file='/u/fc4.img'/&gt;
-      &lt;target dev='sda1'/&gt;
-    &lt;/disk&gt;</span>
-    <span style="color: #0000FF; background-color: #FFFFFF">&lt;interface type='bridge'&gt;
-      &lt;source bridge='xenbr0'/&gt;
-      &lt;mac address='</span><span style="color: #0000FF; background-color: #FFFFFF"></span><span style="color: #0000FF; background-color: #FFFFFF">aa:00:00:00:00:11'/&gt;
-      &lt;script path='/etc/xen/scripts/vif-bridge'/&gt;
-    &lt;/interface&gt;</span>
-    <span style="color: #FF8000; background-color: #FFFFFF">&lt;console tty='/dev/pts/5'/&gt;</span>
-  &lt;/devices&gt;
-&lt;/domain&gt;</pre><p>The root element must be called <code>domain</code> with no namespace, the
-<code>type</code> attribute indicates the kind of hypervisor used, 'xen' is
-the default value. The <code>id</code> attribute gives the domain id at
-runtime (not however that this may change, for example if the domain is saved
-to disk and restored). The domain has a few children whose order is not
-significant:</p><ul><li>name: the domain name, preferably ASCII based</li>
-  <li>memory: the maximum memory allocated to the domain in kilobytes</li>
-  <li>vcpu: the number of virtual cpu configured for the domain</li>
-  <li>os: a block describing the Operating System, its content will be
-    dependent on the OS type
-    <ul><li>type: indicate the OS type, always linux at this point</li>
-      <li>kernel: path to the kernel on the Domain 0 filesystem</li>
-      <li>initrd: an optional path for the init ramdisk on the Domain 0
-        filesystem</li>
-      <li>cmdline: optional command line to the kernel</li>
-      <li>root: the root filesystem from the guest viewpoint, it may be
-        passed as part of the cmdline content too</li>
-    </ul></li>
-  <li>devices: a list of <code>disk</code>, <code>interface</code> and
-    <code>console</code> descriptions in no special order</li>
-</ul><p>The format of the devices and their type may grow over time, but the
-following should be sufficient for basic use:</p><p>A <code>disk</code> device indicates a block device, it can have two
-values for the type attribute either 'file' or 'block' corresponding to the 2
-options available at the Xen layer. It has two mandatory children, and one
-optional one in no specific order:</p><ul><li>source with a file attribute containing the path in Domain 0 to the
-    file or a dev attribute if using a block device, containing the device
-    name ('hda5' or '/dev/hda5')</li>
-  <li>target indicates in a dev attribute the device where it is mapped in
-    the guest</li>
-  <li>readonly an optional empty element indicating the device is
-  read-only</li>
-  <li>shareable an optional empty element indicating the device
-  can be used read/write with other domains</li>
-</ul><p>An <code>interface</code> element describes a network device mapped on the
-guest, it also has a type whose value is currently 'bridge', it also have a
-number of children in no specific order:</p><ul><li>source: indicating the bridge name</li>
-  <li>mac: the optional mac address provided in the address attribute</li>
-  <li>ip: the optional IP address provided in the address attribute</li>
-  <li>script: the script used to bridge the interface in the Domain 0</li>
-  <li>target: and optional target indicating the device name.</li>
-</ul><p>A <code>console</code> element describes a serial console connection to
-the guest. It has no children, and a single attribute <code>tty</code> which
-provides the path to the Pseudo TTY on which the guest console can be
-accessed</p><p>Life cycle actions for the domain can also be expressed in the XML format,
-they drive what should be happening if the domain crashes, is rebooted or is
-poweroff. There is various actions possible when this happen:</p><ul><li>destroy: The domain is cleaned up (that's the default normal processing
-    in Xen)</li>
-  <li>restart: A new domain is started in place of the old one with the same
-    configuration parameters</li>
-  <li>preserve: The domain will remain in memory until it is destroyed
-    manually, it won't be running but allows for post-mortem debugging</li>
-  <li>rename-restart: a variant of the previous one but where the old domain
-    is renamed before being saved to allow a restart</li>
-</ul><p>The following could be used for a Xen production system:</p><pre>&lt;domain&gt;
-  ...
-  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
-  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
-  &lt;on_crash&gt;rename-restart&lt;/on_crash&gt;
-  ...
-&lt;/domain&gt;</pre><p>While the format may be extended in various ways as support for more
-hypervisor types and features are added, it is expected that this core subset
-will remain functional in spite of the evolution of the library.</p><h3 id="Fully"><a name="Fully1" id="Fully1">Fully virtualized guests</a>
-(added in 0.1.3):</h3><p>Here is an example of a domain description used to start a fully
-virtualized (a.k.a. HVM) Xen domain. This requires hardware virtualization
-support at the processor level but allows to run unmodified operating
-systems:</p><pre>&lt;domain type='xen' id='3'&gt;
-  &lt;name&gt;fv0&lt;/name&gt;
-  &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
-  &lt;os&gt;
-    <span style="color: #0000E5; background-color: #FFFFFF">&lt;type&gt;hvm&lt;/type&gt;</span>
-    <span style="color: #0000E5; background-color: #FFFFFF">&lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;</span>
-    <span style="color: #0000E5; background-color: #FFFFFF">&lt;boot dev='hd'/&gt;</span>
-  &lt;/os&gt;
-  &lt;memory&gt;524288&lt;/memory&gt;
-  &lt;vcpu&gt;1&lt;/vcpu&gt;
-  &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
-  &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
-  &lt;on_crash&gt;restart&lt;/on_crash&gt;
-  &lt;features&gt;
-     <span style="color: #E50000; background-color: #FFFFFF">&lt;pae/&gt;
-     &lt;acpi/&gt;
-     &lt;apic/&gt;</span>
-  &lt;/features&gt;
-  <span style="color: #0000E5; background-color: #FFFFFF">&lt;clock sync="localtime"/&gt;</span>
-  &lt;devices&gt;
-    <span style="color: #0000E5; background-color: #FFFFFF">&lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;</span>
-    &lt;interface type='bridge'&gt;
-      &lt;source bridge='xenbr0'/&gt;
-      &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
-      &lt;script path='vif-bridge'/&gt;
-    &lt;/interface&gt;
-    &lt;disk type='file'&gt;
-      &lt;source file='/root/fv0'/&gt;
-      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='hda'</span>/&gt;
-    &lt;/disk&gt;
-    &lt;disk type='file' <span style="color: #0000E5; background-color: #FFFFFF">device='cdrom'</span>&gt;
-      &lt;source file='/root/fc5-x86_64-boot.iso'/&gt;
-      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='hdc'</span>/&gt;
-      &lt;readonly/&gt;
-    &lt;/disk&gt;
-    &lt;disk type='file' <span style="color: #0000E5; background-color: #FFFFFF">device='floppy'</span>&gt;
-      &lt;source file='/root/fd.img'/&gt;
-      &lt;target <span style="color: #0000E5; background-color: #FFFFFF">dev='fda'</span>/&gt;
-    &lt;/disk&gt;
-    <span style="color: #0000E5; background-color: #FFFFFF">&lt;graphics type='vnc' port='5904'/&gt;</span>
-  &lt;/devices&gt;
-&lt;/domain&gt;</pre><p>There is a few things to notice specifically for HVM domains:</p><ul><li>the optional <code>&lt;features&gt;</code> block is used to enable
-    certain guest CPU / system features. For HVM guests the following
-    features are defined:
-    <ul><li><code>pae</code> - enable PAE memory addressing</li>
-      <li><code>apic</code> - enable IO APIC</li>
-      <li><code>acpi</code> - enable ACPI bios</li>
-    </ul></li>
-  <li>the optional <code>&lt;clock&gt;</code> element is used to specify
-     whether the emulated BIOS clock in the guest is synced to either
-     <code>localtime</code> or <code>utc</code>. In general Windows will
-     want <code>localtime</code> while all other operating systems will
-     want <code>utc</code>. The default is thus <code>utc</code></li>
-  <li>the <code>&lt;os&gt;</code> block description is very different, first
-    it indicates that the type is 'hvm' for hardware virtualization, then
-    instead of a kernel, boot and command line arguments, it points to an os
-    boot loader which will extract the boot information from the boot device
-    specified in a separate boot element. The <code>dev</code> attribute on
-    the <code>boot</code> tag can be one of:
-    <ul><li><code>fd</code> - boot from first floppy device</li>
-      <li><code>hd</code> - boot from first harddisk device</li>
-      <li><code>cdrom</code> - boot from first cdrom device</li>
-    </ul></li>
-  <li>the <code>&lt;devices&gt;</code> section includes an emulator entry
-    pointing to an additional program in charge of emulating the devices</li>
-  <li>the disk entry indicates in the dev target section that the emulation
-    for the drive is the first IDE disk device hda. The list of device names
-    supported is dependent on the Hypervisor, but for Xen it can be any IDE
-    device <code>hda</code>-<code>hdd</code>, or a floppy device
-    <code>fda</code>, <code>fdb</code>. The <code>&lt;disk&gt;</code> element
-    also supports a 'device' attribute to indicate what kinda of hardware to
-    emulate. The following values are supported:
-    <ul><li><code>floppy</code> - a floppy disk controller</li>
-      <li><code>disk</code> - a generic hard drive (the default it
-      omitted)</li>
-      <li><code>cdrom</code> - a CDROM device</li>
-    </ul>
-    For Xen 3.0.2 and earlier a CDROM device can only be emulated on the
-    <code>hdc</code> channel, while for 3.0.3 and later, it can be emulated
-    on any IDE channel.</li>
-  <li>the <code>&lt;devices&gt;</code> section also include at least one
-    entry for the graphic device used to render the os. Currently there is
-    just 2 types possible 'vnc' or 'sdl'. If the type is 'vnc', then an
-    additional <code>port</code> attribute will be present indicating the TCP
-    port on which the VNC server is accepting client connections.</li>
-</ul><p>It is likely that the HVM description gets additional optional elements
-and attributes as the support for fully virtualized domain expands,
-especially for the variety of devices emulated and the graphic support
-options offered.</p><h3><a name="KVM1" id="KVM1">KVM domain (added in 0.2.0)</a></h3><p>Support for the <a href="http://kvm.qumranet.com/">KVM virtualization</a>
-is provided in recent Linux kernels (2.6.20 and onward). This requires
-specific hardware with acceleration support and the availability of the
-special version of the <a href="http://fabrice.bellard.free.fr/qemu/">QEmu</a> binary. Since this
-relies on QEmu for the machine emulation like fully virtualized guests the
-XML description is quite similar, here is a simple example:</p><pre>&lt;domain <span style="color: #FF0000; background-color: #FFFFFF">type='kvm'</span>&gt;
-  &lt;name&gt;demo2&lt;/name&gt;
-  &lt;uuid&gt;4dea24b3-1d52-d8f3-2516-782e98a23fa0&lt;/uuid&gt;
-  &lt;memory&gt;131072&lt;/memory&gt;
-  &lt;vcpu&gt;1&lt;/vcpu&gt;
-  &lt;os&gt;
-    &lt;type&gt;hvm&lt;/type&gt;
-  &lt;/os&gt;
-  <span style="color: #0000E5; background-color: #FFFFFF">&lt;clock sync="localtime"/&gt;</span>
-  &lt;devices&gt;
-    <span style="color: #FF0000; background-color: #FFFFFF">&lt;emulator&gt;/home/user/usr/kvm-devel/bin/qemu-system-x86_64&lt;/emulator&gt;</span>
-    &lt;disk type='file' device='disk'&gt;
-      &lt;source file='/home/user/fedora/diskboot.img'/&gt;
-      &lt;target dev='hda'/&gt;
-    &lt;/disk&gt;
-    &lt;interface <span style="color: #FF0000; background-color: #FFFFFF">type='user'</span>&gt;
-      &lt;mac address='24:42:53:21:52:45'/&gt;
-    &lt;/interface&gt;
-    &lt;graphics type='vnc' port='-1'/&gt;
-  &lt;/devices&gt;
-&lt;/domain&gt;</pre><p>The specific points to note if using KVM are:</p><ul><li>the top level domain element carries a type of 'kvm'</li>
-  <li>the &lt;clock&gt; optional is supported as with Xen HVM</li>
-  <li>the &lt;devices&gt; emulator points to the special qemu binary required
-    for KVM</li>
-  <li>networking interface definitions definitions are somewhat different due
-    to a different model from Xen see below</li>
-</ul><p>except those points the options should be quite similar to Xen HVM
-ones.</p><h3><a name="Net1" id="Net1">Networking options for QEmu and KVM (added in 0.2.0)</a></h3><p>The networking support in the QEmu and KVM case is more flexible, and
-support a variety of options:</p><ol><li>Userspace SLIRP stack
-    <p>Provides a virtual LAN with NAT to the outside world. The virtual
-    network has DHCP &amp; DNS services and will give the guest VM addresses
-    starting from <code>10.0.2.15</code>. The default router will be
-    <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
-    This networking is the only option for unprivileged users who need their
-    VMs to have outgoing access. Example configs are:</p>
-    <pre>&lt;interface type='user'/&gt;</pre>
-    <pre>
-&lt;interface type='user'&gt;
-  &lt;mac address="11:22:33:44:55:66"/&gt;
-&lt;/interface&gt;
-    </pre>
-  </li>
-  <li>Virtual network
-    <p>Provides a virtual network using a bridge device in the host.
-    Depending on the virtual network configuration, the network may be
-    totally isolated, NAT'ing to an explicit network device, or NAT'ing to
-    the default route. DHCP and DNS are provided on the virtual network in
-    all cases and the IP range can be determined by examining the virtual
-    network config with '<code>virsh net-dumpxml &lt;network
-    name&gt;</code>'. There is one virtual network called 'default' setup out
-    of the box which does NAT'ing to the default route and has an IP range of
-    <code>192.168.22.0/255.255.255.0</code>. Each guest will have an
-    associated tun device created with a name of vnetN, which can also be
-    overridden with the &lt;target&gt; element. Example configs are:</p>
-    <pre>&lt;interface type='network'&gt;
-  &lt;source network='default'/&gt;
-&lt;/interface&gt;
-
-&lt;interface type='network'&gt;
-  &lt;source network='default'/&gt;
-  &lt;target dev='vnet7'/&gt;
-  &lt;mac address="11:22:33:44:55:66"/&gt;
-&lt;/interface&gt;
-    </pre>
-  </li>
-  <li>Bridge to to LAN
-    <p>Provides a bridge from the VM directly onto the LAN. This assumes
-    there is a bridge device on the host which has one or more of the hosts
-    physical NICs enslaved. The guest VM will have an associated tun device
-    created with a name of vnetN, which can also be overridden with the
-    &lt;target&gt; element. The tun device will be enslaved to the bridge.
-    The IP range / network configuration is whatever is used on the LAN. This
-    provides the guest VM full incoming &amp; outgoing net access just like a
-    physical machine. Examples include:</p>
-    <pre>&lt;interface type='bridge'&gt;
- &lt;source bridge='br0'/&gt;
-&lt;/interface&gt;
-
-&lt;interface type='bridge'&gt;
-  &lt;source bridge='br0'/&gt;
-  &lt;target dev='vnet7'/&gt;
-  &lt;mac address="11:22:33:44:55:66"/&gt;
-&lt;/interface&gt;</pre>
-  </li>
-  <li>Generic connection to LAN
-    <p>Provides a means for the administrator to execute an arbitrary script
-    to connect the guest's network to the LAN. The guest will have a tun
-    device created with a name of vnetN, which can also be overridden with the
-    &lt;target&gt; element. After creating the tun device a shell script will
-    be run which is expected to do whatever host network integration is
-    required. By default this script is called /etc/qemu-ifup but can be
-    overridden.</p>
-    <pre>&lt;interface type='ethernet'/&gt;
-
-&lt;interface type='ethernet'&gt;
-  &lt;target dev='vnet7'/&gt;
-  &lt;script path='/etc/qemu-ifup-mynet'/&gt;
-&lt;/interface&gt;</pre>
-  </li>
-  <li>Multicast tunnel
-    <p>A multicast group is setup to represent a virtual network. Any VMs
-    whose network devices are in the same multicast group can talk to each
-    other even across hosts. This mode is also available to unprivileged
-    users. There is no default DNS or DHCP support and no outgoing network
-    access. To provide outgoing network access, one of the VMs should have a
-    2nd NIC which is connected to one of the first 4 network types and do the
-    appropriate routing. The multicast protocol is compatible with that used
-    by user mode linux guests too. The source address used must be from the
-    multicast address block.</p>
-    <pre>&lt;interface type='mcast'&gt;
-  &lt;source address='230.0.0.1' port='5558'/&gt;
-&lt;/interface&gt;</pre>
-  </li>
-  <li>TCP tunnel
-    <p>A TCP client/server architecture provides a virtual network. One VM
-    provides the server end of the network, all other VMS are configured as
-    clients. All network traffic is routed between the VMs via the server.
-    This mode is also available to unprivileged users. There is no default
-    DNS or DHCP support and no outgoing network access. To provide outgoing
-    network access, one of the VMs should have a 2nd NIC which is connected
-    to one of the first 4 network types and do the appropriate routing.</p>
-    <p>Example server config:</p>
-    <pre>&lt;interface type='server'&gt;
-  &lt;source address='192.168.0.1' port='5558'/&gt;
-&lt;/interface&gt;</pre>
-    <p>Example client config:</p>
-    <pre>&lt;interface type='client'&gt;
-  &lt;source address='192.168.0.1' port='5558'/&gt;
-&lt;/interface&gt;</pre>
-  </li>
-</ol><p>To be noted, options 2, 3, 4 are also supported by Xen VMs, so it is
-possible to use these configs to have networking with both Xen &amp;
-QEMU/KVMs connected to each other.</p><h3>Q<a name="QEmu1" id="QEmu1">Emu domain (added in 0.2.0)</a></h3><p>Libvirt support for KVM and QEmu is the same code base with only minor
-changes. The configuration is as a result nearly identical, the only changes
-are related to QEmu ability to emulate <a href="http://www.qemu.org/status.html">various CPU type and hardware
-platforms</a>, and kqemu support (QEmu own kernel accelerator when the
-emulated CPU is i686 as well as the target machine):</p><pre>&lt;domain <span style="color: #FF0000; background-color: #FFFFFF">type='qemu'</span>&gt;
-  &lt;name&gt;QEmu-fedora-i686&lt;/name&gt;
-  &lt;uuid&gt;c7a5fdbd-cdaf-9455-926a-d65c16db1809&lt;/uuid&gt;
-  &lt;memory&gt;219200&lt;/memory&gt;
-  &lt;currentMemory&gt;219200&lt;/currentMemory&gt;
-  &lt;vcpu&gt;2&lt;/vcpu&gt;
-  &lt;os&gt;
-    <span style="color: #FF0000; background-color: #FFFFFF">&lt;type arch='i686' machine='pc'&gt;hvm&lt;/type&gt;</span>
-    &lt;boot dev='cdrom'/&gt;
-  &lt;/os&gt;
-  &lt;devices&gt;
-    <span style="color: #FF0000; background-color: #FFFFFF">&lt;emulator&gt;/usr/bin/qemu&lt;/emulator&gt;</span>
-    &lt;disk type='file' device='cdrom'&gt;
-      &lt;source file='/home/user/boot.iso'/&gt;
-      &lt;target dev='hdc'/&gt;
-      &lt;readonly/&gt;
-    &lt;/disk&gt;
-    &lt;disk type='file' device='disk'&gt;
-      &lt;source file='/home/user/fedora.img'/&gt;
-      &lt;target dev='hda'/&gt;
-    &lt;/disk&gt;
-    &lt;interface type='network'&gt;
-      &lt;source name='default'/&gt;
-    &lt;/interface&gt;
-    &lt;graphics type='vnc' port='-1'/&gt;
-  &lt;/devices&gt;
-&lt;/domain&gt;</pre><p>The difference here are:</p><ul><li>the value of type on top-level domain, it's 'qemu' or kqemu if asking
-    for <a href="http://www.qemu.org/kqemu-tech.html">kernel assisted
-    acceleration</a></li>
-  <li>the os type block defines the architecture to be emulated, and
-    optionally the machine type, see the discovery API below</li>
-  <li>the emulator string must point to the right emulator for that
-    architecture</li>
-</ul><h3><a name="Capa1" id="Capa1">Discovering virtualization capabilities (Added in 0.2.1)</a></h3><p>As new virtualization engine support gets added to libvirt, and to handle
-cases like QEmu supporting a variety of emulations, a query interface has
-been added in 0.2.1 allowing to list the set of supported virtualization
-capabilities on the host:</p><pre>    char * virConnectGetCapabilities (virConnectPtr conn);</pre><p>The value returned is an XML document listing the virtualization
-capabilities of the host and virtualization engine to which
-<code>@conn</code> is connected. One can test it using <code>virsh</code>
-command line tool command '<code>capabilities</code>', it dumps the XML
-associated to the current connection. For example in the case of a 64 bits
-machine with hardware virtualization capabilities enabled in the chip and
-BIOS you will see</p><pre>&lt;capabilities&gt;
-  <span style="color: #E50000; background-color: #FFFFFF">&lt;host&gt;
-    &lt;cpu&gt;
-      &lt;arch&gt;x86_64&lt;/arch&gt;
-      &lt;features&gt;
-        &lt;vmx/&gt;
-      &lt;/features&gt;
-    &lt;/cpu&gt;
-  &lt;/host&gt;</span>
-
-  &lt;!-- xen-3.0-x86_64 --&gt;
-  <span style="color: #0000E5; background-color: #FFFFFF">&lt;guest&gt;
-    &lt;os_type&gt;xen&lt;/os_type&gt;
-    &lt;arch name="x86_64"&gt;
-      &lt;wordsize&gt;64&lt;/wordsize&gt;
-      &lt;domain type="xen"&gt;&lt;/domain&gt;
-      &lt;emulator&gt;/usr/lib64/xen/bin/qemu-dm&lt;/emulator&gt;
-    &lt;/arch&gt;
-    &lt;features&gt;
-    &lt;/features&gt;
-  &lt;/guest&gt;</span>
-
-  &lt;!-- hvm-3.0-x86_32 --&gt;
-  <span style="color: #00B200; background-color: #FFFFFF">&lt;guest&gt;
-    &lt;os_type&gt;hvm&lt;/os_type&gt;
-    &lt;arch name="i686"&gt;
-      &lt;wordsize&gt;32&lt;/wordsize&gt;
-      &lt;domain type="xen"&gt;&lt;/domain&gt;
-      &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
-      &lt;machine&gt;pc&lt;/machine&gt;
-      &lt;machine&gt;isapc&lt;/machine&gt;
-      &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
-    &lt;/arch&gt;
-    &lt;features&gt;
-    &lt;/features&gt;
-  &lt;/guest&gt;</span>
-  ...
-&lt;/capabilities&gt;</pre><p>The first block (in red) indicates the host hardware capabilities, currently
-it is limited to the CPU properties but other information may be available,
-it shows the CPU architecture, and the features of the chip (the feature
-block is similar to what you will find in a Xen fully virtualized domain
-description).</p><p>The second block (in blue) indicates the paravirtualization support of the
-Xen support, you will see the os_type of xen to indicate a paravirtual
-kernel, then architecture information and potential features.</p><p>The third block (in green) gives similar information but when running a
-32 bit OS fully virtualized with Xen using the hvm support.</p><p>This section is likely to be updated and augmented in the future, see <a href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the
-discussion</a> which led to the capabilities format in the mailing-list
-archives.</p></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="index.html">Home</a></li><li><a href="news.html">Releases</a></li><li><a href="intro.html">Introduction</a></li><li><a href="architecture.html">libvirt architecture</a></li><li><a href="downloads.html">Downloads</a></li><li><a href="format.html">XML Format</a></li><li><a href="python.html">Bindings for other languages</a></li><li><a href="errors.html">Handling of errors</a></li><li><a href="FAQ.html">FAQ</a></li><li><a href="bugs.html">Reporting bugs and getting help</a></li><li><a href="windows.html">Windows support</a></li><li><a href="remote.html">Remote support</a></li><li><a href="auth.html">Access control</a></li><li><a href="uri.html">Connection URIs</a></li><li><a href="hvsupport.html">Hypervisor support</a></li><li><a href="storage.html">Storage Management</a></li><li><a href="html/index.html">API Menu</a></li><li><a href="examples/index.html">C code examples</a></li><li><a href="ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from format.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: XML Format</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <span class="active">XML format</span>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>XML Format</h1>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/format.html.in

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <body>
+    <h1 >XML Format</h1>
+
+
+
+  </body>
+</html>

docs/formatcaps.html

@@ -0,0 +1,187 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from formatcaps.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Driver capabilities XML format</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="active" href="format.html">XML format</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Capabilities</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Driver capabilities XML format</h1>
+        <p>As new virtualization engine support gets added to libvirt, and to handle
+cases like QEmu supporting a variety of emulations, a query interface has
+been added in 0.2.1 allowing to list the set of supported virtualization
+capabilities on the host:</p>
+        <pre>    char * virConnectGetCapabilities (virConnectPtr conn);</pre>
+        <p>The value returned is an XML document listing the virtualization
+capabilities of the host and virtualization engine to which
+<code>@conn</code> is connected. One can test it using <code>virsh</code>
+command line tool command '<code>capabilities</code>', it dumps the XML
+associated to the current connection. For example in the case of a 64 bits
+machine with hardware virtualization capabilities enabled in the chip and
+BIOS you will see</p>
+        <pre>&lt;capabilities&gt;
+  <span style="color: #E50000">&lt;host&gt;
+    &lt;cpu&gt;
+      &lt;arch&gt;x86_64&lt;/arch&gt;
+      &lt;features&gt;
+        &lt;vmx/&gt;
+      &lt;/features&gt;
+    &lt;/cpu&gt;
+  &lt;/host&gt;</span>
+
+  &lt;!-- xen-3.0-x86_64 --&gt;
+  <span style="color: #0000E5">&lt;guest&gt;
+    &lt;os_type&gt;xen&lt;/os_type&gt;
+    &lt;arch name="x86_64"&gt;
+      &lt;wordsize&gt;64&lt;/wordsize&gt;
+      &lt;domain type="xen"&gt;&lt;/domain&gt;
+      &lt;emulator&gt;/usr/lib64/xen/bin/qemu-dm&lt;/emulator&gt;
+    &lt;/arch&gt;
+    &lt;features&gt;
+    &lt;/features&gt;
+  &lt;/guest&gt;</span>
+
+  &lt;!-- hvm-3.0-x86_32 --&gt;
+  <span style="color: #00B200">&lt;guest&gt;
+    &lt;os_type&gt;hvm&lt;/os_type&gt;
+    &lt;arch name="i686"&gt;
+      &lt;wordsize&gt;32&lt;/wordsize&gt;
+      &lt;domain type="xen"&gt;&lt;/domain&gt;
+      &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
+      &lt;machine&gt;pc&lt;/machine&gt;
+      &lt;machine&gt;isapc&lt;/machine&gt;
+      &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
+    &lt;/arch&gt;
+    &lt;features&gt;
+    &lt;/features&gt;
+  &lt;/guest&gt;</span>
+  ...
+&lt;/capabilities&gt;</pre>
+        <p>The first block (in red) indicates the host hardware capabilities, currently
+it is limited to the CPU properties but other information may be available,
+it shows the CPU architecture, and the features of the chip (the feature
+block is similar to what you will find in a Xen fully virtualized domain
+description).</p>
+        <p>The second block (in blue) indicates the paravirtualization support of the
+Xen support, you will see the os_type of xen to indicate a paravirtual
+kernel, then architecture information and potential features.</p>
+        <p>The third block (in green) gives similar information but when running a
+32 bit OS fully virtualized with Xen using the hvm support.</p>
+        <p>This section is likely to be updated and augmented in the future, see <a href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the
+discussion</a> which led to the capabilities format in the mailing-list
+archives.</p>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/formatcaps.html.in

@@ -0,0 +1,70 @@
+<html>
+  <body>
+    <h1>Driver capabilities XML format</h1>
+
+        <p>As new virtualization engine support gets added to libvirt, and to handle
+cases like QEmu supporting a variety of emulations, a query interface has
+been added in 0.2.1 allowing to list the set of supported virtualization
+capabilities on the host:</p>
+        <pre>    char * virConnectGetCapabilities (virConnectPtr conn);</pre>
+        <p>The value returned is an XML document listing the virtualization
+capabilities of the host and virtualization engine to which
+<code>@conn</code> is connected. One can test it using <code>virsh</code>
+command line tool command '<code>capabilities</code>', it dumps the XML
+associated to the current connection. For example in the case of a 64 bits
+machine with hardware virtualization capabilities enabled in the chip and
+BIOS you will see</p>
+        <pre>&lt;capabilities&gt;
+  <span style="color: #E50000">&lt;host&gt;
+    &lt;cpu&gt;
+      &lt;arch&gt;x86_64&lt;/arch&gt;
+      &lt;features&gt;
+        &lt;vmx/&gt;
+      &lt;/features&gt;
+    &lt;/cpu&gt;
+  &lt;/host&gt;</span>
+
+  &lt;!-- xen-3.0-x86_64 --&gt;
+  <span style="color: #0000E5">&lt;guest&gt;
+    &lt;os_type&gt;xen&lt;/os_type&gt;
+    &lt;arch name="x86_64"&gt;
+      &lt;wordsize&gt;64&lt;/wordsize&gt;
+      &lt;domain type="xen"&gt;&lt;/domain&gt;
+      &lt;emulator&gt;/usr/lib64/xen/bin/qemu-dm&lt;/emulator&gt;
+    &lt;/arch&gt;
+    &lt;features&gt;
+    &lt;/features&gt;
+  &lt;/guest&gt;</span>
+
+  &lt;!-- hvm-3.0-x86_32 --&gt;
+  <span style="color: #00B200">&lt;guest&gt;
+    &lt;os_type&gt;hvm&lt;/os_type&gt;
+    &lt;arch name="i686"&gt;
+      &lt;wordsize&gt;32&lt;/wordsize&gt;
+      &lt;domain type="xen"&gt;&lt;/domain&gt;
+      &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
+      &lt;machine&gt;pc&lt;/machine&gt;
+      &lt;machine&gt;isapc&lt;/machine&gt;
+      &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
+    &lt;/arch&gt;
+    &lt;features&gt;
+    &lt;/features&gt;
+  &lt;/guest&gt;</span>
+  ...
+&lt;/capabilities&gt;</pre>
+        <p>The first block (in red) indicates the host hardware capabilities, currently
+it is limited to the CPU properties but other information may be available,
+it shows the CPU architecture, and the features of the chip (the feature
+block is similar to what you will find in a Xen fully virtualized domain
+description).</p>
+        <p>The second block (in blue) indicates the paravirtualization support of the
+Xen support, you will see the os_type of xen to indicate a paravirtual
+kernel, then architecture information and potential features.</p>
+        <p>The third block (in green) gives similar information but when running a
+32 bit OS fully virtualized with Xen using the hvm support.</p>
+        <p>This section is likely to be updated and augmented in the future, see <a href="https://www.redhat.com/archives/libvir-list/2007-March/msg00215.html">the
+discussion</a> which led to the capabilities format in the mailing-list
+archives.</p>
+
+  </body>
+</html>

docs/formatdomain.html

@@ -0,0 +1,907 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from formatdomain.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Domain XML format</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="active" href="format.html">XML format</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <span class="active">Domains</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Domain XML format</h1>
+        <ul><li>
+            <a href="#elements">Element and attribute overview</a>
+            <ul><li>
+                <a href="#elementsMetadata">General metadata</a>
+              </li><li>
+                <a href="#elementsOS">Operating system booting</a>
+                <ul><li>
+                    <a href="#elementsOSBIOS">BIOS bootloader</a>
+                  </li><li>
+                    <a href="#elementsOSBootloader">Host bootloader</a>
+                  </li><li>
+                    <a href="#elementsOSKernel">Direct kernel boot</a>
+                  </li></ul>
+              </li><li>
+                <a href="#elementsResources">Basic resources</a>
+              </li><li>
+                <a href="#elementsLifecycle">Lifecycle control</a>
+              </li><li>
+                <a href="#elementsFeatures">Hypervisor features</a>
+              </li><li>
+                <a href="#elementsTime">Time keeping</a>
+              </li><li>
+                <a href="#elementsDevices">Devices</a>
+                <ul><li>
+                    <a href="#elementsDisks">Hard drives, floppy disks, CDROMs</a>
+                  </li><li>
+                    <a href="#elementsUSB">USB devices</a>
+                  </li><li>
+                    <a href="#elementsNICS">Network interfaces</a>
+                    <ul><li>
+                        <a href="#elementsNICSVirtual">Virtual network</a>
+                      </li><li>
+                        <a href="#elementsNICSBridge">Bridge to to LAN</a>
+                      </li><li>
+                        <a href="#elementsNICSSlirp">Userspace SLIRP stack</a>
+                      </li><li>
+                        <a href="#elementsNICSEthernet">Generic ethernet connection</a>
+                      </li><li>
+                        <a href="#elementsNICSMulticast">Multicast tunnel</a>
+                      </li><li>
+                        <a href="#elementsNICSTCP">TCP tunnel</a>
+                      </li><li>
+                        <a href="#elementsNICSModel">Setting the NIC model</a>
+                      </li></ul>
+                  </li><li>
+                    <a href="#elementsInput">Input devices</a>
+                  </li><li>
+                    <a href="#elementsGraphics">Graphical framebuffers</a>
+                  </li><li>
+                    <a href="#elementsConsole">Consoles, serial &amp; parallel devices</a>
+                    <ul><li>
+                        <a href="#elementsCharSTDIO">Domain logfile</a>
+                      </li><li>
+                        <a href="#elementsCharFle">Device logfile</a>
+                      </li><li>
+                        <a href="#elementsCharVC">Virtual console</a>
+                      </li><li>
+                        <a href="#elementsCharNull">Null device</a>
+                      </li><li>
+                        <a href="#elementsCharPTY">Pseudo TTY</a>
+                      </li><li>
+                        <a href="#elementsCharHost">Host device proxy</a>
+                      </li><li>
+                        <a href="#elementsCharTCP">TCP client/server</a>
+                      </li><li>
+                        <a href="#elementsCharUDP">UDP network console</a>
+                      </li><li>
+                        <a href="#elementsCharUNIX">UNIX domain socket client/server</a>
+                      </li></ul>
+                  </li></ul>
+              </li></ul>
+          </li><li>
+            <a href="#examples">Example configs</a>
+          </li></ul>
+        <p>
+      This section describes the XML format used to represent domains, there are
+      variations on the format based on the kind of domains run and the options
+      used to launch them. For hypervisor specific details consult the
+      <a href="drivers.html">driver docs</a>
+    </p>
+        <h2>
+          <a name="elements" id="elements">Element and attribute overview</a>
+        </h2>
+        <p>
+      The root element required for all virtual machines is
+      named <code>domain</code>. It has two attributes, the
+      <code>type</code> specifies the hypervisor used for running
+      the domain. The allowed values are driver specific, but
+      include "xen", "kvm", "qemu", "lxc" and "kqemu". The
+      second attribute is <code>id</code> which is a unique
+      integer identifier for the running guest machine. Inactive
+      machines have no id value.
+    </p>
+        <h3>
+          <a name="elementsMetadata" id="elementsMetadata">General metadata</a>
+        </h3>
+        <pre>
+      &lt;domain type='xen' id='3'&gt;
+        &lt;name&gt;fv0&lt;/name&gt;
+        &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
+        ...</pre>
+        <dl><dt><code>name</code></dt><dd>The content of the <code>name</code> element provides
+	a short name for the virtual machine. This name should
+	consist only of alpha-numeric characters and is required
+	to be unique within the scope of a single host. It is
+	often used to form the filename for storing the persistent
+	configuration file. <span class="since">Since 0.0.1</span></dd><dt><code>uuid</code></dt><dd>The content of the <code>uuid</code> element provides
+	a globally unique identifier for the virtual machine.
+	The format must be RFC 4122 compliant, eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
+	If omitted when defining/creating a new machine, a random
+	UUID is generated. <span class="since">Since 0.0.1</span></dd></dl>
+        <h3>
+          <a name="elementsOS" id="elementsOS">Operating system booting</a>
+        </h3>
+        <p>
+      There are a number of different ways to boot virtual machines
+      each with their own pros and cons.
+    </p>
+        <h4>
+          <a name="elementsOSBIOS" id="elementsOSBIOS">BIOS bootloader</a>
+        </h4>
+        <p>
+      Booting via the BIOS is available for hypervisors supporting
+      full virtualization. In this case the BIOS has a boot order
+      priority (floppy, harddisk, cdrom, network) determining where
+      to obtain/find the boot image.
+    </p>
+        <pre>
+        ...
+        &lt;os&gt;
+          &lt;type&gt;hvm&lt;/type&gt;
+          &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
+          &lt;boot dev='hd'/&gt;
+        &lt;/os&gt;
+        ...</pre>
+        <dl><dt><code>type</code></dt><dd>The content of the <code>type</code> element specifies the
+	type of operating system to be booted in the virtual machine.
+	<code>hvm</code> indicates that the OS is one designed to run
+	on bare metal, so requires full virtualization. <code>linux</code>
+	(badly named!) refers to an OS that supports the Xen 3 hypervisor
+	guest ABI. There are also two optional attributes, <code>arch</code>
+	specifying the CPU architecture to virtualization, and <code>machine</code>
+	referring to the machine type. The <a href="formatcaps.html">Capabilities XML</a>
+	provides details on allowed values for these. <span class="since">Since 0.0.1</span></dd><dt><code>loader</code></dt><dd>The optional <code>loader</code> tag refers to a firmware blob
+	used to assist the domain creation process. At this time, it is
+	only needed by Xen fully virtualized domains. <span class="since">Since 0.1.0</span></dd><dt><code>boot</code></dt><dd>The <code>dev</code> attribute takes one of the values "fd", "hd",
+	"cdrom" or "network" and is used to specify the next boot device
+	to consider. The <code>boot</code> element can be repeated multiple
+	times to setup a priority list of boot devices to try in turn.
+	<span class="since">Since 0.1.3</span>
+      </dd></dl>
+        <h4>
+          <a name="elementsOSBootloader" id="elementsOSBootloader">Host bootloader</a>
+        </h4>
+        <p>
+      Hypervisors employing paravirtualization do not usually emulate
+      a BIOS, and instead the host is responsible to kicking off the
+      operating system boot. This may use a pseudo-bootloader in the
+      host to provide an interface to choose a kernel for the guest.
+      An example is <code>pygrub</code> with Xen.
+    </p>
+        <pre>
+        ...
+	&lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
+	&lt;bootloader_args&gt;--append single&lt;/bootloader_args&gt;
+        ...</pre>
+        <dl><dt><code>bootloader</code></dt><dd>The content of the <code>bootloader</code> element provides
+	a fully qualified path to the bootloader executable in the
+	host OS. This bootloader will be run to choose which kernel
+	to boot. The required output of the bootloader is dependent
+	on the hypervisor in use. <span class="since">Since 0.1.0</span></dd><dt><code>bootloader_args</code></dt><dd>The optional <code>bootloader_args</code> element allows
+	command line arguments to be passed to the bootloader.
+	<span class="since">Since 0.2.3</span>
+	</dd></dl>
+        <h4>
+          <a name="elementsOSKernel" id="elementsOSKernel">Direct kernel boot</a>
+        </h4>
+        <p>
+      When installing a new guest OS it is often useful to boot directly
+      from a kernel and initrd stored in the host OS, allowing command
+      line arguments to be passed directly to the installer. This capability
+      is usually available for both para and full virtualized guests.
+    </p>
+        <pre>
+        ...
+	&lt;os&gt;
+          &lt;type&gt;hvm&lt;/type&gt;
+          &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
+          &lt;kernel&gt;/root/f8-i386-vmlinuz&lt;/kernel&gt;
+          &lt;initrd&gt;/root/f8-i386-initrd&lt;/initrd&gt;
+          &lt;cmdline&gt;console=ttyS0 ks=http://example.com/f8-i386/os/&lt;/cmdline&gt;
+	&lt;/os&gt;
+	...</pre>
+        <dl><dt><code>type</code></dt><dd>This element has the same semantics as described earlier in the
+	<a href="#elementsOSBIOS">BIOS boot section</a></dd><dt><code>loader</code></dt><dd>This element has the same semantics as described earlier in the
+	<a href="#elementsOSBIOS">BIOS boot section</a></dd><dt><code>kernel</code></dt><dd>The contents of this element specify the fully-qualified path
+	to the kernel image in the host OS.</dd><dt><code>initrd</code></dt><dd>The contents of this element specify the fully-qualified path
+	to the (optional) ramdisk image in the host OS.</dd><dt><code>cmdline</code></dt><dd>The contents of this element specify arguments to be passed to
+	the kernel (or installer) at boottime. This is often used to
+	specify an alternate primary console (eg serial port), or the
+	installation media source / kickstart file</dd></dl>
+        <h3>
+          <a name="elementsResources" id="elementsResources">Basic resources</a>
+        </h3>
+        <pre>
+        ...
+	&lt;memory&gt;524288&lt;/memory&gt;
+	&lt;currentMemory&gt;524288&lt;/currentMemory&gt;
+	&lt;vcpu&gt;1&lt;/vcpu&gt;
+	...</pre>
+        <dl><dt><code>memory</code></dt><dd>The maximum allocation of memory for the guest at boot time.
+	The units for this value are kilobytes (i.e. blocks of 1024 bytes)</dd><dt><code>currentMemory</code></dt><dd>The actual allocation of memory for the guest. This value
+	be less than the maximum allocation, to allow for ballooning
+	up the guests memory on the fly. If this is omitted, it defaults
+	to the same value as the <code>memory<code> element</code></code></dd><dt><code>vcpu</code></dt><dd>The content of this element defines the number of virtual
+	CPUs allocated for the guest OS.</dd></dl>
+        <h3>
+          <a name="elementsLifecycle" id="elementsLifecycle">Lifecycle control</a>
+        </h3>
+        <p>
+      It is sometimes necessary to override the default actions taken
+      when a guest OS triggers a lifecycle operation. The following
+      collections of elements allow the actions to be specified. A
+      common use case is to force a reboot to be treated as a poweroff
+      when doing the initial OS installation. This allows the VM to be
+      re-configured for the first post-install bootup.
+    </p>
+        <pre>
+        ...
+	&lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
+	&lt;on_reboot&gt;restart&lt;/on_reboot&gt;
+	&lt;on_crash&gt;restart&lt;/on_crash&gt;
+	...</pre>
+        <dl><dt><code>on_poweroff</code></dt><dd>The content of this element specifies the action to take when
+	the guest requests a poweroff.</dd><dt><code>on_reboot</code></dt><dd>The content of this element specifies the action to take when
+	the guest requests a reboot.</dd><dt><code>on_crash</code></dt><dd>The content of this element specifies the action to take when
+	the guest crashes.</dd></dl>
+        <p>
+      Each of these states allow for the same four possible actions.
+    </p>
+        <dl><dt><code>destroy</code></dt><dd>The domain will be terminated completely and all resources
+	released</dd><dt><code>restart</code></dt><dd>The domain will be terminated, and then restarted with
+	the same configuration</dd><dt><code>preserve</code></dt><dd>The domain will be terminated, and its resource preserved
+	to allow analysis.</dd><dt><code>rename-restart</code></dt><dd>The domain will be terminated, and then restarted with
+	a new name</dd></dl>
+        <h3>
+          <a name="elementsFeatures" id="elementsFeatures">Hypervisor features</a>
+        </h3>
+        <p>
+      Hypervisors may allow certain CPU / machine features to be
+      toggled on/off.
+    </p>
+        <pre>
+        ...
+	&lt;features&gt;
+	  &lt;pae/&gt;
+	  &lt;acpi/&gt;
+	  &lt;apic/&gt;
+	&lt;/features&gt;
+	...</pre>
+        <p>
+      All features are listed within the <code>features</code>
+      element, omitting a togglable feature tag turns it off.
+      The available features can be found by asking
+      for the <a href="formatcaps.html">capabilities XML</a>,
+      but a common set for fully virtualized domains are:
+    </p>
+        <dl><dt><code>pae</code></dt><dd>Physical address extension mode allows 32-bit guests
+	to address more than 4 GB of memory.</dd><dt><code>acpi</code></dt><dd>ACPI is useful for power management, for example, with
+	KVM guests it is required for graceful shutdown to work.
+      </dd></dl>
+        <h3>
+          <a name="elementsTime" id="elementsTime">Time keeping</a>
+        </h3>
+        <p>
+      The guest clock is typically initialized from the host clock.
+      Most operating systems expect the hardware clock to be kept
+      in UTC, and this is the default. Windows, however, expects
+      it to be in so called 'localtime'.
+    </p>
+        <pre>
+        ...
+        &lt;clock sync="localtime"/&gt;
+	...</pre>
+        <dl><dt><code>clock</code></dt><dd>The <code>sync</code> attribute takes either "utc" or
+	"localtime" to specify how the guest clock is initialized
+	in relation to the host OS.
+      </dd></dl>
+        <h3>
+          <a name="elementsDevices" id="elementsDevices">Devices</a>
+        </h3>
+        <p>
+      The final set of XML elements are all used to describe devices
+      provided to the guest domain. All devices occur as children
+      of the main <code>devices</code> element.
+      <span class="since">Since 0.1.3</span>
+    </p>
+        <pre>
+        ...
+        &lt;devices&gt;
+	  &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
+          ...</pre>
+        <dl><dt><code>emulator</code></dt><dd>
+	The contents of the <code>emulator</code> element specify
+	the fully qualified path to the device model emulator binary.
+	The <a href="formatcaps.html">capabilities XML</a> specifies
+	the recommended default emulator to use for each particular
+	domain type / architecture combination.
+      </dd></dl>
+        <h4>
+          <a name="elementsDisks" id="elementsDisks">Hard drives, floppy disks, CDROMs</a>
+        </h4>
+        <p>
+      Any device that looks like a disk, be it a floppy, harddisk,
+      cdrom, or paravirtualized driver is specified via the <code>disk</code>
+      element.
+    </p>
+        <pre>
+          ...
+	  &lt;disk type='file'&gt;
+	    &lt;driver name="tap" type="aio"&gt;
+	    &lt;source file='/var/lib/xen/images/fv0'/&gt;
+	    &lt;target dev='hda' bus='ide'/&gt;
+	  &lt;/disk&gt;
+	  ...</pre>
+        <dl><dt><code>disk</code></dt><dd>The <code>disk</code> element is the main container for describing
+	disks. The <code>type</code> attribute is either "file" or "block"
+	and refers to the underlying source for the disk. The optional
+	<code>device</code> attribute indicates how the disk is to be exposed
+	to the guest OS. Possible values for this attribute are "floppy", "disk"
+	and "cdrom", defaulting to "disk".
+	<span class="since">Since 0.0.3; "device" attribute since 0.1.4</span></dd><dt><code>source</code></dt><dd>If the disk <code>type</code> is "file", then the <code>file</code> attribute
+	specifies the fully-qualified path to the file holding the disk. If the disk
+	<code>type</code> is "block", then the <code>dev</code> attribute specifies
+	the path to the host device to serve as the disk. <span class="since">Since 0.0.3</span></dd><dt><code>target</code></dt><dd>The <code>target</code> element controls the bus / device under which the
+	disk is exposed to the guest OS. The <code>dev</code> attribute indicates
+	the "logical" device name. The actual device name specified is not guaranteed to map to
+	the device name in the guest OS. Treat it as a device ordering hint.
+	The optional <code>bus</code> attribute specifies the type of disk device
+	to emulate; possible values are driver specific, with typical values being
+	"ide", "scsi", "virtio", "xen" or "usb". If omitted, the bus type is
+	inferred from the style of the device name. eg, a device named 'sda'
+	will typically be exported using a SCSI bus.
+	<span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
+        "usb" attribute value since after 0.4.4</span></dd><dt><code>driver</code></dt><dd>If the hypervisor supports multiple backend drivers, then the optional
+	<code>driver</code> element allows them to be selected. The <code>name</code>
+	attribute is the primary backend driver name, while the optional <code>type</code>
+	attribute provides the sub-type. <span class="since">Since 0.1.8</span>
+      </dd></dl>
+        <h4>
+          <a name="elementsUSB" id="elementsUSB">USB devices</a>
+        </h4>
+        <p>
+      USB devices attached to the host can be passed through to the guest using
+      the <code>hostdev</code> element. <span class="since">since after 0.4.4</span>
+    </p>
+        <pre>
+          ...
+	  &lt;hostdev mode='subsystem' type='usb'&gt;
+	    &lt;source&gt;
+	      &lt;vendor id='0x1234'/&gt;
+	      &lt;product id='0xbeef'/&gt;
+	    &lt;/source&gt;
+	  &lt;/disk&gt;
+	  ...</pre>
+        <dl><dt><code>hostdev</code></dt><dd>The <code>hostdev</code> element is the main container for describing
+      host devices. For usb device passthrough <code>mode</code> is always
+      "subsystem" and <code>type</code> is "usb".
+      </dd><dt><code>source</code></dt><dd>The source element describes the device as seen from the host.
+      The USB device can either be addressed by vendor / product id using the
+      <code>vendor</code> and <code>product</code> elements or by the device's
+      address on the hosts using the <code>address</code> element.</dd><dt><code>vendor</code>, <code>product</code></dt><dd>The <code>vendor</code> and <code>product</code> elements each have an
+      <code>id</code> attribute that specifies the USB vendor and product id.
+      The ids can be given in decimal, hexadecimal (starting with 0x) or
+      octal (starting with 0) form.</dd><dt><code>address</code></dt><dd>The <code>address</code> element has a <code>bus</code> and
+      <code>device</code> attribute to specify the USB bus and device number
+      the device appears at on the host. The values of these attributes can
+      be given in decimal, hexadecimal (starting with 0x) or octal (starting
+      with 0) form.</dd></dl>
+        <h4>
+          <a name="elementsNICS" id="elementsNICS">Network interfaces</a>
+        </h4>
+        <pre>
+          ...
+	  &lt;interface type='bridge'&gt;
+	    &lt;source bridge='xenbr0'/&gt;
+	    &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
+	    &lt;script path='vif-bridge'/&gt;
+	  &lt;/interface&gt;
+	  ...</pre>
+        <h5>
+          <a name="elementsNICSVirtual" id="elementsNICSVirtual">Virtual network</a>
+        </h5>
+        <p>
+      <strong><em>
+      This is the recommended config for general guest connectivity on
+      hosts with dynamic / wireless networking configs
+      </em></strong>
+    </p>
+        <p>
+      Provides a virtual network using a bridge device in the host.
+      Depending on the virtual network configuration, the network may be
+      totally isolated, NAT'ing to an explicit network device, or NAT'ing to
+      the default route. DHCP and DNS are provided on the virtual network in
+      all cases and the IP range can be determined by examining the virtual
+      network config with '<code>virsh net-dumpxml [networkname]</code>'.
+      There is one virtual network called 'default' setup out
+      of the box which does NAT'ing to the default route and has an IP range of
+      <code>192.168.22.0/255.255.255.0</code>. Each guest will have an
+      associated tun device created with a name of vnetN, which can also be
+      overridden with the &lt;target&gt; element.
+    </p>
+        <pre>
+      ...
+      &lt;interface type='network'&gt;
+        &lt;source network='default'/&gt;
+      &lt;/interface&gt;
+      ...
+      &lt;interface type='network'&gt;
+        &lt;source network='default'/&gt;
+        &lt;target dev='vnet7'/&gt;
+        &lt;mac address="11:22:33:44:55:66"/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsNICSBridge" id="elementsNICSBridge">Bridge to to LAN</a>
+        </h5>
+        <p>
+      <strong><em>
+      This is the recommended config for general guest connectivity on
+      hosts with static wired networking configs
+      </em></strong>
+    </p>
+        <p>
+      Provides a bridge from the VM directly onto the LAN. This assumes
+      there is a bridge device on the host which has one or more of the hosts
+      physical NICs enslaved. The guest VM will have an associated tun device
+      created with a name of vnetN, which can also be overridden with the
+      &lt;target&gt; element. The tun device will be enslaved to the bridge.
+      The IP range / network configuration is whatever is used on the LAN. This
+      provides the guest VM full incoming &amp; outgoing net access just like a
+      physical machine.
+    </p>
+        <pre>
+      ...
+      &lt;interface type='bridge'&gt;
+        &lt;source bridge='br0'/&gt;
+      &lt;/interface&gt;
+
+      &lt;interface type='bridge'&gt;
+        &lt;source bridge='br0'/&gt;
+        &lt;target dev='vnet7'/&gt;
+        &lt;mac address="11:22:33:44:55:66"/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsNICSSlirp" id="elementsNICSSlirp">Userspace SLIRP stack</a>
+        </h5>
+        <p>
+      Provides a virtual LAN with NAT to the outside world. The virtual
+      network has DHCP &amp; DNS services and will give the guest VM addresses
+      starting from <code>10.0.2.15</code>. The default router will be
+      <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
+      This networking is the only option for unprivileged users who need their
+      VMs to have outgoing access.
+    </p>
+        <pre>
+      ...
+      &lt;interface type='user'/&gt;
+      ...
+      &lt;interface type='user'&gt;
+        &lt;mac address="11:22:33:44:55:66"/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsNICSEthernet" id="elementsNICSEthernet">Generic ethernet connection</a>
+        </h5>
+        <p>
+      Provides a means for the administrator to execute an arbitrary script
+      to connect the guest's network to the LAN. The guest will have a tun
+      device created with a name of vnetN, which can also be overridden with the
+      &lt;target&gt; element. After creating the tun device a shell script will
+      be run which is expected to do whatever host network integration is
+      required. By default this script is called /etc/qemu-ifup but can be
+      overridden.
+    </p>
+        <pre>
+      ...
+      &lt;interface type='ethernet'/&gt;
+      ...
+      &lt;interface type='ethernet'&gt;
+        &lt;target dev='vnet7'/&gt;
+        &lt;script path='/etc/qemu-ifup-mynet'/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsNICSMulticast" id="elementsNICSMulticast">Multicast tunnel</a>
+        </h5>
+        <p>
+      A multicast group is setup to represent a virtual network. Any VMs
+      whose network devices are in the same multicast group can talk to each
+      other even across hosts. This mode is also available to unprivileged
+      users. There is no default DNS or DHCP support and no outgoing network
+      access. To provide outgoing network access, one of the VMs should have a
+      2nd NIC which is connected to one of the first 4 network types and do the
+      appropriate routing. The multicast protocol is compatible with that used
+      by user mode linux guests too. The source address used must be from the
+      multicast address block.
+    </p>
+        <pre>
+      ...
+      &lt;interface type='mcast'&gt;
+        &lt;source address='230.0.0.1' port='5558'/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsNICSTCP" id="elementsNICSTCP">TCP tunnel</a>
+        </h5>
+        <p>
+      A TCP client/server architecture provides a virtual network. One VM
+      provides the server end of the network, all other VMS are configured as
+      clients. All network traffic is routed between the VMs via the server.
+      This mode is also available to unprivileged users. There is no default
+      DNS or DHCP support and no outgoing network access. To provide outgoing
+      network access, one of the VMs should have a 2nd NIC which is connected
+      to one of the first 4 network types and do the appropriate routing.</p>
+        <pre>
+      ...
+      &lt;interface type='server'&gt;
+        &lt;source address='192.168.0.1' port='5558'/&gt;
+      &lt;/interface&gt;
+      ...
+      &lt;interface type='client'&gt;
+      &lt;source address='192.168.0.1' port='5558'/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsNICSModel" id="elementsNICSModel">Setting the NIC model</a>
+        </h5>
+        <pre>
+      ...
+      &lt;interface type='network'&gt;
+        &lt;source network='default'/&gt;
+        &lt;target dev='vnet1'/&gt;
+        <b>&lt;model type='ne2k_pci'/&gt;</b>
+      &lt;/interface&gt;
+      ...</pre>
+        <p>
+      For hypervisors which support this, you can set the model of
+      emulated network interface card.
+    </p>
+        <p>
+      The values for <code>type</code> aren't defined specifically by
+      libvirt, but by what the underlying hypervisor supports (if
+      any).  For QEMU and KVM you can get a list of supported models
+      with these commands:
+    </p>
+        <pre>
+qemu -net nic,model=? /dev/null
+qemu-kvm -net nic,model=? /dev/null
+</pre>
+        <p>
+      Typical values for QEMU and KVM include:
+      ne2k_isa i82551 i82557b i82559er ne2k_pci pcnet rtl8139 e1000 virtio
+    </p>
+        <h4>
+          <a name="elementsInput" id="elementsInput">Input devices</a>
+        </h4>
+        <p>
+      Input devices allow interaction with the graphical framebuffer in the guest
+      virtual machine. When enabling the framebuffer, an input device is automatically
+      provided. It may be possible to add additional devices explicitly, for example,
+      to provide a graphics tablet for absolute cursor movement.
+    </p>
+        <pre>
+          ...
+	  &lt;input type='mouse' bus='usb'/&gt;
+	  ...</pre>
+        <dl><dt><code>input</code></dt><dd>The <code>input</code> element has one mandatory attribute, the <code>type</code>
+	whose value can be either 'mouse' or 'tablet'. The latter provides absolute
+	cursor movement, while the former uses relative movement. The optional
+	<code>bus</code> attribute can be used to refine the exact device type.
+	It takes values "xen" (paravirtualized), "ps2" and "usb".</dd></dl>
+        <h4>
+          <a name="elementsGraphics" id="elementsGraphics">Graphical framebuffers</a>
+        </h4>
+        <p>
+      A graphics device allows for graphical interaction with the
+      guest OS. A guest will typically have either a framebuffer
+      or a text console configured to allow interaction with the
+      admin.
+    </p>
+        <pre>
+          ...
+	  &lt;graphics type='vnc' port='5904'/&gt;
+	  ...</pre>
+        <dl><dt><code>graphics</code></dt><dd>The <code>graphics</code> element has a mandatory <code>type</code>
+	attribute which takes the value "sdl" or "vnc". The former displays
+	a window on the host desktop, while the latter activates a VNC server.
+	If the latter is used the <code>port</code> attribute specifies the TCP
+	port number (with -1 as legacy syntax indicating that it should be
+	auto-allocated). The <code>autoport</code> attribute is the new
+	preferred syntax for indicating autoallocation of the TCP port to use.
+	The <code>listen</code> attribute is an IP address for the server to
+	listen on. The <code>password</code> attribute provides a VNC password
+	in clear text.</dd></dl>
+        <h4>
+          <a name="elementsConsole" id="elementsConsole">Consoles, serial &amp; parallel devices</a>
+        </h4>
+        <p>
+      A character device provides a way to interact with the virtual machine.
+      Paravirtualized consoles, serial ports and parallel ports are all
+      classed as character devices and so represented using the same syntax.
+    </p>
+        <pre>
+        ...
+        &lt;parallel type='pty'&gt;
+	  &lt;source path='/dev/pts/2'/&gt;
+	  &lt;target port='0'/&gt;
+        &lt;/parallel&gt;
+        &lt;serial type='pty'&gt;
+	  &lt;source path='/dev/pts/3'/&gt;
+	  &lt;target port='0'/&gt;
+        &lt;/serial&gt;
+        &lt;console type='pty'&gt;
+	  &lt;source path='/dev/pts/4'/&gt;
+	  &lt;target port='0'/&gt;
+        &lt;/console&gt;
+        &lt;/devices&gt;
+      &lt;/domain&gt;</pre>
+        <dl><dt><code>parallel</code></dt><dd>Represents a parallel port</dd><dt><code>serial</code></dt><dd>Represents a serial port</dd><dt><code>console</code></dt><dd>Represents the primary console. This can be the paravirtualized
+	console with Xen guests, or duplicates the primary serial port
+	for fully virtualized guests without a paravirtualized console.</dd><dt><code>source</code></dt><dd>The attributes available for the <code>source</code> element
+	vary according to the <code>type</code> attribute on the parent
+	tag. Allowed variations will be described below</dd><dt><code>target</code></dt><dd>The port number of the character device is specified via the
+	<code>port</code> attribute, numbered starting from 1. There is
+	usually only one console device, and 0, 1 or 2 serial devices
+	or parallel devices.
+    </dd></dl>
+        <h5>
+          <a name="elementsCharSTDIO" id="elementsCharSTDIO">Domain logfile</a>
+        </h5>
+        <p>
+      This disables all input on the character device, and sends output
+      into the virtual machine's logfile
+    </p>
+        <pre>
+      ...
+      &lt;console type='stdio'&gt;
+        &lt;target port='1'&gt;
+      &lt;/console&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsCharFle" id="elementsCharFle">Device logfile</a>
+        </h5>
+        <p>
+      A file is opened and all data sent to the character
+      device is written to the file.
+    </p>
+        <pre>
+      ...
+      &lt;serial type="file"&gt;
+        &lt;source path="/var/log/vm/vm-serial.log"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsCharVC" id="elementsCharVC">Virtual console</a>
+        </h5>
+        <p>
+      Connects the character device to the graphical framebuffer in
+      a virtual console. This is typically accessed via a special
+      hotkey sequence such as "ctrl+alt+3"
+    </p>
+        <pre>
+      ...
+      &lt;serial type='vc'&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsCharNull" id="elementsCharNull">Null device</a>
+        </h5>
+        <p>
+      Connects the character device to the void. No data is ever
+      provided to the input. All data written is discarded.
+    </p>
+        <pre>
+      ...
+      &lt;serial type='null'&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsCharPTY" id="elementsCharPTY">Pseudo TTY</a>
+        </h5>
+        <p>
+      A Pseudo TTY is allocated using /dev/ptmx. A suitable client
+      such as 'virsh console' can connect to interact with the
+      serial port locally.
+    </p>
+        <pre>
+      ...
+      &lt;serial type="pty"&gt;
+        &lt;source path="/dev/pts/3"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+        <p>
+      NB special case if &lt;console type='pty'&gt;, then the TTY
+      path is also duplicated as an attribute tty='/dev/pts/3'
+      on the top level &lt;console&gt; tag. This provides compat
+      with existing syntax for &lt;console&gt; tags.
+    </p>
+        <h5>
+          <a name="elementsCharHost" id="elementsCharHost">Host device proxy</a>
+        </h5>
+        <p>
+      The character device is passed through to the underlying
+      physical character device. The device types must match,
+      eg the emulated serial port should only be connected to
+      a host serial port - don't connect a serial port to a parallel
+      port.
+    </p>
+        <pre>
+      ...
+      &lt;serial type="dev"&gt;
+        &lt;source path="/dev/ttyS0"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsCharTCP" id="elementsCharTCP">TCP client/server</a>
+        </h5>
+        <p>
+      The character device acts as a TCP client connecting to a
+      remote server, or as a server waiting for a client connection.
+    </p>
+        <pre>
+      ...
+      &lt;serial type="tcp"&gt;
+        &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
+        &lt;wiremode type="telnet"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsCharUDP" id="elementsCharUDP">UDP network console</a>
+        </h5>
+        <p>
+      The character device acts as a UDP netconsole service,
+      sending and receiving packets. This is a lossy service.
+    </p>
+        <pre>
+      ...
+      &lt;serial type="udp"&gt;
+        &lt;source mode="bind" host="0.0.0.0" service="2445"/&gt;
+        &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+        <h5>
+          <a name="elementsCharUNIX" id="elementsCharUNIX">UNIX domain socket client/server</a>
+        </h5>
+        <p>
+      The character device acts as a UNIX domain socket server,
+      accepting connections from local clients.
+    </p>
+        <pre>
+      ...
+      &lt;serial type="unix"&gt;
+        &lt;source mode="bind" path="/tmp/foo"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+        <h2>
+          <a name="examples" id="examples">Example configs</a>
+        </h2>
+        <p>
+      Example configurations for each driver are provide on the
+      driver specific pages listed below
+    </p>
+        <ul><li><a href="drvxen.html#xmlconfig">Xen examples</a></li><li><a href="drvqemu.html#xmlconfig">QEMU/KVM examples</a></li></ul>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/formatdomain.html.in

@@ -0,0 +1,874 @@
+<html>
+  <body>
+    <h1>Domain XML format</h1>
+
+    <ul id="toc"></ul>
+
+    <p>
+      This section describes the XML format used to represent domains, there are
+      variations on the format based on the kind of domains run and the options
+      used to launch them. For hypervisor specific details consult the
+      <a href="drivers.html">driver docs</a>
+    </p>
+
+
+    <h2><a name="elements">Element and attribute overview</a></h2>
+
+    <p>
+      The root element required for all virtual machines is
+      named <code>domain</code>. It has two attributes, the
+      <code>type</code> specifies the hypervisor used for running
+      the domain. The allowed values are driver specific, but
+      include "xen", "kvm", "qemu", "lxc" and "kqemu". The
+      second attribute is <code>id</code> which is a unique
+      integer identifier for the running guest machine. Inactive
+      machines have no id value.
+    </p>
+
+
+    <h3><a name="elementsMetadata">General metadata</a></h3>
+
+    <pre>
+      &lt;domain type='xen' id='3'&gt;
+        &lt;name&gt;fv0&lt;/name&gt;
+        &lt;uuid&gt;4dea22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
+        ...</pre>
+
+    <dl>
+      <dt><code>name</code></dt>
+      <dd>The content of the <code>name</code> element provides
+	a short name for the virtual machine. This name should
+	consist only of alpha-numeric characters and is required
+	to be unique within the scope of a single host. It is
+	often used to form the filename for storing the persistent
+	configuration file. <span class="since">Since 0.0.1</span></dd>
+      <dt><code>uuid</code></dt>
+      <dd>The content of the <code>uuid</code> element provides
+	a globally unique identifier for the virtual machine.
+	The format must be RFC 4122 compliant, eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
+	If omitted when defining/creating a new machine, a random
+	UUID is generated. <span class="since">Since 0.0.1</span></dd>
+    </dl>
+
+    <h3><a name="elementsOS">Operating system booting</a></h3>
+
+    <p>
+      There are a number of different ways to boot virtual machines
+      each with their own pros and cons.
+    </p>
+
+    <h4><a name="elementsOSBIOS">BIOS bootloader</a></h4>
+
+    <p>
+      Booting via the BIOS is available for hypervisors supporting
+      full virtualization. In this case the BIOS has a boot order
+      priority (floppy, harddisk, cdrom, network) determining where
+      to obtain/find the boot image.
+    </p>
+
+    <pre>
+        ...
+        &lt;os&gt;
+          &lt;type&gt;hvm&lt;/type&gt;
+          &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
+          &lt;boot dev='hd'/&gt;
+        &lt;/os&gt;
+        ...</pre>
+
+    <dl>
+      <dt><code>type</code></dt>
+      <dd>The content of the <code>type</code> element specifies the
+	type of operating system to be booted in the virtual machine.
+	<code>hvm</code> indicates that the OS is one designed to run
+	on bare metal, so requires full virtualization. <code>linux</code>
+	(badly named!) refers to an OS that supports the Xen 3 hypervisor
+	guest ABI. There are also two optional attributes, <code>arch</code>
+	specifying the CPU architecture to virtualization, and <code>machine</code>
+	referring to the machine type. The <a href="formatcaps.html">Capabilities XML</a>
+	provides details on allowed values for these. <span class="since">Since 0.0.1</span></dd>
+      <dt><code>loader</code></dt>
+      <dd>The optional <code>loader</code> tag refers to a firmware blob
+	used to assist the domain creation process. At this time, it is
+	only needed by Xen fully virtualized domains. <span class="since">Since 0.1.0</span></dd>
+      <dt><code>boot</code></dt>
+      <dd>The <code>dev</code> attribute takes one of the values "fd", "hd",
+	"cdrom" or "network" and is used to specify the next boot device
+	to consider. The <code>boot</code> element can be repeated multiple
+	times to setup a priority list of boot devices to try in turn.
+	<span class="since">Since 0.1.3</span>
+      </dd>
+    </dl>
+
+    <h4><a name="elementsOSBootloader">Host bootloader</a></h4>
+
+    <p>
+      Hypervisors employing paravirtualization do not usually emulate
+      a BIOS, and instead the host is responsible to kicking off the
+      operating system boot. This may use a pseudo-bootloader in the
+      host to provide an interface to choose a kernel for the guest.
+      An example is <code>pygrub</code> with Xen.
+    </p>
+
+    <pre>
+        ...
+	&lt;bootloader&gt;/usr/bin/pygrub&lt;/bootloader&gt;
+	&lt;bootloader_args&gt;--append single&lt;/bootloader_args&gt;
+        ...</pre>
+
+    <dl>
+      <dt><code>bootloader</code></dt>
+      <dd>The content of the <code>bootloader</code> element provides
+	a fully qualified path to the bootloader executable in the
+	host OS. This bootloader will be run to choose which kernel
+	to boot. The required output of the bootloader is dependent
+	on the hypervisor in use. <span class="since">Since 0.1.0</span></dd>
+      <dt><code>bootloader_args</code></dt>
+      <dd>The optional <code>bootloader_args</code> element allows
+	command line arguments to be passed to the bootloader.
+	<span class="since">Since 0.2.3</span>
+	</dd>
+
+    </dl>
+
+    <h4><a name="elementsOSKernel">Direct kernel boot</a></h4>
+
+    <p>
+      When installing a new guest OS it is often useful to boot directly
+      from a kernel and initrd stored in the host OS, allowing command
+      line arguments to be passed directly to the installer. This capability
+      is usually available for both para and full virtualized guests.
+    </p>
+
+    <pre>
+        ...
+	&lt;os&gt;
+          &lt;type&gt;hvm&lt;/type&gt;
+          &lt;loader&gt;/usr/lib/xen/boot/hvmloader&lt;/loader&gt;
+          &lt;kernel&gt;/root/f8-i386-vmlinuz&lt;/kernel&gt;
+          &lt;initrd&gt;/root/f8-i386-initrd&lt;/initrd&gt;
+          &lt;cmdline&gt;console=ttyS0 ks=http://example.com/f8-i386/os/&lt;/cmdline&gt;
+	&lt;/os&gt;
+	...</pre>
+
+    <dl>
+      <dt><code>type</code></dt>
+      <dd>This element has the same semantics as described earlier in the
+	<a href="#elementsOSBIOS">BIOS boot section</a></dd>
+      <dt><code>loader</code></dt>
+      <dd>This element has the same semantics as described earlier in the
+	<a href="#elementsOSBIOS">BIOS boot section</a></dd>
+      <dt><code>kernel</code></dt>
+      <dd>The contents of this element specify the fully-qualified path
+	to the kernel image in the host OS.</dd>
+      <dt><code>initrd</code></dt>
+      <dd>The contents of this element specify the fully-qualified path
+	to the (optional) ramdisk image in the host OS.</dd>
+      <dt><code>cmdline</code></dt>
+      <dd>The contents of this element specify arguments to be passed to
+	the kernel (or installer) at boottime. This is often used to
+	specify an alternate primary console (eg serial port), or the
+	installation media source / kickstart file</dd>
+    </dl>
+
+    <h3><a name="elementsResources">Basic resources</a></h3>
+
+    <pre>
+        ...
+	&lt;memory&gt;524288&lt;/memory&gt;
+	&lt;currentMemory&gt;524288&lt;/currentMemory&gt;
+	&lt;vcpu&gt;1&lt;/vcpu&gt;
+	...</pre>
+
+    <dl>
+      <dt><code>memory</code></dt>
+      <dd>The maximum allocation of memory for the guest at boot time.
+	The units for this value are kilobytes (i.e. blocks of 1024 bytes)</dd>
+      <dt><code>currentMemory</code></dt>
+      <dd>The actual allocation of memory for the guest. This value
+	be less than the maximum allocation, to allow for ballooning
+	up the guests memory on the fly. If this is omitted, it defaults
+	to the same value as the <code>memory<code> element</dd>
+      <dt><code>vcpu</code></dt>
+      <dd>The content of this element defines the number of virtual
+	CPUs allocated for the guest OS.</dd>
+    </dl>
+
+    <h3><a name="elementsLifecycle">Lifecycle control</a></h3>
+
+    <p>
+      It is sometimes necessary to override the default actions taken
+      when a guest OS triggers a lifecycle operation. The following
+      collections of elements allow the actions to be specified. A
+      common use case is to force a reboot to be treated as a poweroff
+      when doing the initial OS installation. This allows the VM to be
+      re-configured for the first post-install bootup.
+    </p>
+
+    <pre>
+        ...
+	&lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
+	&lt;on_reboot&gt;restart&lt;/on_reboot&gt;
+	&lt;on_crash&gt;restart&lt;/on_crash&gt;
+	...</pre>
+
+    <dl>
+      <dt><code>on_poweroff</code></dt>
+      <dd>The content of this element specifies the action to take when
+	the guest requests a poweroff.</dd>
+      <dt><code>on_reboot</code></dt>
+      <dd>The content of this element specifies the action to take when
+	the guest requests a reboot.</dd>
+      <dt><code>on_crash</code></dt>
+      <dd>The content of this element specifies the action to take when
+	the guest crashes.</dd>
+    </dl>
+
+    <p>
+      Each of these states allow for the same four possible actions.
+    </p>
+
+    <dl>
+      <dt><code>destroy</code></dt>
+      <dd>The domain will be terminated completely and all resources
+	released</dd>
+      <dt><code>restart</code></dt>
+      <dd>The domain will be terminated, and then restarted with
+	the same configuration</dd>
+      <dt><code>preserve</code></dt>
+      <dd>The domain will be terminated, and its resource preserved
+	to allow analysis.</dd>
+      <dt><code>rename-restart</code></dt>
+      <dd>The domain will be terminated, and then restarted with
+	a new name</dd>
+    </dl>
+
+    <h3><a name="elementsFeatures">Hypervisor features</a></h3>
+
+    <p>
+      Hypervisors may allow certain CPU / machine features to be
+      toggled on/off.
+    </p>
+
+    <pre>
+        ...
+	&lt;features&gt;
+	  &lt;pae/&gt;
+	  &lt;acpi/&gt;
+	  &lt;apic/&gt;
+	&lt;/features&gt;
+	...</pre>
+
+    <p>
+      All features are listed within the <code>features</code>
+      element, omitting a togglable feature tag turns it off.
+      The available features can be found by asking
+      for the <a href="formatcaps.html">capabilities XML</a>,
+      but a common set for fully virtualized domains are:
+    </p>
+
+    <dl>
+      <dt><code>pae</code></dt>
+      <dd>Physical address extension mode allows 32-bit guests
+	to address more than 4 GB of memory.</dd>
+      <dt><code>acpi</code></dt>
+      <dd>ACPI is useful for power management, for example, with
+	KVM guests it is required for graceful shutdown to work.
+      </dd>
+    </dl>
+
+    <h3><a name="elementsTime">Time keeping</a></h3>
+
+    <p>
+      The guest clock is typically initialized from the host clock.
+      Most operating systems expect the hardware clock to be kept
+      in UTC, and this is the default. Windows, however, expects
+      it to be in so called 'localtime'.
+    </p>
+
+    <pre>
+        ...
+        &lt;clock sync="localtime"/&gt;
+	...</pre>
+
+    <dl>
+      <dt><code>clock</code></dt>
+      <dd>The <code>sync</code> attribute takes either "utc" or
+	"localtime" to specify how the guest clock is initialized
+	in relation to the host OS.
+      </dd>
+    </dl>
+
+    <h3><a name="elementsDevices">Devices</a></h3>
+
+    <p>
+      The final set of XML elements are all used to describe devices
+      provided to the guest domain. All devices occur as children
+      of the main <code>devices</code> element.
+      <span class="since">Since 0.1.3</span>
+    </p>
+
+    <pre>
+        ...
+        &lt;devices&gt;
+	  &lt;emulator&gt;/usr/lib/xen/bin/qemu-dm&lt;/emulator&gt;
+          ...</pre>
+
+    <dl>
+      <dt><code>emulator</code></dt>
+      <dd>
+	The contents of the <code>emulator</code> element specify
+	the fully qualified path to the device model emulator binary.
+	The <a href="formatcaps.html">capabilities XML</a> specifies
+	the recommended default emulator to use for each particular
+	domain type / architecture combination.
+      </dd>
+    </dl>
+
+    <h4><a name="elementsDisks">Hard drives, floppy disks, CDROMs</a></h4>
+
+    <p>
+      Any device that looks like a disk, be it a floppy, harddisk,
+      cdrom, or paravirtualized driver is specified via the <code>disk</code>
+      element.
+    </p>
+
+    <pre>
+          ...
+	  &lt;disk type='file'&gt;
+	    &lt;driver name="tap" type="aio"&gt;
+	    &lt;source file='/var/lib/xen/images/fv0'/&gt;
+	    &lt;target dev='hda' bus='ide'/&gt;
+	  &lt;/disk&gt;
+	  ...</pre>
+
+    <dl>
+      <dt><code>disk</code></dt>
+      <dd>The <code>disk</code> element is the main container for describing
+	disks. The <code>type</code> attribute is either "file" or "block"
+	and refers to the underlying source for the disk. The optional
+	<code>device</code> attribute indicates how the disk is to be exposed
+	to the guest OS. Possible values for this attribute are "floppy", "disk"
+	and "cdrom", defaulting to "disk".
+	<span class="since">Since 0.0.3; "device" attribute since 0.1.4</span></dd>
+      <dt><code>source</code></dt>
+      <dd>If the disk <code>type</code> is "file", then the <code>file</code> attribute
+	specifies the fully-qualified path to the file holding the disk. If the disk
+	<code>type</code> is "block", then the <code>dev</code> attribute specifies
+	the path to the host device to serve as the disk. <span class="since">Since 0.0.3</span></dd>
+      <dt><code>target</code></dt>
+      <dd>The <code>target</code> element controls the bus / device under which the
+	disk is exposed to the guest OS. The <code>dev</code> attribute indicates
+	the "logical" device name. The actual device name specified is not guaranteed to map to
+	the device name in the guest OS. Treat it as a device ordering hint.
+	The optional <code>bus</code> attribute specifies the type of disk device
+	to emulate; possible values are driver specific, with typical values being
+	"ide", "scsi", "virtio", "xen" or "usb". If omitted, the bus type is
+	inferred from the style of the device name. eg, a device named 'sda'
+	will typically be exported using a SCSI bus.
+	<span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
+        "usb" attribute value since after 0.4.4</span></dd>
+      <dt><code>driver</code></dt>
+      <dd>If the hypervisor supports multiple backend drivers, then the optional
+	<code>driver</code> element allows them to be selected. The <code>name</code>
+	attribute is the primary backend driver name, while the optional <code>type</code>
+	attribute provides the sub-type. <span class="since">Since 0.1.8</span>
+      </dd>
+    </dl>
+
+    <h4><a name="elementsUSB">USB devices</a></h4>
+
+    <p>
+      USB devices attached to the host can be passed through to the guest using
+      the <code>hostdev</code> element. <span class="since">since after 0.4.4</span>
+    </p>
+
+    <pre>
+          ...
+	  &lt;hostdev mode='subsystem' type='usb'&gt;
+	    &lt;source&gt;
+	      &lt;vendor id='0x1234'/&gt;
+	      &lt;product id='0xbeef'/&gt;
+	    &lt;/source&gt;
+	  &lt;/disk&gt;
+	  ...</pre>
+
+    <dl>
+      <dt><code>hostdev</code></dt>
+      <dd>The <code>hostdev</code> element is the main container for describing
+      host devices. For usb device passthrough <code>mode</code> is always
+      "subsystem" and <code>type</code> is "usb".
+      <dt><code>source</code></dt>
+      <dd>The source element describes the device as seen from the host.
+      The USB device can either be addressed by vendor / product id using the
+      <code>vendor</code> and <code>product</code> elements or by the device's
+      address on the hosts using the <code>address</code> element.</dd>
+      <dt><code>vendor</code>, <code>product</code></dt>
+      <dd>The <code>vendor</code> and <code>product</code> elements each have an
+      <code>id</code> attribute that specifies the USB vendor and product id.
+      The ids can be given in decimal, hexadecimal (starting with 0x) or
+      octal (starting with 0) form.</dd>
+      <dt><code>address</code></dt>
+      <dd>The <code>address</code> element has a <code>bus</code> and
+      <code>device</code> attribute to specify the USB bus and device number
+      the device appears at on the host. The values of these attributes can
+      be given in decimal, hexadecimal (starting with 0x) or octal (starting
+      with 0) form.</dd>
+    </dl>
+
+    <h4><a name="elementsNICS">Network interfaces</a></h4>
+
+    <pre>
+          ...
+	  &lt;interface type='bridge'&gt;
+	    &lt;source bridge='xenbr0'/&gt;
+	    &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
+	    &lt;script path='vif-bridge'/&gt;
+	  &lt;/interface&gt;
+	  ...</pre>
+
+    <h5><a name="elementsNICSVirtual">Virtual network</a></h5>
+
+    <p>
+      <strong><em>
+      This is the recommended config for general guest connectivity on
+      hosts with dynamic / wireless networking configs
+      </em></strong>
+    </p>
+
+    <p>
+      Provides a virtual network using a bridge device in the host.
+      Depending on the virtual network configuration, the network may be
+      totally isolated, NAT'ing to an explicit network device, or NAT'ing to
+      the default route. DHCP and DNS are provided on the virtual network in
+      all cases and the IP range can be determined by examining the virtual
+      network config with '<code>virsh net-dumpxml [networkname]</code>'.
+      There is one virtual network called 'default' setup out
+      of the box which does NAT'ing to the default route and has an IP range of
+      <code>192.168.22.0/255.255.255.0</code>. Each guest will have an
+      associated tun device created with a name of vnetN, which can also be
+      overridden with the &lt;target&gt; element.
+    </p>
+
+    <pre>
+      ...
+      &lt;interface type='network'&gt;
+        &lt;source network='default'/&gt;
+      &lt;/interface&gt;
+      ...
+      &lt;interface type='network'&gt;
+        &lt;source network='default'/&gt;
+        &lt;target dev='vnet7'/&gt;
+        &lt;mac address="11:22:33:44:55:66"/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+
+    <h5><a name="elementsNICSBridge">Bridge to to LAN</a></h5>
+
+    <p>
+      <strong><em>
+      This is the recommended config for general guest connectivity on
+      hosts with static wired networking configs
+      </em></strong>
+    </p>
+
+    <p>
+      Provides a bridge from the VM directly onto the LAN. This assumes
+      there is a bridge device on the host which has one or more of the hosts
+      physical NICs enslaved. The guest VM will have an associated tun device
+      created with a name of vnetN, which can also be overridden with the
+      &lt;target&gt; element. The tun device will be enslaved to the bridge.
+      The IP range / network configuration is whatever is used on the LAN. This
+      provides the guest VM full incoming &amp; outgoing net access just like a
+      physical machine.
+    </p>
+
+    <pre>
+      ...
+      &lt;interface type='bridge'&gt;
+        &lt;source bridge='br0'/&gt;
+      &lt;/interface&gt;
+
+      &lt;interface type='bridge'&gt;
+        &lt;source bridge='br0'/&gt;
+        &lt;target dev='vnet7'/&gt;
+        &lt;mac address="11:22:33:44:55:66"/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+
+    <h5><a name="elementsNICSSlirp">Userspace SLIRP stack</a></h5>
+
+    <p>
+      Provides a virtual LAN with NAT to the outside world. The virtual
+      network has DHCP &amp; DNS services and will give the guest VM addresses
+      starting from <code>10.0.2.15</code>. The default router will be
+      <code>10.0.2.2</code> and the DNS server will be <code>10.0.2.3</code>.
+      This networking is the only option for unprivileged users who need their
+      VMs to have outgoing access.
+    </p>
+
+    <pre>
+      ...
+      &lt;interface type='user'/&gt;
+      ...
+      &lt;interface type='user'&gt;
+        &lt;mac address="11:22:33:44:55:66"/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+
+
+    <h5><a name="elementsNICSEthernet">Generic ethernet connection</a></h5>
+
+    <p>
+      Provides a means for the administrator to execute an arbitrary script
+      to connect the guest's network to the LAN. The guest will have a tun
+      device created with a name of vnetN, which can also be overridden with the
+      &lt;target&gt; element. After creating the tun device a shell script will
+      be run which is expected to do whatever host network integration is
+      required. By default this script is called /etc/qemu-ifup but can be
+      overridden.
+    </p>
+
+    <pre>
+      ...
+      &lt;interface type='ethernet'/&gt;
+      ...
+      &lt;interface type='ethernet'&gt;
+        &lt;target dev='vnet7'/&gt;
+        &lt;script path='/etc/qemu-ifup-mynet'/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+
+    <h5><a name="elementsNICSMulticast">Multicast tunnel</a></h5>
+
+    <p>
+      A multicast group is setup to represent a virtual network. Any VMs
+      whose network devices are in the same multicast group can talk to each
+      other even across hosts. This mode is also available to unprivileged
+      users. There is no default DNS or DHCP support and no outgoing network
+      access. To provide outgoing network access, one of the VMs should have a
+      2nd NIC which is connected to one of the first 4 network types and do the
+      appropriate routing. The multicast protocol is compatible with that used
+      by user mode linux guests too. The source address used must be from the
+      multicast address block.
+    </p>
+
+    <pre>
+      ...
+      &lt;interface type='mcast'&gt;
+        &lt;source address='230.0.0.1' port='5558'/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+
+    <h5><a name="elementsNICSTCP">TCP tunnel</a></h5>
+
+    <p>
+      A TCP client/server architecture provides a virtual network. One VM
+      provides the server end of the network, all other VMS are configured as
+      clients. All network traffic is routed between the VMs via the server.
+      This mode is also available to unprivileged users. There is no default
+      DNS or DHCP support and no outgoing network access. To provide outgoing
+      network access, one of the VMs should have a 2nd NIC which is connected
+      to one of the first 4 network types and do the appropriate routing.</p>
+
+    <pre>
+      ...
+      &lt;interface type='server'&gt;
+        &lt;source address='192.168.0.1' port='5558'/&gt;
+      &lt;/interface&gt;
+      ...
+      &lt;interface type='client'&gt;
+      &lt;source address='192.168.0.1' port='5558'/&gt;
+      &lt;/interface&gt;
+      ...</pre>
+
+    <h5><a name="elementsNICSModel">Setting the NIC model</a></h5>
+
+    <pre>
+      ...
+      &lt;interface type='network'&gt;
+        &lt;source network='default'/&gt;
+        &lt;target dev='vnet1'/&gt;
+        <b>&lt;model type='ne2k_pci'/&gt;</b>
+      &lt;/interface&gt;
+      ...</pre>
+
+    <p>
+      For hypervisors which support this, you can set the model of
+      emulated network interface card.
+    </p>
+
+    <p>
+      The values for <code>type</code> aren't defined specifically by
+      libvirt, but by what the underlying hypervisor supports (if
+      any).  For QEMU and KVM you can get a list of supported models
+      with these commands:
+    </p>
+
+<pre>
+qemu -net nic,model=? /dev/null
+qemu-kvm -net nic,model=? /dev/null
+</pre>
+
+    <p>
+      Typical values for QEMU and KVM include:
+      ne2k_isa i82551 i82557b i82559er ne2k_pci pcnet rtl8139 e1000 virtio
+    </p>
+
+    <h4><a name="elementsInput">Input devices</a></h4>
+
+    <p>
+      Input devices allow interaction with the graphical framebuffer in the guest
+      virtual machine. When enabling the framebuffer, an input device is automatically
+      provided. It may be possible to add additional devices explicitly, for example,
+      to provide a graphics tablet for absolute cursor movement.
+    </p>
+
+    <pre>
+          ...
+	  &lt;input type='mouse' bus='usb'/&gt;
+	  ...</pre>
+
+    <dl>
+      <dt><code>input</code></dt>
+      <dd>The <code>input</code> element has one mandatory attribute, the <code>type</code>
+	whose value can be either 'mouse' or 'tablet'. The latter provides absolute
+	cursor movement, while the former uses relative movement. The optional
+	<code>bus</code> attribute can be used to refine the exact device type.
+	It takes values "xen" (paravirtualized), "ps2" and "usb".</dd>
+    </dl>
+
+
+    <h4><a name="elementsGraphics">Graphical framebuffers</a></h4>
+
+    <p>
+      A graphics device allows for graphical interaction with the
+      guest OS. A guest will typically have either a framebuffer
+      or a text console configured to allow interaction with the
+      admin.
+    </p>
+
+    <pre>
+          ...
+	  &lt;graphics type='vnc' port='5904'/&gt;
+	  ...</pre>
+
+    <dl>
+      <dt><code>graphics</code></dt>
+      <dd>The <code>graphics</code> element has a mandatory <code>type</code>
+	attribute which takes the value "sdl" or "vnc". The former displays
+	a window on the host desktop, while the latter activates a VNC server.
+	If the latter is used the <code>port</code> attribute specifies the TCP
+	port number (with -1 as legacy syntax indicating that it should be
+	auto-allocated). The <code>autoport</code> attribute is the new
+	preferred syntax for indicating autoallocation of the TCP port to use.
+	The <code>listen</code> attribute is an IP address for the server to
+	listen on. The <code>password</code> attribute provides a VNC password
+	in clear text.</dd>
+    </dl>
+
+    <h4><a name="elementsConsole">Consoles, serial &amp; parallel devices</a></h4>
+
+    <p>
+      A character device provides a way to interact with the virtual machine.
+      Paravirtualized consoles, serial ports and parallel ports are all
+      classed as character devices and so represented using the same syntax.
+    </p>
+
+    <pre>
+        ...
+        &lt;parallel type='pty'&gt;
+	  &lt;source path='/dev/pts/2'/&gt;
+	  &lt;target port='0'/&gt;
+        &lt;/parallel&gt;
+        &lt;serial type='pty'&gt;
+	  &lt;source path='/dev/pts/3'/&gt;
+	  &lt;target port='0'/&gt;
+        &lt;/serial&gt;
+        &lt;console type='pty'&gt;
+	  &lt;source path='/dev/pts/4'/&gt;
+	  &lt;target port='0'/&gt;
+        &lt;/console&gt;
+        &lt;/devices&gt;
+      &lt;/domain&gt;</pre>
+
+
+    <dl>
+      <dt><code>parallel</code></dt>
+      <dd>Represents a parallel port</dd>
+      <dt><code>serial</code></dt>
+      <dd>Represents a serial port</dd>
+      <dt><code>console</code></dt>
+      <dd>Represents the primary console. This can be the paravirtualized
+	console with Xen guests, or duplicates the primary serial port
+	for fully virtualized guests without a paravirtualized console.</dd>
+      <dt><code>source</code></dt>
+      <dd>The attributes available for the <code>source</code> element
+	vary according to the <code>type</code> attribute on the parent
+	tag. Allowed variations will be described below</dd>
+      <dt><code>target</code></dt>
+      <dd>The port number of the character device is specified via the
+	<code>port</code> attribute, numbered starting from 1. There is
+	usually only one console device, and 0, 1 or 2 serial devices
+	or parallel devices.
+    </dl>
+
+    <h5><a name="elementsCharSTDIO">Domain logfile</a></h5>
+
+    <p>
+      This disables all input on the character device, and sends output
+      into the virtual machine's logfile
+    </p>
+
+    <pre>
+      ...
+      &lt;console type='stdio'&gt;
+        &lt;target port='1'&gt;
+      &lt;/console&gt;
+      ...</pre>
+
+
+    <h5><a name="elementsCharFle">Device logfile</a></h5>
+
+    <p>
+      A file is opened and all data sent to the character
+      device is written to the file.
+    </p>
+
+    <pre>
+      ...
+      &lt;serial type="file"&gt;
+        &lt;source path="/var/log/vm/vm-serial.log"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+
+    <h5><a name="elementsCharVC">Virtual console</a></h5>
+
+    <p>
+      Connects the character device to the graphical framebuffer in
+      a virtual console. This is typically accessed via a special
+      hotkey sequence such as "ctrl+alt+3"
+    </p>
+
+    <pre>
+      ...
+      &lt;serial type='vc'&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+
+    <h5><a name="elementsCharNull">Null device</a></h5>
+
+    <p>
+      Connects the character device to the void. No data is ever
+      provided to the input. All data written is discarded.
+    </p>
+
+    <pre>
+      ...
+      &lt;serial type='null'&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+
+    <h5><a name="elementsCharPTY">Pseudo TTY</a></h5>
+
+    <p>
+      A Pseudo TTY is allocated using /dev/ptmx. A suitable client
+      such as 'virsh console' can connect to interact with the
+      serial port locally.
+    </p>
+
+    <pre>
+      ...
+      &lt;serial type="pty"&gt;
+        &lt;source path="/dev/pts/3"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+
+    <p>
+      NB special case if &lt;console type='pty'&gt;, then the TTY
+      path is also duplicated as an attribute tty='/dev/pts/3'
+      on the top level &lt;console&gt; tag. This provides compat
+      with existing syntax for &lt;console&gt; tags.
+    </p>
+
+    <h5><a name="elementsCharHost">Host device proxy</a></h5>
+
+    <p>
+      The character device is passed through to the underlying
+      physical character device. The device types must match,
+      eg the emulated serial port should only be connected to
+      a host serial port - don't connect a serial port to a parallel
+      port.
+    </p>
+
+    <pre>
+      ...
+      &lt;serial type="dev"&gt;
+        &lt;source path="/dev/ttyS0"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+
+    <h5><a name="elementsCharTCP">TCP client/server</a></h5>
+
+    <p>
+      The character device acts as a TCP client connecting to a
+      remote server, or as a server waiting for a client connection.
+    </p>
+
+    <pre>
+      ...
+      &lt;serial type="tcp"&gt;
+        &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
+        &lt;wiremode type="telnet"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+
+    <h5><a name="elementsCharUDP">UDP network console</a></h5>
+
+    <p>
+      The character device acts as a UDP netconsole service,
+      sending and receiving packets. This is a lossy service.
+    </p>
+
+    <pre>
+      ...
+      &lt;serial type="udp"&gt;
+        &lt;source mode="bind" host="0.0.0.0" service="2445"/&gt;
+        &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+
+    <h5><a name="elementsCharUNIX">UNIX domain socket client/server</a></h5>
+
+    <p>
+      The character device acts as a UNIX domain socket server,
+      accepting connections from local clients.
+    </p>
+
+    <pre>
+      ...
+      &lt;serial type="unix"&gt;
+        &lt;source mode="bind" path="/tmp/foo"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+
+    <h2><a name="examples">Example configs</a></h2>
+
+    <p>
+      Example configurations for each driver are provide on the
+      driver specific pages listed below
+    </p>
+
+    <ul>
+      <li><a href="drvxen.html#xmlconfig">Xen examples</a></li>
+      <li><a href="drvqemu.html#xmlconfig">QEMU/KVM examples</a></li>
+    </ul>
+  </body>
+</html>

docs/formatnetwork.html

@@ -0,0 +1,310 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from formatnetwork.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Network XML format</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="active" href="format.html">XML format</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Networks</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Network XML format</h1>
+        <ul><li>
+            <a href="#elements">Element and attribute overview</a>
+            <ul><li>
+                <a href="#elementsMetadata">General metadata</a>
+              </li><li>
+                <a href="#elementsConnect">Connectivity</a>
+              </li><li>
+                <a href="#elementsAddress">Addressing</a>
+              </li></ul>
+          </li><li>
+            <a href="#examples">Example configuration</a>
+            <ul><li>
+                <a href="#examplesNAT">NAT based network</a>
+              </li><li>
+                <a href="#examplesRoute">Routed network config</a>
+              </li><li>
+                <a href="#examplesPrivate">Isolated network config</a>
+              </li></ul>
+          </li></ul>
+        <p>
+      This page provides an introduction to the network XML format. For background
+      information on the concepts referred to here, consult the <a href="archnetwork.html">network driver architecture</a>
+      page.
+    </p>
+        <h2>
+          <a name="elements" id="elements">Element and attribute overview</a>
+        </h2>
+        <p>
+      The root element required for all virtual networks is
+      named <code>network</code> and has no attributes.
+      The network XML format is available <span class="since">since 0.3.0</span>
+    </p>
+        <h3>
+          <a name="elementsMetadata" id="elementsMetadata">General metadata</a>
+        </h3>
+        <p>
+      The first elements provide basic metadata about the virtual
+      network.
+    </p>
+        <pre>
+      &lt;network&gt;
+        &lt;name&gt;default&lt;/name&gt;
+        &lt;uuid&gt;3e3fce45-4f53-4fa7-bb32-11f34168b82b&lt;/uuid&gt;
+        ...</pre>
+        <dl><dt><code>name</code></dt><dd>The content of the <code>name</code> element provides
+	a short name for the virtual network. This name should
+	consist only of alpha-numeric characters and is required
+	to be unique within the scope of a single host. It is
+	used to form the filename for storing the persistent
+	configuration file. <span class="since">Since 0.3.0</span></dd><dt><code>uuid</code></dt><dd>The content of the <code>uuid</code> element provides
+	a globally unique identifier for the virtual network.
+	The format must be RFC 4122 compliant, eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
+	If omitted when defining/creating a new network, a random
+	UUID is generated. <span class="since">Since 0.3.0</span></dd></dl>
+        <h3>
+          <a name="elementsConnect" id="elementsConnect">Connectivity</a>
+        </h3>
+        <p>
+      The next set of elements control how a virtual network is
+      provided connectivity to the physical LAN (if at all).
+    </p>
+        <pre>
+        ...
+        &lt;bridge name="virbr0" /&gt;
+	&lt;forward mode="nat" dev="eth0"/&gt;
+	...</pre>
+        <dl><dt><code>bridge</code></dt><dd>The <code>name</code> attribute on the <code>bridge</code> element
+	defines the name of a bridge device which will be used to construct
+	the virtual network. The virtual machines will be connected to this
+	bridge device allowing them to talk to each other. The bridge device
+	may also be connected to the LAN. It is recommended that bridge
+	device names started with the prefix <code>vir</code>, but the name
+	<code>virbr0</code> is reserved for the "default" virtual network.
+	This element should always be provided when defining a new network.
+	<span class="since">Since 0.3.0</span>
+      </dd><dt><code>forward</code></dt><dd>Inclusion of the <code>forward</code> element indicates that
+	the virtual network is to be connected to the physical LAN. If
+	no attributes are set, NAT forwarding will be used for connectivity.
+	Firewall rules will allow forwarding to any other network device whether
+	ethernet, wireless, dialup, or VPN. If the <code>dev</code> attribute
+	is set, the firewall rules will restrict forwarding to the named
+	device only. If the <code>mode</code> attribute is set to <code>route</code>
+	then the traffic will not have NAT applied. This presumes that the
+	local LAN router has suitable routing table entries to return traffic
+	to this host. <span class="since">Since 0.3.0; 'mode' attribute since
+        0.4.2</span></dd></dl>
+        <h3>
+          <a name="elementsAddress" id="elementsAddress">Addressing</a>
+        </h3>
+        <p>
+      The final set of elements define the IPv4 address range available,
+      and optionally enable DHCP sevices.
+    </p>
+        <pre>
+        ...
+	&lt;ip address="192.168.122.1" netmask="255.255.255.0"&gt;
+	  &lt;dhcp&gt;
+	    &lt;range start="192.168.122.2" end="192.168.122.254" /&gt;
+	  &lt;/dhcp&gt;
+	&lt;/ip&gt;
+      &lt;/network&gt;</pre>
+        <dl><dt><code>ip</code></dt><dd>The <code>address</code> attribute defines an IPv4 address in
+	dotted-decimal format, that will be configured on the bridge
+	device associated with the virtual network. To the guests this
+	address will be their default route. The <code>netmask</code>
+	attribute defines the significant bits of the network address,
+	again specified in dotted-decimal format.  <span class="since">Since 0.3.0</span>
+      </dd><dt><code>dhcp</code></dt><dd>Immediately within the <code>ip</code> element there is an
+	optional <code>dhcp</code> element. The presence of this element
+	enables DHCP services on the virtual network. It will further
+	contain one or more <code>range</code> elements.
+	<span class="since">Since 0.3.0</span>
+      </dd><dt><code>range</code></dt><dd>The <code>start</code> and <code>end</code> attributes on the
+	<code>range</code> element specify the boundaries of a pool of
+	IPv4 addresses to be provided to DHCP clients. These two addresses
+	must lie within the scope of the network defined on the parent
+	<code>ip</code> element.  <span class="since">Since 0.3.0</span>
+      </dd></dl>
+        <h2>
+          <a name="examples" id="examples">Example configuration</a>
+        </h2>
+        <h3>
+          <a name="examplesNAT" id="examplesNAT">NAT based network</a>
+        </h3>
+        <p>
+      This example is the so called "default" virtual network. It is
+      provided and enabled out-of-the-box for all libvirt installations.
+      This is a configuration that allows guest OS to get outbound
+      connectivity regardless of whether the host uses ethernet, wireless,
+      dialup, or VPN networking without requiring any specific admin
+      configuration. In the absence of host networking, it at least allows
+      guests to talk directly to each other.
+    </p>
+        <pre>
+      &lt;network&gt;
+	&lt;name&gt;default&lt;/name&gt;
+	&lt;bridge name="virbr0" /&gt;
+	&lt;forward mode="nat"/&gt;
+	&lt;ip address="192.168.122.1" netmask="255.255.255.0"&gt;
+	  &lt;dhcp&gt;
+	    &lt;range start="192.168.122.2" end="192.168.122.254" /&gt;
+	  &lt;/dhcp&gt;
+	&lt;/ip&gt;
+      &lt;/network&gt;</pre>
+        <h3>
+          <a name="examplesRoute" id="examplesRoute">Routed network config</a>
+        </h3>
+        <p>
+      This is a variant on the default network which routes traffic
+      from the virtual network to the LAN without applying any NAT.
+      It requires that the IP address range be pre-configured in the
+      routing tables of the router on the host network. This example
+      further specifies that guest traffic may only go out via the
+      <code>eth1</code> host network device.
+    </p>
+        <pre>
+      &lt;network&gt;
+	&lt;name&gt;local&lt;/name&gt;
+	&lt;bridge name="virbr1" /&gt;
+	&lt;forward mode="route" dev="eth1"/&gt;
+	&lt;ip address="192.168.122.1" netmask="255.255.255.0"&gt;
+	  &lt;dhcp&gt;
+	    &lt;range start="192.168.122.2" end="192.168.122.254" /&gt;
+	  &lt;/dhcp&gt;
+	&lt;/ip&gt;
+      &lt;/network&gt;</pre>
+        <h3>
+          <a name="examplesPrivate" id="examplesPrivate">Isolated network config</a>
+        </h3>
+        <p>
+      This variant provides a completely isolated private network
+      for guests. The guests can talk to each other, and the host
+      OS, but cannot reach any other machines on the LAN, due to
+      the omission of the <code>forward</code> element in the XML
+      description.
+    </p>
+        <pre>
+      &lt;network&gt;
+	&lt;name&gt;private&lt;/name&gt;
+	&lt;bridge name="virbr2" /&gt;
+	&lt;ip address="192.168.152.1" netmask="255.255.255.0"&gt;
+	  &lt;dhcp&gt;
+	    &lt;range start="192.168.152.2" end="192.168.152.254" /&gt;
+	  &lt;/dhcp&gt;
+	&lt;/ip&gt;
+      &lt;/network&gt;</pre>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/formatnetwork.html.in

@@ -0,0 +1,202 @@
+<html>
+  <body>
+    <h1>Network XML format</h1>
+
+    <ul id="toc">
+    </ul>
+
+    <p>
+      This page provides an introduction to the network XML format. For background
+      information on the concepts referred to here, consult the <a href="archnetwork.html">network driver architecture</a>
+      page.
+    </p>
+
+    <h2><a name="elements">Element and attribute overview</a></h2>
+
+    <p>
+      The root element required for all virtual networks is
+      named <code>network</code> and has no attributes.
+      The network XML format is available <span class="since">since 0.3.0</span>
+    </p>
+
+    <h3><a name="elementsMetadata">General metadata</a></h3>
+
+    <p>
+      The first elements provide basic metadata about the virtual
+      network.
+    </p>
+
+    <pre>
+      &lt;network&gt;
+        &lt;name&gt;default&lt;/name&gt;
+        &lt;uuid&gt;3e3fce45-4f53-4fa7-bb32-11f34168b82b&lt;/uuid&gt;
+        ...</pre>
+
+    <dl>
+      <dt><code>name</code></dt>
+      <dd>The content of the <code>name</code> element provides
+	a short name for the virtual network. This name should
+	consist only of alpha-numeric characters and is required
+	to be unique within the scope of a single host. It is
+	used to form the filename for storing the persistent
+	configuration file. <span class="since">Since 0.3.0</span></dd>
+      <dt><code>uuid</code></dt>
+      <dd>The content of the <code>uuid</code> element provides
+	a globally unique identifier for the virtual network.
+	The format must be RFC 4122 compliant, eg <code>3e3fce45-4f53-4fa7-bb32-11f34168b82b</code>.
+	If omitted when defining/creating a new network, a random
+	UUID is generated. <span class="since">Since 0.3.0</span></dd>
+    </dl>
+
+    <h3><a name="elementsConnect">Connectivity</a></h3>
+
+    <p>
+      The next set of elements control how a virtual network is
+      provided connectivity to the physical LAN (if at all).
+    </p>
+
+    <pre>
+        ...
+        &lt;bridge name="virbr0" /&gt;
+	&lt;forward mode="nat" dev="eth0"/&gt;
+	...</pre>
+
+    <dl>
+      <dt><code>bridge</code></dt>
+      <dd>The <code>name</code> attribute on the <code>bridge</code> element
+	defines the name of a bridge device which will be used to construct
+	the virtual network. The virtual machines will be connected to this
+	bridge device allowing them to talk to each other. The bridge device
+	may also be connected to the LAN. It is recommended that bridge
+	device names started with the prefix <code>vir</code>, but the name
+	<code>virbr0</code> is reserved for the "default" virtual network.
+	This element should always be provided when defining a new network.
+	<span class="since">Since 0.3.0</span>
+      </dd>
+      <dt><code>forward</code></dt>
+      <dd>Inclusion of the <code>forward</code> element indicates that
+	the virtual network is to be connected to the physical LAN. If
+	no attributes are set, NAT forwarding will be used for connectivity.
+	Firewall rules will allow forwarding to any other network device whether
+	ethernet, wireless, dialup, or VPN. If the <code>dev</code> attribute
+	is set, the firewall rules will restrict forwarding to the named
+	device only. If the <code>mode</code> attribute is set to <code>route</code>
+	then the traffic will not have NAT applied. This presumes that the
+	local LAN router has suitable routing table entries to return traffic
+	to this host. <span class="since">Since 0.3.0; 'mode' attribute since
+        0.4.2</span></dd>
+    </dl>
+
+    <h3><a name="elementsAddress">Addressing</a></h3>
+
+    <p>
+      The final set of elements define the IPv4 address range available,
+      and optionally enable DHCP sevices.
+    </p>
+
+    <pre>
+        ...
+	&lt;ip address="192.168.122.1" netmask="255.255.255.0"&gt;
+	  &lt;dhcp&gt;
+	    &lt;range start="192.168.122.2" end="192.168.122.254" /&gt;
+	  &lt;/dhcp&gt;
+	&lt;/ip&gt;
+      &lt;/network&gt;</pre>
+
+    <dl>
+      <dt><code>ip</code></dt>
+      <dd>The <code>address</code> attribute defines an IPv4 address in
+	dotted-decimal format, that will be configured on the bridge
+	device associated with the virtual network. To the guests this
+	address will be their default route. The <code>netmask</code>
+	attribute defines the significant bits of the network address,
+	again specified in dotted-decimal format.  <span class="since">Since 0.3.0</span>
+      </dd>
+      <dt><code>dhcp</code></dt>
+      <dd>Immediately within the <code>ip</code> element there is an
+	optional <code>dhcp</code> element. The presence of this element
+	enables DHCP services on the virtual network. It will further
+	contain one or more <code>range</code> elements.
+	<span class="since">Since 0.3.0</span>
+      </dd>
+      <dt><code>range</code></dt>
+      <dd>The <code>start</code> and <code>end</code> attributes on the
+	<code>range</code> element specify the boundaries of a pool of
+	IPv4 addresses to be provided to DHCP clients. These two addresses
+	must lie within the scope of the network defined on the parent
+	<code>ip</code> element.  <span class="since">Since 0.3.0</span>
+      </dd>
+    </dl>
+
+    <h2><a name="examples">Example configuration</a></h2>
+
+    <h3><a name="examplesNAT">NAT based network</a></h3>
+
+    <p>
+      This example is the so called "default" virtual network. It is
+      provided and enabled out-of-the-box for all libvirt installations.
+      This is a configuration that allows guest OS to get outbound
+      connectivity regardless of whether the host uses ethernet, wireless,
+      dialup, or VPN networking without requiring any specific admin
+      configuration. In the absence of host networking, it at least allows
+      guests to talk directly to each other.
+    </p>
+
+    <pre>
+      &lt;network&gt;
+	&lt;name&gt;default&lt;/name&gt;
+	&lt;bridge name="virbr0" /&gt;
+	&lt;forward mode="nat"/&gt;
+	&lt;ip address="192.168.122.1" netmask="255.255.255.0"&gt;
+	  &lt;dhcp&gt;
+	    &lt;range start="192.168.122.2" end="192.168.122.254" /&gt;
+	  &lt;/dhcp&gt;
+	&lt;/ip&gt;
+      &lt;/network&gt;</pre>
+
+    <h3><a name="examplesRoute">Routed network config</a></h3>
+
+    <p>
+      This is a variant on the default network which routes traffic
+      from the virtual network to the LAN without applying any NAT.
+      It requires that the IP address range be pre-configured in the
+      routing tables of the router on the host network. This example
+      further specifies that guest traffic may only go out via the
+      <code>eth1</code> host network device.
+    </p>
+
+    <pre>
+      &lt;network&gt;
+	&lt;name&gt;local&lt;/name&gt;
+	&lt;bridge name="virbr1" /&gt;
+	&lt;forward mode="route" dev="eth1"/&gt;
+	&lt;ip address="192.168.122.1" netmask="255.255.255.0"&gt;
+	  &lt;dhcp&gt;
+	    &lt;range start="192.168.122.2" end="192.168.122.254" /&gt;
+	  &lt;/dhcp&gt;
+	&lt;/ip&gt;
+      &lt;/network&gt;</pre>
+
+    <h3><a name="examplesPrivate">Isolated network config</a></h3>
+
+    <p>
+      This variant provides a completely isolated private network
+      for guests. The guests can talk to each other, and the host
+      OS, but cannot reach any other machines on the LAN, due to
+      the omission of the <code>forward</code> element in the XML
+      description.
+    </p>
+
+    <pre>
+      &lt;network&gt;
+	&lt;name&gt;private&lt;/name&gt;
+	&lt;bridge name="virbr2" /&gt;
+	&lt;ip address="192.168.152.1" netmask="255.255.255.0"&gt;
+	  &lt;dhcp&gt;
+	    &lt;range start="192.168.152.2" end="192.168.152.254" /&gt;
+	  &lt;/dhcp&gt;
+	&lt;/ip&gt;
+      &lt;/network&gt;</pre>
+
+  </body>
+</html>

docs/formatnode.html

@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from formatnode.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Node devices XML format</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="active" href="format.html">XML format</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The storage pool and volume XML format" class="inactive" href="formatstorage.html">Storage</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Node Devices</span>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Node devices XML format</h1>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/formatnode.html.in

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <h1>Node devices XML format</h1>
+  </body>
+</html>

docs/formatstorage.html

@@ -0,0 +1,415 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<!--
+        This file is autogenerated from formatstorage.html.in
+        Do not edit this file. Changes will be lost.
+      -->
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: Storage pool and volume XML format</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
+  </head>
+  <body>
+    <div id="header">
+      <div id="headerLogo"></div>
+      <div id="headerSearch">
+        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
+            <input id="query" name="query" type="text" size="12" value="" />
+            <input id="submit" name="submit" type="submit" value="Search" />
+          </div></form>
+      </div>
+    </div>
+    <div id="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
+              <ul class="l1"><li>
+                  <div>
+                    <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Description of the XML formats used in libvirt" class="active" href="format.html">XML format</a>
+                    <ul class="l2"><li>
+                        <div>
+                          <a title="The domain XML format" class="inactive" href="formatdomain.html">Domains</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The virtual network XML format" class="inactive" href="formatnetwork.html">Networks</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <span class="active">Storage</span>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The driver capabilities XML format" class="inactive" href="formatcaps.html">Capabilities</a>
+                        </div>
+                      </li><li>
+                        <div>
+                          <a title="The host device XML format" class="inactive" href="formatnode.html">Node Devices</a>
+                        </div>
+                      </li></ul>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Hypervisor specific driver information" class="inactive" href="drivers.html">Drivers</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
+                  </div>
+                </li><li>
+                  <div>
+                    <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
+                  </div>
+                </li></ul>
+            </div>
+          </li><li>
+            <div>
+              <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
+            </div>
+          </li><li>
+            <div>
+              <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
+            </div>
+          </li></ul>
+      </div>
+      <div id="content">
+        <h1>Storage pool and volume XML format</h1>
+        <ul><li>
+            <a href="#StoragePool">Storage pool XML</a>
+            <ul><li>
+                <a href="#StoragePoolFirst">General metadata</a>
+              </li><li>
+                <a href="#StoragePoolSource">Source elements</a>
+              </li><li>
+                <a href="#StoragePoolTarget">Target elements</a>
+              </li><li>
+                <a href="#StoragePoolExtents">Device extents</a>
+              </li></ul>
+          </li><li>
+            <a href="#StorageVol">Storage volume XML</a>
+            <ul><li>
+                <a href="#StorageVolFirst">General metadata</a>
+              </li><li>
+                <a href="#StorageVolTarget">Target elements</a>
+              </li></ul>
+          </li><li>
+            <a href="#examples">Example configuration</a>
+            <ul><li>
+                <a href="#exampleFile">File based storage pool</a>
+              </li><li>
+                <a href="#exampleISCSI">iSCSI based storage pool</a>
+              </li><li>
+                <a href="#exampleVol">Storage volume</a>
+              </li></ul>
+          </li></ul>
+        <h2>
+          <a name="StoragePool" id="StoragePool">Storage pool XML</a>
+        </h2>
+        <p>
+      Although all storage pool backends share the same public APIs and
+      XML format, they have varying levels of capabilities. Some may
+      allow creation of volumes, others may only allow use of pre-existing
+      volumes. Some may have constraints on volume size, or placement.
+    </p>
+        <p>
+      The is the top level tag for a storage pool document is 'pool'. It has
+      a single attribute <code>type</code>, which is one of <code>dir</code>,
+      <code>fs</code>,<code>netfs</code>,<code>disk</code>,<code>iscsi</code>,
+      <code>logical</code>. This corresponds to the storage backend drivers
+      listed further along in this document.
+      The storage pool XML format is available <span class="since">since 0.4.1</span>
+    </p>
+        <h3>
+          <a name="StoragePoolFirst" id="StoragePoolFirst">General metadata</a>
+        </h3>
+        <pre>
+      &lt;pool type="iscsi"&gt;
+        &lt;name&gt;virtimages&lt;/name&gt;
+        &lt;uuid&gt;3e3fce45-4f53-4fa7-bb32-11f34168b82b&lt;/uuid&gt;
+        &lt;allocation&gt;10000000&lt;/allocation&gt;
+        &lt;capacity&gt;50000000&lt;/capacity&gt;
+        &lt;available&gt;40000000&lt;/available&gt;
+        ...</pre>
+        <dl><dt><code>name</code></dt><dd>Providing a name for the pool which is unique to the host.
+	This is mandatory when defining a pool. <span class="since">Since 0.4.1</span></dd><dt><code>uuid</code></dt><dd>Providing an identifier for the pool which is globally unique.
+	This is optional when defining a pool, a UUID will be generated if
+	omitted. <span class="since">Since 0.4.1</span></dd><dt><code>allocation</code></dt><dd>Providing the total storage allocation for the pool. This may
+	be larger than the sum of the allocation of all volumes due to
+	metadata overhead. This value is in bytes. This is not applicable
+	when creating a pool. <span class="since">Since 0.4.1</span></dd><dt><code>capacity</code></dt><dd>Providing the total storage capacity for the pool. Due to
+	underlying device constraints it may not be possible to use the
+	full capacity for storage volumes. This value is in bytes. This
+	is not applicable when creating a pool. <span class="since">Since 0.4.1</span></dd><dt><code>available</code></dt><dd>Providing the free space available for allocating new volumes
+	in the pool. Due to underlying device constraints it may not be
+	possible to allocate the entire free space to a single volume.
+	This value is in bytes. This is not applicable when creating a
+	pool. <span class="since">Since 0.4.1</span></dd></dl>
+        <h3>
+          <a name="StoragePoolSource" id="StoragePoolSource">Source elements</a>
+        </h3>
+        <p>
+      A single <code>source</code> element is contained within the top level
+      <code>pool</code> element. This tag is used to describe the source of
+      the storage pool. It can contain the following child elements:
+    </p>
+        <pre>
+        ...
+        &lt;source&gt;
+          &lt;host name="iscsi.example.com"/&gt;
+          &lt;device path="demo-target"/&gt;
+        &lt;/source&gt;
+	...</pre>
+        <dl><dt><code>device</code></dt><dd>Provides the source for pools backed by physical devices.
+	May be repeated multiple times depending on backend driver. Contains
+	a single attribute <code>path</code> which is the fully qualified
+	path to the block device node. <span class="since">Since 0.4.1</span></dd><dt><code>directory</code></dt><dd>Provides the source for pools backed by directories. May
+	only occur once. Contains a single attribute <code>path</code>
+	which is the fully qualified path to the block device node.
+	<span class="since">Since 0.4.1</span></dd><dt><code>host</code></dt><dd>Provides the source for pools backed by storage from a
+	remote server. Will be used in combination with a <code>directory</code>
+	or <code>device</code> element. Contains an attribute <code>name</code>
+	which is the hostname or IP address of the server. May optionally
+	contain a <code>port</code> attribute for the protocol specific
+	port number. <span class="since">Since 0.4.1</span></dd><dt><code>name</code></dt><dd>Provides the source for pools backed by storage from a
+	named element (e.g., a logical volume group name).
+	remote server. Contains a string identifier.
+	<span class="since">Since 0.4.5</span></dd><dt><code>format</code></dt><dd>Provides information about the format of the pool. This
+	contains a single attribute <code>type</code> whose value is
+	backend specific. This is typically used to indicate filesystem
+	type, or network filesystem type, or partition table type, or
+	LVM metadata type. All drivers are required to have a default
+	value for this, so it is optional. <span class="since">Since 0.4.1</span></dd></dl>
+        <h3>
+          <a name="StoragePoolTarget" id="StoragePoolTarget">Target elements</a>
+        </h3>
+        <p>
+      A single <code>target</code> element is contained within the top level
+      <code>pool</code> element. This tag is used to describe the mapping of
+      the storage pool into the host filesystem. It can contain the following
+      child elements:
+    </p>
+        <pre>
+        ...
+        &lt;target&gt;
+          &lt;path&gt;/dev/disk/by-path&lt;/path&gt;
+          &lt;permissions&gt;
+            &lt;owner&gt;0744&lt;/owner&gt;
+            &lt;group&gt;0744&lt;/group&gt;
+            &lt;mode&gt;0744&lt;/mode&gt;
+            &lt;label&gt;virt_image_t&lt;/label&gt;
+          &lt;/permissions&gt;
+        &lt;/target&gt;
+      &lt;/pool&gt;</pre>
+        <dl><dt><code>path</code></dt><dd>Provides the location at which the pool will be mapped into
+	the local filesystem namespace. For a filesystem/directory based
+	pool it will be the name of the directory in which volumes will
+	be created. For device based pools it will be the name of the directory in which
+	devices nodes exist. For the latter <code>/dev/</code> may seem
+	like the logical choice, however, devices nodes there are not
+	guaranteed stable across reboots, since they are allocated on
+	demand. It is preferable to use a stable location such as one
+	of the <code>/dev/disk/by-{path,id,uuid,label</code> locations.
+	<span class="since">Since 0.4.1</span>
+      </dd><dt><code>permissions</code></dt><dd>Provides information about the default permissions to use
+	when creating volumes. This is currently only useful for directory
+	or filesystem based pools, where the volumes allocated are simple
+	files. For pools where the volumes are device nodes, the hotplug
+	scripts determine permissions. It contains 4 child elements. The
+	<code>mode</code> element contains the octal permission set. The
+	<code>owner</code> element contains the numeric user ID. The <code>group</code>
+	element contains the numeric group ID. The <code>label</code> element
+	contains the MAC (eg SELinux) label string.
+	<span class="since">Since 0.4.1</span>
+      </dd></dl>
+        <h3>
+          <a name="StoragePoolExtents" id="StoragePoolExtents">Device extents</a>
+        </h3>
+        <p>
+      If a storage pool exposes information about its underlying
+      placement / allocation scheme, the <code>device</code> element
+      within the <code>source</code> element may contain information
+      about its available extents. Some pools have a constraint that
+      a volume must be allocated entirely within a single constraint
+      (eg disk partition pools). Thus the extent information allows an
+      application to determine the maximum possible size for a new
+      volume
+    </p>
+        <p>
+      For storage pools supporting extent information, within each
+      <code>device</code> element there will be zero or more <code>freeExtent</code>
+      elements. Each of these elements contains two attributes, <code>start</code>
+      and <code>end</code> which provide the boundaries of the extent on the
+      device, measured in bytes.  <span class="since">Since 0.4.1</span>
+    </p>
+        <h2>
+          <a name="StorageVol" id="StorageVol">Storage volume XML</a>
+        </h2>
+        <p>
+      A storage volume will be either a file or a device node.
+      The storage volume XML format is available <span class="since">since 0.4.1</span>
+    </p>
+        <h3>
+          <a name="StorageVolFirst" id="StorageVolFirst">General metadata</a>
+        </h3>
+        <pre>
+      &lt;volume type="file"&gt;
+	&lt;name&gt;sparse.img&lt;/name&gt;
+	&lt;key&gt;/var/lib/xen/images/sparse.img&lt;/key&gt;
+        &lt;allocation&gt;0&lt;/allocation&gt;
+	&lt;capacity unit="T"&gt;1&lt;/capacity&gt;
+        ...</pre>
+        <dl><dt><code>name</code></dt><dd>Providing a name for the volume which is unique to the pool.
+	This is mandatory when defining a volume.  <span class="since">Since 0.4.1</span></dd><dt><code>key</code></dt><dd>Providing an identifier for the volume which is globally unique.
+	This is optional when defining a volume, a key will be generated if
+	omitted. <span class="since">Since 0.4.1</span></dd><dt><code>allocation</code></dt><dd>Providing the total storage allocation for the volume. This
+	may be smaller than the logical capacity if the volume is sparsely
+	allocated. It may also be larger than the logical capacity if the
+	volume has substantial metadata overhead. This value is in bytes.
+	If omitted when creating a volume, the volume will be fully
+	allocated at time of creation. If set to a value smaller than the
+	capacity, the pool has the <strong>option</strong> of deciding
+	to sparsely allocate a volume. It does not have to honour requests
+	for sparse allocation though. <span class="since">Since 0.4.1</span></dd><dt><code>capacity</code></dt><dd>Providing the logical capacity for the volume. This value is
+	in bytes. This is compulsory when creating a volume.
+	<span class="since">Since 0.4.1</span></dd><dt><code>source</code></dt><dd>Provides information about the underlying storage allocation
+	of the volume. This may not be available for some pool types.
+	<span class="since">Since 0.4.1</span></dd><dt><code>target</code></dt><dd>Provides information about the representation of the volume
+	on the local host. <span class="since">Since 0.4.1</span></dd></dl>
+        <h3>
+          <a name="StorageVolTarget" id="StorageVolTarget">Target elements</a>
+        </h3>
+        <p>
+      A single <code>target</code> element is contained within the top level
+      <code>volume</code> element. This tag is used to describe the mapping of
+      the storage volume into the host filesystem. It can contain the following
+      child elements:
+    </p>
+        <pre>
+        ...
+	&lt;target&gt;
+          &lt;path&gt;/var/lib/virt/images/sparse.img&lt;/path&gt;
+          &lt;permissions&gt;
+            &lt;owner&gt;0744&lt;/owner&gt;
+            &lt;group&gt;0744&lt;/group&gt;
+            &lt;mode&gt;0744&lt;/mode&gt;
+            &lt;label&gt;virt_image_t&lt;/label&gt;
+          &lt;/permissions&gt;
+	&lt;/target&gt;
+      &lt;/volume&gt;</pre>
+        <dl><dt><code>path</code></dt><dd>Provides the location at which the volume can be accessed on
+	the local filesystem, as an absolute path. This is a readonly
+	attribute, so shouldn't be specified when creating a volume.
+	<span class="since">Since 0.4.1</span></dd><dt><code>format</code></dt><dd>Provides information about the pool specific volume format.
+	For disk pools it will provide the partition type. For filesystem
+	or directory pools it will provide the file format type, eg cow,
+	qcow, vmdk, raw. If omitted when creating a volume, the pool's
+	default format will be used. The actual format is specified via
+	the <code>type</code>. Consult the pool-specific docs for the
+	list of valid values. <span class="since">Since 0.4.1</span></dd><dt><code>permissions</code></dt><dd>Provides information about the default permissions to use
+	when creating volumes. This is currently only useful for directory
+	or filesystem based pools, where the volumes allocated are simple
+	files. For pools where the volumes are device nodes, the hotplug
+	scripts determine permissions. It contains 4 child elements. The
+	<code>mode</code> element contains the octal permission set. The
+	<code>owner</code> element contains the numeric user ID. The <code>group</code>
+	element contains the numeric group ID. The <code>label</code> element
+	contains the MAC (eg SELinux) label string.
+	<span class="since">Since 0.4.1</span>
+      </dd></dl>
+        <h2>
+          <a name="examples" id="examples">Example configuration</a>
+        </h2>
+        <p>
+      Here are a couple of examples, for a more complete set demonstrating
+      every type of storage pool, consult the <a href="storage.html">storage driver page</a>
+    </p>
+        <h3>
+          <a name="exampleFile" id="exampleFile">File based storage pool</a>
+        </h3>
+        <pre>
+      &lt;pool type="dir"&gt;
+        &lt;name&gt;virtimages&lt;/name&gt;
+        &lt;target&gt;
+          &lt;path&gt;/var/lib/virt/images&lt;/path&gt;
+        &lt;/target&gt;
+      &lt;/pool&gt;</pre>
+        <h3>
+          <a name="exampleISCSI" id="exampleISCSI">iSCSI based storage pool</a>
+        </h3>
+        <pre>
+      &lt;pool type="iscsi"&gt;
+        &lt;name&gt;virtimages&lt;/name&gt;
+        &lt;source&gt;
+          &lt;host name="iscsi.example.com"/&gt;
+          &lt;device path="demo-target"/&gt;
+        &lt;/source&gt;
+        &lt;target&gt;
+          &lt;path&gt;/dev/disk/by-path&lt;/path&gt;
+        &lt;/target&gt;
+      &lt;/pool&gt;</pre>
+        <h3>
+          <a name="exampleVol" id="exampleVol">Storage volume</a>
+        </h3>
+        <pre>
+      &lt;volume type="file"&gt;
+	&lt;name&gt;sparse.img&lt;/name&gt;
+	&lt;allocation&gt;0&lt;/allocation&gt;
+	&lt;capacity unit="T"&gt;1&lt;/capacity&gt;
+	&lt;target&gt;
+          &lt;path&gt;/var/lib/virt/images/sparse.img&lt;/path&gt;
+          &lt;permissions&gt;
+            &lt;owner&gt;0744&lt;/owner&gt;
+            &lt;group&gt;0744&lt;/group&gt;
+            &lt;mode&gt;0744&lt;/mode&gt;
+            &lt;label&gt;virt_image_t&lt;/label&gt;
+          &lt;/permissions&gt;
+	&lt;/target&gt;
+      &lt;/volume&gt;</pre>
+      </div>
+    </div>
+    <div id="footer">
+      <p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
+    </div>
+  </body>
+</html>

docs/formatstorage.html.in

@@ -0,0 +1,323 @@
+<html>
+  <body>
+    <h1>Storage pool and volume XML format</h1>
+
+    <ul id="toc"></ul>
+
+    <h2><a name="StoragePool">Storage pool XML</a></h2>
+
+    <p>
+      Although all storage pool backends share the same public APIs and
+      XML format, they have varying levels of capabilities. Some may
+      allow creation of volumes, others may only allow use of pre-existing
+      volumes. Some may have constraints on volume size, or placement.
+    </p>
+    <p>
+      The is the top level tag for a storage pool document is 'pool'. It has
+      a single attribute <code>type</code>, which is one of <code>dir</code>,
+      <code>fs</code>,<code>netfs</code>,<code>disk</code>,<code>iscsi</code>,
+      <code>logical</code>. This corresponds to the storage backend drivers
+      listed further along in this document.
+      The storage pool XML format is available <span class="since">since 0.4.1</span>
+    </p>
+    <h3><a name="StoragePoolFirst">General metadata</a></h3>
+
+    <pre>
+      &lt;pool type="iscsi"&gt;
+        &lt;name&gt;virtimages&lt;/name&gt;
+        &lt;uuid&gt;3e3fce45-4f53-4fa7-bb32-11f34168b82b&lt;/uuid&gt;
+        &lt;allocation&gt;10000000&lt;/allocation&gt;
+        &lt;capacity&gt;50000000&lt;/capacity&gt;
+        &lt;available&gt;40000000&lt;/available&gt;
+        ...</pre>
+
+    <dl>
+      <dt><code>name</code></dt>
+      <dd>Providing a name for the pool which is unique to the host.
+	This is mandatory when defining a pool. <span class="since">Since 0.4.1</span></dd>
+      <dt><code>uuid</code></dt>
+      <dd>Providing an identifier for the pool which is globally unique.
+	This is optional when defining a pool, a UUID will be generated if
+	omitted. <span class="since">Since 0.4.1</span></dd>
+      <dt><code>allocation</code></dt>
+      <dd>Providing the total storage allocation for the pool. This may
+	be larger than the sum of the allocation of all volumes due to
+	metadata overhead. This value is in bytes. This is not applicable
+	when creating a pool. <span class="since">Since 0.4.1</span></dd>
+      <dt><code>capacity</code></dt>
+      <dd>Providing the total storage capacity for the pool. Due to
+	underlying device constraints it may not be possible to use the
+	full capacity for storage volumes. This value is in bytes. This
+	is not applicable when creating a pool. <span class="since">Since 0.4.1</span></dd>
+      <dt><code>available</code></dt>
+      <dd>Providing the free space available for allocating new volumes
+	in the pool. Due to underlying device constraints it may not be
+	possible to allocate the entire free space to a single volume.
+	This value is in bytes. This is not applicable when creating a
+	pool. <span class="since">Since 0.4.1</span></dd>
+    </dl>
+
+    <h3><a name="StoragePoolSource">Source elements</a></h3>
+
+    <p>
+      A single <code>source</code> element is contained within the top level
+      <code>pool</code> element. This tag is used to describe the source of
+      the storage pool. It can contain the following child elements:
+    </p>
+
+    <pre>
+        ...
+        &lt;source&gt;
+          &lt;host name="iscsi.example.com"/&gt;
+          &lt;device path="demo-target"/&gt;
+        &lt;/source&gt;
+	...</pre>
+
+    <dl>
+      <dt><code>device</code></dt>
+      <dd>Provides the source for pools backed by physical devices.
+	May be repeated multiple times depending on backend driver. Contains
+	a single attribute <code>path</code> which is the fully qualified
+	path to the block device node. <span class="since">Since 0.4.1</span></dd>
+      <dt><code>directory</code></dt>
+      <dd>Provides the source for pools backed by directories. May
+	only occur once. Contains a single attribute <code>path</code>
+	which is the fully qualified path to the block device node.
+	<span class="since">Since 0.4.1</span></dd>
+      <dt><code>host</code></dt>
+      <dd>Provides the source for pools backed by storage from a
+	remote server. Will be used in combination with a <code>directory</code>
+	or <code>device</code> element. Contains an attribute <code>name</code>
+	which is the hostname or IP address of the server. May optionally
+	contain a <code>port</code> attribute for the protocol specific
+	port number. <span class="since">Since 0.4.1</span></dd>
+      <dt><code>name</code></dt>
+      <dd>Provides the source for pools backed by storage from a
+	named element (e.g., a logical volume group name).
+	remote server. Contains a string identifier.
+	<span class="since">Since 0.4.5</span></dd>
+      <dt><code>format</code></dt>
+      <dd>Provides information about the format of the pool. This
+	contains a single attribute <code>type</code> whose value is
+	backend specific. This is typically used to indicate filesystem
+	type, or network filesystem type, or partition table type, or
+	LVM metadata type. All drivers are required to have a default
+	value for this, so it is optional. <span class="since">Since 0.4.1</span></dd>
+    </dl>
+
+    <h3><a name="StoragePoolTarget">Target elements</a></h3>
+
+    <p>
+      A single <code>target</code> element is contained within the top level
+      <code>pool</code> element. This tag is used to describe the mapping of
+      the storage pool into the host filesystem. It can contain the following
+      child elements:
+    </p>
+
+    <pre>
+        ...
+        &lt;target&gt;
+          &lt;path&gt;/dev/disk/by-path&lt;/path&gt;
+          &lt;permissions&gt;
+            &lt;owner&gt;0744&lt;/owner&gt;
+            &lt;group&gt;0744&lt;/group&gt;
+            &lt;mode&gt;0744&lt;/mode&gt;
+            &lt;label&gt;virt_image_t&lt;/label&gt;
+          &lt;/permissions&gt;
+        &lt;/target&gt;
+      &lt;/pool&gt;</pre>
+
+    <dl>
+      <dt><code>path</code></dt>
+      <dd>Provides the location at which the pool will be mapped into
+	the local filesystem namespace. For a filesystem/directory based
+	pool it will be the name of the directory in which volumes will
+	be created. For device based pools it will be the name of the directory in which
+	devices nodes exist. For the latter <code>/dev/</code> may seem
+	like the logical choice, however, devices nodes there are not
+	guaranteed stable across reboots, since they are allocated on
+	demand. It is preferable to use a stable location such as one
+	of the <code>/dev/disk/by-{path,id,uuid,label</code> locations.
+	<span class="since">Since 0.4.1</span>
+      </dd>
+      <dt><code>permissions</code></dt>
+      <dd>Provides information about the default permissions to use
+	when creating volumes. This is currently only useful for directory
+	or filesystem based pools, where the volumes allocated are simple
+	files. For pools where the volumes are device nodes, the hotplug
+	scripts determine permissions. It contains 4 child elements. The
+	<code>mode</code> element contains the octal permission set. The
+	<code>owner</code> element contains the numeric user ID. The <code>group</code>
+	element contains the numeric group ID. The <code>label</code> element
+	contains the MAC (eg SELinux) label string.
+	<span class="since">Since 0.4.1</span>
+      </dd>
+    </dl>
+
+    <h3><a name="StoragePoolExtents">Device extents</a></h3>
+
+    <p>
+      If a storage pool exposes information about its underlying
+      placement / allocation scheme, the <code>device</code> element
+      within the <code>source</code> element may contain information
+      about its available extents. Some pools have a constraint that
+      a volume must be allocated entirely within a single constraint
+      (eg disk partition pools). Thus the extent information allows an
+      application to determine the maximum possible size for a new
+      volume
+    </p>
+    <p>
+      For storage pools supporting extent information, within each
+      <code>device</code> element there will be zero or more <code>freeExtent</code>
+      elements. Each of these elements contains two attributes, <code>start</code>
+      and <code>end</code> which provide the boundaries of the extent on the
+      device, measured in bytes.  <span class="since">Since 0.4.1</span>
+    </p>
+
+    <h2><a name="StorageVol">Storage volume XML</a></h2>
+    <p>
+      A storage volume will be either a file or a device node.
+      The storage volume XML format is available <span class="since">since 0.4.1</span>
+    </p>
+
+    <h3><a name="StorageVolFirst">General metadata</a></h3>
+
+    <pre>
+      &lt;volume type="file"&gt;
+	&lt;name&gt;sparse.img&lt;/name&gt;
+	&lt;key&gt;/var/lib/xen/images/sparse.img&lt;/key&gt;
+        &lt;allocation&gt;0&lt;/allocation&gt;
+	&lt;capacity unit="T"&gt;1&lt;/capacity&gt;
+        ...</pre>
+
+    <dl>
+      <dt><code>name</code></dt>
+      <dd>Providing a name for the volume which is unique to the pool.
+	This is mandatory when defining a volume.  <span class="since">Since 0.4.1</span></dd>
+      <dt><code>key</code></dt>
+      <dd>Providing an identifier for the volume which is globally unique.
+	This is optional when defining a volume, a key will be generated if
+	omitted. <span class="since">Since 0.4.1</span></dd>
+      <dt><code>allocation</code></dt>
+      <dd>Providing the total storage allocation for the volume. This
+	may be smaller than the logical capacity if the volume is sparsely
+	allocated. It may also be larger than the logical capacity if the
+	volume has substantial metadata overhead. This value is in bytes.
+	If omitted when creating a volume, the volume will be fully
+	allocated at time of creation. If set to a value smaller than the
+	capacity, the pool has the <strong>option</strong> of deciding
+	to sparsely allocate a volume. It does not have to honour requests
+	for sparse allocation though. <span class="since">Since 0.4.1</span></dd>
+      <dt><code>capacity</code></dt>
+      <dd>Providing the logical capacity for the volume. This value is
+	in bytes. This is compulsory when creating a volume.
+	<span class="since">Since 0.4.1</span></dd>
+      <dt><code>source</code></dt>
+      <dd>Provides information about the underlying storage allocation
+	of the volume. This may not be available for some pool types.
+	<span class="since">Since 0.4.1</span></dd>
+      <dt><code>target</code></dt>
+      <dd>Provides information about the representation of the volume
+	on the local host. <span class="since">Since 0.4.1</span></dd>
+    </dl>
+
+    <h3><a name="StorageVolTarget">Target elements</a></h3>
+
+    <p>
+      A single <code>target</code> element is contained within the top level
+      <code>volume</code> element. This tag is used to describe the mapping of
+      the storage volume into the host filesystem. It can contain the following
+      child elements:
+    </p>
+
+    <pre>
+        ...
+	&lt;target&gt;
+          &lt;path&gt;/var/lib/virt/images/sparse.img&lt;/path&gt;
+          &lt;permissions&gt;
+            &lt;owner&gt;0744&lt;/owner&gt;
+            &lt;group&gt;0744&lt;/group&gt;
+            &lt;mode&gt;0744&lt;/mode&gt;
+            &lt;label&gt;virt_image_t&lt;/label&gt;
+          &lt;/permissions&gt;
+	&lt;/target&gt;
+      &lt;/volume&gt;</pre>
+
+    <dl>
+      <dt><code>path</code></dt>
+      <dd>Provides the location at which the volume can be accessed on
+	the local filesystem, as an absolute path. This is a readonly
+	attribute, so shouldn't be specified when creating a volume.
+	<span class="since">Since 0.4.1</span></dd>
+      <dt><code>format</code></dt>
+      <dd>Provides information about the pool specific volume format.
+	For disk pools it will provide the partition type. For filesystem
+	or directory pools it will provide the file format type, eg cow,
+	qcow, vmdk, raw. If omitted when creating a volume, the pool's
+	default format will be used. The actual format is specified via
+	the <code>type</code>. Consult the pool-specific docs for the
+	list of valid values. <span class="since">Since 0.4.1</span></dd>
+      <dt><code>permissions</code></dt>
+      <dd>Provides information about the default permissions to use
+	when creating volumes. This is currently only useful for directory
+	or filesystem based pools, where the volumes allocated are simple
+	files. For pools where the volumes are device nodes, the hotplug
+	scripts determine permissions. It contains 4 child elements. The
+	<code>mode</code> element contains the octal permission set. The
+	<code>owner</code> element contains the numeric user ID. The <code>group</code>
+	element contains the numeric group ID. The <code>label</code> element
+	contains the MAC (eg SELinux) label string.
+	<span class="since">Since 0.4.1</span>
+      </dd>
+    </dl>
+
+    <h2><a name="examples">Example configuration</a></h2>
+
+    <p>
+      Here are a couple of examples, for a more complete set demonstrating
+      every type of storage pool, consult the <a href="storage.html">storage driver page</a>
+    </p>
+
+    <h3><a name="exampleFile">File based storage pool</a></h3>
+
+    <pre>
+      &lt;pool type="dir"&gt;
+        &lt;name&gt;virtimages&lt;/name&gt;
+        &lt;target&gt;
+          &lt;path&gt;/var/lib/virt/images&lt;/path&gt;
+        &lt;/target&gt;
+      &lt;/pool&gt;</pre>
+
+    <h3><a name="exampleISCSI">iSCSI based storage pool</a></h3>
+
+    <pre>
+      &lt;pool type="iscsi"&gt;
+        &lt;name&gt;virtimages&lt;/name&gt;
+        &lt;source&gt;
+          &lt;host name="iscsi.example.com"/&gt;
+          &lt;device path="demo-target"/&gt;
+        &lt;/source&gt;
+        &lt;target&gt;
+          &lt;path&gt;/dev/disk/by-path&lt;/path&gt;
+        &lt;/target&gt;
+      &lt;/pool&gt;</pre>
+
+    <h3><a name="exampleVol">Storage volume</a></h3>
+
+    <pre>
+      &lt;volume type="file"&gt;
+	&lt;name&gt;sparse.img&lt;/name&gt;
+	&lt;allocation&gt;0&lt;/allocation&gt;
+	&lt;capacity unit="T"&gt;1&lt;/capacity&gt;
+	&lt;target&gt;
+          &lt;path&gt;/var/lib/virt/images/sparse.img&lt;/path&gt;
+          &lt;permissions&gt;
+            &lt;owner&gt;0744&lt;/owner&gt;
+            &lt;group&gt;0744&lt;/group&gt;
+            &lt;mode&gt;0744&lt;/mode&gt;
+            &lt;label&gt;virt_image_t&lt;/label&gt;
+          &lt;/permissions&gt;
+	&lt;/target&gt;
+      &lt;/volume&gt;</pre>
+  </body>
+</html>

docs/generic.css

@@ -0,0 +1,75 @@
+
+body {
+  margin: 0em;
+  padding: 0px;
+  color: rgb(0,0,0);
+  font-family: Verdana, Arial, Helvetica, sans-serif;
+  font-size: 80%;
+//  font-size: 83%;
+}
+
+p, ul, ol, dl {
+  padding: 0px;
+  margin: 0px;
+}
+
+ol,ul {
+  margin-left: 3em;
+}
+
+ol,ul,dl,p {
+  margin-top: 1em;
+  margin-bottom: 1em;
+}
+
+p:first-line {
+  margin-right: 1em;
+}
+
+div.body p:first-letter {
+  font-size: 1.2em;
+  font-weight: bold;
+}
+
+h1,h2,h3,h4,h5,h6 {
+  font-weight: bold;
+  margin: 0px;
+  padding: 0px;
+  margin-top: 0.5em;
+}
+
+div.footer {
+  margin-top: 1em;
+}
+
+h1 {
+  font-size: 2em;
+}
+h2 {
+  font-size: 1.6em;
+}
+h3 {
+  font-size: 1.4em;
+}
+h4 {
+  font-size: 1.2em;
+}
+h5 {
+  font-size: 1em;
+}
+h6 {
+  font-size: 0.8em;
+}
+
+dl dt {
+  margin-left: 1em;
+  margin-right: 2em;
+  font-weight: bold;
+  font-size: larger;
+}
+
+dl dd {
+  margin-left: 2em;
+  margin-right: 2em;
+  margin-bottom: 0.5em;
+}

docs/html/book1.html

@@ -1,3 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reference Manual for libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reference Manual for libvirt</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvirt.html">libvirt</a>: core interfaces for the libvirt library</li><li><a href="libvirt-virterror.html">virterror</a>: error handling interfaces for the libvirt library</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a href="../html/index.html">API Menu</a></li><li><a href="../examples/index.html">C code examples</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>

docs/html/index.html

@@ -1,3 +1,7 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reference Manual for libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reference Manual for libvirt</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvirt.html">libvirt</a>: core interfaces for the libvirt library</li><li><a href="libvirt-virterror.html">virterror</a>: error handling interfaces for the libvirt library</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a href="../html/index.html">API Menu</a></li><li><a href="../examples/index.html">C code examples</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml"><!--
+        This file is autogenerated from html/index.html.in
+        Do not edit this file. Changes will be lost.
+      --><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../main.css" /><link rel="SHORTCUT ICON" href="../32favicon.png" /><title>libvirt: Reference Manual for libvirt</title><meta name="description" content="libvirt, virtualization, virtualization API" /></head><body><div id="header"><div id="headerLogo"></div><div id="headerSearch"><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><div><input id="query" name="query" type="text" size="12" value="" /><input id="submit" name="submit" type="submit" value="Search" /></div></form></div></div><div id="body"><div id="menu"><ul class="l0"><li><div><a title="Front page of the libvirt website" class="inactive" href="../index.html">Home</a></div></li><li><div><a title="Details of new features and bugs fixed in each release" class="inactive" href="../news.html">News</a></div></li><li><div><a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="../downloads.html">Downloads</a></div></li><li><div><a title="Information for users, administrators and developers" class="active" href="../docs.html">Documentation</a><ul class="l1"><li><div><a title="Information about deploying and using libvirt" class="inactive" href="../deployment.html">Deployment</a></div></li><li><div><a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="../intro.html">Architecture</a></div></li><li><div><a title="Description of the XML formats used in libvirt" class="inactive" href="../format.html">XML format</a></div></li><li><div><a title="Hypervisor specific driver information" class="inactive" href="../drivers.html">Drivers</a></div></li><li><div><span class="active">API reference</span><ul class="l2"><li><div><a title="core interfaces for the libvirt library" class="inactive" href="../html/libvirt-libvirt.html">libvirt</a></div></li><li><div><a title="error handling interfaces for the libvirt library" class="inactive" href="../html/libvirt-virterror.html">virterror</a></div></li><li><div><a title="matrix of API support per hypervisor per release" class="inactive" href="../hvsupport.html">Driver support</a></div></li></ul></div></li><li><div><a title="Bindings of the libvirt API for other languages" class="inactive" href="../bindings.html">Language bindings</a></div></li></ul></div></li><li><div><a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a></div></li><li><div><a title="Frequently asked questions" class="inactive" href="../FAQ.html">FAQ</a></div></li><li><div><a title="How and where to report bugs and request features" class="inactive" href="../bugs.html">Bug reports</a></div></li><li><div><a title="How to contact the developers via email and IRC" class="inactive" href="../contact.html">Contact</a></div></li><li><div><a title="Miscellaneous links of interest related to libvirt" class="inactive" href="../relatedlinks.html">Related Links</a></div></li><li><div><a title="Overview of all content on the website" class="inactive" href="../sitemap.html">Sitemap</a></div></li></ul></div><div id="content"><h1>Reference Manual for libvirt</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvirt.html">libvirt</a>: core interfaces for the libvirt library</li><li><a href="libvirt-virterror.html">virterror</a>: error handling interfaces for the libvirt library</li></ul></div></div><div id="footer"><p id="sponsor">
+	    Sponsored by:<br /><a href="http://et.redhat.com/"><img src="../et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p></div></body></html>

docs/html/libvirt-conf.html

@@ -1,44 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Module conf from libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Module conf from libvirt</h1><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libvirt-virterror.html"><img src="left.png" width="24" height="24" border="0" alt="Prev" /></a></td><th align="left"><a href="libvirt-virterror.html">virterror</a></th><td><a accesskey="u" href="index.html"><img src="up.png" width="24" height="24" border="0" alt="Up" /></a></td><th align="left"><a href="index.html">API documentation</a></th><td><a accesskey="h" href="../index.html"><img src="home.png" width="24" height="24" border="0" alt="Home" /></a></td><th align="center"><a href="../index.html">The virtualization API</a></th></tr></table><h2>Table of Contents</h2><pre class="programlisting">Structure <a href="#virConf">virConf</a><br />struct _virConf
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Typedef <a href="libvirt-conf.html#virConf">virConf</a> * <a name="virConfPtr" id="virConfPtr">virConfPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virConfType">virConfType</a>
-</pre><pre class="programlisting">Structure <a href="#virConfValue">virConfValue</a><br />struct _virConfValue
-</pre><pre class="programlisting">Typedef <a href="libvirt-conf.html#virConfValue">virConfValue</a> * <a name="virConfValuePtr" id="virConfValuePtr">virConfValuePtr</a>
-</pre><pre class="programlisting">int	<a href="#virConfFree">virConfFree</a>			(<a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)</pre>
-<pre class="programlisting"><a href="libvirt-conf.html#virConfValuePtr">virConfValuePtr</a>	<a href="#virConfGetValue">virConfGetValue</a>		(<a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf, <br />					 const char * setting)</pre>
-<pre class="programlisting"><a href="libvirt-conf.html#virConfPtr">virConfPtr</a>	<a href="#virConfReadFile">virConfReadFile</a>		(const char * filename)</pre>
-<pre class="programlisting"><a href="libvirt-conf.html#virConfPtr">virConfPtr</a>	<a href="#virConfReadMem">virConfReadMem</a>		(const char * memory, <br />					 int len)</pre>
-<pre class="programlisting">int	<a href="#virConfWriteFile">virConfWriteFile</a>		(const char * filename, <br />					 <a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)</pre>
-<pre class="programlisting">int	<a href="#virConfWriteMem">virConfWriteMem</a>			(char * memory, <br />					 int * len, <br />					 <a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)</pre>
-<h2>Description</h2>
-<h3><a name="virConf" id="virConf">Structure virConf</a></h3><pre class="programlisting">Structure virConf<br />struct _virConf {
-The content of this structure is not made public by the API.
-}</pre>
-      a pointer to a parsed configuration file
-    <h3>Enum <a name="virConfType" id="virConfType">virConfType</a></h3><pre class="programlisting">Enum virConfType {
-    <a name="VIR_CONF_NONE" id="VIR_CONF_NONE">VIR_CONF_NONE</a> = 0 : undefined
-    <a name="VIR_CONF_LONG" id="VIR_CONF_LONG">VIR_CONF_LONG</a> = 1 : a long int
-    <a name="VIR_CONF_STRING" id="VIR_CONF_STRING">VIR_CONF_STRING</a> = 2 : a string
-    <a name="VIR_CONF_LIST" id="VIR_CONF_LIST">VIR_CONF_LIST</a> = 3 : a list
-}
-</pre><h3><a name="virConfValue" id="virConfValue">Structure virConfValue</a></h3><pre class="programlisting">Structure virConfValue<br />struct _virConfValue {
-    <a href="libvirt-conf.html#virConfType">virConfType</a>	type	: the <a href="libvirt-conf.html#virConfType">virConfType</a>
-    <a href="libvirt-conf.html#virConfValuePtr">virConfValuePtr</a>	next	: next element if in a list
-    long	l	: long integer
-    char *	str	: pointer to 0 terminated string
-    <a href="libvirt-conf.html#virConfValuePtr">virConfValuePtr</a>	list	: list of a list
-}</pre><h3><a name="virConfFree" id="virConfFree"></a>Function: virConfFree</h3><pre class="programlisting">int	virConfFree			(<a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)<br />
-</pre><p>Frees all data associated to the handle</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conf</tt></i>:</span></td><td>a configuration file handle</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error.</td></tr></tbody></table></div><h3><a name="virConfGetValue" id="virConfGetValue"></a>Function: virConfGetValue</h3><pre class="programlisting"><a href="libvirt-conf.html#virConfValuePtr">virConfValuePtr</a>	virConfGetValue		(<a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf, <br />					 const char * setting)<br />
-</pre><p>Lookup the value associated to this entry in the configuration file</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conf</tt></i>:</span></td><td>a configuration file handle</td></tr><tr><td><span class="term"><i><tt>setting</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the value or NULL if the lookup failed, the data associated will be freed when virConfFree() is called</td></tr></tbody></table></div><h3><a name="virConfReadFile" id="virConfReadFile"></a>Function: virConfReadFile</h3><pre class="programlisting"><a href="libvirt-conf.html#virConfPtr">virConfPtr</a>	virConfReadFile		(const char * filename)<br />
-</pre><p>Reads a configuration file.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>filename</tt></i>:</span></td><td>the path to the configuration file.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>an handle to lookup settings or NULL if it failed to read or parse the file, use virConfFree() to free the data.</td></tr></tbody></table></div><h3><a name="virConfReadMem" id="virConfReadMem"></a>Function: virConfReadMem</h3><pre class="programlisting"><a href="libvirt-conf.html#virConfPtr">virConfPtr</a>	virConfReadMem		(const char * memory, <br />					 int len)<br />
-</pre><p>Reads a configuration file loaded in memory. The string can be zero terminated in which case @len can be 0</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>pointer to the content of the configuration file</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>length in byte</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>an handle to lookup settings or NULL if it failed to parse the content, use virConfFree() to free the data.</td></tr></tbody></table></div><h3><a name="virConfWriteFile" id="virConfWriteFile"></a>Function: virConfWriteFile</h3><pre class="programlisting">int	virConfWriteFile		(const char * filename, <br />					 <a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)<br />
-</pre><p>Writes a configuration file back to a file.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>filename</tt></i>:</span></td><td>the path to the configuration file.</td></tr><tr><td><span class="term"><i><tt>conf</tt></i>:</span></td><td>the conf</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of bytes written or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virConfWriteMem" id="virConfWriteMem"></a>Function: virConfWriteMem</h3><pre class="programlisting">int	virConfWriteMem			(char * memory, <br />					 int * len, <br />					 <a href="libvirt-conf.html#virConfPtr">virConfPtr</a> conf)<br />
-</pre><p>Writes a configuration file back to a memory area. @len is an IN/OUT parameter, it indicates the size available in bytes, and on output the size required for the configuration file (even if the call fails due to insufficient space).</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>pointer to the memory to store the config file</td></tr><tr><td><span class="term"><i><tt>len</tt></i>:</span></td><td>pointer to the length in byte of the store, on output the size</td></tr><tr><td><span class="term"><i><tt>conf</tt></i>:</span></td><td>the conf</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of bytes written or -1 in case of error.</td></tr></tbody></table></div></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a href="../html/index.html">API Menu</a></li><li><a href="../examples/index.html">C code examples</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>

docs/html/libvirt-lib.html

@@ -1,3 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reference Manual for libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reference Manual for libvirt</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvirt.html">libvirt</a>: core interfaces for the libvirt library</li><li><a href="libvirt-virterror.html">virterror</a>: error handling interfaces for the libvirt library</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a href="../html/index.html">API Menu</a></li><li><a href="../examples/index.html">C code examples</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="https://bugzilla.redhat.com/bugzilla/buglist.cgi?product=Fedora+Core&amp;component=libvirt&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_status=MODIFIED&amp;short_desc_type=allwordssubstr&amp;short_desc=&amp;long_desc_type=allwordssubstr">Open bugs</a></li><li><a href="http://virt-manager.et.redhat.com/">virt-manager</a></li><li><a href="http://search.cpan.org/~danberr/Sys-Virt-0.1.0/">Perl bindings</a></li><li><a href="http://libvirt.org/ocaml/">OCaml bindings</a></li><li><a href="http://libvirt.org/ruby/">Ruby bindings</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html>