* configure.in libvirt.spec.in NEWS docs/*: release of libvirt-0.4.6

* src/storage_backend_logical.c: re-add the -f flag to vgremove
* po/*: rebuilt
Daniel

.cvsignore

@@ -20,6 +20,7 @@ ltconfig
 update.log
 libvirt.pc
 libvirt.spec
+mingw-libvirt.spec
 COPYING
 m4
 ABOUT-NLS

.x-sc_prohibit_strcmp

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

AUTHORS

@@ -5,28 +5,30 @@ 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>
 
 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,11 +39,22 @@ 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>
+  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>
+
 
   [....send patches to get your name here....]
 
+The libvirt Logo was designed by Diana Fong
 
 -- End

GNUmakefile

@@ -4,7 +4,7 @@
 # It is necessary if you want to build targets usually of interest
 # only to the maintainer.
 
-# Copyright (C) 2001, 2003, 2006-2007 Free Software Foundation, Inc.
+# Copyright (C) 2001, 2003, 2006-2008 Free Software Foundation, Inc.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -29,11 +29,11 @@ else
 SHELL = sh
 endif
 
-have-Makefile := $(shell test -f Makefile && echo yes)
+_have-Makefile := $(shell test -f Makefile && echo yes)
 
 # If the user runs GNU make but has not yet run ./configure,
 # give them a diagnostic.
-ifeq ($(have-Makefile),yes)
+ifeq ($(_have-Makefile),yes)
 
 # Make tar archive easier to reproduce.
 export TAR_OPTIONS = --owner=0 --group=0 --numeric-owner
@@ -50,6 +50,8 @@ all:
 	@echo "You must run ./configure before running \`make'." 1>&2
 	@exit 1
 
+check dist distcheck install: all
+
 endif
 
 # Tell version 3.79 and up of GNU make to not build goals in this

HACKING

@@ -0,0 +1,247 @@
+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.

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
 
 ACLOCAL_AMFLAGS = -I m4 -I gnulib/m4
 
 EXTRA_DIST = \
   libvirt.spec libvirt.spec.in \
+  mingw-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

@@ -8,25 +8,23 @@ gzip_rsyncable := \
   $(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null && echo --rsyncable)
 GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
 
-CVS_LIST = build-aux/vc-list-files
+VC_LIST = build-aux/vc-list-files
 
-CVS_LIST_EXCEPT = \
-$(CVS_LIST) | if test -f .x-$@; then grep -vEf .x-$@; else grep -v ChangeLog; fi
+VC_LIST_EXCEPT = \
+  $(VC_LIST) | if test -f .x-$@; then grep -vEf .x-$@; else grep -v ChangeLog; fi
 
 # Prevent programs like 'sort' from considering distinct strings to be equal.
 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
 export LC_ALL = C
 
 # Collect the names of rules starting with `sc_'.
-syntax-check-rules := $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' $(ME))
+syntax-check-rules := $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
+                        $(srcdir)/$(ME))
 .PHONY: $(syntax-check-rules)
 
-# Checks that don't require cvs.
-# Run `changelog-check' last, as previous test may reveal problems requiring
-# new ChangeLog entries.
 local-checks-available = \
   po-check copyright-check m4-check author_mark_check \
-  changelog-check patch-check strftime-check $(syntax-check-rules) \
+  patch-check strftime-check $(syntax-check-rules) \
   makefile_path_separator_check \
   makefile-check check-AUTHORS
 .PHONY: $(local-checks-available)
@@ -34,23 +32,29 @@ local-checks-available = \
 local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
 
 syntax-check: $(local-check)
+#	@grep -nE '#  *include <(limits|std(def|arg|bool))\.h>'		\
+#	    $$(find -type f -name '*.[chly]') &&			\
+#	  { echo '$(ME): found conditional include' 1>&2;		\
+#	    exit 1; } || :
 
-## --------------- ##
-## Sanity checks.  ##
-## --------------- ##
+#	grep -nE '^#  *include <(string|stdlib)\.h>'			\
+#	    $(srcdir)/{lib,src}/*.[chy] &&				\
+#	  { echo '$(ME): FIXME' 1>&2;					\
+#	    exit 1; } || :
+# FIXME: don't allow `#include .strings\.h' anywhere
 
 sc_avoid_if_before_free:
 	@$(srcdir)/build-aux/useless-if-before-free			\
 		$(useless_free_options)					\
-	    $$($(CVS_LIST_EXCEPT)) &&					\
+	    $$($(VC_LIST_EXCEPT)) &&					\
 	  { echo '$(ME): found useless "if" before "free" above' 1>&2;	\
 	    exit 1; } || :
 
 # Avoid uses of write(2).  Either switch to streams (fwrite), or use
 # the safewrite wrapper.
 sc_avoid_write:
-	@if $(CVS_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then		\
-	  grep '\<write *(' $$($(CVS_LIST_EXCEPT) | grep '\.c$$') &&	\
+	@if $(VC_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then		\
+	  grep '\<write *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$') &&	\
 	    { echo "$(ME): the above files use write;"			\
 	      " consider using the safewrite wrapper instead"		\
 		  1>&2; exit 1; } || :;					\
@@ -58,22 +62,22 @@ sc_avoid_write:
 	fi
 
 sc_cast_of_argument_to_free:
-	@grep -nE '\<free \(\(' $$($(CVS_LIST_EXCEPT)) &&		\
+	@grep -nE '\<free \(\(' $$($(VC_LIST_EXCEPT)) &&		\
 	  { echo '$(ME): don'\''t cast free argument' 1>&2;		\
 	    exit 1; } || :
 
 sc_cast_of_x_alloc_return_value:
-	@grep -nE '\*\) *x(m|c|re)alloc\>' $$($(CVS_LIST_EXCEPT)) &&	\
+	@grep -nE '\*\) *x(m|c|re)alloc\>' $$($(VC_LIST_EXCEPT)) &&	\
 	  { echo '$(ME): don'\''t cast x*alloc return value' 1>&2;	\
 	    exit 1; } || :
 
 sc_cast_of_alloca_return_value:
-	@grep -nE '\*\) *alloca\>' $$($(CVS_LIST_EXCEPT)) &&		\
+	@grep -nE '\*\) *alloca\>' $$($(VC_LIST_EXCEPT)) &&		\
 	  { echo '$(ME): don'\''t cast alloca return value' 1>&2;	\
 	    exit 1; } || :
 
 sc_space_tab:
-	@grep -n '[ ]	' $$($(CVS_LIST_EXCEPT)) &&			\
+	@grep -n '[ ]	' $$($(VC_LIST_EXCEPT)) &&			\
 	  { echo '$(ME): found SPACE-TAB sequence; remove the SPACE'	\
 		1>&2; exit 1; } || :
 
@@ -81,14 +85,15 @@ sc_space_tab:
 # They provide no error checking mechanism.
 # Instead, use strto* functions.
 sc_prohibit_atoi_atof:
-	@grep -nE '\<([fs]?scanf|ato([filq]|ll))\>' $$($(CVS_LIST_EXCEPT)) && \
+	@grep -nE '\<([fs]?scanf|ato([filq]|ll))\>' $$($(VC_LIST_EXCEPT)) && \
 	  { echo '$(ME): do not use *scan''f, ato''f, ato''i, ato''l, ato''ll, ato''q, or ss''canf'	\
 		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 \([^)]+\) *==' \
-	    $$($(CVS_LIST_EXCEPT)) && \
+	@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; } || :
 
@@ -101,74 +106,83 @@ sc_error_exit_success:
 	    exit 1; } || :
 
 sc_file_system:
-	@grep -ni 'file''system' $$($(CVS_LIST_EXCEPT)) &&		\
+	@grep -ni 'file''system' $$($(VC_LIST_EXCEPT)) &&		\
 	  { echo '$(ME): found use of "file''system";'			\
 	    'rewrite to use "file system"' 1>&2;			\
 	    exit 1; } || :
 
 sc_no_have_config_h:
-	@grep -n '^# *if.*HAVE''_CONFIG_H' $$($(CVS_LIST_EXCEPT)) &&	\
+	@grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) &&	\
 	  { echo '$(ME): found use of HAVE''_CONFIG_H; remove'		\
 		1>&2; exit 1; } || :
 
 # Nearly all .c files must include <config.h>.
 sc_require_config_h:
-	@if $(CVS_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then		\
+	@if $(VC_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then		\
 	  grep -L '^# *include <config\.h>'				\
-		$$($(CVS_LIST_EXCEPT) | grep '\.c$$')			\
+		$$($(VC_LIST_EXCEPT) | grep '\.c$$')			\
 	      | grep . &&						\
 	  { echo '$(ME): the above files do not include <config.h>'	\
 		1>&2; exit 1; } || :;					\
 	else :;								\
 	fi
 
+# To use this "command" macro, you must first define two shell variables:
+# h: the header, enclosed in <> or ""
+# re: a regular expression that matches IFF something provided by $h is used.
+define _header_without_use
+  h_esc=`echo "$$h"|sed 's/\./\\./'`;					\
+  if $(VC_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then			\
+    files=$$(grep -l '^# *include '"$$h_esc"				\
+	     $$($(VC_LIST_EXCEPT) | grep '\.c$$')) &&			\
+    grep -LE "$$re" $$files | grep . &&					\
+      { echo "$(ME): the above files include $$h but don't use it"	\
+	1>&2; exit 1; } || :;						\
+  else :;								\
+  fi
+endef
+
 # Prohibit the inclusion of assert.h without an actual use of assert.
 sc_prohibit_assert_without_use:
-	@if $(CVS_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then		\
-	  files=$$(grep -l '# *include <assert\.h>'			\
-		    $$($(CVS_LIST_EXCEPT) | grep '\.c$$')) &&		\
-	  grep -L '\<assert (' $$files					\
-	      | grep . &&						\
-	    { echo "$(ME): the above files include <assert.h> but don't use it" \
-		  1>&2; exit 1; } || :;					\
-	else :;								\
-	fi
+	@h='<assert.h>' re='\<assert *\(' $(_header_without_use)
+
+# Prohibit the inclusion of getopt.h without an actual use.
+sc_prohibit_getopt_without_use:
+	@h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
 
 # Don't include quotearg.h unless you use one of its functions.
 sc_prohibit_quotearg_without_use:
-	@if $(CVS_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then		\
-	  files=$$(grep -l '# *include "quotearg\.h"'			\
-		    $$($(CVS_LIST_EXCEPT) | grep '\.c$$')) &&		\
-	  grep -LE '\<quotearg(_[^ ]+)? \(' $$files			\
-	      | grep . &&						\
-	    { echo "$(ME): the above files include "quotearg.h" but don't use it" \
-		  1>&2; exit 1; } || :;					\
-	else :;								\
-	fi
+	@h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
 
 # Don't include quote.h unless you use one of its functions.
 sc_prohibit_quote_without_use:
-	@if $(CVS_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then		\
-	  files=$$(grep -l '# *include "quote\.h"'			\
-		    $$($(CVS_LIST_EXCEPT) | grep '\.c$$')) &&		\
-	  grep -LE '\<quote(_n)? \(' $$files			\
-	      | grep . &&						\
-	    { echo "$(ME): the above files include "quote.h" but don't use it" \
-		  1>&2; exit 1; } || :;					\
-	else :;								\
-	fi
+	@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)\>'			\
-	     $$($(CVS_LIST_EXCEPT)) &&					\
+	     $$($(VC_LIST_EXCEPT)) &&					\
 	  { echo '$(ME): do not use HAVE''_FCNTL_H or O''_NDELAY'	\
 		1>&2; exit 1; } || :
 
 # 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; } || :
 
@@ -194,7 +208,7 @@ endif
 # Make sure that none are inadvertently reintroduced.
 sc_prohibit_jm_in_m4:
 	@grep -nE 'jm_[A-Z]'					\
-		$$($(CVS_LIST) m4 |grep '\.m4$$'; echo /dev/null) && \
+		$$($(VC_LIST) m4 |grep '\.m4$$'; echo /dev/null) && \
 	    { echo '$(ME): do not use jm_ in m4 macro names'	\
 	      1>&2; exit 1; } || :
 
@@ -202,8 +216,8 @@ sc_root_tests:
 	@if test -d tests \
 	      && grep check-root tests/Makefile.am>/dev/null 2>&1; then \
 	t1=sc-root.expected; t2=sc-root.actual;				\
-	grep -nl '^PRIV_CHECK_ARG=require-root'				\
-	  $$($(CVS_LIST) tests) |sed s,tests,., |sort > $$t1;		\
+	grep -nl '^require_root_$$'					\
+	  $$($(VC_LIST) tests) |sed s,tests,., |sort > $$t1;		\
 	sed -n 's,	cd \([^ ]*\) .*MAKE..check TESTS=\(.*\),./\1/\2,p' \
 	  $(srcdir)/tests/Makefile.am |sort > $$t2;			\
 	diff -u $$t1 $$t2 || diff=1;					\
@@ -242,7 +256,7 @@ headers_with_interesting_macro_defs = \
 sc_always_defined_macros: .re-defmac
 	@if test -f $(srcdir)/src/system.h; then			\
 	  trap 'rc=$$?; rm -f .re-defmac; exit $$rc' 0 1 2 3 15;	\
-	  grep -f .re-defmac $$($(CVS_LIST))				\
+	  grep -f .re-defmac $$($(VC_LIST))				\
 	    && { echo '$(ME): define the above via some gnulib .h file'	\
 		  1>&2;  exit 1; } || :;				\
 	fi
@@ -262,7 +276,7 @@ sc_system_h_headers: .re-list
 	@if test -f $(srcdir)/src/system.h; then			\
 	  trap 'rc=$$?; rm -f .re-list; exit $$rc' 0 1 2 3 15;		\
 	  grep -nE -f .re-list						\
-	      $$($(CVS_LIST) src |					\
+	      $$($(VC_LIST) src |					\
 		 grep -Ev '((copy|system)\.h|parse-gram\.c)$$')		\
 	    && { echo '$(ME): the above are already included via system.h'\
 		  1>&2;  exit 1; } || :;				\
@@ -271,12 +285,12 @@ sc_system_h_headers: .re-list
 sc_sun_os_names:
 	@grep -nEi \
 	    'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
-	    $$($(CVS_LIST_EXCEPT)) &&					\
+	    $$($(VC_LIST_EXCEPT)) &&					\
 	  { echo '$(ME): found misuse of Sun OS version numbers' 1>&2;	\
 	    exit 1; } || :
 
 sc_the_the:
-	@grep -ni '\<the ''the\>' $$($(CVS_LIST_EXCEPT)) &&		\
+	@grep -ni '\<the ''the\>' $$($(VC_LIST_EXCEPT)) &&		\
 	  { echo '$(ME): found use of "the ''the";' 1>&2;		\
 	    exit 1; } || :
 
@@ -284,23 +298,72 @@ sc_tight_scope:
 	$(MAKE) -C src $@
 
 sc_trailing_blank:
-	@grep -n '[	 ]$$' $$($(CVS_LIST_EXCEPT)) &&			\
+	@grep -n '[	 ]$$' $$($(VC_LIST_EXCEPT)) &&			\
 	  { 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
 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
 sc_two_space_separator_in_usage:
 	@grep -nE '^   *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$'		\
-	    $$($(CVS_LIST_EXCEPT)) &&					\
+	    $$($(VC_LIST_EXCEPT)) &&					\
 	  { echo "$(ME): help2man requires at least two spaces between"; \
 	    echo "$(ME): an option and its description"; \
 		1>&2; exit 1; } || :
 
-err_func_re = \
-(DISABLE_fprintf|qemudLog|(xmlRpc|vir(Xend|XML|Hash|Conf|Test|LibConn|StorageReport))Error)
+msg_gen_function =
+msg_gen_function += DISABLE_fprintf
+msg_gen_function += virXendError
+msg_gen_function += virXMLError
+msg_gen_function += virHashError
+msg_gen_function += virConfError
+msg_gen_function += virTestError
+msg_gen_function += virLibConnError
+msg_gen_function += virStorageReportError
+msg_gen_function += virxmlRpcError
+msg_gen_function += virLog
+msg_gen_function += qemudLog
+msg_gen_function += remoteDispatchError
+msg_gen_function += virStorageLog
+msg_gen_function += xenXMError
+msg_gen_function += ReportError
+msg_gen_function += qemudReportError
+msg_gen_function += openvzLog
+msg_gen_function += openvzError
+msg_gen_function += virDomainReportError
+
+# Uncomment the following and run "make syntax-check" to see diagnostics
+# that are not yet marked for translation, but that need to be rewritten
+# so that they are translatable.
+# 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))
 
 # Look for diagnostics that aren't marked for translation.
 # This won't find any for which error's format string is on a separate line.
@@ -309,32 +372,32 @@ err_func_re = \
 #    "%s", _("no storage vol w..."
 sc_unmarked_diagnostics:
 	@grep -nE							\
-	    '\<(vshError|error) \([^"]*"[^"]*[a-z]{3}' $$($(CVS_LIST_EXCEPT))	\
+            '\<$(func_re) \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT))	\
 	  | grep -v '_''(' &&						\
 	  { echo '$(ME): found unmarked diagnostic(s)' 1>&2;		\
 	    exit 1; } || :
-	@{ grep     -nE '\<$(err_func_re) *\(.*;$$' $$($(CVS_LIST_EXCEPT));   \
-	   grep -A1 -nE '\<$(err_func_re) *\(.*,$$' $$($(CVS_LIST_EXCEPT)); } \
+	@{ grep     -nE '\<$(func_re) *\(.*;$$' $$($(VC_LIST_EXCEPT));   \
+	   grep -A1 -nE '\<$(func_re) *\(.*,$$' $$($(VC_LIST_EXCEPT)); } \
 	   | sed 's/_("[^"][^"]*"//;s/[	 ]"%s"//'			\
 	   | grep '[	 ]"' &&						\
 	  { echo '$(ME): found unmarked diagnostic(s)' 1>&2;		\
 	    exit 1; } || :
 
 sc_prohibit_virBufferAdd_with_string_literal:
-	@grep -nE '\<virBufferAdd *\([^,]+, *"[^"]' $$($(CVS_LIST_EXCEPT)) && \
+	@grep -nE '\<virBufferAdd *\([^,]+, *"[^"]' $$($(VC_LIST_EXCEPT)) && \
 	  { echo '$(ME): use virBufferAddLit, not virBufferAdd,' \
 	      'with a string literal' 1>&2; exit 1; } || :
 
 # Avoid useless parentheses like those in this example:
 # #if defined (SYMBOL) || defined (SYM2)
 sc_useless_cpp_parens:
-	@grep -n '^# *if .*defined *(' $$($(CVS_LIST_EXCEPT)) &&	\
+	@grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) &&		\
 	  { echo '$(ME): found useless parentheses in cpp directive'	\
 		1>&2; exit 1; } || :
 
 # Require the latest GPL.
 sc_GPL_version:
-	@grep -n 'either ''version [^3]' $$($(CVS_LIST_EXCEPT)) &&	\
+	@grep -n 'either ''version [^3]' $$($(VC_LIST_EXCEPT)) &&	\
 	  { echo '$(ME): GPL vN, N!=3' 1>&2; exit 1; } || :
 
 # Ensure that the c99-to-c89 patch applies cleanly.
@@ -359,7 +422,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;							\
@@ -406,16 +469,20 @@ m4-check:
 # 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-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=;							\
-	  for file in $$($(CVS_LIST_EXCEPT)); do			\
+	  for file in $$($(VC_LIST_EXCEPT)); do				\
+	    case $$file in						\
+	    djgpp/* | man/*) continue;;					\
+	    */c99-to-c89.diff) continue;;				\
+	    esac;							\
 	    case $$file in						\
 	    *.[ch])							\
 	      base=`expr " $$file" : ' \(.*\)\..'`;			\
 	      { test -f $$base.l || test -f $$base.y; } && continue;;	\
-	    *) continue;;						\
+	    *) continue;;				\
 	    esac;							\
 	    files="$$files $$file";					\
 	  done;								\
@@ -447,16 +514,14 @@ makefile_path_separator_check:
 # Check that `make alpha' will not fail at the end of the process.
 writable-files:
 	if test -d $(release_archive_dir); then :; else			\
-	  mkdir $(release_archive_dir);					\
+	  for file in $(distdir).tar.gz					\
+	              $(release_archive_dir)/$(distdir).tar.gz; do	\
+	    test -e $$file || continue;					\
+	    test -w $$file						\
+	      || { echo ERROR: $$file is not writable; fail=1; };	\
+	  done;								\
+	  test "$$fail" && exit 1 || :
 	fi
-	for file in $(distdir).tar.gz $(xd-delta)			\
-	            $(release_archive_dir)/$(distdir).tar.gz		\
-	            $(release_archive_dir)/$(xd-delta); do		\
-	  test -e $$file || continue;					\
-	  test -w $$file						\
-	    || { echo ERROR: $$file is not writable; fail=1; };		\
-	done;								\
-	test "$$fail" && exit 1 || :
 
 v_etc_file = lib/version-etc.c
 sample-test = tests/sample-test

NEWS

@@ -1,564 +0,0 @@
-
-        NEWS file for libvirt
-
-  Note that this is automatically generated from the news webpage at:
-       http://libvirt.org/news.html
-
-Releases
-0.4.1: Mar 3 2008:
-   - New features: build on MacOSX (Richard Jones), storage management
-      (Daniel Berrange), Xenner - Xen on KVM - support (Daniel Berrange)
-   - Documentation: Fix of various typos (Atsushi SAKAI), memory and
-      vcpu settings details (Richard Jones), ethernet bridging typo
-      (Maxwell Bottiger), add storage APIs documentation (Daniel Berrange)
-   - Bug fixes: OpenVZ code compilation (Mikhail Pokidko), crash in
-      policykit auth handling (Daniel Berrange), large config files
-      (Daniel Berrange), cpumap hypercall size (Saori Fukuta), crash
-      in remote auth (Daniel Berrange), ssh args error (Daniel Berrange),
-      preserve vif order from config files (Hiroyuki Kaguchi), invalid
-      pointer access (Jim Meyering), virDomainGetXMLDesc flag handling,
-      device name conversion on stats (Daniel Berrange), double mutex lock
-      (Daniel Berrange), config file reading crashes (Guido Guenther),
-      xenUnifiedDomainSuspend bug (Marcus Meissner), do not crash if
-      /sys/hypervisor/capabilities is missing (Mark McLoughlin),
-      virHashRemoveSet bug (Hiroyuki Kaguchi), close-on-exec flag for
-      qemud signal pipe (Daniel Berrange), double free in OpenVZ
-      (Anton Protopopov), handle mac without addresses (Shigeki Sakamoto),
-      MAC addresses checks (Shigeki Sakamoto and Richard Jones)
-   - Improvements: Windows build (Richard Jones), KVM/QEmu shutdown
-      (Guido Guenther), catch virExec output on debug (Mark McLoughlin),
-      integration of iptables and lokkit (Mark McLoughlin), keymap
-      parameter for VNC servers (Daniel Hokka Zakrisson), enable debug
-      by default using VIR_DEBUG (Daniel Berrange), xen 3.2 fixes
-      (Daniel Berrange), Python bindings for VCPU and scheduling
-      (Daniel Berrange), framework for automatic code syntax checks
-      (Jim Meyering), allow kernel+initrd setup in Xen PV (Daniel Berrange),
-      allow change of Disk/NIC of an inactive domains (Shigeki Sakamoto),
-      virsh commands to manipulate and create storage(Daniel Berrange),
-      update use of PolicyKit APIs, better detection of fedault hypervisor,
-      block device statistics for QEmu/KVM (Richard Jones), various improvements
-      for Xenner (Daniel Berrange)
-   - Code cleanups: avoid warnings (Daniel Berrange), virRun helper
-      function (Dan Berrange), iptable code fixes (Mark McLoughlin),
-      static and const cleanups (Jim Meyering), malloc and python cleanups
-      (Jim Meyering), xstrtol_ull and xstrtol_ll functions (Daniel Berrange),
-      remove no-op networking from OpenVZ (Daniel Berrange), python generator
-      cleanups (Daniel Berrange), cleanup ref counting (Daniel Berrange),
-      remove uninitialized warnings (Jim Meyering), cleanup configure
-      for RHEL4 (Daniel Berrange), CR/LF cleanups (Richard Jones),
-      various automatic code check and associated cleanups (Jim Meyering),
-      various memory leaks (Jim Meyering), fix compilation when building
-      without Xen (Guido Guenther), mark translatables strings (Jim Meyering),
-      use virBufferAddLit for constant strings (Jim Meyering), fix
-      make distcheck (Jim Meyering), return values for python bindings (Cole
-      Robinson), trailing blanks fixes (Jim Meyering), gcc-4.3.0 fixes
-      (Mark McLoughlin), use safe read and write routines (Jim Meyering),
-      refactoring of code dealing with hypervisor capabilities (Daniel
-      Berrange), qemudReportError to use virErrorMsg (Cole Robinson),
-      intemediate library and Makefiles for compiling static and coverage
-      rule support (Jim Meyering), cleanup of various leaks (Jim Meyering)
-
-
-0.4.0: Dec 18 2007:
-   - New features: Compilation on Windows cygwin/mingw (Richard Jones),
-      Ruby bindings (David Lutterkort), SASL based authentication for
-      libvirt remote support (Daniel Berrange), PolicyKit authentication
-      (Daniel Berrange)
-   - Documentation: example files for QEMU and libvirtd configuations
-      (Daniel Berrange), english cleanups (Jim Paris), CIM and OpenVZ
-      references, document <shareable/>, daemon startup when using
-      QEMU/KVM, document HV support for new NUMA calls (Richard Jones),
-      various english fixes (Bruce Montague), OCaml docs links (Richard Jones),
-      describe the various bindings add Ruby link, Windows support page
-      (Richard Jones), authentication documentation updates (Daniel Berrange)
-      
-   - Bug fixes: NUMA topology error handling (Beth Kon), NUMA topology
-      cells without CPU (Beth Kon), XML to/from XM bridge config (Daniel
-      Berrange), XM processing of vnc parameters (Daniel Berrange), Reset
-      migration source after failure (Jim Paris), negative integer in config
-      (Tatsuro Enokura), zero terminating string buffer, detect integer
-      overflow (Jim Meyering), QEmu command line ending fixes (Daniel Berrange),
-      recursion problem in the daemon (Daniel Berrange), HVM domain with CDRom
-      (Masayuki Sunou), off by one error in NUMA cpu count (Beth Kon),
-      avoid xend errors when adding disks (Masayuki Sunou), compile error
-      (Chris Lalancette), transposed fwrite args (Jim Meyering), compile
-      without xen and on solaris (Jim Paris), parsing of interface names
-      (Richard Jones), overflow for starts on 32bits (Daniel Berrange),
-      fix problems in error reporting (Saori Fukuta), wrong call to
-      brSetForwardDelay changed to brSetEnableSTP (Richard Jones),
-      allow shareable disk in old Xen, fix wrong certificate file (Jim
-      Meyering), avoid some startup error when non-root, off-by-1 buffer
-      NULL termination (Daniel Berrange), various string allocation fixes
-      (Daniel Berrange), avoid problems with vnetXXX interfaces in domain dumps
-      (Daniel Berrange), build fixes for RHEL (Daniel Berrange), virsh prompt
-      should not depend on uid (Richard Jones), fix scaping of '<' (Richard
-      Jones), fix detach-disk on Xen tap devices (Saori Fukuta), CPU
-      parameter setting in XM config (Saori Fukuta), credential handling
-      fixes (Daniel Berrange), fix compatibility with Xen 3.2.0 (Daniel
-      Berrange)
-      
-   - Improvements: /etc/libvirt/qemu.conf configuration for QEMU driver
-      (Daniel Berrange), NUMA cpu pinning in config files (DV and Saori Fukuta),
-      CDRom media change in KVM/QEMU (Daniel Berrange), tests for
-      <shareable/> in configs, pinning inactive domains for Xen 3.0.3
-      (Saori Fukuta), use gnulib for portability enhancement (Jim Meyering),
-      --without-libvirtd config option (Richard Jones), Python bindings for
-      NUMA, add extra utility functions to buffer (Richard Jones),
-      separate qparams module for handling query parameters (Richard Jones)
-      
-   - Code cleanups: remove virDomainRestart from API as it was never used
-      (Richard Jones), constify params for attach/detach APIs (Daniel Berrange),
-      gcc printf attribute checkings (Jim Meyering), refactoring of device
-      parsing code and shell escaping (Daniel Berrange), virsh schedinfo
-      parameters validation (Masayuki Sunou), Avoid risk of format string abuse
-      (Jim Meyering), integer parsing cleanups (Jim Meyering), build out
-      of the source tree (Jim Meyering), URI parsing refactoring (Richard
-      Jones), failed strdup/malloc handling (Jim Meyering), Make "make
-      distcheck" work (Jim Meyering), improve xen internall error reports
-      (Richard Jones), cleanup of the daemon remote code (Daniel Berrange),
-      rename error VIR_FROM_LINUX to VIR_FROM_STATS_LINUX (Richard Jones),
-      don't compile the proxy if without Xen (Richard Jones), fix paths when
-      configuring for /usr prefix, improve error reporting code (Jim Meyering),
-      detect heap allocation failure (Jim Meyering), disable xen sexpr parsing
-      code if Xen is disabled (Daniel Berrange), cleanup of the GetType
-      entry point for Xen drivers, move some QEmu path handling to generic
-      module (Daniel Berrange), many code cleanups related to the Windows
-      port (Richard Jones), disable the proxy if using PolicyKit, readline
-      availability detection, test libvirtd's config-processing code (Jim
-      Meyering), use a variable name as sizeof argument (Jim Meyering)
-      
-
-
-0.3.3: Sep 30 2007:
-   - New features: Avahi mDNS daemon export (Daniel Berrange),
-      NUMA support (Beth Kan) 
-   - Documentation: cleanups (Toth Istvan), typos (Eduardo Pereira), 
-   - Bug fixes: memory corruption on large dumps (Masayuki Sunou), fix
-      virsh vncdisplay command exit (Masayuki Sunou), Fix network stats
-      TX/RX result (Richard Jones), warning on Xen 3.0.3 (Richard Jones),
-      missing buffer check in virDomainXMLDevID (Hugh Brock), avoid zombies
-      when using remote (Daniel Berrange), xend connection error message
-      (Richard Jones), avoid ssh tty prompt (Daniel Berrange), username
-      handling for remote URIs (Fabian Deutsch), fix potential crash
-      on multiple input XML tags (Daniel Berrange), Solaris Xen hypercalls
-      fixup (Mark Johnson)
-   - Improvements: OpenVZ support (Shuveb Hussain and Anoop Cyriac),
-      CD-Rom reload on XEn (Hugh Brock), PXE boot got QEmu/KVM (Daniel
-      Berrange), QEmu socket permissions customization (Daniel Berrange),
-      more QEmu support (Richard Jones), better path detection for qemu and
-      dnsmasq (Richard Jones), QEmu flags are per-Domain (Daniel Berrange),
-      virsh freecell command, Solaris portability fixes (Mark Johnson),
-      default bootloader support (Daniel Berrange), new virNodeGetFreeMemory
-      API, vncpasswd extraction in configuration files if secure (Mark
-      Johnson and Daniel Berrange), Python bindings for block and interface
-      statistics
-   - Code cleanups: virDrvOpenRemoteFlags definition (Richard Jones),
-      configure tests and output (Daniel Berrange)
-
-
-0.3.2: Aug 21 2007:
-   - New features: KVM migration and save/restore (Jim Paris),
-      added API for migration (Richard Jones), added APIs for block device and
-      interface statistic (Richard Jones).
-   - Documentation: examples for XML network APIs,
-      fix typo and schedinfo synopsis in man page (Atsushi SAKAI),
-      hypervisor support page update (Richard Jones).
-   - Bug fixes: remove a couple of leaks in QEmu/KVM backend(Daniel berrange),
-      fix GnuTLS 1.0 compatibility (Richard Jones), --config/-f option
-      mistake for libvirtd (Richard Jones), remove leak in QEmu backend
-      (Jim Paris), fix some QEmu communication bugs (Jim Paris), UUID
-      lookup though proxy fix, setvcpus checking bugs (with Atsushi SAKAI),
-      int checking in virsh parameters (with Masayuki Sunou), deny devices
-      attach/detach for < Xen 3.0.4 (Masayuki Sunou), XenStore query
-      memory leak (Masayuki Sunou), virsh schedinfo cleanup (Saori Fukuta).
-   - Improvement: virsh new ttyconsole command, networking API implementation
-      for test driver (Daniel berrange), qemu/kvm feature reporting of
-      ACPI/APIC (David Lutterkort), checking of QEmu architectures (Daniel
-      berrange), improve devices XML errors reporting (Masayuki Sunou),
-      speedup of domain queries on Xen (Daniel berrange), augment XML dumps
-      with interface devices names (Richard Jones), internal API to query
-      drivers for features (Richard Jones).
-      
-   - Cleanups: Improve virNodeGetInfo implentation (Daniel berrange),
-      general UUID code cleanup (Daniel berrange), fix API generator
-      file selection. 
-
-
-0.3.1: Jul 24 2007:
-   - Documentation: index to remote page, script to test certificates,
-      IPv6 remote support docs (Daniel Berrange), document
-      VIRSH_DEFAULT_CONNECT_URI in virsh man page (David Lutterkort),
-      Relax-NG early grammar for the network XML (David Lutterkort)
-   - Bug fixes: leaks in disk XML parsing (Masayuki Sunou), hypervisor
-      alignment call problems on PPC64 (Christian Ehrhardt), dead client
-      registration in daemon event loop (Daniel Berrange), double free
-      in error handling (Daniel Berrange), close on exec for log file
-      descriptors in the daemon (Daniel Berrange), avoid caching problem
-      in remote daemon (Daniel Berrange), avoid crash after QEmu domain
-      failure (Daniel Berrange)
-   - Improvements: checks of x509 certificates and keys (Daniel Berrange),
-      error reports in the daemon (Daniel Berrange), checking of Ethernet MAC
-      addresses in XML configs (Masayuki Sunou), support for a new
-      clock switch between UTC and localtime (Daniel Berrange), early
-      version of OpenVZ support (Shuveb Hussain), support for input devices
-      on PS/2 and USB buses (Daniel Berrange), more tests especially
-      the QEmu support (Daniel Berrange), range check in credit scheduler
-      (with Saori Fukuta and Atsushi Sakai), add support for listen VNC
-      parameter un QEmu and fix command line arg (Daniel Berrange)
-   - Cleanups: debug tracing (Richard Jones), removal of --with-qemud-pid-file
-      (Richard Jones), remove unused virDeviceMode, new util module for
-      code shared between drivers (Shuveb Hussain), xen header location
-      detection (Richard Jones)
-
-
-0.3.0: Jul 9 2007:
-   - Secure Remote support (Richard Jones).
-      See the remote page
-      of the documentation
-  
-   - Documentation: remote support (Richard Jones), description of
-      the URI connection strings (Richard Jones), update of virsh man
-      page, matrix of libvirt API/hypervisor support with version
-      informations (Richard Jones)
-   - Bug fixes: examples Makefile.am generation (Richard Jones),
-      SetMem fix (Mark Johnson), URI handling and ordering of
-      drivers (Daniel Berrange), fix virsh help without hypervisor (Richard
-      Jones), id marshalling fix (Daniel Berrange), fix virConnectGetMaxVcpus
-      on remote (Richard Jones), avoid a realloc leak (Jim Meyering), scheduler
-      parameters handling for Xen (Richard Jones), various early remote
-      bug fixes (Richard Jones), remove virsh leaks of domains references
-      (Masayuki Sunou), configCache refill bug (Richard Jones), fix
-      XML serialization bugs
-   - Improvements: QEmu switch to XDR-based protocol (Dan Berrange),
-      device attach/detach commands (Masayuki Sunou), OCaml bindings
-      (Richard Jones), new entry points virDomainGetConnect and
-      virNetworkGetConnect useful for bindings (Richard Jones),
-      reunitifaction of remote and qemu daemon under a single libvirtd
-      with a config file (Daniel Berrange)
-   - Cleanups: parsing of connection URIs (Richard Jones), messages
-      from virsh (Saori Fukuta), Coverage files (Daniel Berrange),
-      Solaris fixes (Mark Johnson), avoid [r]index calls (Richard Jones),
-      release information in Xen backend, virsh cpupin command cleanups
-      (Masayuki Sunou), xen:/// suppport as standard Xen URI (Richard Jones and
-      Daniel Berrange), improve driver selection/decline mechanism (Richard
-      Jones), error reporting on XML dump (Richard Jones), Remove unused
-      virDomainKernel structure (Richard Jones), daemon event loop event
-      handling (Daniel Berrange), various unifications cleanup in the daemon
-      merging (Daniel Berrange), internal file and timer monitoring API
-      (Daniel Berrange), remove libsysfs dependancy, call brctl program
-      directly (Daniel Berrange), virBuffer functions cleanups (Richard Jones),
-      make init script LSB compliant, error handling on lookup functions
-      (Richard Jones), remove internal virGetDomainByID (Richard Jones),
-      revamp of xen subdrivers interfaces (Richard Jones)
-   - Localization updates
-
-
-0.2.3: Jun 8 2007:
-   - Documentation: documentation for upcoming remote access (Richard Jones),
-      virConnectNumOfDefinedDomains doc (Jan Michael), virsh help messages
-      for dumpxml and net-dumpxml (Chris Wright), 
-   - Bug fixes: RelaxNG schemas regexp fix (Robin Green), RelaxNG arch bug
-      (Mark McLoughlin), large buffers bug fixes (Shigeki Sakamoto), error
-      on out of memory condition (Shigeki Sakamoto), virshStrdup fix, non-root
-      driver when using Xen bug (Richard Jones), use --strict-order when
-      running dnsmasq (Daniel Berrange), virbr0 weirdness on restart (Mark
-      McLoughlin), keep connection error messages (Richard Jones), increase
-      QEmu read buffer on help (Daniel Berrange), rpm dependance on
-      dnsmasq (Daniel Berrange), fix XML boot device syntax (Daniel Berrange),
-      QEmu memory bug (Daniel Berrange), memory leak fix (Masayuki Sunou),
-      fix compiler flags (Richard Jones), remove type ioemu on recent Xen
-      HVM for paravirt drivers (Saori Fukuta), uninitialized string bug
-      (Masayuki Sunou), allow init even if the daemon is not running,
-      XML to config fix (Daniel Berrange)
-   - Improvements: add a special error class for the test module (Richard
-      Jones), virConnectGetCapabilities on proxy (Richard Jones), allow
-      network driver to decline usage (Richard Jones), extend error messages
-      for upcoming remote access (Richard Jones), on_reboot support for QEmu
-      (Daniel Berrange), save daemon output in a log file (Daniel Berrange),
-      xenXMDomainDefineXML can override guest config (Hugh Brock),
-      add attach-device and detach-device commands to virsh (Masayuki Sunou
-      and Mark McLoughlin and Richard Jones), make virGetVersion case
-      insensitive and Python bindings (Richard Jones), new scheduler API
-      (Atsushi SAKAI), localizations updates, add logging option for virsh
-      (Nobuhiro Itou), allow arguments to be passed to bootloader (Hugh Brock),
-      increase the test suite (Daniel Berrange and Hugh Brock)
-   - Cleanups: Remove VIR_DRV_OPEN_QUIET (Richard Jones), disable xm_internal.c
-      for Xen > 3.0.3 (Daniel Berrange), unused fields in _virDomain (Richard
-      Jones), export __virGetDomain and __virGetNetwork for libvirtd only
-      (Richard Jones), ignore old VNC config for HVM on recent Xen (Daniel
-      Berrange), various code cleanups, -Werror cleanup (Hugh Brock)
-
-
-0.2.2: Apr 17 2007:
-   - Documentation: fix errors due to Amaya (with Simon Hernandez),
-      virsh uses kB not bytes (Atsushi SAKAI), add command line help to
-      qemud (Richard Jones), xenUnifiedRegister docs (Atsushi SAKAI),
-      strings typos (Nikolay Sivov), ilocalization probalem raised by
-      Thomas Canniot
-   - Bug fixes: virsh memory values test (Masayuki Sunou), operations without
-      libvirt_qemud (Atsushi SAKAI), fix spec file (Florian La Roche, Jeremy
-      Katz, Michael Schwendt),
-      direct hypervisor call (Atsushi SAKAI), buffer overflow on qemu
-      networking command (Daniel Berrange), buffer overflow in quemud (Daniel
-      Berrange), virsh vcpupin bug (Masayuki Sunou), host PAE detections
-      and strcuctures size (Richard Jones), Xen PAE flag handling (Daniel
-      Berrange), bridged config configuration (Daniel Berrange), erroneous
-      XEN_V2_OP_SETMAXMEM value (Masayuki Sunou), memory free error (Mark
-      McLoughlin), set VIR_CONNECT_RO on read-only connections (S.Sakamoto),
-      avoid memory explosion bug (Daniel Berrange), integer overflow
-      for qemu CPU time (Daniel Berrange), QEMU binary path check (Daniel
-      Berrange)
-   - Cleanups: remove some global variables (Jim Meyering), printf-style
-      functions checks (Jim Meyering), better virsh error messages, increase
-      compiler checkings and security (Daniel Berrange), virBufferGrow usage
-      and docs, use calloc instead of malloc/memset, replace all sprintf by
-      snprintf, avoid configure clobbering user's CTAGS (Jim Meyering),
-      signal handler error cleanup (Richard Jones), iptables internal code
-      claenup (Mark McLoughlin), unified Xen driver (Richard Jones),
-      cleanup XPath libxml2 calls, IPTables rules tightening (Daniel
-      Berrange), 
-   - Improvements: more regression tests on XML (Daniel Berrange), Python
-      bindings now generate exception in error cases (Richard Jones),
-      Python bindings for vir*GetAutoStart (Daniel Berrange),
-      handling of CD-Rom device without device name (Nobuhiro Itou),
-      fix hypervisor call to work with Xen 3.0.5 (Daniel Berrange),
-      DomainGetOSType for inactive domains (Daniel Berrange), multiple boot
-      devices for HVM (Daniel Berrange),
-      
-
-
-0.2.1: Mar 16 2007:
-   - Various internal cleanups (Richard Jones,Daniel Berrange,Mark McLoughlin)
-   - Bug fixes: libvirt_qemud daemon path (Daniel Berrange), libvirt
-      config directory (Daniel Berrange and Mark McLoughlin), memory leak
-      in qemud (Mark), various fixes on network support (Mark), avoid Xen
-      domain zombies on device hotplug errors (Daniel Berrange), various
-      fixes on qemud (Mark), args parsing (Richard Jones), virsh -t argument
-      (Saori Fukuta), avoid virsh crash on TAB key (Daniel Berrange), detect
-      xend operation failures (Kazuki Mizushima), don't listen on null socket
-      (Rich Jones), read-only socket cleanup (Rich Jones), use of vnc port 5900
-      (Nobuhiro Itou), assorted networking fixes (Daniel Berrange), shutoff and
-      shutdown mismatches (Kazuki Mizushima), unlimited memory handling
-      (Atsushi SAKAI), python binding fixes (Tatsuro Enokura)
-   - Build and portability fixes: IA64 fixes (Atsushi SAKAI), dependancies
-      and build (Daniel Berrange), fix xend port detection (Daniel
-      Berrange), icompile time warnings (Mark), avoid const related
-      compiler warnings (Daniel Berrange), automated builds (Daniel
-      Berrange), pointer/int mismatch (Richard Jones), configure time
-      selection of drivers, libvirt spec hacking (Daniel Berrange)
-   - Add support for network autostart and init scripts (Mark McLoughlin)
-   - New API virConnectGetCapabilities() to detect the virtualization
-    capabilities of a host (Richard Jones)
-   - Minor improvements: qemud signal handling (Mark), don't shutdown or reboot
-    domain0 (Kazuki Mizushima), QEmu version autodetection (Daniel Berrange),
-    network UUIDs (Mark), speed up UUID domain lookups (Tatsuro Enokura and
-    Daniel Berrange), support for paused QEmu CPU (Daniel Berrange), keymap
-    VNC attribute support (Takahashi Tomohiro and Daniel Berrange), maximum
-    number of virtual CPU (Masayuki Sunou), virtsh --readonly option (Rich
-    Jones), python bindings for new functions (Daniel Berrange)
-   - Documentation updates especially on the XML formats
-
-
-0.2.0: Feb 14 2007:
-   - Various internal cleanups (Mark McLoughlin, Richard Jones,
-      Daniel Berrange, Karel Zak)
-   - Bug fixes: avoid a crash in connect (Daniel Berrange), virsh args
-      parsing (Richard Jones)
-   - Add support for QEmu and KVM virtualization (Daniel Berrange)
-   - Add support for network configuration (Mark McLoughlin)
-   - Minor improvements: regression testing (Daniel Berrange),
-      localization string updates
-
-
-0.1.11: Jan 22 2007:
-   - Finish XML <-> XM config files support
-   - Remove memory leak when freeing virConf objects
-   - Finishing inactive domain support (Daniel Berrange)
-   - Added a Relax-NG schemas to check XML instances
-
-
-0.1.10: Dec 20 2006:
-   - more localizations
-   - bug fixes: VCPU info breakages on xen 3.0.3, xenDaemonListDomains buffer overflow (Daniel Berrange), reference count bug when creating Xen domains (Daniel Berrange).
-   - improvements: support graphic framebuffer for Xen paravirt (Daniel Berrange), VNC listen IP range support (Daniel Berrange), support for default Xen config files and inactive domains of 3.0.4 (Daniel Berrange).
-
-
-0.1.9: Nov 29 2006:
-   - python bindings: release interpeter lock when calling C (Daniel Berrange)
-   - don't raise HTTP error when looking informations for a domain
-   - some refactoring to use the driver for all entry points
-   - better error reporting (Daniel Berrange)
-   - fix OS reporting when running as non-root
-   - provide XML parsing errors
-   - extension of the test framework (Daniel Berrange)
-   - fix the reconnect regression test
-   - python bindings: Domain instances now link to the Connect to avoid garbage collection and disconnect
-   - separate the notion of maximum memory and current use at the XML level
-   - Fix a memory leak (Daniel Berrange)
-   - add support for shareable drives
-   - add support for non-bridge style networking configs for guests(Daniel Berrange)
-   - python bindings: fix unsigned long marshalling (Daniel Berrange)
-   - new config APIs virConfNew() and virConfSetValue() to build configs from scratch
-   - hot plug device support based on Michel Ponceau patch
-   - added support for inactive domains, new APIs, various associated cleanup (Daniel Berrange)
-   - special device model for HVM guests (Daniel Berrange)
-   - add API to dump core of domains (but requires a patched xend)
-   - pygrub bootloader informations take over <os> informations
-   - updated the localization strings
-
-
-0.1.8: Oct 16 2006:
-   -  Bug for system with page size != 4k
-   -  vcpu number initialization (Philippe Berthault)
-   -  don't label crashed domains as shut off (Peter Vetere)
-   -  fix virsh man page (Noriko Mizumoto)
-   -  blktapdd support for alternate drivers like blktap (Daniel Berrange)
-   -  memory leak fixes (xend interface and XML parsing) (Daniel Berrange)
-   -  compile fix
-   -  mlock/munlock size fixes (Daniel Berrange)
-   -  improve error reporting
-
-
-0.1.7: Sep 29 2006:
-   -  fix a memory bug on getting vcpu informations from xend (Daniel Berrange)
-   -  fix another problem in the hypercalls change in Xen changeset
-       86d26e6ec89b when getting domain informations (Daniel Berrange)
-
-
-0.1.6: Sep 22 2006:
-   - Support for localization of strings using gettext (Daniel Berrange)
-   - Support for new Xen-3.0.3 cdrom and disk configuration (Daniel Berrange)
-   - Support for setting VNC port when creating domains with new
-      xend config files (Daniel Berrange) 
-   - Fix bug when running against xen-3.0.2 hypercalls (Jim Fehlig)
-   - Fix reconnection problem when talking directly to http xend
-
-
-0.1.5: Sep 5 2006:
-   - Support for new hypercalls change in Xen changeset 86d26e6ec89b
-   - bug fixes: virParseUUID() was wrong, netwoking for paravirt guestsi
-      (Daniel Berrange), virsh on non-existent domains (Daniel Berrange),
-      string cast bug when handling error in python (Pete Vetere), HTTP
-      500 xend error code handling (Pete Vetere and Daniel Berrange)
-   - improvements: test suite for SEXPR <-> XML format conversions (Daniel
-      Berrange), virsh output regression suite (Daniel Berrange), new environ
-      variable VIRSH_DEFAULT_CONNECT_URI for the default URI when connecting
-      (Daniel Berrange), graphical console support for paravirt guests
-      (Jeremy Katz), parsing of simple Xen config files (with Daniel Berrange),
-      early work on defined (not running) domains (Daniel Berrange),
-      virsh output improvement (Daniel Berrange
-
-
-0.1.4: Aug 16 2006:
-   - bug fixes: spec file fix (Mark McLoughlin), error report problem (with
-    Hugh Brock), long integer in Python bindings (with Daniel Berrange), XML
-    generation bug for CDRom (Daniel Berrange), bug whem using number() XPath
-    function (Mark McLoughlin), fix python detection code, remove duplicate
-    initialization errors (Daniel Berrange)
-   - improvements: UUID in XML description (Peter Vetere), proxy code
-    cleanup, virtual CPU and affinity support + virsh support (Michel
-    Ponceau, Philippe Berthault, Daniel Berrange), port and tty informations
-    for console in XML (Daniel Berrange), added XML dump to driver and proxy
-    support (Daniel Berrange), extention of boot options with support for
-    floppy and cdrom (Daniel Berrange), features block in XML to report/ask
-    PAE, ACPI, APIC for HVM domains (Daniel Berrange), fail saide-effect
-    operations when using read-only connection, large improvements to test
-    driver (Daniel Berrange) 
-   - documentation: spelling (Daniel Berrange), test driver examples.
-
-
-0.1.3: Jul 11 2006:
-   - bugfixes: build as non-root, fix xend access when root, handling of
-    empty XML elements (Mark McLoughlin), XML serialization and parsing fixes
-    (Mark McLoughlin), allow to create domains without disk (Mark
-  McLoughlin),
-   - improvement: xenDaemonLookupByID from O(n^2) to O(n) (Daniel Berrange),
-    support for fully virtualized guest (Jim Fehlig, DV, Mark McLoughlin)
-   - documentation: augmented to cover hvm domains
-
-
-0.1.2: Jul 3 2006:
-   - headers include paths fixup
-   - proxy mechanism for unpriviledged read-only access by httpu
-
-
-0.1.1: Jun 21 2006:
-   - building fixes: ncurses fallback (Jim Fehlig), VPATH builds (Daniel P.
-    Berrange)
-   - driver cleanups: new entry points, cleanup of libvirt.c (with Daniel P.
-    Berrange)
-   - Cope with API change introduced in Xen changeset 10277
-   - new test driver for regression checks (Daniel P. Berrange)
-   - improvements: added UUID to XML serialization, buffer usage (Karel
-    Zak), --connect argument to virsh (Daniel P. Berrange),
-   - bug fixes: uninitialized memory access in error reporting, S-Expr
-    parsing (Jim Fehlig, Jeremy Katz), virConnectOpen bug, remove a TODO in
-    xs_internal.c
-   - documentation: Python examples (David Lutterkort), new Perl binding
-    URL, man page update (Karel Zak)
-
-
-0.1.0: Apr 10 2006:
-   - building fixes: --with-xen-distdir option (Ronald Aigner), out of tree
-    build and pkginfo cflag fix (Daniel Berrange)
-   - enhancement and fixes of the XML description format (David Lutterkort
-    and Jim Fehlig)
-   - new APIs: for Node information and Reboot
-   - internal code cleanup: refactoring internals into a driver model, more
-    error handling, structure sharing, thread safety and ref counting
-   - bug fixes: error message (Jim Meyering), error allocation in virsh (Jim
-    Meyering), virDomainLookupByID (Jim Fehlig),
-   - documentation: updates on architecture, and format, typo fix (Jim
-    Meyering)
-   - bindings: exception handling in examples (Jim Meyering), perl ones out
-    of tree (Daniel Berrange)
-   - virsh: more options, create, nodeinfo (Karel Zak), renaming of some
-    options (Karel Zak), use stderr only for errors (Karel Zak), man page
-    (Andrew Puch)
-
-
-0.0.6: Feb 28 2006:
-   - add UUID lookup and extract API
-   - add error handling APIs both synchronous and asynchronous
-   - added minimal hook for error handling at the python level, improved the
-    python bindings
-   - augment the documentation and tests to cover error handling
-
-
-0.0.5: Feb 23 2006:
-   - Added XML description parsing, dependance to libxml2, implemented the
-    creation API virDomainCreateLinux()
-   - new APIs to lookup and name domain by UUID
-   - fixed the XML dump when using the Xend access
-   - Fixed a few more problem related to the name change
-   - Adding regression tests in python and examples in C
-   - web site improvement, extended the documentation to cover the XML
-    format and Python API
-   - Added devhelp help for Gnome/Gtk programmers
-
-
-0.0.4: Feb 10 2006:
-   - Fix various bugs introduced in the name change
-
-
-0.0.3: Feb 9 2006:
-   - Switch name from from 'libvir' to libvirt
-   - Starting infrastructure to add code examples
-   - Update of python bindings for completeness
-
-
-0.0.2: Jan 29 2006:
-   - Update of the documentation, web site redesign (Diana Fong)
-   - integration of HTTP xend RPC based on libxend by Anthony Liquori for
-    most operations
-   - Adding Save and Restore APIs
-   - extended the virsh command line tool (Karel Zak)
-   - remove xenstore transactions (Anthony Liguori)
-   - fix the Python bindings bug when domain and connections where freed
-
-
-0.0.1: Dec 19 2005:
-   - First release
-   - Basic management of existing Xen domains
-   - Minimal autogenerated Python bindings
-

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,17 +14,30 @@ 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
@@ -36,5 +49,40 @@ if [ -f /usr/bin/rpmbuild ]; then
     NOW=`date +"%s"`
     EXTRA_RELEASE=".$USER$NOW"
   fi
-  rpmbuild --nodeps --define "extra_release $EXTRA_RELEASE" -ta --clean *.tar.gz
+
+  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-openvz \
+    --without-libvirtd
+
+  make
+  make install
+
+  #set -o pipefail
+  #make check 2>&1 | tee "$RESULTS"
+
+  rpmbuild --nodeps \
+     --define "extra_release $EXTRA_RELEASE" \
+     --define "_sourcedir `pwd`" \
+     -ba --clean mingw-libvirt.spec
 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,26 @@ esac
 gnulib_tool=$GNULIB_SRCDIR/gnulib-tool
 <$gnulib_tool || exit
 
+modules='
+c-ctype
+getaddrinfo
+getpass
+gettext
+inet_pton
+mkstemp
+mktempd
+physmem
+poll
+posix-shell
+strndup
+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,11 +95,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      \
-    vc-list-files
+  --import $modules
 
 rm -f				\
     .gitignore			\

build-aux/.cvsignore

@@ -7,3 +7,4 @@ install-sh
 ltmain.sh
 missing
 mkinstalldirs
+mktempd

build-aux/mktempd

@@ -0,0 +1,134 @@
+#!/bin/sh
+# Create a temporary directory, much like mktemp -d does.
+
+# Copyright (C) 2007-2008 Free Software Foundation, Inc.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Written by Jim Meyering.
+
+# Usage: mktempd /tmp phoey.XXXXXXXXXX
+
+# First, try to use the mktemp program.
+# Failing that, we'll roll our own mktemp-like function:
+#  - try to get random bytes from /dev/urandom
+#  - failing that, generate output from a combination of quickly-varying
+#      sources and gzip.  Ignore non-varying gzip header, and extract
+#      "random" bits from there.
+#  - given those bits, map to file-name bytes using tr, and try to create
+#      the desired directory.
+#  - make only $MAX_TRIES attempts
+
+ME=`basename "$0"`
+die() { echo >&2 "$ME: $@"; exit 1; }
+
+MAX_TRIES=4
+
+rand_bytes()
+{
+  n=$1
+
+  chars=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789
+
+  dev_rand=/dev/urandom
+  if test -r "$dev_rand"; then
+    # Note: 256-length($chars) == 194; 3 copies of $chars is 186 + 8 = 194.
+    dd ibs=$n count=1 if="$dev_rand" | tr -c $chars 01234567$chars$chars$chars
+    return
+  fi
+
+  cmds='date; date +%N; free; who -a; w; ps auxww; ps ef; netstat -n'
+  data=` (eval "$cmds") 2>&1 | gzip `
+
+  n_plus_50=`expr $n + 50`
+
+  # Ensure that $data has length at least 50+$n
+  while :; do
+    len=`echo "$data"|wc -c`
+    test $n_plus_50 -le $len && break;
+    data=` (echo "$data"; eval "$cmds") 2>&1 | gzip `
+  done
+
+  echo "$data" \
+    | dd bs=1 skip=50 count=$n 2>/dev/null \
+    | tr -c $chars 01234567$chars$chars$chars
+}
+
+mktempd()
+{
+  case $# in
+  2);;
+  *) die "Usage: $ME DIR TEMPLATE";;
+  esac
+
+  destdir=$1
+  template=$2
+
+  # Disallow any trailing slash on specified destdir:
+  # it would subvert the post-mktemp "case"-based destdir test.
+  case $destdir in
+  /) ;;
+  */) die "invalid destination dir: remove trailing slash(es)";;
+  esac
+
+  case $template in
+  *XXXX) ;;
+  *) die "invalid template: $template (must have a suffix of at least 4 X's)";;
+  esac
+
+  fail=0
+
+  # First, try to use mktemp.
+  d=`env -u TMPDIR mktemp -d -t -p "$destdir" "$template" 2>/dev/null` \
+    || fail=1
+
+  # The resulting name must be in the specified directory.
+  case $d in "$destdir"*);; *) fail=1;; esac
+
+  # It must have created the directory.
+  test -d "$d" || fail=1
+
+  # It must have 0700 permissions.  Handle sticky "S" bits.
+  perms=`ls -dgo "$d" 2>/dev/null|tr S -` || fail=1
+  case $perms in drwx------*) ;; *) fail=1;; esac
+
+  test $fail = 0 && {
+    echo "$d"
+    return
+  }
+
+  # If we reach this point, we'll have to create a directory manually.
+
+  # Get a copy of the template without its suffix of X's.
+  base_template=`echo "$template"|sed 's/XX*$//'`
+
+  # Calculate how many X's we've just removed.
+  template_length=`echo "$template" | wc -c`
+  nx=`echo "$base_template" | wc -c`
+  nx=`expr $template_length - $nx`
+
+  err=
+  i=1
+  while :; do
+    X=`rand_bytes $nx`
+    candidate_dir="$destdir/$base_template$X"
+    err=`mkdir -m 0700 "$candidate_dir" 2>&1` \
+      && { echo "$candidate_dir"; return; }
+    test $MAX_TRIES -le $i && break;
+    i=`expr $i + 1`
+  done
+  die "$err"
+}
+
+mktempd "$@"

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-02-11 08:08'; # 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*\2\s*\)|
-                \s*\{\s*$regexp\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/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 maintainance 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> ?
+    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
+  </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 priviledges,
+        <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,7 @@ included_files = {
 
 ignored_words = {
   "ATTRIBUTE_UNUSED": (0, "macro keyword"),
+  "VIR_DEPRECATED": (0, "macro keyword"),
 }
 
 def escape(raw):
@@ -752,7 +753,7 @@ class CParser:
 	return((args, desc))
 
      #
-     # Parse a comment block and merge the informations found in the
+     # Parse a comment block and merge the information found in the
      # parameters descriptions, finally returns a block as complete
      # as possible
      #

docs/apps.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 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>
+      </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,108 @@
+<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>
+
+
+  </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,34 +1,115 @@
 <?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 informations shared by the
+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
-priviledge of the embedding program. If it runs with root access,
+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 informations at
+may talk directly to the hypervisor when gathering state information at
 least when possible (i.e. when the running program using libvirt has root
-priviledge 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,32 +117,41 @@ 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 targetted.</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
-maintainance and simplify the support of other virtualization engine the
+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 hypvisor drivers
-defining a common set of routines. That way the Xen Daemon accces, the Xen
+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,39 +1,168 @@
 <?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, independant
+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>
-The libvirt daemon allows the adminstrator to choose the authentication
-mechanisms used for client connections on each network socket independantly.
+</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
 <code>/etc/libvirt/libvirtd.conf</code>. Each of the libvirt sockets can
-have its authentication mechanism configured independantly. There is
+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>
-The default policy can be overriden by the adminstrator using the PolicyKit
+</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,27 +248,31 @@ 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 neccessary to install a sub-package such as <code>cyrus-sasl-gssapi</code>.
+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>
-Next is is neccessary for the adminsitrator of the Kerberos realm to issue a principle
+</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>
+</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 acces 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,17 +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, <a href="http://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora%20Core&amp;component=libvirt">log a new bug</a> and 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 developpers 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/libvirt-conf.html

@@ -104,7 +104,7 @@ The content of this structure is not made public by the API.
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConfReadMem"/>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>lenght 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></div>
+<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></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConfWriteFile"/>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>
@@ -112,7 +112,7 @@ The content of this structure is not made public by the API.
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConfWriteMem"/>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 lenght 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 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>
         <hr/>
       </div>
     </div>

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>
@@ -77,10 +77,11 @@ typedef struct _virStorageVol <a href="#virStorageVol">virStorageVol</a>;
 typedef <a href="libvirt-libvirt.html#virStorageVolInfo">virStorageVolInfo</a> * <a href="#virStorageVolInfoPtr">virStorageVolInfoPtr</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="#virDomainMemoryFlags">virDomainMemoryFlags</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 <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 <a href="libvirt-libvirt.html#virVcpuInfo">virVcpuInfo</a> * <a href="#virVcpuInfoPtr">virVcpuInfoPtr</a>;
@@ -161,12 +162,14 @@ int	<a href="#virDomainGetInfo">virDomainGetInfo</a>		(<a href="libvirt-libvirt.
 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);
 <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="#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);
@@ -212,6 +215,7 @@ int	<a href="#virConnectNumOfDefinedStoragePools">virConnectNumOfDefinedStorageP
 int	<a href="#virStoragePoolCreate">virStoragePoolCreate</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned int flags);
 int	<a href="#virDomainSetVcpus">virDomainSetVcpus</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned int nvcpus);
 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);
 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 +325,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 {
@@ -338,7 +342,7 @@ The content of this structure is not made public by the API.
     long long	rd_req	: number of read requests
     long long	rd_bytes	: number of read bytes
     long long	wr_req	: number of write requests
-    long long	wr_bytes	: numbber of written bytes
+    long long	wr_bytes	: number of written bytes
     long long	errs	: In Xen this returns the mysterious 'oo_req'.
 } virDomainBlockStatsStruct;
 </pre><p/>
@@ -351,7 +355,7 @@ The content of this structure is not made public by the API.
 </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 +383,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 +398,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> {
@@ -404,8 +414,8 @@ The content of this structure is not made public by the API.
 </div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainXMLFlags">Enum </a>virDomainXMLFlags</h3><pre class="programlisting">enum <a href="#virDomainXMLFlags">virDomainXMLFlags</a> {
-    <a name="VIR_DOMAIN_XML_SECURE">VIR_DOMAIN_XML_SECURE</a> = 1 /* dump security sensitive informations too */
-    <a name="VIR_DOMAIN_XML_INACTIVE">VIR_DOMAIN_XML_INACTIVE</a> = 2 /*  dump inactive domain informations */
+    <a name="VIR_DOMAIN_XML_SECURE">VIR_DOMAIN_XML_SECURE</a> = 1 /* dump security sensitive information too */
+    <a name="VIR_DOMAIN_XML_INACTIVE">VIR_DOMAIN_XML_INACTIVE</a> = 2 /*  dump inactive domain information */
 };
 </pre><p/>
 </div>
@@ -574,6 +584,10 @@ 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="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>
@@ -596,11 +610,11 @@ 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 a hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the URI string which must be freed by the caller, or NULL if there was an error.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConnectGetVersion"/>virConnectGetVersion ()</h3><pre class="programlisting">int	virConnectGetVersion		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 unsigned long * hvVer)<br/>
-</pre><p>Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with priviledged access to the hypervisor, not with a Read-Only connection.</p>
+</pre><p>Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with privileged access to the hypervisor, not with a Read-Only connection.</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>hvVer</tt></i>:</span></td><td>return value for the version of the running hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 otherwise. if the version can't be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConnectListDefinedDomains"/>virConnectListDefinedDomains ()</h3><pre class="programlisting">int	virConnectListDefinedDomains	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 char ** const names, <br/>					 int maxnames)<br/>
-</pre><p>list the defined domains, stores the pointers to the names in @names</p>
+</pre><p>list the defined but inactive domains, stores the pointers to the names in @names</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>names</tt></i>:</span></td><td>pointer to an array to store the names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names provided in the array or -1 in case of error</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConnectListDefinedNetworks"/>virConnectListDefinedNetworks ()</h3><pre class="programlisting">int	virConnectListDefinedNetworks	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>					 char ** const names, <br/>					 int maxnames)<br/>
@@ -624,7 +638,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 hypervisor connection</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array of char * to fill with pool names (allocated by caller)</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on error</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConnectNumOfDefinedDomains"/>virConnectNumOfDefinedDomains ()</h3><pre class="programlisting">int	virConnectNumOfDefinedDomains	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br/>
-</pre><p>Provides the number of inactive domains.</p>
+</pre><p>Provides the number of defined but inactive 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>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConnectNumOfDefinedNetworks"/>virConnectNumOfDefinedNetworks ()</h3><pre class="programlisting">int	virConnectNumOfDefinedNetworks	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br/>
@@ -652,16 +666,20 @@ 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>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConnectOpenAuth"/>virConnectOpenAuth ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virConnectOpenAuth	(const char * name, <br/>					 <a href="libvirt-libvirt.html#virConnectAuthPtr">virConnectAuthPtr</a> auth, <br/>					 int flags)<br/>
-</pre><p>This function should be called first to get a connection to the Hypervisor. If neccessary, authentication will be performed fetching credentials via the callback</p>
+</pre><p>This function should be called first to get a connection to the Hypervisor. If necessary, authentication will be performed fetching credentials via the callback</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>auth</tt></i>:</span></td><td>Authenticate callback parameters</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>Open flags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virConnectOpenReadOnly"/>virConnectOpenReadOnly ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virConnectOpenReadOnly	(const char * name)<br/>
-</pre><p>This function should be called first to get a restricted connection to the libbrary functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</p>
+</pre><p>This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div></div>
         <hr/>
         <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 +694,15 @@ 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 priviledged 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>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>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. 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 priviledged 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/>
@@ -744,8 +762,8 @@ 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>buf</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainGetVcpus"/>virDomainGetVcpus ()</h3><pre class="programlisting">int	virDomainGetVcpus		(<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)<br/>
-</pre><p>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer is'nt NULL.</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, 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 cupmap 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>
+</pre><p>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer isn't NULL.</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, 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>
@@ -756,7 +774,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,13 +788,17 @@ 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>
 <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>dconn</tt></i>:</span></td><td>destination host (a connection object)</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags</td></tr><tr><td><span class="term"><i><tt>dname</tt></i>:</span></td><td>(optional) rename domain to this at destination</td></tr><tr><td><span class="term"><i><tt>uri</tt></i>:</span></td><td>(optional) dest hostname/URI as seen from the source host</td></tr><tr><td><span class="term"><i><tt>bandwidth</tt></i>:</span></td><td>(optional) specify migration bandwidth limit in Mbps</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the new domain object if the migration was successful, or NULL in case of error. Note that the new domain object exists in the scope of the destination connection (dconn).</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainPinVcpu"/>virDomainPinVcpu ()</h3><pre class="programlisting">int	virDomainPinVcpu		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned int vcpu, <br/>					 unsigned char * cpumap, <br/>					 int maplen)<br/>
-</pre><p>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires priviledged access to the hypervisor.</p>
+</pre><p>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</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, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>vcpu</tt></i>:</span></td><td>virtual CPU number</td></tr><tr><td><span class="term"><i><tt>cpumap</tt></i>:</span></td><td>pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.</td></tr><tr><td><span class="term"><i><tt>maplen</tt></i>:</span></td><td>number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen &lt; size, missing bytes are set to zero. If maplen &gt; size, failure code is returned.</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="virDomainReboot"/>virDomainReboot ()</h3><pre class="programlisting">int	virDomainReboot			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned int flags)<br/>
@@ -788,7 +810,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>from</tt></i>:</span></td><td>path to the</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="virDomainResume"/>virDomainResume ()</h3><pre class="programlisting">int	virDomainResume			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br/>
-</pre><p>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires priviledged access</p>
+</pre><p>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires 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="virDomainSave"/>virDomainSave ()</h3><pre class="programlisting">int	virDomainSave			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 const char * to)<br/>
@@ -800,11 +822,11 @@ 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>autostart</tt></i>:</span></td><td>whether the domain should be automatically started 0 or 1</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainSetMaxMemory"/>virDomainSetMaxMemory ()</h3><pre class="programlisting">int	virDomainSetMaxMemory		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned long memory)<br/>
-</pre><p>Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function requires priviledged access to the hypervisor.</p>
+</pre><p>Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function requires privileged access to the hypervisor.</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 or NULL</td></tr><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>the memory size in kilobytes</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="virDomainSetMemory"/>virDomainSetMemory ()</h3><pre class="programlisting">int	virDomainSetMemory		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned long memory)<br/>
-</pre><p>Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may requires priviledged access to the hypervisor.</p>
+</pre><p>Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. 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>domain</tt></i>:</span></td><td>a domain object or NULL</td></tr><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>the memory size in kilobytes</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="virDomainSetSchedulerParameters"/>virDomainSetSchedulerParameters ()</h3><pre class="programlisting">int	virDomainSetSchedulerParameters	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br/>					 int nparams)<br/>
@@ -812,7 +834,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</td></tr><tr><td><span class="term"><i><tt>params</tt></i>:</span></td><td>pointer to scheduler parameter objects</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>number of scheduler parameter (this value should be same or less than the returned value nparams of virDomainGetSchedulerType)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainSetVcpus"/>virDomainSetVcpus ()</h3><pre class="programlisting">int	virDomainSetVcpus		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br/>					 unsigned int nvcpus)<br/>
-</pre><p>Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires priviledged access to the hypervisor.</p>
+</pre><p>Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires privileged access to the hypervisor.</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, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>nvcpus</tt></i>:</span></td><td>the new number of virtual CPUs for this 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 failure.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virDomainShutdown"/>virDomainShutdown ()</h3><pre class="programlisting">int	virDomainShutdown		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br/>
@@ -820,15 +842,15 @@ 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="virDomainSuspend"/>virDomainSuspend ()</h3><pre class="programlisting">int	virDomainSuspend		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br/>
-</pre><p>Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires priviledged access.</p>
+</pre><p>Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires 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="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="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 availble, an error code will be returned and @typeVer will be 0.</p>
+</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>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>libVer</tt></i>:</span></td><td>return value for the library version (OUT)</td></tr><tr><td><span class="term"><i><tt>type</tt></i>:</span></td><td>the type of connection/driver looked at</td></tr><tr><td><span class="term"><i><tt>typeVer</tt></i>:</span></td><td>return value for the version of the hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virInitialize"/>virInitialize ()</h3><pre class="programlisting">int	virInitialize			(void)<br/>
@@ -848,7 +870,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 priviledged 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/>
@@ -908,7 +930,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>freeMems</tt></i>:</span></td><td>pointer to the array of unsigned long long</td></tr><tr><td><span class="term"><i><tt>startCell</tt></i>:</span></td><td>index of first cell to return freeMems info on.</td></tr><tr><td><span class="term"><i><tt>maxCells</tt></i>:</span></td><td>Maximum number of cells for which freeMems information can be returned.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of entries filled in freeMems, or -1 in case of error.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virNodeGetFreeMemory"/>virNodeGetFreeMemory ()</h3><pre class="programlisting">unsigned long long	virNodeGetFreeMemory	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br/>
-</pre><p>provides the free memory availble on the Node</p>
+</pre><p>provides the free memory available on 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>Returns</tt></i>:</span></td><td>the available free memory in kilobytes or 0 in case of error</td></tr></tbody></table></div></div>
         <hr/>
         <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/>
@@ -917,19 +939,19 @@ The content of this structure is not made public by the API.
         <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>
-<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 upon failure</td></tr></tbody></table></div></div>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 upon failure</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStoragePoolCreate"/>virStoragePoolCreate ()</h3><pre class="programlisting">int	virStoragePoolCreate		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned int flags)<br/>
 </pre><p>Starts an inactive storage pool</p>
-<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be started</td></tr></tbody></table></div></div>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be started</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStoragePoolCreateXML"/>virStoragePoolCreateXML ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolCreateXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>						 const char * xmlDesc, <br/>						 unsigned int flags)<br/>
-</pre><p>Create a new storage based on its XML description. The pool is not persitent, so its definition will disappear when it is destroyed, or if the host is restarted</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>xmlDesc</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div></div>
+</pre><p>Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted</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>xmlDesc</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStoragePoolDefineXML"/>virStoragePoolDefineXML ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolDefineXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/>						 const char * xml, <br/>						 unsigned int flags)<br/>
-</pre><p>Define a new inactive storage pool based on its XML description. The pool is persitent, until explicitly undefined.</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>xml</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div></div>
+</pre><p>Define a new inactive storage pool based on its XML description. The pool is persistent, until explicitly undefined.</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>xml</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStoragePoolDelete"/>virStoragePoolDelete ()</h3><pre class="programlisting">int	virStoragePoolDelete		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned int flags)<br/>
 </pre><p>Delete the underlying pool resources. This is a non-recoverable operation. The <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object itself is not free'd.</p>
@@ -949,7 +971,7 @@ The content of this structure is not made public by the API.
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStoragePoolGetConnect"/>virStoragePoolGetConnect ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virStoragePoolGetConnect	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br/>
 </pre><p>Provides the connection pointer associated with a storage pool. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the pool object together.</p>
-<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to a poool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div></div>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to a pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStoragePoolGetInfo"/>virStoragePoolGetInfo ()</h3><pre class="programlisting">int	virStoragePoolGetInfo		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 <a href="libvirt-libvirt.html#virStoragePoolInfoPtr">virStoragePoolInfoPtr</a> info)<br/>
 </pre><p>Get volatile information about the storage pool such as free space / usage summary</p>
@@ -969,7 +991,7 @@ The content of this structure is not made public by the API.
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStoragePoolGetXMLDesc"/>virStoragePoolGetXMLDesc ()</h3><pre class="programlisting">char *	virStoragePoolGetXMLDesc	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 unsigned int flags)<br/>
 </pre><p>Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the <a href="libvirt-libvirt.html#virStoragePoolCreateXML">virStoragePoolCreateXML</a> method.</p>
-<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML format options (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a XML document, or NULL on error</td></tr></tbody></table></div></div>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML format options (set of virDomainXMLFlags)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a XML document, or NULL on error</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStoragePoolListVolumes"/>virStoragePoolListVolumes ()</h3><pre class="programlisting">int	virStoragePoolListVolumes	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br/>					 char ** const names, <br/>					 int maxnames)<br/>
 </pre><p>Fetch list of storage volume names, limiting to at most maxnames.</p>
@@ -1013,7 +1035,7 @@ The content of this structure is not made public by the API.
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStorageVolDelete"/>virStorageVolDelete ()</h3><pre class="programlisting">int	virStorageVolDelete		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br/>					 unsigned int flags)<br/>
 </pre><p>Delete the storage volume from the pool</p>
-<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td/></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div></div>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStorageVolFree"/>virStorageVolFree ()</h3><pre class="programlisting">int	virStorageVolFree		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br/>
 </pre><p>Release the storage volume handle. The underlying storage volume contains to exist</p>
@@ -1021,14 +1043,14 @@ The content of this structure is not made public by the API.
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStorageVolGetConnect"/>virStorageVolGetConnect ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virStorageVolGetConnect	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br/>
 </pre><p>Provides the connection pointer associated with a storage volume. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the volume object together.</p>
-<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to a poool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div></div>
+<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to a pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStorageVolGetInfo"/>virStorageVolGetInfo ()</h3><pre class="programlisting">int	virStorageVolGetInfo		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br/>					 <a href="libvirt-libvirt.html#virStorageVolInfoPtr">virStorageVolInfoPtr</a> info)<br/>
 </pre><p>Fetches volatile information about the storage volume such as its current allocation</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer at which to store info</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on failure</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStorageVolGetKey"/>virStorageVolGetKey ()</h3><pre class="programlisting">const char *	virStorageVolGetKey	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br/>
-</pre><p>Fetch the storage volume key. This is globally unique, so the same volume will hve the same key no matter what host it is accessed from</p>
+</pre><p>Fetch the storage volume key. This is globally unique, so the same volume will have the same key no matter what host it is accessed from</p>
 <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the volume key, or NULL on error</td></tr></tbody></table></div></div>
         <hr/>
         <div class="refsect2" lang="en"><h3><a name="virStorageVolGetName"/>virStorageVolGetName ()</h3><pre class="programlisting">const char *	virStorageVolGetName	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br/>

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, see note above
+    <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	dom	: domain if available, 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, see note above
 } virError;
 </pre><p/>
 </div>
@@ -97,7 +97,10 @@ void	<a href="#virConnResetLastError">virConnResetLastError</a>		(<a href="libvi
     <a name="VIR_FROM_OPENVZ">VIR_FROM_OPENVZ</a> = 14 /* Error from OpenVZ driver */
     <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_STORAGE">VIR_FROM_STORAGE</a> = 17 /*  Error from storage driver */
+    <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_NETWORK">VIR_FROM_NETWORK</a> = 19 /* Error from network config */
+    <a name="VIR_FROM_DOMAIN">VIR_FROM_DOMAIN</a> = 20 /*  Error from domain config */
 };
 </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,144 @@
+<?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 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,132 @@
+<?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 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,132 @@
+<?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 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>
+      </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,5 @@
+<html>
+  <body>
+    <h1>OpenVZ container driver</h1>
+  </body>
+</html>

docs/drvqemu.html

@@ -0,0 +1,210 @@
+<?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 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,132 @@
+<?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 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,132 @@
+<?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 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/drvxen.html

@@ -0,0 +1,326 @@
+<?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 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,69 +1,138 @@
 <?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 informations 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 prossible 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 informations</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 informations are 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
-    targetted in the operation</li>
-</ul><p>and then extra raw informations about the error which may be initialized
-to 0 or NULL if unused</p><ul><li>str1, str2, str3: string informations, usually str1 is the error
-    message format</li>
-  <li>int1, int2: integer informations</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>,
-chech the value of the code value, take appropriate action, if needed let
+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):
+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/examples.xml

@@ -1,7 +1,7 @@
 <examples>
   <example filename='info1.c'>
-    <synopsis>Extract informations about Xen domain 0</synopsis>
-    <purpose>Demonstrate the basic use of the library to connect to the hypervisor and extract domain informations.</purpose>
+    <synopsis>Extract information about Xen domain 0</synopsis>
+    <purpose>Demonstrate the basic use of the library to connect to the hypervisor and extract domain information.</purpose>
     <usage>info1</usage>
     <test>info1</test>
     <author>Daniel Veillard</author>

docs/examples/index.html

@@ -1,7 +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>Libvirt set of C code examples</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Libvirt set of C code examples</h1><p> The examples are stored per section depending on the main focus
-    of the example:</p><ul><li><p><a href="#Informations">Informations</a> :</p><ul><li><a href="#info1.c">info1.c</a>: Extract informations about Xen domain 0</li></ul></li><li><p><a href="#Scheduling">Scheduling</a> :</p><ul><li><a href="#suspend.c">suspend.c</a>: Suspend a domain and then resume its execution</li></ul></li></ul><p> Getting the compilation options and libraries dependancies needed
+    of the example:</p><ul><li><p><a href="#Informations">Informations</a> :</p><ul><li><a href="#info1.c">info1.c</a>: Extract information about Xen domain 0</li></ul></li><li><p><a href="#Scheduling">Scheduling</a> :</p><ul><li><a href="#suspend.c">suspend.c</a>: Suspend a domain and then resume its execution</li></ul></li></ul><p> Getting the compilation options and libraries dependancies needed
 to generate binaries from the examples is best done on Linux/Unix by using
 the pkg-config data which should have been installed as part of <i>make
-install</i> step or when installing the libvirt development package:</p><pre>gcc -o example example.c `pkg-config libvirt --libs`</pre><h2><a name="Informations" id="Informations"></a>Informations Examples</h2><h3><a name="info1.c" href="info1.c" id="info1.c">info1.c</a>: Extract informations about Xen domain 0</h3><p>Demonstrate the basic use of the library to connect to the hypervisor and extract domain informations.</p><p>Uses:</p><ul><li> line 29: Function <a href="../html/libvirt-libvirt.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a> from libvirt.h</li><li> line 36: Function <a href="../html/libvirt-libvirt.html#virDomainLookupByID">virDomainLookupByID</a> from libvirt.h</li><li> line 43: Function <a href="../html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a> from libvirt.h</li><li> line 53: Function <a href="../html/libvirt-libvirt.html#virDomainFree">virDomainFree</a> from libvirt.h</li><li> line 55: Function <a href="../html/libvirt-libvirt.html#virConnectClose">virConnectClose</a> from libvirt.h</li></ul><p>Usage:</p><p>info1</p><p>Author: Daniel Veillard</p><h2><a name="Scheduling" id="Scheduling"></a>Scheduling Examples</h2><h3><a name="suspend.c" href="suspend.c" id="suspend.c">suspend.c</a>: Suspend a domain and then resume its execution</h3><p>Demonstrate the basic use of the library to suspend and resume a domain. If no id is given on the command line this script will suspend and resume the first domain found which is not Domain 0.</p><p>Uses:</p><ul><li> line 31: Function <a href="../html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a> from libvirt.h</li><li> line 50: Function <a href="../html/libvirt-libvirt.html#virDomainLookupByID">virDomainLookupByID</a> from libvirt.h</li><li> line 62: Function <a href="../html/libvirt-libvirt.html#virDomainSuspend">virDomainSuspend</a> from libvirt.h</li><li> line 73: Function <a href="../html/libvirt-libvirt.html#virDomainResume">virDomainResume</a> from libvirt.h</li><li> line 93: Function <a href="../html/libvirt-libvirt.html#virDomainFree">virDomainFree</a> from libvirt.h</li><li> line 100: Function <a href="../html/libvirt-libvirt.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a> from libvirt.h</li><li> line 111: Function <a href="../html/libvirt-libvirt.html#virConnectListDomains">virConnectListDomains</a> from libvirt.h</li><li> line 132: Function <a href="../html/libvirt-libvirt.html#virConnectClose">virConnectClose</a> from libvirt.h</li></ul><p>Usage:</p><p>suspend [id]</p><p>Author: Daniel Veillard</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="../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>
+install</i> step or when installing the libvirt development package:</p><pre>gcc -o example example.c `pkg-config libvirt --libs`</pre><h2><a name="Informations" id="Informations"></a>Informations Examples</h2><h3><a name="info1.c" href="info1.c" id="info1.c">info1.c</a>: Extract information about Xen domain 0</h3><p>Demonstrate the basic use of the library to connect to the hypervisor and extract domain information.</p><p>Uses:</p><ul><li> line 29: Function <a href="../html/libvirt-libvirt.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a> from libvirt.h</li><li> line 36: Function <a href="../html/libvirt-libvirt.html#virDomainLookupByID">virDomainLookupByID</a> from libvirt.h</li><li> line 43: Function <a href="../html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a> from libvirt.h</li><li> line 53: Function <a href="../html/libvirt-libvirt.html#virDomainFree">virDomainFree</a> from libvirt.h</li><li> line 55: Function <a href="../html/libvirt-libvirt.html#virConnectClose">virConnectClose</a> from libvirt.h</li></ul><p>Usage:</p><p>info1</p><p>Author: Daniel Veillard</p><h2><a name="Scheduling" id="Scheduling"></a>Scheduling Examples</h2><h3><a name="suspend.c" href="suspend.c" id="suspend.c">suspend.c</a>: Suspend a domain and then resume its execution</h3><p>Demonstrate the basic use of the library to suspend and resume a domain. If no id is given on the command line this script will suspend and resume the first domain found which is not Domain 0.</p><p>Uses:</p><ul><li> line 31: Function <a href="../html/libvirt-libvirt.html#virDomainGetInfo">virDomainGetInfo</a> from libvirt.h</li><li> line 50: Function <a href="../html/libvirt-libvirt.html#virDomainLookupByID">virDomainLookupByID</a> from libvirt.h</li><li> line 62: Function <a href="../html/libvirt-libvirt.html#virDomainSuspend">virDomainSuspend</a> from libvirt.h</li><li> line 73: Function <a href="../html/libvirt-libvirt.html#virDomainResume">virDomainResume</a> from libvirt.h</li><li> line 93: Function <a href="../html/libvirt-libvirt.html#virDomainFree">virDomainFree</a> from libvirt.h</li><li> line 100: Function <a href="../html/libvirt-libvirt.html#virConnectOpenReadOnly">virConnectOpenReadOnly</a> from libvirt.h</li><li> line 111: Function <a href="../html/libvirt-libvirt.html#virConnectListDomains">virConnectListDomains</a> from libvirt.h</li><li> line 132: Function <a href="../html/libvirt-libvirt.html#virConnectClose">virConnectClose</a> from libvirt.h</li></ul><p>Usage:</p><p>suspend [id]</p><p>Author: Daniel Veillard</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="../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/examples/info1.c

@@ -1,8 +1,8 @@
 /**
  * section: Informations
- * synopsis: Extract informations about Xen domain 0
+ * synopsis: Extract information about Xen domain 0
  * purpose: Demonstrate the basic use of the library to connect to the
- *          hypervisor and extract domain informations.
+ *          hypervisor and extract domain information.
  * usage: info1
  * test: info1
  * author: Daniel Veillard
@@ -16,34 +16,34 @@
  * getDomainInfo:
  * @id: the id of the domain
  *
- * extract the domain 0 informations
+ * extract the domain 0 information
  */
 static void
 getDomainInfo(int id) {
     virConnectPtr conn = NULL; /* the hypervisor connection */
     virDomainPtr dom = NULL;   /* the domain being checked */
-    virDomainInfo info;        /* the informations being fetched */
+    virDomainInfo info;        /* the information being fetched */
     int ret;
 
     /* NULL means connect to local Xen hypervisor */
     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 informations */
+    /* Get the information */
     ret = virDomainGetInfo(dom, &info);
     if (ret < 0) {
-        fprintf(stderr, "Failed to get informations for Domain %d\n", id);
-	goto error;
+        fprintf(stderr, "Failed to get information for Domain %d\n", id);
+        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

@@ -25,12 +25,12 @@ static virConnectPtr conn = NULL; /* the hypervisor connection */
  */
 static int
 checkDomainState(virDomainPtr dom) {
-    virDomainInfo info;        /* the informations being fetched */
+    virDomainInfo info;        /* the information being fetched */
     int ret;
 
     ret = virDomainGetInfo(dom, &info);
     if (ret < 0) {
-	return(-1);
+        return(-1);
     }
     return(info.state);
 }
@@ -39,7 +39,7 @@ checkDomainState(virDomainPtr dom) {
  * SuspendAndResumeDomain:
  * @id: the id of the domain
  *
- * extract the domain 0 informations
+ * extract the domain 0 information
  */
 static void
 SuspendAndResumeDomain(int id) {
@@ -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
-    dependant 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 informations 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 dependant 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
-    overriden 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 overriden 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 overriden 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
-    overriden.</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 capbilities, 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 informations and potential features.</p><p>The third block (in green) gives similar informations 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,876 @@
+<?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></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>
+        <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,842 @@
+<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>
+
+
+    <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,422 @@
+<?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 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>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,330 @@
+<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 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>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>lenght 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 lenght 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>

docs/html/libvirt-libvirt.html

@@ -1,590 +1,387 @@
 <?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 libvirt 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 libvirt from libvirt</h1><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><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><th align="right"><a href="libvirt-virterror.html">virterror</a></th><td><a accesskey="n" href="libvirt-virterror.html"><img src="right.png" width="24" height="24" border="0" alt="Next" /></a></td></tr></table><p>Provides the interfaces of the libvirt library to handle Xen domains from a process running in domain 0 </p><h2>Table of Contents</h2><pre class="programlisting">#define <a href="#LIBVIR_VERSION_NUMBER">LIBVIR_VERSION_NUMBER</a></pre><pre class="programlisting">#define <a href="#VIR_COPY_CPUMAP">VIR_COPY_CPUMAP</a></pre><pre class="programlisting">#define <a href="#VIR_CPU_MAPLEN">VIR_CPU_MAPLEN</a></pre><pre class="programlisting">#define <a href="#VIR_CPU_USABLE">VIR_CPU_USABLE</a></pre><pre class="programlisting">#define <a href="#VIR_DOMAIN_SCHED_FIELD_LENGTH">VIR_DOMAIN_SCHED_FIELD_LENGTH</a></pre><pre class="programlisting">#define <a href="#VIR_GET_CPUMAP">VIR_GET_CPUMAP</a></pre><pre class="programlisting">#define <a href="#VIR_NODEINFO_MAXCPUS">VIR_NODEINFO_MAXCPUS</a></pre><pre class="programlisting">#define <a href="#VIR_UNUSE_CPU">VIR_UNUSE_CPU</a></pre><pre class="programlisting">#define <a href="#VIR_USE_CPU">VIR_USE_CPU</a></pre><pre class="programlisting">#define <a href="#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a></pre><pre class="programlisting">#define <a href="#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a></pre><pre class="programlisting">Structure <a href="#virConnect">virConnect</a><br />struct _virConnect
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Structure <a href="#virConnectAuth">virConnectAuth</a><br />struct _virConnectAuth
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virConnectAuth">virConnectAuth</a> * <a name="virConnectAuthPtr" id="virConnectAuthPtr">virConnectAuthPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virConnectCredential">virConnectCredential</a><br />struct _virConnectCredential
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virConnectCredential">virConnectCredential</a> * <a name="virConnectCredentialPtr" id="virConnectCredentialPtr">virConnectCredentialPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virConnectCredentialType">virConnectCredentialType</a>
-</pre><pre class="programlisting">Enum <a href="#virConnectFlags">virConnectFlags</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virConnect">virConnect</a> * <a name="virConnectPtr" id="virConnectPtr">virConnectPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virDomain">virDomain</a><br />struct _virDomain
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virDomainBlockStatsStruct">virDomainBlockStatsStruct</a> * <a name="virDomainBlockStatsPtr" id="virDomainBlockStatsPtr">virDomainBlockStatsPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virDomainBlockStatsStruct">virDomainBlockStatsStruct</a><br />struct _virDomainBlockStats
-</pre><pre class="programlisting">Enum <a href="#virDomainCreateFlags">virDomainCreateFlags</a>
-</pre><pre class="programlisting">Structure <a href="#virDomainInfo">virDomainInfo</a><br />struct _virDomainInfo
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virDomainInfo">virDomainInfo</a> * <a name="virDomainInfoPtr" id="virDomainInfoPtr">virDomainInfoPtr</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virDomainInterfaceStatsStruct">virDomainInterfaceStatsStruct</a> * <a name="virDomainInterfaceStatsPtr" id="virDomainInterfaceStatsPtr">virDomainInterfaceStatsPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virDomainInterfaceStatsStruct">virDomainInterfaceStatsStruct</a><br />struct _virDomainInterfaceStats
-</pre><pre class="programlisting">Enum <a href="#virDomainMigrateFlags">virDomainMigrateFlags</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virDomain">virDomain</a> * <a name="virDomainPtr" id="virDomainPtr">virDomainPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virDomainState">virDomainState</a>
-</pre><pre class="programlisting">Enum <a href="#virDomainXMLFlags">virDomainXMLFlags</a>
-</pre><pre class="programlisting">Structure <a href="#virNetwork">virNetwork</a><br />struct _virNetwork
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virNetwork">virNetwork</a> * <a name="virNetworkPtr" id="virNetworkPtr">virNetworkPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virNodeInfo">virNodeInfo</a><br />struct _virNodeInfo
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virNodeInfo">virNodeInfo</a> * <a name="virNodeInfoPtr" id="virNodeInfoPtr">virNodeInfoPtr</a>
-</pre><pre class="programlisting">Structure <a href="#virSchedParameter">virSchedParameter</a><br />struct _virSchedParameter
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virSchedParameter">virSchedParameter</a> * <a name="virSchedParameterPtr" id="virSchedParameterPtr">virSchedParameterPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virSchedParameterType">virSchedParameterType</a>
-</pre><pre class="programlisting">Structure <a href="#virStoragePool">virStoragePool</a><br />struct _virStoragePool
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Enum <a href="#virStoragePoolBuildFlags">virStoragePoolBuildFlags</a>
-</pre><pre class="programlisting">Enum <a href="#virStoragePoolDeleteFlags">virStoragePoolDeleteFlags</a>
-</pre><pre class="programlisting">Structure <a href="#virStoragePoolInfo">virStoragePoolInfo</a><br />struct _virStoragePoolInfo
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virStoragePoolInfo">virStoragePoolInfo</a> * <a name="virStoragePoolInfoPtr" id="virStoragePoolInfoPtr">virStoragePoolInfoPtr</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virStoragePool">virStoragePool</a> * <a name="virStoragePoolPtr" id="virStoragePoolPtr">virStoragePoolPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virStoragePoolState">virStoragePoolState</a>
-</pre><pre class="programlisting">Structure <a href="#virStorageVol">virStorageVol</a><br />struct _virStorageVol
-The content of this structure is not made public by the API.
-</pre><pre class="programlisting">Enum <a href="#virStorageVolDeleteFlags">virStorageVolDeleteFlags</a>
-</pre><pre class="programlisting">Structure <a href="#virStorageVolInfo">virStorageVolInfo</a><br />struct _virStorageVolInfo
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virStorageVolInfo">virStorageVolInfo</a> * <a name="virStorageVolInfoPtr" id="virStorageVolInfoPtr">virStorageVolInfoPtr</a>
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virStorageVol">virStorageVol</a> * <a name="virStorageVolPtr" id="virStorageVolPtr">virStorageVolPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virStorageVolType">virStorageVolType</a>
-</pre><pre class="programlisting">Structure <a href="#virVcpuInfo">virVcpuInfo</a><br />struct _virVcpuInfo
-</pre><pre class="programlisting">Typedef <a href="libvirt-libvirt.html#virVcpuInfo">virVcpuInfo</a> * <a name="virVcpuInfoPtr" id="virVcpuInfoPtr">virVcpuInfoPtr</a>
-</pre><pre class="programlisting">Enum <a href="#virVcpuState">virVcpuState</a>
-</pre><pre class="programlisting">Function type: <a href="#virConnectAuthCallbackPtr">virConnectAuthCallbackPtr</a>
+<html xmlns="http://www.w3.org/1999/xhtml"><!--
+        This file is autogenerated from html/libvirt-libvirt.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: Module libvirt from 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><a title="Reference manual for the C public API" class="active" href="../html/index.html">API reference</a><ul class="l2"><li><div><span class="active">libvirt</span></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>Module libvirt from libvirt</h1><p>Provides the interfaces of the libvirt library to handle virtualized domains </p><h2>Table of Contents</h2><h3><a href="#macros">Macros</a></h3><pre>#define <a href="#LIBVIR_VERSION_NUMBER">LIBVIR_VERSION_NUMBER</a>
+#define <a href="#VIR_COPY_CPUMAP">VIR_COPY_CPUMAP</a>
+#define <a href="#VIR_CPU_MAPLEN">VIR_CPU_MAPLEN</a>
+#define <a href="#VIR_CPU_USABLE">VIR_CPU_USABLE</a>
+#define <a href="#VIR_DOMAIN_SCHED_FIELD_LENGTH">VIR_DOMAIN_SCHED_FIELD_LENGTH</a>
+#define <a href="#VIR_GET_CPUMAP">VIR_GET_CPUMAP</a>
+#define <a href="#VIR_NODEINFO_MAXCPUS">VIR_NODEINFO_MAXCPUS</a>
+#define <a href="#VIR_UNUSE_CPU">VIR_UNUSE_CPU</a>
+#define <a href="#VIR_USE_CPU">VIR_USE_CPU</a>
+#define <a href="#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a>
+#define <a href="#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a>
+</pre><h3><a href="#types">Types</a></h3><pre>typedef struct _virConnect <a href="#virConnect">virConnect</a>
+typedef struct _virConnectAuth <a href="#virConnectAuth">virConnectAuth</a>
+typedef <a href="libvirt-libvirt.html#virConnectAuth">virConnectAuth</a> * <a name="virConnectAuthPtr" id="virConnectAuthPtr">virConnectAuthPtr</a>
+typedef struct _virConnectCredential <a href="#virConnectCredential">virConnectCredential</a>
+typedef <a href="libvirt-libvirt.html#virConnectCredential">virConnectCredential</a> * <a name="virConnectCredentialPtr" id="virConnectCredentialPtr">virConnectCredentialPtr</a>
+typedef enum <a href="#virConnectCredentialType">virConnectCredentialType</a>
+typedef enum <a href="#virConnectFlags">virConnectFlags</a>
+typedef <a href="libvirt-libvirt.html#virConnect">virConnect</a> * <a name="virConnectPtr" id="virConnectPtr">virConnectPtr</a>
+typedef struct _virDomain <a href="#virDomain">virDomain</a>
+typedef <a href="libvirt-libvirt.html#virDomainBlockStatsStruct">virDomainBlockStatsStruct</a> * <a name="virDomainBlockStatsPtr" id="virDomainBlockStatsPtr">virDomainBlockStatsPtr</a>
+typedef struct _virDomainBlockStats <a href="#virDomainBlockStatsStruct">virDomainBlockStatsStruct</a>
+typedef enum <a href="#virDomainCreateFlags">virDomainCreateFlags</a>
+typedef struct _virDomainInfo <a href="#virDomainInfo">virDomainInfo</a>
+typedef <a href="libvirt-libvirt.html#virDomainInfo">virDomainInfo</a> * <a name="virDomainInfoPtr" id="virDomainInfoPtr">virDomainInfoPtr</a>
+typedef <a href="libvirt-libvirt.html#virDomainInterfaceStatsStruct">virDomainInterfaceStatsStruct</a> * <a name="virDomainInterfaceStatsPtr" id="virDomainInterfaceStatsPtr">virDomainInterfaceStatsPtr</a>
+typedef struct _virDomainInterfaceStats <a href="#virDomainInterfaceStatsStruct">virDomainInterfaceStatsStruct</a>
+typedef enum <a href="#virDomainMemoryFlags">virDomainMemoryFlags</a>
+typedef enum <a href="#virDomainMigrateFlags">virDomainMigrateFlags</a>
+typedef <a href="libvirt-libvirt.html#virDomain">virDomain</a> * <a name="virDomainPtr" id="virDomainPtr">virDomainPtr</a>
+typedef enum <a href="#virDomainState">virDomainState</a>
+typedef enum <a href="#virDomainXMLFlags">virDomainXMLFlags</a>
+typedef struct _virNetwork <a href="#virNetwork">virNetwork</a>
+typedef <a href="libvirt-libvirt.html#virNetwork">virNetwork</a> * <a name="virNetworkPtr" id="virNetworkPtr">virNetworkPtr</a>
+typedef struct _virNodeInfo <a href="#virNodeInfo">virNodeInfo</a>
+typedef <a href="libvirt-libvirt.html#virNodeInfo">virNodeInfo</a> * <a name="virNodeInfoPtr" id="virNodeInfoPtr">virNodeInfoPtr</a>
+typedef struct _virSchedParameter <a href="#virSchedParameter">virSchedParameter</a>
+typedef <a href="libvirt-libvirt.html#virSchedParameter">virSchedParameter</a> * <a name="virSchedParameterPtr" id="virSchedParameterPtr">virSchedParameterPtr</a>
+typedef enum <a href="#virSchedParameterType">virSchedParameterType</a>
+typedef struct _virStoragePool <a href="#virStoragePool">virStoragePool</a>
+typedef enum <a href="#virStoragePoolBuildFlags">virStoragePoolBuildFlags</a>
+typedef enum <a href="#virStoragePoolDeleteFlags">virStoragePoolDeleteFlags</a>
+typedef struct _virStoragePoolInfo <a href="#virStoragePoolInfo">virStoragePoolInfo</a>
+typedef <a href="libvirt-libvirt.html#virStoragePoolInfo">virStoragePoolInfo</a> * <a name="virStoragePoolInfoPtr" id="virStoragePoolInfoPtr">virStoragePoolInfoPtr</a>
+typedef <a href="libvirt-libvirt.html#virStoragePool">virStoragePool</a> * <a name="virStoragePoolPtr" id="virStoragePoolPtr">virStoragePoolPtr</a>
+typedef enum <a href="#virStoragePoolState">virStoragePoolState</a>
+typedef struct _virStorageVol <a href="#virStorageVol">virStorageVol</a>
+typedef enum <a href="#virStorageVolDeleteFlags">virStorageVolDeleteFlags</a>
+typedef struct _virStorageVolInfo <a href="#virStorageVolInfo">virStorageVolInfo</a>
+typedef <a href="libvirt-libvirt.html#virStorageVolInfo">virStorageVolInfo</a> * <a name="virStorageVolInfoPtr" id="virStorageVolInfoPtr">virStorageVolInfoPtr</a>
+typedef <a href="libvirt-libvirt.html#virStorageVol">virStorageVol</a> * <a name="virStorageVolPtr" id="virStorageVolPtr">virStorageVolPtr</a>
+typedef enum <a href="#virStorageVolType">virStorageVolType</a>
+typedef struct _virVcpuInfo <a href="#virVcpuInfo">virVcpuInfo</a>
+typedef <a href="libvirt-libvirt.html#virVcpuInfo">virVcpuInfo</a> * <a name="virVcpuInfoPtr" id="virVcpuInfoPtr">virVcpuInfoPtr</a>
+typedef enum <a href="#virVcpuState">virVcpuState</a>
+</pre><h3><a href="#functions">Functions</a></h3><pre>typedef <a href="#virConnectAuthCallbackPtr">virConnectAuthCallbackPtr</a>
 int	<a href="#virConnectAuthCallbackPtr">virConnectAuthCallbackPtr</a>	(<a href="libvirt-libvirt.html#virConnectCredentialPtr">virConnectCredentialPtr</a> cred, <br />					 unsigned int ncred, <br />					 void * cbdata)
-</pre>
-<pre class="programlisting">int	<a href="#virConnectClose">virConnectClose</a>			(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">char *	<a href="#virConnectGetCapabilities">virConnectGetCapabilities</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">char *	<a href="#virConnectGetHostname">virConnectGetHostname</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int	<a href="#virConnectGetMaxVcpus">virConnectGetMaxVcpus</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * type)</pre>
-<pre class="programlisting">const char *	<a href="#virConnectGetType">virConnectGetType</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">char *	<a href="#virConnectGetURI">virConnectGetURI</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int	<a href="#virConnectGetVersion">virConnectGetVersion</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 unsigned long * hvVer)</pre>
-<pre class="programlisting">int	<a href="#virConnectListDefinedDomains">virConnectListDefinedDomains</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)</pre>
-<pre class="programlisting">int	<a href="#virConnectListDefinedNetworks">virConnectListDefinedNetworks</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)</pre>
-<pre class="programlisting">int	<a href="#virConnectListDefinedStoragePools">virConnectListDefinedStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 char ** const names, <br />						 int maxnames)</pre>
-<pre class="programlisting">int	<a href="#virConnectListDomains">virConnectListDomains</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 int * ids, <br />					 int maxids)</pre>
-<pre class="programlisting">int	<a href="#virConnectListNetworks">virConnectListNetworks</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)</pre>
-<pre class="programlisting">int	<a href="#virConnectListStoragePools">virConnectListStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)</pre>
-<pre class="programlisting">int	<a href="#virConnectNumOfDefinedDomains">virConnectNumOfDefinedDomains</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int	<a href="#virConnectNumOfDefinedNetworks">virConnectNumOfDefinedNetworks</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int	<a href="#virConnectNumOfDefinedStoragePools">virConnectNumOfDefinedStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int	<a href="#virConnectNumOfDomains">virConnectNumOfDomains</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int	<a href="#virConnectNumOfNetworks">virConnectNumOfNetworks</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">int	<a href="#virConnectNumOfStoragePools">virConnectNumOfStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virConnectOpen">virConnectOpen</a>		(const char * name)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virConnectOpenReadOnly">virConnectOpenReadOnly</a>	(const char * name)</pre>
-<pre class="programlisting">int	<a href="#virDomainAttachDevice">virDomainAttachDevice</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * xml)</pre>
-<pre class="programlisting">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)</pre>
-<pre class="programlisting">int	<a href="#virDomainCoreDump">virDomainCoreDump</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * to, <br />					 int flags)</pre>
-<pre class="programlisting">int	<a href="#virDomainCreate">virDomainCreate</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting">int	<a href="#virDomainDestroy">virDomainDestroy</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int	<a href="#virDomainDetachDevice">virDomainDetachDevice</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * xml)</pre>
-<pre class="programlisting">int	<a href="#virDomainFree">virDomainFree</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int	<a href="#virDomainGetAutostart">virDomainGetAutostart</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int * autostart)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virDomainGetConnect">virDomainGetConnect</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom)</pre>
-<pre class="programlisting">unsigned int	<a href="#virDomainGetID">virDomainGetID</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">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)</pre>
-<pre class="programlisting">unsigned long	<a href="#virDomainGetMaxMemory">virDomainGetMaxMemory</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int	<a href="#virDomainGetMaxVcpus">virDomainGetMaxVcpus</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">const char *	<a href="#virDomainGetName">virDomainGetName</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">char *	<a href="#virDomainGetOSType">virDomainGetOSType</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">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)</pre>
-<pre class="programlisting">char *	<a href="#virDomainGetSchedulerType">virDomainGetSchedulerType</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int * nparams)</pre>
-<pre class="programlisting">int	<a href="#virDomainGetUUID">virDomainGetUUID</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned char * uuid)</pre>
-<pre class="programlisting">int	<a href="#virDomainGetUUIDString">virDomainGetUUIDString</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 char * buf)</pre>
-<pre class="programlisting">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)</pre>
-<pre class="programlisting">char *	<a href="#virDomainGetXMLDesc">virDomainGetXMLDesc</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int flags)</pre>
-<pre class="programlisting">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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting">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)</pre>
-<pre class="programlisting">int	<a href="#virDomainReboot">virDomainReboot</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned int flags)</pre>
-<pre class="programlisting">int	<a href="#virDomainRestore">virDomainRestore</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * from)</pre>
-<pre class="programlisting">int	<a href="#virDomainResume">virDomainResume</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int	<a href="#virDomainSave">virDomainSave</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * to)</pre>
-<pre class="programlisting">int	<a href="#virDomainSetAutostart">virDomainSetAutostart</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int autostart)</pre>
-<pre class="programlisting">int	<a href="#virDomainSetMaxMemory">virDomainSetMaxMemory</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned long memory)</pre>
-<pre class="programlisting">int	<a href="#virDomainSetMemory">virDomainSetMemory</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned long memory)</pre>
-<pre class="programlisting">int	<a href="#virDomainSetSchedulerParameters">virDomainSetSchedulerParameters</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br />					 int nparams)</pre>
-<pre class="programlisting">int	<a href="#virDomainSetVcpus">virDomainSetVcpus</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned int nvcpus)</pre>
-<pre class="programlisting">int	<a href="#virDomainShutdown">virDomainShutdown</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int	<a href="#virDomainSuspend">virDomainSuspend</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int	<a href="#virDomainUndefine">virDomainUndefine</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)</pre>
-<pre class="programlisting">int	<a href="#virGetVersion">virGetVersion</a>			(unsigned long * libVer, <br />					 const char * type, <br />					 unsigned long * typeVer)</pre>
-<pre class="programlisting">int	<a href="#virInitialize">virInitialize</a>			(void)</pre>
-<pre class="programlisting">int	<a href="#virNetworkCreate">virNetworkCreate</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting">int	<a href="#virNetworkDestroy">virNetworkDestroy</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting">int	<a href="#virNetworkFree">virNetworkFree</a>			(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting">int	<a href="#virNetworkGetAutostart">virNetworkGetAutostart</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int * autostart)</pre>
-<pre class="programlisting">char *	<a href="#virNetworkGetBridgeName">virNetworkGetBridgeName</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virNetworkGetConnect">virNetworkGetConnect</a>	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net)</pre>
-<pre class="programlisting">const char *	<a href="#virNetworkGetName">virNetworkGetName</a>	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting">int	<a href="#virNetworkGetUUID">virNetworkGetUUID</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 unsigned char * uuid)</pre>
-<pre class="programlisting">int	<a href="#virNetworkGetUUIDString">virNetworkGetUUIDString</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 char * buf)</pre>
-<pre class="programlisting">char *	<a href="#virNetworkGetXMLDesc">virNetworkGetXMLDesc</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int flags)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting">int	<a href="#virNetworkSetAutostart">virNetworkSetAutostart</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int autostart)</pre>
-<pre class="programlisting">int	<a href="#virNetworkUndefine">virNetworkUndefine</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)</pre>
-<pre class="programlisting">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)</pre>
-<pre class="programlisting">unsigned long long	<a href="#virNodeGetFreeMemory">virNodeGetFreeMemory</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)</pre>
-<pre class="programlisting">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)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolBuild">virStoragePoolBuild</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolCreate">virStoragePoolCreate</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	<a href="#virStoragePoolDefineXML">virStoragePoolDefineXML</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 const char * xml, <br />						 unsigned int flags)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolDelete">virStoragePoolDelete</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolDestroy">virStoragePoolDestroy</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolFree">virStoragePoolFree</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolGetAutostart">virStoragePoolGetAutostart</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 int * autostart)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virStoragePoolGetConnect">virStoragePoolGetConnect</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting">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)</pre>
-<pre class="programlisting">const char *	<a href="#virStoragePoolGetName">virStoragePoolGetName</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolGetUUID">virStoragePoolGetUUID</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned char * uuid)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolGetUUIDString">virStoragePoolGetUUIDString</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 char * buf)</pre>
-<pre class="programlisting">char *	<a href="#virStoragePoolGetXMLDesc">virStoragePoolGetXMLDesc</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolListVolumes">virStoragePoolListVolumes</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 char ** const names, <br />					 int maxnames)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	<a href="#virStoragePoolLookupByVolume">virStoragePoolLookupByVolume</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolNumOfVolumes">virStoragePoolNumOfVolumes</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolRefresh">virStoragePoolRefresh</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolSetAutostart">virStoragePoolSetAutostart</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 int autostart)</pre>
-<pre class="programlisting">int	<a href="#virStoragePoolUndefine">virStoragePoolUndefine</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting">int	<a href="#virStorageVolDelete">virStorageVolDelete</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br />					 unsigned int flags)</pre>
-<pre class="programlisting">int	<a href="#virStorageVolFree">virStorageVolFree</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virStorageVolGetConnect">virStorageVolGetConnect</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting">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)</pre>
-<pre class="programlisting">const char *	<a href="#virStorageVolGetKey">virStorageVolGetKey</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting">const char *	<a href="#virStorageVolGetName">virStorageVolGetName</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting">char *	<a href="#virStorageVolGetPath">virStorageVolGetPath</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)</pre>
-<pre class="programlisting">char *	<a href="#virStorageVolGetXMLDesc">virStorageVolGetXMLDesc</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br />					 unsigned int flags)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><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)</pre>
-<pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	<a href="#virStorageVolLookupByPath">virStorageVolLookupByPath</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const char * path)</pre>
-<h2>Description</h2>
-<h3><a name="LIBVIR_VERSION_NUMBER" id="LIBVIR_VERSION_NUMBER"></a>Macro: LIBVIR_VERSION_NUMBER</h3><pre>#define LIBVIR_VERSION_NUMBER</pre><p>Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro</p>
-<h3><a name="VIR_COPY_CPUMAP" id="VIR_COPY_CPUMAP"></a>Macro: VIR_COPY_CPUMAP</h3><pre>#define VIR_COPY_CPUMAP</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. <a href="libvirt-libvirt.html#VIR_COPY_CPUMAP">VIR_COPY_CPUMAP</a> macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.</p>
-<h3><a name="VIR_CPU_MAPLEN" id="VIR_CPU_MAPLEN"></a>Macro: VIR_CPU_MAPLEN</h3><pre>#define VIR_CPU_MAPLEN</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual &amp; all physical CPUs of a domain.</p>
-<h3><a name="VIR_CPU_USABLE" id="VIR_CPU_USABLE"></a>Macro: VIR_CPU_USABLE</h3><pre>#define VIR_CPU_USABLE</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() API. <a href="libvirt-libvirt.html#VIR_CPU_USABLE">VIR_CPU_USABLE</a> macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.</p>
-<h3><a name="VIR_DOMAIN_SCHED_FIELD_LENGTH" id="VIR_DOMAIN_SCHED_FIELD_LENGTH"></a>Macro: VIR_DOMAIN_SCHED_FIELD_LENGTH</h3><pre>#define VIR_DOMAIN_SCHED_FIELD_LENGTH</pre><p>Macro providing the field length of <a href="libvirt-libvirt.html#virSchedParameter">virSchedParameter</a></p>
-<h3><a name="VIR_GET_CPUMAP" id="VIR_GET_CPUMAP"></a>Macro: VIR_GET_CPUMAP</h3><pre>#define VIR_GET_CPUMAP</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. <a href="libvirt-libvirt.html#VIR_GET_CPUMAP">VIR_GET_CPUMAP</a> macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.</p>
-<h3><a name="VIR_NODEINFO_MAXCPUS" id="VIR_NODEINFO_MAXCPUS"></a>Macro: VIR_NODEINFO_MAXCPUS</h3><pre>#define VIR_NODEINFO_MAXCPUS</pre><p>This macro is to calculate the total number of CPUs supported but not necessary active in the host.</p>
-<h3><a name="VIR_UNUSE_CPU" id="VIR_UNUSE_CPU"></a>Macro: VIR_UNUSE_CPU</h3><pre>#define VIR_UNUSE_CPU</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.</p>
-<h3><a name="VIR_USE_CPU" id="VIR_USE_CPU"></a>Macro: VIR_USE_CPU</h3><pre>#define VIR_USE_CPU</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.</p>
-<h3><a name="VIR_UUID_BUFLEN" id="VIR_UUID_BUFLEN"></a>Macro: VIR_UUID_BUFLEN</h3><pre>#define VIR_UUID_BUFLEN</pre><p>This macro provides the length of the buffer required for virDomainGetUUID()</p>
-<h3><a name="VIR_UUID_STRING_BUFLEN" id="VIR_UUID_STRING_BUFLEN"></a>Macro: VIR_UUID_STRING_BUFLEN</h3><pre>#define VIR_UUID_STRING_BUFLEN</pre><p>This macro provides the length of the buffer required for virDomainGetUUIDString()</p>
-<h3><a name="virConnect" id="virConnect">Structure virConnect</a></h3><pre class="programlisting">Structure virConnect<br />struct _virConnect {
-The content of this structure is not made public by the API.
-}</pre><h3><a name="virConnectAuth" id="virConnectAuth">Structure virConnectAuth</a></h3><pre class="programlisting">Structure virConnectAuth<br />struct _virConnectAuth {
-    int *	credtype	: List of supported virConnectCredentialT
-    unsigned int	ncredtype
-    <a href="libvirt-libvirt.html#virConnectAuthCallbackPtr">virConnectAuthCallbackPtr</a>	cb	: Callback used to collect credentials
-    void *	cbdata
-}</pre><h3><a name="virConnectCredential" id="virConnectCredential">Structure virConnectCredential</a></h3><pre class="programlisting">Structure virConnectCredential<br />struct _virConnectCredential {
-    int	type	: One of <a href="libvirt-libvirt.html#virConnectCredentialType">virConnectCredentialType</a> constan
-    const char *	prompt	: Prompt to show to user
-    const char *	challenge	: Additional challenge to show
-    const char *	defresult	: Optional default result
-    char *	result	: Result to be filled with user response
-    unsigned int	resultlen	: Length of the result
-}</pre><h3>Enum <a name="virConnectCredentialType" id="virConnectCredentialType">virConnectCredentialType</a></h3><pre class="programlisting">Enum virConnectCredentialType {
-    <a name="VIR_CRED_USERNAME" id="VIR_CRED_USERNAME">VIR_CRED_USERNAME</a> = 1 : Identity to act as
-    <a name="VIR_CRED_AUTHNAME" id="VIR_CRED_AUTHNAME">VIR_CRED_AUTHNAME</a> = 2 : Identify to authorize as
-    <a name="VIR_CRED_LANGUAGE" id="VIR_CRED_LANGUAGE">VIR_CRED_LANGUAGE</a> = 3 : RFC 1766 languages, comma separated
-    <a name="VIR_CRED_CNONCE" id="VIR_CRED_CNONCE">VIR_CRED_CNONCE</a> = 4 : client supplies a nonce
-    <a name="VIR_CRED_PASSPHRASE" id="VIR_CRED_PASSPHRASE">VIR_CRED_PASSPHRASE</a> = 5 : Passphrase secret
-    <a name="VIR_CRED_ECHOPROMPT" id="VIR_CRED_ECHOPROMPT">VIR_CRED_ECHOPROMPT</a> = 6 : Challenge response
-    <a name="VIR_CRED_NOECHOPROMPT" id="VIR_CRED_NOECHOPROMPT">VIR_CRED_NOECHOPROMPT</a> = 7 : Challenge response
-    <a name="VIR_CRED_REALM" id="VIR_CRED_REALM">VIR_CRED_REALM</a> = 8 : Authentication realm
-    <a name="VIR_CRED_EXTERNAL" id="VIR_CRED_EXTERNAL">VIR_CRED_EXTERNAL</a> = 9 : Externally managed credential More may be added - expect the unexpected
+
+int	<a href="#virConnectClose">virConnectClose</a>			(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+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)
+char *	<a href="#virConnectGetCapabilities">virConnectGetCapabilities</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+char *	<a href="#virConnectGetHostname">virConnectGetHostname</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int	<a href="#virConnectGetMaxVcpus">virConnectGetMaxVcpus</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * type)
+const char *	<a href="#virConnectGetType">virConnectGetType</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+char *	<a href="#virConnectGetURI">virConnectGetURI</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int	<a href="#virConnectGetVersion">virConnectGetVersion</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 unsigned long * hvVer)
+int	<a href="#virConnectListDefinedDomains">virConnectListDefinedDomains</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)
+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="#virConnectListDefinedStoragePools">virConnectListDefinedStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 char ** const names, <br />						 int maxnames)
+int	<a href="#virConnectListDomains">virConnectListDomains</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 int * ids, <br />					 int maxids)
+int	<a href="#virConnectListNetworks">virConnectListNetworks</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)
+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="#virConnectNumOfDefinedDomains">virConnectNumOfDefinedDomains</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int	<a href="#virConnectNumOfDefinedNetworks">virConnectNumOfDefinedNetworks</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int	<a href="#virConnectNumOfDefinedStoragePools">virConnectNumOfDefinedStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int	<a href="#virConnectNumOfDomains">virConnectNumOfDomains</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int	<a href="#virConnectNumOfNetworks">virConnectNumOfNetworks</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+int	<a href="#virConnectNumOfStoragePools">virConnectNumOfStoragePools</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virConnectOpen">virConnectOpen</a>		(const char * name)
+<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)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virConnectOpenReadOnly">virConnectOpenReadOnly</a>	(const char * name)
+int	<a href="#virDomainAttachDevice">virDomainAttachDevice</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * xml)
+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)
+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)
+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="#virDomainCreate">virDomainCreate</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+<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)
+<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="#virDomainDestroy">virDomainDestroy</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int	<a href="#virDomainDetachDevice">virDomainDetachDevice</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * xml)
+int	<a href="#virDomainFree">virDomainFree</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int	<a href="#virDomainGetAutostart">virDomainGetAutostart</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int * autostart)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virDomainGetConnect">virDomainGetConnect</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom)
+unsigned int	<a href="#virDomainGetID">virDomainGetID</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+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)
+unsigned long	<a href="#virDomainGetMaxMemory">virDomainGetMaxMemory</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int	<a href="#virDomainGetMaxVcpus">virDomainGetMaxVcpus</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+const char *	<a href="#virDomainGetName">virDomainGetName</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+char *	<a href="#virDomainGetOSType">virDomainGetOSType</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+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)
+char *	<a href="#virDomainGetSchedulerType">virDomainGetSchedulerType</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int * nparams)
+int	<a href="#virDomainGetUUID">virDomainGetUUID</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned char * uuid)
+int	<a href="#virDomainGetUUIDString">virDomainGetUUIDString</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 char * buf)
+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)
+char *	<a href="#virDomainGetXMLDesc">virDomainGetXMLDesc</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int flags)
+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)
+<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)
+<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)
+<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)
+<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="#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#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="#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="#virDomainReboot">virDomainReboot</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned int flags)
+int	<a href="#virDomainRestore">virDomainRestore</a>		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * from)
+int	<a href="#virDomainResume">virDomainResume</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int	<a href="#virDomainSave">virDomainSave</a>			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * to)
+int	<a href="#virDomainSetAutostart">virDomainSetAutostart</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int autostart)
+int	<a href="#virDomainSetMaxMemory">virDomainSetMaxMemory</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned long memory)
+int	<a href="#virDomainSetMemory">virDomainSetMemory</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned long memory)
+int	<a href="#virDomainSetSchedulerParameters">virDomainSetSchedulerParameters</a>	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br />					 int nparams)
+int	<a href="#virDomainSetVcpus">virDomainSetVcpus</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned int nvcpus)
+int	<a href="#virDomainShutdown">virDomainShutdown</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int	<a href="#virDomainSuspend">virDomainSuspend</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int	<a href="#virDomainUndefine">virDomainUndefine</a>		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)
+int	<a href="#virGetVersion">virGetVersion</a>			(unsigned long * libVer, <br />					 const char * type, <br />					 unsigned long * typeVer)
+int	<a href="#virInitialize">virInitialize</a>			(void)
+int	<a href="#virNetworkCreate">virNetworkCreate</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+<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)
+<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="#virNetworkDestroy">virNetworkDestroy</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+int	<a href="#virNetworkFree">virNetworkFree</a>			(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+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)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virNetworkGetConnect">virNetworkGetConnect</a>	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net)
+const char *	<a href="#virNetworkGetName">virNetworkGetName</a>	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+int	<a href="#virNetworkGetUUID">virNetworkGetUUID</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 unsigned char * uuid)
+int	<a href="#virNetworkGetUUIDString">virNetworkGetUUIDString</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 char * buf)
+char *	<a href="#virNetworkGetXMLDesc">virNetworkGetXMLDesc</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int flags)
+<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)
+<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)
+<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)
+int	<a href="#virNetworkSetAutostart">virNetworkSetAutostart</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int autostart)
+int	<a href="#virNetworkUndefine">virNetworkUndefine</a>		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)
+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)
+unsigned long long	<a href="#virNodeGetFreeMemory">virNodeGetFreeMemory</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)
+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="#virStoragePoolBuild">virStoragePoolBuild</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)
+int	<a href="#virStoragePoolCreate">virStoragePoolCreate</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)
+<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#virStoragePoolPtr">virStoragePoolPtr</a>	<a href="#virStoragePoolDefineXML">virStoragePoolDefineXML</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 const char * xml, <br />						 unsigned int flags)
+int	<a href="#virStoragePoolDelete">virStoragePoolDelete</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)
+int	<a href="#virStoragePoolDestroy">virStoragePoolDestroy</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+int	<a href="#virStoragePoolFree">virStoragePoolFree</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+int	<a href="#virStoragePoolGetAutostart">virStoragePoolGetAutostart</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 int * autostart)
+<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	<a href="#virStoragePoolGetConnect">virStoragePoolGetConnect</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+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)
+const char *	<a href="#virStoragePoolGetName">virStoragePoolGetName</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+int	<a href="#virStoragePoolGetUUID">virStoragePoolGetUUID</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned char * uuid)
+int	<a href="#virStoragePoolGetUUIDString">virStoragePoolGetUUIDString</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 char * buf)
+char *	<a href="#virStoragePoolGetXMLDesc">virStoragePoolGetXMLDesc</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)
+int	<a href="#virStoragePoolListVolumes">virStoragePoolListVolumes</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 char ** const names, <br />					 int maxnames)
+<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="#virStoragePoolLookupByUUID">virStoragePoolLookupByUUID</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const unsigned char * uuid)
+<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)
+<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	<a href="#virStoragePoolLookupByVolume">virStoragePoolLookupByVolume</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)
+int	<a href="#virStoragePoolNumOfVolumes">virStoragePoolNumOfVolumes</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+int	<a href="#virStoragePoolRefresh">virStoragePoolRefresh</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)
+int	<a href="#virStoragePoolSetAutostart">virStoragePoolSetAutostart</a>	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 int autostart)
+int	<a href="#virStoragePoolUndefine">virStoragePoolUndefine</a>		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)
+<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="#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)
+<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="#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="#virStorageVolGetKey">virStorageVolGetKey</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)
+const char *	<a href="#virStorageVolGetName">virStorageVolGetName</a>	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)
+char *	<a href="#virStorageVolGetPath">virStorageVolGetPath</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)
+char *	<a href="#virStorageVolGetXMLDesc">virStorageVolGetXMLDesc</a>		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br />					 unsigned int flags)
+<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)
+<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#virStorageVolPtr">virStorageVolPtr</a>	<a href="#virStorageVolLookupByPath">virStorageVolLookupByPath</a>	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const char * path)
+</pre><h2>Description</h2><h3><a name="macros" id="macros">Macros</a></h3><h3><a name="LIBVIR_VERSION_NUMBER" id="LIBVIR_VERSION_NUMBER"><code>LIBVIR_VERSION_NUMBER</code></a></h3><pre>#define LIBVIR_VERSION_NUMBER</pre><p>Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro</p><h3><a name="VIR_COPY_CPUMAP" id="VIR_COPY_CPUMAP"><code>VIR_COPY_CPUMAP</code></a></h3><pre>#define VIR_COPY_CPUMAP</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. <a href="libvirt-libvirt.html#VIR_COPY_CPUMAP">VIR_COPY_CPUMAP</a> macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.</p><h3><a name="VIR_CPU_MAPLEN" id="VIR_CPU_MAPLEN"><code>VIR_CPU_MAPLEN</code></a></h3><pre>#define VIR_CPU_MAPLEN</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual &amp; all physical CPUs of a domain.</p><h3><a name="VIR_CPU_USABLE" id="VIR_CPU_USABLE"><code>VIR_CPU_USABLE</code></a></h3><pre>#define VIR_CPU_USABLE</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() API. <a href="libvirt-libvirt.html#VIR_CPU_USABLE">VIR_CPU_USABLE</a> macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.</p><h3><a name="VIR_DOMAIN_SCHED_FIELD_LENGTH" id="VIR_DOMAIN_SCHED_FIELD_LENGTH"><code>VIR_DOMAIN_SCHED_FIELD_LENGTH</code></a></h3><pre>#define VIR_DOMAIN_SCHED_FIELD_LENGTH</pre><p>Macro providing the field length of <a href="libvirt-libvirt.html#virSchedParameter">virSchedParameter</a></p><h3><a name="VIR_GET_CPUMAP" id="VIR_GET_CPUMAP"><code>VIR_GET_CPUMAP</code></a></h3><pre>#define VIR_GET_CPUMAP</pre><p>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. <a href="libvirt-libvirt.html#VIR_GET_CPUMAP">VIR_GET_CPUMAP</a> macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.</p><h3><a name="VIR_NODEINFO_MAXCPUS" id="VIR_NODEINFO_MAXCPUS"><code>VIR_NODEINFO_MAXCPUS</code></a></h3><pre>#define VIR_NODEINFO_MAXCPUS</pre><p>This macro is to calculate the total number of CPUs supported but not necessary active in the host.</p><h3><a name="VIR_UNUSE_CPU" id="VIR_UNUSE_CPU"><code>VIR_UNUSE_CPU</code></a></h3><pre>#define VIR_UNUSE_CPU</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.</p><h3><a name="VIR_USE_CPU" id="VIR_USE_CPU"><code>VIR_USE_CPU</code></a></h3><pre>#define VIR_USE_CPU</pre><p>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.</p><h3><a name="VIR_UUID_BUFLEN" id="VIR_UUID_BUFLEN"><code>VIR_UUID_BUFLEN</code></a></h3><pre>#define VIR_UUID_BUFLEN</pre><p>This macro provides the length of the buffer required for virDomainGetUUID()</p><h3><a name="VIR_UUID_STRING_BUFLEN" id="VIR_UUID_STRING_BUFLEN"><code>VIR_UUID_STRING_BUFLEN</code></a></h3><pre>#define VIR_UUID_STRING_BUFLEN</pre><p>This macro provides the length of the buffer required for virDomainGetUUIDString()</p><h3><a name="types" id="types">Types</a></h3><h3><a name="virConnect" id="virConnect"><code>virConnect</code></a></h3><div class="api"><pre>struct virConnect{
+</pre><table><tr><td colspan="3">The content of this structure is not made public by the API</td></tr></table><pre>
 }
-</pre><h3>Enum <a name="virConnectFlags" id="virConnectFlags">virConnectFlags</a></h3><pre class="programlisting">Enum virConnectFlags {
-    <a name="VIR_CONNECT_RO" id="VIR_CONNECT_RO">VIR_CONNECT_RO</a> = 1 : A readonly connection
+</pre></div><h3><a name="virConnectAuth" id="virConnectAuth"><code>virConnectAuth</code></a></h3><div class="api"><pre>struct virConnectAuth{
+</pre><table><tr><td>int *</td><td>credtype</td><td> : List of supported <a href="libvirt-libvirt.html#virConnectCredentialType">virConnectCredentialType</a> values</td></tr><tr><td>unsigned int</td><td>ncredtype</td></tr><tr><td><a href="libvirt-libvirt.html#virConnectAuthCallbackPtr">virConnectAuthCallbackPtr</a></td><td>cb</td><td> : Callback used to collect credentials</td></tr><tr><td>void *</td><td>cbdata</td></tr></table><pre>
 }
-</pre>
-      a virConnectPtr is pointer to a virConnect private structure, this is the type used to reference a connection to the Xen Hypervisor in the API.
-    <h3><a name="virDomain" id="virDomain">Structure virDomain</a></h3><pre class="programlisting">Structure virDomain<br />struct _virDomain {
-The content of this structure is not made public by the API.
-}</pre>
-      A pointer to a virDomainBlockStats structure
-    <h3><a name="virDomainBlockStatsStruct" id="virDomainBlockStatsStruct">Structure virDomainBlockStatsStruct</a></h3><pre class="programlisting">Structure virDomainBlockStatsStruct<br />struct _virDomainBlockStats {
-    long long	rd_req	: number of read requests
-    long long	rd_bytes	: number of read bytes
-    long long	wr_req	: number of write requests
-    long long	wr_bytes	: numbber of written bytes
-    long long	errs	: In Xen this returns the mysterious 'oo_
-}</pre><h3>Enum <a name="virDomainCreateFlags" id="virDomainCreateFlags">virDomainCreateFlags</a></h3><pre class="programlisting">Enum virDomainCreateFlags {
-    <a name="VIR_DOMAIN_NONE" id="VIR_DOMAIN_NONE">VIR_DOMAIN_NONE</a> = 0
+</pre></div><h3><a name="virConnectCredential" id="virConnectCredential"><code>virConnectCredential</code></a></h3><div class="api"><pre>struct virConnectCredential{
+</pre><table><tr><td>int</td><td>type</td><td> : One of <a href="libvirt-libvirt.html#virConnectCredentialType">virConnectCredentialType</a> constants</td></tr><tr><td>const char *</td><td>prompt</td><td> : Prompt to show to user</td></tr><tr><td>const char *</td><td>challenge</td><td> : Additional challenge to show</td></tr><tr><td>const char *</td><td>defresult</td><td> : Optional default result</td></tr><tr><td>char *</td><td>result</td><td> : Result to be filled with user response (or defresult)</td></tr><tr><td>unsigned int</td><td>resultlen</td><td> : Length of the result</td></tr></table><pre>
 }
-</pre><h3><a name="virDomainInfo" id="virDomainInfo">Structure virDomainInfo</a></h3><pre class="programlisting">Structure virDomainInfo<br />struct _virDomainInfo {
-    unsigned char	state	: the running state, one of virDomainFlag
-    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 doma
-    unsigned long long	cpuTime	: the CPU time used in nanoseconds
-}</pre>
-      a virDomainInfoPtr is a pointer to a virDomainInfo structure.
-    
-      A pointer to a virDomainInterfaceStats structure
-    <h3><a name="virDomainInterfaceStatsStruct" id="virDomainInterfaceStatsStruct">Structure virDomainInterfaceStatsStruct</a></h3><pre class="programlisting">Structure virDomainInterfaceStatsStruct<br />struct _virDomainInterfaceStats {
-    long long	rx_bytes
-    long long	rx_packets
-    long long	rx_errs
-    long long	rx_drop
-    long long	tx_bytes
-    long long	tx_packets
-    long long	tx_errs
-    long long	tx_drop
-}</pre><h3>Enum <a name="virDomainMigrateFlags" id="virDomainMigrateFlags">virDomainMigrateFlags</a></h3><pre class="programlisting">Enum virDomainMigrateFlags {
-    <a name="VIR_MIGRATE_LIVE" id="VIR_MIGRATE_LIVE">VIR_MIGRATE_LIVE</a> = 1 : live migration
+</pre></div><h3><a name="virConnectCredentialType" id="virConnectCredentialType"><code>virConnectCredentialType</code></a></h3><div class="api"><pre>enum virConnectCredentialType {
+</pre><table><tr><td><a name="VIR_CRED_USERNAME" id="VIR_CRED_USERNAME">VIR_CRED_USERNAME</a></td><td> = </td><td>1</td><td> : Identity to act as</td></tr><tr><td><a name="VIR_CRED_AUTHNAME" id="VIR_CRED_AUTHNAME">VIR_CRED_AUTHNAME</a></td><td> = </td><td>2</td><td> : Identify to authorize as</td></tr><tr><td><a name="VIR_CRED_LANGUAGE" id="VIR_CRED_LANGUAGE">VIR_CRED_LANGUAGE</a></td><td> = </td><td>3</td><td> : RFC 1766 languages, comma separated</td></tr><tr><td><a name="VIR_CRED_CNONCE" id="VIR_CRED_CNONCE">VIR_CRED_CNONCE</a></td><td> = </td><td>4</td><td> : client supplies a nonce</td></tr><tr><td><a name="VIR_CRED_PASSPHRASE" id="VIR_CRED_PASSPHRASE">VIR_CRED_PASSPHRASE</a></td><td> = </td><td>5</td><td> : Passphrase secret</td></tr><tr><td><a name="VIR_CRED_ECHOPROMPT" id="VIR_CRED_ECHOPROMPT">VIR_CRED_ECHOPROMPT</a></td><td> = </td><td>6</td><td> : Challenge response</td></tr><tr><td><a name="VIR_CRED_NOECHOPROMPT" id="VIR_CRED_NOECHOPROMPT">VIR_CRED_NOECHOPROMPT</a></td><td> = </td><td>7</td><td> : Challenge response</td></tr><tr><td><a name="VIR_CRED_REALM" id="VIR_CRED_REALM">VIR_CRED_REALM</a></td><td> = </td><td>8</td><td> : Authentication realm</td></tr><tr><td><a name="VIR_CRED_EXTERNAL" id="VIR_CRED_EXTERNAL">VIR_CRED_EXTERNAL</a></td><td> = </td><td>9</td><td> : Externally managed credential More may be added - expect the unexpected</td></tr></table><pre>}
+</pre></div><h3><a name="virConnectFlags" id="virConnectFlags"><code>virConnectFlags</code></a></h3><div class="api"><pre>enum virConnectFlags {
+</pre><table><tr><td><a name="VIR_CONNECT_RO" id="VIR_CONNECT_RO">VIR_CONNECT_RO</a></td><td> = </td><td>1</td><td> : A readonly connection</td></tr></table><pre>}
+</pre></div><h3><a name="virDomain" id="virDomain"><code>virDomain</code></a></h3><div class="api"><pre>struct virDomain{
+</pre><table><tr><td colspan="3">The content of this structure is not made public by the API</td></tr></table><pre>
 }
-</pre>
-      a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a Xen domain in the API.
-    <h3>Enum <a name="virDomainState" id="virDomainState">virDomainState</a></h3><pre class="programlisting">Enum virDomainState {
-    <a name="VIR_DOMAIN_NOSTATE" id="VIR_DOMAIN_NOSTATE">VIR_DOMAIN_NOSTATE</a> = 0 : no state
-    <a name="VIR_DOMAIN_RUNNING" id="VIR_DOMAIN_RUNNING">VIR_DOMAIN_RUNNING</a> = 1 : the domain is running
-    <a name="VIR_DOMAIN_BLOCKED" id="VIR_DOMAIN_BLOCKED">VIR_DOMAIN_BLOCKED</a> = 2 : the domain is blocked on resource
-    <a name="VIR_DOMAIN_PAUSED" id="VIR_DOMAIN_PAUSED">VIR_DOMAIN_PAUSED</a> = 3 : the domain is paused by user
-    <a name="VIR_DOMAIN_SHUTDOWN" id="VIR_DOMAIN_SHUTDOWN">VIR_DOMAIN_SHUTDOWN</a> = 4 : the domain is being shut down
-    <a name="VIR_DOMAIN_SHUTOFF" id="VIR_DOMAIN_SHUTOFF">VIR_DOMAIN_SHUTOFF</a> = 5 : the domain is shut off
-    <a name="VIR_DOMAIN_CRASHED" id="VIR_DOMAIN_CRASHED">VIR_DOMAIN_CRASHED</a> = 6 : the domain is crashed
+</pre></div><h3><a name="virDomainBlockStatsStruct" id="virDomainBlockStatsStruct"><code>virDomainBlockStatsStruct</code></a></h3><div class="api"><pre>struct virDomainBlockStatsStruct{
+</pre><table><tr><td>long long</td><td>rd_req</td><td> : number of read requests</td></tr><tr><td>long long</td><td>rd_bytes</td><td> : number of read bytes</td></tr><tr><td>long long</td><td>wr_req</td><td> : number of write requests</td></tr><tr><td>long long</td><td>wr_bytes</td><td> : number of written bytes</td></tr><tr><td>long long</td><td>errs</td><td> : In Xen this returns the mysterious 'oo_req'.</td></tr></table><pre>
 }
-</pre><h3>Enum <a name="virDomainXMLFlags" id="virDomainXMLFlags">virDomainXMLFlags</a></h3><pre class="programlisting">Enum virDomainXMLFlags {
-    <a name="VIR_DOMAIN_XML_SECURE" id="VIR_DOMAIN_XML_SECURE">VIR_DOMAIN_XML_SECURE</a> = 1 : dump security sensitive informations too
-    <a name="VIR_DOMAIN_XML_INACTIVE" id="VIR_DOMAIN_XML_INACTIVE">VIR_DOMAIN_XML_INACTIVE</a> = 2 : dump inactive domain informations
+</pre></div><h3><a name="virDomainCreateFlags" id="virDomainCreateFlags"><code>virDomainCreateFlags</code></a></h3><div class="api"><pre>enum virDomainCreateFlags {
+</pre><table><tr><td><a name="VIR_DOMAIN_NONE" id="VIR_DOMAIN_NONE">VIR_DOMAIN_NONE</a></td><td> = </td><td>0</td></tr></table><pre>}
+</pre></div><h3><a name="virDomainInfo" id="virDomainInfo"><code>virDomainInfo</code></a></h3><div class="api"><pre>struct virDomainInfo{
+</pre><table><tr><td>unsigned char</td><td>state</td><td> : the running state, one of <a href="libvirt-libvirt.html#virDomainState">virDomainState</a></td></tr><tr><td>unsigned long</td><td>maxMem</td><td> : the maximum memory in KBytes allowed</td></tr><tr><td>unsigned long</td><td>memory</td><td> : the memory in KBytes used by the domain</td></tr><tr><td>unsigned short</td><td>nrVirtCpu</td><td> : the number of virtual CPUs for the domain</td></tr><tr><td>unsigned long long</td><td>cpuTime</td><td> : the CPU time used in nanoseconds</td></tr></table><pre>
 }
-</pre><h3><a name="virNetwork" id="virNetwork">Structure virNetwork</a></h3><pre class="programlisting">Structure virNetwork<br />struct _virNetwork {
-The content of this structure is not made public by the API.
-}</pre>
-      a virNetworkPtr is pointer to a virNetwork private structure, this is the type used to reference a virtual network in the API.
-    <h3><a name="virNodeInfo" id="virNodeInfo">Structure virNodeInfo</a></h3><pre class="programlisting">Structure virNodeInfo<br />struct _virNodeInfo {
-    charmodel[32]	model	: string indicating the CPU model
-    unsigned long	memory	: memory size in kilobytes
-    unsigned int	cpus	: the number of active CPUs
-    unsigned int	mhz	: expected CPU frequency
-    unsigned int	nodes	: the number of NUMA cell, 1 for uniform
-    unsigned int	sockets	: number of CPU socket per node
-    unsigned int	cores	: number of core per socket
-    unsigned int	threads	: number of threads per core
-}</pre>
-      a virNodeInfoPtr is a pointer to a virNodeInfo structure.
-    <h3><a name="virSchedParameter" id="virSchedParameter">Structure virSchedParameter</a></h3><pre class="programlisting">Structure virSchedParameter<br />struct _virSchedParameter {
-    charfield[VIR_DOMAIN_SCHED_FIELD_LENGTH]	field	: parameter name
-    int	type	: parameter type
-}</pre>
-      a virSchedParameterPtr is a pointer to a virSchedParameter structure.
-    <h3>Enum <a name="virSchedParameterType" id="virSchedParameterType">virSchedParameterType</a></h3><pre class="programlisting">Enum virSchedParameterType {
-    <a name="VIR_DOMAIN_SCHED_FIELD_INT" id="VIR_DOMAIN_SCHED_FIELD_INT">VIR_DOMAIN_SCHED_FIELD_INT</a> = 1 : integer case
-    <a name="VIR_DOMAIN_SCHED_FIELD_UINT" id="VIR_DOMAIN_SCHED_FIELD_UINT">VIR_DOMAIN_SCHED_FIELD_UINT</a> = 2 : unsigned integer case
-    <a name="VIR_DOMAIN_SCHED_FIELD_LLONG" id="VIR_DOMAIN_SCHED_FIELD_LLONG">VIR_DOMAIN_SCHED_FIELD_LLONG</a> = 3 : long long case
-    <a name="VIR_DOMAIN_SCHED_FIELD_ULLONG" id="VIR_DOMAIN_SCHED_FIELD_ULLONG">VIR_DOMAIN_SCHED_FIELD_ULLONG</a> = 4 : unsigned long long case
-    <a name="VIR_DOMAIN_SCHED_FIELD_DOUBLE" id="VIR_DOMAIN_SCHED_FIELD_DOUBLE">VIR_DOMAIN_SCHED_FIELD_DOUBLE</a> = 5 : double case
-    <a name="VIR_DOMAIN_SCHED_FIELD_BOOLEAN" id="VIR_DOMAIN_SCHED_FIELD_BOOLEAN">VIR_DOMAIN_SCHED_FIELD_BOOLEAN</a> = 6 : boolean(character) case
+</pre></div><h3><a name="virDomainInterfaceStatsStruct" id="virDomainInterfaceStatsStruct"><code>virDomainInterfaceStatsStruct</code></a></h3><div class="api"><pre>struct virDomainInterfaceStatsStruct{
+</pre><table><tr><td>long long</td><td>rx_bytes</td></tr><tr><td>long long</td><td>rx_packets</td></tr><tr><td>long long</td><td>rx_errs</td></tr><tr><td>long long</td><td>rx_drop</td></tr><tr><td>long long</td><td>tx_bytes</td></tr><tr><td>long long</td><td>tx_packets</td></tr><tr><td>long long</td><td>tx_errs</td></tr><tr><td>long long</td><td>tx_drop</td></tr></table><pre>
 }
-</pre><h3><a name="virStoragePool" id="virStoragePool">Structure virStoragePool</a></h3><pre class="programlisting">Structure virStoragePool<br />struct _virStoragePool {
-The content of this structure is not made public by the API.
-}</pre><h3>Enum <a name="virStoragePoolBuildFlags" id="virStoragePoolBuildFlags">virStoragePoolBuildFlags</a></h3><pre class="programlisting">Enum virStoragePoolBuildFlags {
-    <a name="VIR_STORAGE_POOL_BUILD_NEW" id="VIR_STORAGE_POOL_BUILD_NEW">VIR_STORAGE_POOL_BUILD_NEW</a> = 0 : Regular build from scratch
-    <a name="VIR_STORAGE_POOL_BUILD_REPAIR" id="VIR_STORAGE_POOL_BUILD_REPAIR">VIR_STORAGE_POOL_BUILD_REPAIR</a> = 1 : Repair / reinitialize
-    <a name="VIR_STORAGE_POOL_BUILD_RESIZE" id="VIR_STORAGE_POOL_BUILD_RESIZE">VIR_STORAGE_POOL_BUILD_RESIZE</a> = 2 : Extend existing pool
+</pre></div><h3><a name="virDomainMemoryFlags" id="virDomainMemoryFlags"><code>virDomainMemoryFlags</code></a></h3><div class="api"><pre>enum virDomainMemoryFlags {
+</pre><table><tr><td><a name="VIR_MEMORY_VIRTUAL" id="VIR_MEMORY_VIRTUAL">VIR_MEMORY_VIRTUAL</a></td><td> = </td><td>1</td><td> : addresses are virtual addresses</td></tr></table><pre>}
+</pre></div><h3><a name="virDomainMigrateFlags" id="virDomainMigrateFlags"><code>virDomainMigrateFlags</code></a></h3><div class="api"><pre>enum virDomainMigrateFlags {
+</pre><table><tr><td><a name="VIR_MIGRATE_LIVE" id="VIR_MIGRATE_LIVE">VIR_MIGRATE_LIVE</a></td><td> = </td><td>1</td><td> : live migration</td></tr></table><pre>}
+</pre></div><h3><a name="virDomainState" id="virDomainState"><code>virDomainState</code></a></h3><div class="api"><pre>enum virDomainState {
+</pre><table><tr><td><a name="VIR_DOMAIN_NOSTATE" id="VIR_DOMAIN_NOSTATE">VIR_DOMAIN_NOSTATE</a></td><td> = </td><td>0</td><td> : no state</td></tr><tr><td><a name="VIR_DOMAIN_RUNNING" id="VIR_DOMAIN_RUNNING">VIR_DOMAIN_RUNNING</a></td><td> = </td><td>1</td><td> : the domain is running</td></tr><tr><td><a name="VIR_DOMAIN_BLOCKED" id="VIR_DOMAIN_BLOCKED">VIR_DOMAIN_BLOCKED</a></td><td> = </td><td>2</td><td> : the domain is blocked on resource</td></tr><tr><td><a name="VIR_DOMAIN_PAUSED" id="VIR_DOMAIN_PAUSED">VIR_DOMAIN_PAUSED</a></td><td> = </td><td>3</td><td> : the domain is paused by user</td></tr><tr><td><a name="VIR_DOMAIN_SHUTDOWN" id="VIR_DOMAIN_SHUTDOWN">VIR_DOMAIN_SHUTDOWN</a></td><td> = </td><td>4</td><td> : the domain is being shut down</td></tr><tr><td><a name="VIR_DOMAIN_SHUTOFF" id="VIR_DOMAIN_SHUTOFF">VIR_DOMAIN_SHUTOFF</a></td><td> = </td><td>5</td><td> : the domain is shut off</td></tr><tr><td><a name="VIR_DOMAIN_CRASHED" id="VIR_DOMAIN_CRASHED">VIR_DOMAIN_CRASHED</a></td><td> = </td><td>6</td><td> : the domain is crashed</td></tr></table><pre>}
+</pre></div><h3><a name="virDomainXMLFlags" id="virDomainXMLFlags"><code>virDomainXMLFlags</code></a></h3><div class="api"><pre>enum virDomainXMLFlags {
+</pre><table><tr><td><a name="VIR_DOMAIN_XML_SECURE" id="VIR_DOMAIN_XML_SECURE">VIR_DOMAIN_XML_SECURE</a></td><td> = </td><td>1</td><td> : dump security sensitive information too</td></tr><tr><td><a name="VIR_DOMAIN_XML_INACTIVE" id="VIR_DOMAIN_XML_INACTIVE">VIR_DOMAIN_XML_INACTIVE</a></td><td> = </td><td>2</td><td> : dump inactive domain information</td></tr></table><pre>}
+</pre></div><h3><a name="virNetwork" id="virNetwork"><code>virNetwork</code></a></h3><div class="api"><pre>struct virNetwork{
+</pre><table><tr><td colspan="3">The content of this structure is not made public by the API</td></tr></table><pre>
 }
-</pre><h3>Enum <a name="virStoragePoolDeleteFlags" id="virStoragePoolDeleteFlags">virStoragePoolDeleteFlags</a></h3><pre class="programlisting">Enum virStoragePoolDeleteFlags {
-    <a name="VIR_STORAGE_POOL_DELETE_NORMAL" id="VIR_STORAGE_POOL_DELETE_NORMAL">VIR_STORAGE_POOL_DELETE_NORMAL</a> = 0 : Delete metadata only (fast)
-    <a name="VIR_STORAGE_POOL_DELETE_ZEROED" id="VIR_STORAGE_POOL_DELETE_ZEROED">VIR_STORAGE_POOL_DELETE_ZEROED</a> = 1 : Clear all data to zeros (slow)
+</pre></div><h3><a name="virNodeInfo" id="virNodeInfo"><code>virNodeInfo</code></a></h3><div class="api"><pre>struct virNodeInfo{
+</pre><table><tr><td>charmodel[32]</td><td>model</td><td> : string indicating the CPU model</td></tr><tr><td>unsigned long</td><td>memory</td><td> : memory size in kilobytes</td></tr><tr><td>unsigned int</td><td>cpus</td><td> : the number of active CPUs</td></tr><tr><td>unsigned int</td><td>mhz</td><td> : expected CPU frequency</td></tr><tr><td>unsigned int</td><td>nodes</td><td> : the number of NUMA cell, 1 for uniform mem access</td></tr><tr><td>unsigned int</td><td>sockets</td><td> : number of CPU socket per node</td></tr><tr><td>unsigned int</td><td>cores</td><td> : number of core per socket</td></tr><tr><td>unsigned int</td><td>threads</td><td> : number of threads per core</td></tr></table><pre>
 }
-</pre><h3><a name="virStoragePoolInfo" id="virStoragePoolInfo">Structure virStoragePoolInfo</a></h3><pre class="programlisting">Structure virStoragePoolInfo<br />struct _virStoragePoolInfo {
-    int	state	: <a href="libvirt-libvirt.html#virStoragePoolState">virStoragePoolState</a> flags
-    unsigned long long	capacity	: Logical size bytes
-    unsigned long long	allocation	: Current allocation bytes
-    unsigned long long	available	: Remaining free space bytes
-}</pre>
-      a virStoragePoolPtr is pointer to a virStoragePool private structure, this is the type used to reference a storage pool in the API.
-    <h3>Enum <a name="virStoragePoolState" id="virStoragePoolState">virStoragePoolState</a></h3><pre class="programlisting">Enum virStoragePoolState {
-    <a name="VIR_STORAGE_POOL_INACTIVE" id="VIR_STORAGE_POOL_INACTIVE">VIR_STORAGE_POOL_INACTIVE</a> = 0 : Not running
-    <a name="VIR_STORAGE_POOL_BUILDING" id="VIR_STORAGE_POOL_BUILDING">VIR_STORAGE_POOL_BUILDING</a> = 1 : Initializing pool, not available
-    <a name="VIR_STORAGE_POOL_RUNNING" id="VIR_STORAGE_POOL_RUNNING">VIR_STORAGE_POOL_RUNNING</a> = 2 : Running normally
-    <a name="VIR_STORAGE_POOL_DEGRADED" id="VIR_STORAGE_POOL_DEGRADED">VIR_STORAGE_POOL_DEGRADED</a> = 3 : Running degraded
+</pre></div><h3><a name="virSchedParameter" id="virSchedParameter"><code>virSchedParameter</code></a></h3><div class="api"><pre>struct virSchedParameter{
+</pre><table><tr><td>charfield[VIR_DOMAIN_SCHED_FIELD_LENGTH]</td><td>field</td><td> : parameter name</td></tr><tr><td>int</td><td>type</td><td> : parameter type</td></tr></table><pre>
 }
-</pre><h3><a name="virStorageVol" id="virStorageVol">Structure virStorageVol</a></h3><pre class="programlisting">Structure virStorageVol<br />struct _virStorageVol {
-The content of this structure is not made public by the API.
-}</pre><h3>Enum <a name="virStorageVolDeleteFlags" id="virStorageVolDeleteFlags">virStorageVolDeleteFlags</a></h3><pre class="programlisting">Enum virStorageVolDeleteFlags {
-    <a name="VIR_STORAGE_VOL_DELETE_NORMAL" id="VIR_STORAGE_VOL_DELETE_NORMAL">VIR_STORAGE_VOL_DELETE_NORMAL</a> = 0 : Delete metadata only (fast)
-    <a name="VIR_STORAGE_VOL_DELETE_ZEROED" id="VIR_STORAGE_VOL_DELETE_ZEROED">VIR_STORAGE_VOL_DELETE_ZEROED</a> = 1 : Clear all data to zeros (slow)
+</pre></div><h3><a name="virSchedParameterType" id="virSchedParameterType"><code>virSchedParameterType</code></a></h3><div class="api"><pre>enum virSchedParameterType {
+</pre><table><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_INT" id="VIR_DOMAIN_SCHED_FIELD_INT">VIR_DOMAIN_SCHED_FIELD_INT</a></td><td> = </td><td>1</td><td> : integer case</td></tr><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_UINT" id="VIR_DOMAIN_SCHED_FIELD_UINT">VIR_DOMAIN_SCHED_FIELD_UINT</a></td><td> = </td><td>2</td><td> : unsigned integer case</td></tr><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_LLONG" id="VIR_DOMAIN_SCHED_FIELD_LLONG">VIR_DOMAIN_SCHED_FIELD_LLONG</a></td><td> = </td><td>3</td><td> : long long case</td></tr><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_ULLONG" id="VIR_DOMAIN_SCHED_FIELD_ULLONG">VIR_DOMAIN_SCHED_FIELD_ULLONG</a></td><td> = </td><td>4</td><td> : unsigned long long case</td></tr><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_DOUBLE" id="VIR_DOMAIN_SCHED_FIELD_DOUBLE">VIR_DOMAIN_SCHED_FIELD_DOUBLE</a></td><td> = </td><td>5</td><td> : double case</td></tr><tr><td><a name="VIR_DOMAIN_SCHED_FIELD_BOOLEAN" id="VIR_DOMAIN_SCHED_FIELD_BOOLEAN">VIR_DOMAIN_SCHED_FIELD_BOOLEAN</a></td><td> = </td><td>6</td><td> : boolean(character) case</td></tr></table><pre>}
+</pre></div><h3><a name="virStoragePool" id="virStoragePool"><code>virStoragePool</code></a></h3><div class="api"><pre>struct virStoragePool{
+</pre><table><tr><td colspan="3">The content of this structure is not made public by the API</td></tr></table><pre>
 }
-</pre><h3><a name="virStorageVolInfo" id="virStorageVolInfo">Structure virStorageVolInfo</a></h3><pre class="programlisting">Structure virStorageVolInfo<br />struct _virStorageVolInfo {
-    int	type	: <a href="libvirt-libvirt.html#virStorageVolType">virStorageVolType</a> flags
-    unsigned long long	capacity	: Logical size bytes
-    unsigned long long	allocation	: Current allocation bytes
-}</pre>
-      a virStorageVolPtr is pointer to a virStorageVol private structure, this is the type used to reference a storage volume in the API.
-    <h3>Enum <a name="virStorageVolType" id="virStorageVolType">virStorageVolType</a></h3><pre class="programlisting">Enum virStorageVolType {
-    <a name="VIR_STORAGE_VOL_FILE" id="VIR_STORAGE_VOL_FILE">VIR_STORAGE_VOL_FILE</a> = 0 : Regular file based volumes
-    <a name="VIR_STORAGE_VOL_BLOCK" id="VIR_STORAGE_VOL_BLOCK">VIR_STORAGE_VOL_BLOCK</a> = 1 : Block based volumes
+</pre></div><h3><a name="virStoragePoolBuildFlags" id="virStoragePoolBuildFlags"><code>virStoragePoolBuildFlags</code></a></h3><div class="api"><pre>enum virStoragePoolBuildFlags {
+</pre><table><tr><td><a name="VIR_STORAGE_POOL_BUILD_NEW" id="VIR_STORAGE_POOL_BUILD_NEW">VIR_STORAGE_POOL_BUILD_NEW</a></td><td> = </td><td>0</td><td> : Regular build from scratch</td></tr><tr><td><a name="VIR_STORAGE_POOL_BUILD_REPAIR" id="VIR_STORAGE_POOL_BUILD_REPAIR">VIR_STORAGE_POOL_BUILD_REPAIR</a></td><td> = </td><td>1</td><td> : Repair / reinitialize</td></tr><tr><td><a name="VIR_STORAGE_POOL_BUILD_RESIZE" id="VIR_STORAGE_POOL_BUILD_RESIZE">VIR_STORAGE_POOL_BUILD_RESIZE</a></td><td> = </td><td>2</td><td> : Extend existing pool</td></tr></table><pre>}
+</pre></div><h3><a name="virStoragePoolDeleteFlags" id="virStoragePoolDeleteFlags"><code>virStoragePoolDeleteFlags</code></a></h3><div class="api"><pre>enum virStoragePoolDeleteFlags {
+</pre><table><tr><td><a name="VIR_STORAGE_POOL_DELETE_NORMAL" id="VIR_STORAGE_POOL_DELETE_NORMAL">VIR_STORAGE_POOL_DELETE_NORMAL</a></td><td> = </td><td>0</td><td> : Delete metadata only (fast)</td></tr><tr><td><a name="VIR_STORAGE_POOL_DELETE_ZEROED" id="VIR_STORAGE_POOL_DELETE_ZEROED">VIR_STORAGE_POOL_DELETE_ZEROED</a></td><td> = </td><td>1</td><td> : Clear all data to zeros (slow)</td></tr></table><pre>}
+</pre></div><h3><a name="virStoragePoolInfo" id="virStoragePoolInfo"><code>virStoragePoolInfo</code></a></h3><div class="api"><pre>struct virStoragePoolInfo{
+</pre><table><tr><td>int</td><td>state</td><td> : <a href="libvirt-libvirt.html#virStoragePoolState">virStoragePoolState</a> flags</td></tr><tr><td>unsigned long long</td><td>capacity</td><td> : Logical size bytes</td></tr><tr><td>unsigned long long</td><td>allocation</td><td> : Current allocation bytes</td></tr><tr><td>unsigned long long</td><td>available</td><td> : Remaining free space bytes</td></tr></table><pre>
 }
-</pre><h3><a name="virVcpuInfo" id="virVcpuInfo">Structure virVcpuInfo</a></h3><pre class="programlisting">Structure virVcpuInfo<br />struct _virVcpuInfo {
-    unsigned int	number	: virtual CPU number
-    int	state	: value from <a href="libvirt-libvirt.html#virVcpuState">virVcpuState</a>
-    unsigned long long	cpuTime	: CPU time used, in nanoseconds
-    int	cpu	: real CPU number, or -1 if offline
-}</pre><h3>Enum <a name="virVcpuState" id="virVcpuState">virVcpuState</a></h3><pre class="programlisting">Enum virVcpuState {
-    <a name="VIR_VCPU_OFFLINE" id="VIR_VCPU_OFFLINE">VIR_VCPU_OFFLINE</a> = 0 : the virtual CPU is offline
-    <a name="VIR_VCPU_RUNNING" id="VIR_VCPU_RUNNING">VIR_VCPU_RUNNING</a> = 1 : the virtual CPU is running
-    <a name="VIR_VCPU_BLOCKED" id="VIR_VCPU_BLOCKED">VIR_VCPU_BLOCKED</a> = 2 : the virtual CPU is blocked on resource
+</pre></div><h3><a name="virStoragePoolState" id="virStoragePoolState"><code>virStoragePoolState</code></a></h3><div class="api"><pre>enum virStoragePoolState {
+</pre><table><tr><td><a name="VIR_STORAGE_POOL_INACTIVE" id="VIR_STORAGE_POOL_INACTIVE">VIR_STORAGE_POOL_INACTIVE</a></td><td> = </td><td>0</td><td> : Not running</td></tr><tr><td><a name="VIR_STORAGE_POOL_BUILDING" id="VIR_STORAGE_POOL_BUILDING">VIR_STORAGE_POOL_BUILDING</a></td><td> = </td><td>1</td><td> : Initializing pool, not available</td></tr><tr><td><a name="VIR_STORAGE_POOL_RUNNING" id="VIR_STORAGE_POOL_RUNNING">VIR_STORAGE_POOL_RUNNING</a></td><td> = </td><td>2</td><td> : Running normally</td></tr><tr><td><a name="VIR_STORAGE_POOL_DEGRADED" id="VIR_STORAGE_POOL_DEGRADED">VIR_STORAGE_POOL_DEGRADED</a></td><td> = </td><td>3</td><td> : Running degraded</td></tr></table><pre>}
+</pre></div><h3><a name="virStorageVol" id="virStorageVol"><code>virStorageVol</code></a></h3><div class="api"><pre>struct virStorageVol{
+</pre><table><tr><td colspan="3">The content of this structure is not made public by the API</td></tr></table><pre>
 }
-</pre><h3><a name="virConnectAuthCallbackPtr" id="virConnectAuthCallbackPtr"></a>Function type: virConnectAuthCallbackPtr</h3><pre class="programlisting">Function type: virConnectAuthCallbackPtr
-int	virConnectAuthCallbackPtr	(<a href="libvirt-libvirt.html#virConnectCredentialPtr">virConnectCredentialPtr</a> cred, <br />					 unsigned int ncred, <br />					 void * cbdata)
-</pre><p></p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>cred</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>ncred</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>cbdata</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td></td></tr></tbody></table></div><br />
-<h3><a name="virConnectClose" id="virConnectClose"></a>Function: 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><h3><a name="virConnectGetCapabilities" id="virConnectGetCapabilities"></a>Function: 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>
-<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>NULL in case of error, or an XML string defining the capabilities. The client must free the returned string after use.</td></tr></tbody></table></div><h3><a name="virConnectGetHostname" id="virConnectGetHostname"></a>Function: virConnectGetHostname</h3><pre class="programlisting">char *	virConnectGetHostname		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>This returns the system hostname on which the hypervisor is running (the result of the gethostname(2) system call). If we are connected to a remote system, then this returns the hostname of the remote system.</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 a hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the hostname which must be freed by the caller, or NULL if there was an error.</td></tr></tbody></table></div><h3><a name="virConnectGetMaxVcpus" id="virConnectGetMaxVcpus"></a>Function: virConnectGetMaxVcpus</h3><pre class="programlisting">int	virConnectGetMaxVcpus		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * type)<br />
-</pre><p>Provides the maximum number of virtual CPUs supported for a guest VM of a specific type. The 'type' parameter here corresponds to the 'type' attribute in the &lt;domain&gt; element of the XML.</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>type</tt></i>:</span></td><td>value of the 'type' attribute in the &lt;domain&gt; element</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the maximum of virtual CPU or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virConnectGetType" id="virConnectGetType"></a>Function: virConnectGetType</h3><pre class="programlisting">const char *	virConnectGetType	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Get the name of the Hypervisor software used.</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>NULL in case of error, a static zero terminated string otherwise. See also: http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html</td></tr></tbody></table></div><h3><a name="virConnectGetURI" id="virConnectGetURI"></a>Function: virConnectGetURI</h3><pre class="programlisting">char *	virConnectGetURI		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>This returns the URI (name) of the hypervisor connection. Normally this is the same as or similar to the string passed to the virConnectOpen/virConnectOpenReadOnly call, but the driver may make the URI canonical. If name == NULL was passed to virConnectOpen, then the driver will return a non-NULL URI which can be used to connect to the same hypervisor later.</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 a hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the URI string which must be freed by the caller, or NULL if there was an error.</td></tr></tbody></table></div><h3><a name="virConnectGetVersion" id="virConnectGetVersion"></a>Function: virConnectGetVersion</h3><pre class="programlisting">int	virConnectGetVersion		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 unsigned long * hvVer)<br />
-</pre><p>Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with priviledged access to the hypervisor, not with a Read-Only connection.</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>hvVer</tt></i>:</span></td><td>return value for the version of the running hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 otherwise. if the version can't be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release</td></tr></tbody></table></div><h3><a name="virConnectListDefinedDomains" id="virConnectListDefinedDomains"></a>Function: virConnectListDefinedDomains</h3><pre class="programlisting">int	virConnectListDefinedDomains	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)<br />
-</pre><p>list the defined domains, stores the pointers to the names in @names</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>names</tt></i>:</span></td><td>pointer to an array to store the names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names provided in the array or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListDefinedNetworks" id="virConnectListDefinedNetworks"></a>Function: virConnectListDefinedNetworks</h3><pre class="programlisting">int	virConnectListDefinedNetworks	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)<br />
-</pre><p>list the inactive networks, stores the pointers to the names in @names</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>names</tt></i>:</span></td><td>pointer to an array to store the names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names provided in the array or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListDefinedStoragePools" id="virConnectListDefinedStoragePools"></a>Function: virConnectListDefinedStoragePools</h3><pre class="programlisting">int	virConnectListDefinedStoragePools	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 char ** const names, <br />						 int maxnames)<br />
-</pre><p>Provides the list of names of inactive storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</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>names</tt></i>:</span></td><td>array of char * to fill with pool names (allocated by caller)</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on error</td></tr></tbody></table></div><h3><a name="virConnectListDomains" id="virConnectListDomains"></a>Function: virConnectListDomains</h3><pre class="programlisting">int	virConnectListDomains		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 int * ids, <br />					 int maxids)<br />
-</pre><p>Collect the list of active domains, and store their ID in @maxids</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>ids</tt></i>:</span></td><td>array to collect the list of IDs of active domains</td></tr><tr><td><span class="term"><i><tt>maxids</tt></i>:</span></td><td>size of @ids</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListNetworks" id="virConnectListNetworks"></a>Function: virConnectListNetworks</h3><pre class="programlisting">int	virConnectListNetworks		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)<br />
-</pre><p>Collect the list of active networks, and store their names in @names</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>names</tt></i>:</span></td><td>array to collect the list of names of active networks</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 networks found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListStoragePools" id="virConnectListStoragePools"></a>Function: virConnectListStoragePools</h3><pre class="programlisting">int	virConnectListStoragePools	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)<br />
-</pre><p>Provides the list of names of active storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</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>names</tt></i>:</span></td><td>array of char * to fill with pool names (allocated by caller)</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedDomains" id="virConnectNumOfDefinedDomains"></a>Function: virConnectNumOfDefinedDomains</h3><pre class="programlisting">int	virConnectNumOfDefinedDomains	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of inactive 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>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedNetworks" id="virConnectNumOfDefinedNetworks"></a>Function: virConnectNumOfDefinedNetworks</h3><pre class="programlisting">int	virConnectNumOfDefinedNetworks	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of inactive networks.</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>the number of networks found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedStoragePools" id="virConnectNumOfDefinedStoragePools"></a>Function: virConnectNumOfDefinedStoragePools</h3><pre class="programlisting">int	virConnectNumOfDefinedStoragePools	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of inactive storage pools</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>Returns</tt></i>:</span></td><td>the number of pools found, or -1 on error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDomains" id="virConnectNumOfDomains"></a>Function: virConnectNumOfDomains</h3><pre class="programlisting">int	virConnectNumOfDomains		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of active 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>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfNetworks" id="virConnectNumOfNetworks"></a>Function: virConnectNumOfNetworks</h3><pre class="programlisting">int	virConnectNumOfNetworks		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of active networks.</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>the number of network found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfStoragePools" id="virConnectNumOfStoragePools"></a>Function: virConnectNumOfStoragePools</h3><pre class="programlisting">int	virConnectNumOfStoragePools	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>Provides the number of active storage pools</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>Returns</tt></i>:</span></td><td>the number of pools found, or -1 on error</td></tr></tbody></table></div><h3><a name="virConnectOpen" id="virConnectOpen"></a>Function: virConnectOpen</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virConnectOpen		(const char * name)<br />
-</pre><p>This function should be called first to get a connection to the Hypervisor and xen store</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virConnectOpenAuth" id="virConnectOpenAuth"></a>Function: virConnectOpenAuth</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virConnectOpenAuth	(const char * name, <br />					 <a href="libvirt-libvirt.html#virConnectAuthPtr">virConnectAuthPtr</a> auth, <br />					 int flags)<br />
-</pre><p>This function should be called first to get a connection to the Hypervisor. If neccessary, authentication will be performed fetching credentials via the callback</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>auth</tt></i>:</span></td><td>Authenticate callback parameters</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>Open flags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virConnectOpenReadOnly" id="virConnectOpenReadOnly"></a>Function: virConnectOpenReadOnly</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virConnectOpenReadOnly	(const char * name)<br />
-</pre><p>This function should be called first to get a restricted connection to the libbrary functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virDomainAttachDevice" id="virDomainAttachDevice"></a>Function: 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><h3><a name="virDomainBlockStats" id="virDomainBlockStats"></a>Function: 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>
-<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>stats</tt></i>:</span></td><td>block device 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><h3><a name="virDomainCoreDump" id="virDomainCoreDump"></a>Function: virDomainCoreDump</h3><pre class="programlisting">int	virDomainCoreDump		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * to, <br />					 int flags)<br />
-</pre><p>This method will dump the core of a domain on a given file for analysis. Note that for remote Xen Daemon the file path will be interpreted in the remote host.</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>to</tt></i>:</span></td><td>path for the core file</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>extra flags, currently unused</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><h3><a name="virDomainCreate" id="virDomainCreate"></a>Function: virDomainCreate</h3><pre class="programlisting">int	virDomainCreate			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.</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><h3><a name="virDomainCreateLinux" id="virDomainCreateLinux"></a>Function: 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 priviledged 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>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><h3><a name="virDomainDefineXML" id="virDomainDefineXML"></a>Function: 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>
-<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><h3><a name="virDomainDestroy" id="virDomainDestroy"></a>Function: 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 priviledged 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><h3><a name="virDomainDetachDevice" id="virDomainDetachDevice"></a>Function: virDomainDetachDevice</h3><pre class="programlisting">int	virDomainDetachDevice		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * xml)<br />
-</pre><p>Destroy 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><h3><a name="virDomainFree" id="virDomainFree"></a>Function: virDomainFree</h3><pre class="programlisting">int	virDomainFree			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</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><h3><a name="virDomainGetAutostart" id="virDomainGetAutostart"></a>Function: virDomainGetAutostart</h3><pre class="programlisting">int	virDomainGetAutostart		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int * autostart)<br />
-</pre><p>Provides a boolean value indicating whether the domain configured to be automatically started when the host machine boots.</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>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetConnect" id="virDomainGetConnect"></a>Function: virDomainGetConnect</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virDomainGetConnect	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom)<br />
-</pre><p>Provides the connection pointer associated with a domain. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the domain object together.</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 a domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetID" id="virDomainGetID"></a>Function: virDomainGetID</h3><pre class="programlisting">unsigned int	virDomainGetID		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Get the hypervisor ID number for the domain</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>the domain ID number or (unsigned int) -1 in case of error</td></tr></tbody></table></div><h3><a name="virDomainGetInfo" id="virDomainGetInfo"></a>Function: virDomainGetInfo</h3><pre class="programlisting">int	virDomainGetInfo		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 <a href="libvirt-libvirt.html#virDomainInfoPtr">virDomainInfoPtr</a> info)<br />
-</pre><p>Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</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>info</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#virDomainInfo">virDomainInfo</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><h3><a name="virDomainGetMaxMemory" id="virDomainGetMaxMemory"></a>Function: virDomainGetMaxMemory</h3><pre class="programlisting">unsigned long	virDomainGetMaxMemory	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Retrieve the maximum amount of physical memory allocated to a domain. If domain is NULL, then this get the amount of memory reserved to Domain0 i.e. the domain where the application runs.</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 or NULL</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the memory size in kilobytes or 0 in case of error.</td></tr></tbody></table></div><h3><a name="virDomainGetMaxVcpus" id="virDomainGetMaxVcpus"></a>Function: virDomainGetMaxVcpus</h3><pre class="programlisting">int	virDomainGetMaxVcpus		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Provides the maximum number of virtual CPUs supported for the guest VM. If the guest is inactive, this is basically the same as virConnectGetMaxVcpus. If the guest is running this will reflect the maximum number of virtual CPUs the guest was booted with.</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>Returns</tt></i>:</span></td><td>the maximum of virtual CPU or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virDomainGetName" id="virDomainGetName"></a>Function: virDomainGetName</h3><pre class="programlisting">const char *	virDomainGetName	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Get the public name for that domain</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>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.</td></tr></tbody></table></div><h3><a name="virDomainGetOSType" id="virDomainGetOSType"></a>Function: virDomainGetOSType</h3><pre class="programlisting">char *	virDomainGetOSType		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Get the type of domain operation system.</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>the new string or NULL in case of error, the string must be freed by the caller.</td></tr></tbody></table></div><h3><a name="virDomainGetSchedulerParameters" id="virDomainGetSchedulerParameters"></a>Function: virDomainGetSchedulerParameters</h3><pre class="programlisting">int	virDomainGetSchedulerParameters	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br />					 int * nparams)<br />
-</pre><p>Get the scheduler parameters, the @params array will be filled with the values.</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>params</tt></i>:</span></td><td>pointer to scheduler parameter object (return value)</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>pointer to number of scheduler parameter (this value should be same than the returned value nparams of virDomainGetSchedulerType)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success.</td></tr></tbody></table></div><h3><a name="virDomainGetSchedulerType" id="virDomainGetSchedulerType"></a>Function: virDomainGetSchedulerType</h3><pre class="programlisting">char *	virDomainGetSchedulerType	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int * nparams)<br />
-</pre><p>Get the scheduler type.</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>nparams</tt></i>:</span></td><td>number of scheduler parameters(return value)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error. The caller must free the returned string.</td></tr></tbody></table></div><h3><a name="virDomainGetUUID" id="virDomainGetUUID"></a>Function: virDomainGetUUID</h3><pre class="programlisting">int	virDomainGetUUID		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned char * uuid)<br />
-</pre><p>Get the UUID for a domain</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>uuid</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetUUIDString" id="virDomainGetUUIDString"></a>Function: virDomainGetUUIDString</h3><pre class="programlisting">int	virDomainGetUUIDString		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 char * buf)<br />
-</pre><p>Get the UUID for a domain as string. For more information about UUID see RFC4122.</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>buf</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetVcpus" id="virDomainGetVcpus"></a>Function: virDomainGetVcpus</h3><pre class="programlisting">int	virDomainGetVcpus		(<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)<br />
-</pre><p>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer is'nt NULL.</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, 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 cupmap 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><h3><a name="virDomainGetXMLDesc" id="virDomainGetXMLDesc"></a>Function: 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>
-<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><h3><a name="virDomainInterfaceStats" id="virDomainInterfaceStats"></a>Function: 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 />
-</pre><p>This function returns network interface stats for interfaces attached to the domain. The path parameter is the name of the network interface. Domains may have more than network interface. 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>
-<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><h3><a name="virDomainLookupByID" id="virDomainLookupByID"></a>Function: 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>
-<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><h3><a name="virDomainLookupByName" id="virDomainLookupByName"></a>Function: 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 />
-</pre><p>Try to lookup a domain on the given hypervisor based on 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>name 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><h3><a name="virDomainLookupByUUID" id="virDomainLookupByUUID"></a>Function: virDomainLookupByUUID</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	virDomainLookupByUUID	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const unsigned char * uuid)<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>uuid</tt></i>:</span></td><td>the raw 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><h3><a name="virDomainLookupByUUIDString" id="virDomainLookupByUUIDString"></a>Function: 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><h3><a name="virDomainMigrate" id="virDomainMigrate"></a>Function: 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>
-<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>dconn</tt></i>:</span></td><td>destination host (a connection object)</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags</td></tr><tr><td><span class="term"><i><tt>dname</tt></i>:</span></td><td>(optional) rename domain to this at destination</td></tr><tr><td><span class="term"><i><tt>uri</tt></i>:</span></td><td>(optional) dest hostname/URI as seen from the source host</td></tr><tr><td><span class="term"><i><tt>bandwidth</tt></i>:</span></td><td>(optional) specify migration bandwidth limit in Mbps</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the new domain object if the migration was successful, or NULL in case of error. Note that the new domain object exists in the scope of the destination connection (dconn).</td></tr></tbody></table></div><h3><a name="virDomainPinVcpu" id="virDomainPinVcpu"></a>Function: virDomainPinVcpu</h3><pre class="programlisting">int	virDomainPinVcpu		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned int vcpu, <br />					 unsigned char * cpumap, <br />					 int maplen)<br />
-</pre><p>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires priviledged access to the hypervisor.</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, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>vcpu</tt></i>:</span></td><td>virtual CPU number</td></tr><tr><td><span class="term"><i><tt>cpumap</tt></i>:</span></td><td>pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.</td></tr><tr><td><span class="term"><i><tt>maplen</tt></i>:</span></td><td>number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen &lt; size, missing bytes are set to zero. If maplen &gt; size, failure code is returned.</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><h3><a name="virDomainReboot" id="virDomainReboot"></a>Function: virDomainReboot</h3><pre class="programlisting">int	virDomainReboot			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned int flags)<br />
-</pre><p>Reboot a domain, the domain object is still usable there after but the domain OS is being stopped for a restart. Note that the guest OS may ignore the request.</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>extra flags for the reboot operation, not used yet</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><h3><a name="virDomainRestore" id="virDomainRestore"></a>Function: virDomainRestore</h3><pre class="programlisting">int	virDomainRestore		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * from)<br />
-</pre><p>This method will restore a domain saved to disk by virDomainSave().</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>from</tt></i>:</span></td><td>path to the</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><h3><a name="virDomainResume" id="virDomainResume"></a>Function: virDomainResume</h3><pre class="programlisting">int	virDomainResume			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires priviledged 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><h3><a name="virDomainSave" id="virDomainSave"></a>Function: virDomainSave</h3><pre class="programlisting">int	virDomainSave			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * to)<br />
-</pre><p>This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this may be a problem). Use virDomainRestore() to restore a domain after saving.</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>to</tt></i>:</span></td><td>path for the output file</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><h3><a name="virDomainSetAutostart" id="virDomainSetAutostart"></a>Function: virDomainSetAutostart</h3><pre class="programlisting">int	virDomainSetAutostart		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int autostart)<br />
-</pre><p>Configure the domain to be automatically started when the host machine boots.</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>autostart</tt></i>:</span></td><td>whether the domain should be automatically started 0 or 1</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainSetMaxMemory" id="virDomainSetMaxMemory"></a>Function: virDomainSetMaxMemory</h3><pre class="programlisting">int	virDomainSetMaxMemory		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned long memory)<br />
-</pre><p>Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function requires priviledged access to the hypervisor.</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 or NULL</td></tr><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>the memory size in kilobytes</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><h3><a name="virDomainSetMemory" id="virDomainSetMemory"></a>Function: virDomainSetMemory</h3><pre class="programlisting">int	virDomainSetMemory		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned long memory)<br />
-</pre><p>Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may requires priviledged access to the hypervisor.</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 or NULL</td></tr><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>the memory size in kilobytes</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><h3><a name="virDomainSetSchedulerParameters" id="virDomainSetSchedulerParameters"></a>Function: virDomainSetSchedulerParameters</h3><pre class="programlisting">int	virDomainSetSchedulerParameters	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br />					 int nparams)<br />
-</pre><p>Change the scheduler parameters</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>params</tt></i>:</span></td><td>pointer to scheduler parameter objects</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>number of scheduler parameter (this value should be same or less than the returned value nparams of virDomainGetSchedulerType)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success.</td></tr></tbody></table></div><h3><a name="virDomainSetVcpus" id="virDomainSetVcpus"></a>Function: virDomainSetVcpus</h3><pre class="programlisting">int	virDomainSetVcpus		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned int nvcpus)<br />
-</pre><p>Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires priviledged access to the hypervisor.</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, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>nvcpus</tt></i>:</span></td><td>the new number of virtual CPUs for this 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 failure.</td></tr></tbody></table></div><h3><a name="virDomainShutdown" id="virDomainShutdown"></a>Function: virDomainShutdown</h3><pre class="programlisting">int	virDomainShutdown		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request. TODO: should we add an option for reboot, knowing it may not be doable in the general case ?</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><h3><a name="virDomainSuspend" id="virDomainSuspend"></a>Function: virDomainSuspend</h3><pre class="programlisting">int	virDomainSuspend		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
-</pre><p>Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires priviledged 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><h3><a name="virDomainUndefine" id="virDomainUndefine"></a>Function: 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>
-<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><h3><a name="virGetVersion" id="virGetVersion"></a>Function: 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 availble, an error code will be returned and @typeVer will be 0.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>libVer</tt></i>:</span></td><td>return value for the library version (OUT)</td></tr><tr><td><span class="term"><i><tt>type</tt></i>:</span></td><td>the type of connection/driver looked at</td></tr><tr><td><span class="term"><i><tt>typeVer</tt></i>:</span></td><td>return value for the version of the hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.</td></tr></tbody></table></div><h3><a name="virInitialize" id="virInitialize"></a>Function: virInitialize</h3><pre class="programlisting">int	virInitialize			(void)<br />
-</pre><p>Initialize the library. It's better to call this routine at startup in multithreaded applications to avoid potential race when initializing the library.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><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="virNetworkCreate" id="virNetworkCreate"></a>Function: virNetworkCreate</h3><pre class="programlisting">int	virNetworkCreate		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
-</pre><p>Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.</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><h3><a name="virNetworkCreateXML" id="virNetworkCreateXML"></a>Function: virNetworkCreateXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	virNetworkCreateXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * xmlDesc)<br />
-</pre><p>Create and start a new virtual network, based on an XML description similar to the one returned by virNetworkGetXMLDesc()</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>an XML description of the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure</td></tr></tbody></table></div><h3><a name="virNetworkDefineXML" id="virNetworkDefineXML"></a>Function: virNetworkDefineXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	virNetworkDefineXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * xml)<br />
-</pre><p>Define a network, but does not create it</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 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><h3><a name="virNetworkDestroy" id="virNetworkDestroy"></a>Function: 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 priviledged 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><h3><a name="virNetworkFree" id="virNetworkFree"></a>Function: virNetworkFree</h3><pre class="programlisting">int	virNetworkFree			(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
-</pre><p>Free the network object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</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><h3><a name="virNetworkGetAutostart" id="virNetworkGetAutostart"></a>Function: virNetworkGetAutostart</h3><pre class="programlisting">int	virNetworkGetAutostart		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int * autostart)<br />
-</pre><p>Provides a boolean value indicating whether the network configured to be automatically started when the host machine boots.</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>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetBridgeName" id="virNetworkGetBridgeName"></a>Function: virNetworkGetBridgeName</h3><pre class="programlisting">char *	virNetworkGetBridgeName		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
-</pre><p>Provides a bridge interface name to which a domain may connect a network interface in order to join the network.</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>a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div><h3><a name="virNetworkGetConnect" id="virNetworkGetConnect"></a>Function: virNetworkGetConnect</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virNetworkGetConnect	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net)<br />
-</pre><p>Provides the connection pointer associated with a network. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the network object together.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>net</tt></i>:</span></td><td>pointer to a network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virNetworkGetName" id="virNetworkGetName"></a>Function: virNetworkGetName</h3><pre class="programlisting">const char *	virNetworkGetName	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
-</pre><p>Get the public name for that network</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>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the network object.</td></tr></tbody></table></div><h3><a name="virNetworkGetUUID" id="virNetworkGetUUID"></a>Function: virNetworkGetUUID</h3><pre class="programlisting">int	virNetworkGetUUID		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 unsigned char * uuid)<br />
-</pre><p>Get the UUID for a network</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>uuid</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetUUIDString" id="virNetworkGetUUIDString"></a>Function: virNetworkGetUUIDString</h3><pre class="programlisting">int	virNetworkGetUUIDString		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 char * buf)<br />
-</pre><p>Get the UUID for a network as string. For more information about UUID see RFC4122.</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>buf</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetXMLDesc" id="virNetworkGetXMLDesc"></a>Function: virNetworkGetXMLDesc</h3><pre class="programlisting">char *	virNetworkGetXMLDesc		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int flags)<br />
-</pre><p>Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().</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>flags</tt></i>:</span></td><td>and OR'ed set of extraction flags, not used yet</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><h3><a name="virNetworkLookupByName" id="virNetworkLookupByName"></a>Function: virNetworkLookupByName</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	virNetworkLookupByName	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * name)<br />
-</pre><p>Try to lookup a network on the given hypervisor based on 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>name for the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkLookupByUUID" id="virNetworkLookupByUUID"></a>Function: virNetworkLookupByUUID</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	virNetworkLookupByUUID	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const unsigned char * uuid)<br />
-</pre><p>Try to lookup a network 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>uuid</tt></i>:</span></td><td>the raw UUID for the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkLookupByUUIDString" id="virNetworkLookupByUUIDString"></a>Function: virNetworkLookupByUUIDString</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	virNetworkLookupByUUIDString	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 const char * uuidstr)<br />
-</pre><p>Try to lookup a network 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 network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkSetAutostart" id="virNetworkSetAutostart"></a>Function: virNetworkSetAutostart</h3><pre class="programlisting">int	virNetworkSetAutostart		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int autostart)<br />
-</pre><p>Configure the network to be automatically started when the host machine boots.</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>autostart</tt></i>:</span></td><td>whether the network should be automatically started 0 or 1</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkUndefine" id="virNetworkUndefine"></a>Function: 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><h3><a name="virNodeGetCellsFreeMemory" id="virNodeGetCellsFreeMemory"></a>Function: 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>
-<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>freeMems</tt></i>:</span></td><td>pointer to the array of unsigned long long</td></tr><tr><td><span class="term"><i><tt>startCell</tt></i>:</span></td><td>index of first cell to return freeMems info on.</td></tr><tr><td><span class="term"><i><tt>maxCells</tt></i>:</span></td><td>Maximum number of cells for which freeMems information can be returned.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of entries filled in freeMems, or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virNodeGetFreeMemory" id="virNodeGetFreeMemory"></a>Function: virNodeGetFreeMemory</h3><pre class="programlisting">unsigned long long	virNodeGetFreeMemory	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
-</pre><p>provides the free memory availble on 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>Returns</tt></i>:</span></td><td>the available free memory in kilobytes or 0 in case of error</td></tr></tbody></table></div><h3><a name="virNodeGetInfo" id="virNodeGetInfo"></a>Function: 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><h3><a name="virStoragePoolBuild" id="virStoragePoolBuild"></a>Function: 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>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 upon failure</td></tr></tbody></table></div><h3><a name="virStoragePoolCreate" id="virStoragePoolCreate"></a>Function: virStoragePoolCreate</h3><pre class="programlisting">int	virStoragePoolCreate		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)<br />
-</pre><p>Starts an inactive storage pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be started</td></tr></tbody></table></div><h3><a name="virStoragePoolCreateXML" id="virStoragePoolCreateXML"></a>Function: virStoragePoolCreateXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolCreateXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 const char * xmlDesc, <br />						 unsigned int flags)<br />
-</pre><p>Create a new storage based on its XML description. The pool is not persitent, so its definition will disappear when it is destroyed, or if the host is restarted</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>xmlDesc</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStoragePoolDefineXML" id="virStoragePoolDefineXML"></a>Function: virStoragePoolDefineXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolDefineXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 const char * xml, <br />						 unsigned int flags)<br />
-</pre><p>Define a new inactive storage pool based on its XML description. The pool is persitent, until explicitly undefined.</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>xml</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStoragePoolDelete" id="virStoragePoolDelete"></a>Function: virStoragePoolDelete</h3><pre class="programlisting">int	virStoragePoolDelete		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)<br />
-</pre><p>Delete the underlying pool resources. This is a non-recoverable operation. The <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object itself is not free'd.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for obliteration process</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be obliterate</td></tr></tbody></table></div><h3><a name="virStoragePoolDestroy" id="virStoragePoolDestroy"></a>Function: virStoragePoolDestroy</h3><pre class="programlisting">int	virStoragePoolDestroy		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Destroy an active storage pool. This will deactivate the pool on the host, but keep any persistent config associated with it. If it has a persistent config it can later be restarted with virStoragePoolCreate(). This does not free the associated <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be destroyed</td></tr></tbody></table></div><h3><a name="virStoragePoolFree" id="virStoragePoolFree"></a>Function: virStoragePoolFree</h3><pre class="programlisting">int	virStoragePoolFree		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Free a storage pool object, releasing all memory associated with it. Does not change the state of the pool on the host.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be free'd.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetAutostart" id="virStoragePoolGetAutostart"></a>Function: virStoragePoolGetAutostart</h3><pre class="programlisting">int	virStoragePoolGetAutostart	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 int * autostart)<br />
-</pre><p>Fetches the value of the autostart flag, which determines whether the pool is automatically started at boot time</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>location in which to store autostart flag</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><h3><a name="virStoragePoolGetConnect" id="virStoragePoolGetConnect"></a>Function: virStoragePoolGetConnect</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virStoragePoolGetConnect	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Provides the connection pointer associated with a storage pool. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the pool object together.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to a poool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetInfo" id="virStoragePoolGetInfo"></a>Function: virStoragePoolGetInfo</h3><pre class="programlisting">int	virStoragePoolGetInfo		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 <a href="libvirt-libvirt.html#virStoragePoolInfoPtr">virStoragePoolInfoPtr</a> info)<br />
-</pre><p>Get volatile information about the storage pool such as free space / usage summary</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer at which to store info</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on failure.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetName" id="virStoragePoolGetName"></a>Function: virStoragePoolGetName</h3><pre class="programlisting">const char *	virStoragePoolGetName	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Fetch the locally unique name of the storage pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the name of the pool, or NULL on error</td></tr></tbody></table></div><h3><a name="virStoragePoolGetUUID" id="virStoragePoolGetUUID"></a>Function: virStoragePoolGetUUID</h3><pre class="programlisting">int	virStoragePoolGetUUID		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned char * uuid)<br />
-</pre><p>Fetch the globally unique ID of the storage pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>buffer of <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes in size</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error;</td></tr></tbody></table></div><h3><a name="virStoragePoolGetUUIDString" id="virStoragePoolGetUUIDString"></a>Function: virStoragePoolGetUUIDString</h3><pre class="programlisting">int	virStoragePoolGetUUIDString	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 char * buf)<br />
-</pre><p>Fetch the globally unique ID of the storage pool as a string</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>buf</tt></i>:</span></td><td>buffer of <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes in size</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error;</td></tr></tbody></table></div><h3><a name="virStoragePoolGetXMLDesc" id="virStoragePoolGetXMLDesc"></a>Function: virStoragePoolGetXMLDesc</h3><pre class="programlisting">char *	virStoragePoolGetXMLDesc	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)<br />
-</pre><p>Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the <a href="libvirt-libvirt.html#virStoragePoolCreateXML">virStoragePoolCreateXML</a> method.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML format options (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a XML document, or NULL on error</td></tr></tbody></table></div><h3><a name="virStoragePoolListVolumes" id="virStoragePoolListVolumes"></a>Function: virStoragePoolListVolumes</h3><pre class="programlisting">int	virStoragePoolListVolumes	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 char ** const names, <br />					 int maxnames)<br />
-</pre><p>Fetch list of storage volume names, limiting to at most maxnames.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array in which to storage volume names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names fetched, or -1 on error</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByName" id="virStoragePoolLookupByName"></a>Function: virStoragePoolLookupByName</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolLookupByName	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const char * name)<br />
-</pre><p>Fetch a storage pool based on its unique 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 hypervisor connection</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByUUID" id="virStoragePoolLookupByUUID"></a>Function: virStoragePoolLookupByUUID</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolLookupByUUID	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const unsigned char * uuid)<br />
-</pre><p>Fetch a storage pool based on its globally unique id</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>uuid</tt></i>:</span></td><td>globally unique id of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByUUIDString" id="virStoragePoolLookupByUUIDString"></a>Function: virStoragePoolLookupByUUIDString</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolLookupByUUIDString	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const char * uuidstr)<br />
-</pre><p>Fetch a storage pool based on its globally unique id</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>uuidstr</tt></i>:</span></td><td>globally unique id of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByVolume" id="virStoragePoolLookupByVolume"></a>Function: virStoragePoolLookupByVolume</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolLookupByVolume	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Fetch a storage pool which contains a particular volume</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolNumOfVolumes" id="virStoragePoolNumOfVolumes"></a>Function: virStoragePoolNumOfVolumes</h3><pre class="programlisting">int	virStoragePoolNumOfVolumes	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Fetch the number of storage volumes within a pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of storage pools, or -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolRefresh" id="virStoragePoolRefresh"></a>Function: virStoragePoolRefresh</h3><pre class="programlisting">int	virStoragePoolRefresh		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)<br />
-</pre><p>Request that the pool refresh its list of volumes. This may involve communicating with a remote server, and/or initializing new devices at the OS layer</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags to control refresh behaviour (currently unused, use 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if the volume list was refreshed, -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolSetAutostart" id="virStoragePoolSetAutostart"></a>Function: virStoragePoolSetAutostart</h3><pre class="programlisting">int	virStoragePoolSetAutostart	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 int autostart)<br />
-</pre><p>Sets the autostart flag</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>new flag setting</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><h3><a name="virStoragePoolUndefine" id="virStoragePoolUndefine"></a>Function: virStoragePoolUndefine</h3><pre class="programlisting">int	virStoragePoolUndefine		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
-</pre><p>Undefine an inactive storage pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStorageVolCreateXML" id="virStorageVolCreateXML"></a>Function: virStorageVolCreateXML</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	virStorageVolCreateXML	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />						 const char * xmldesc, <br />						 unsigned int flags)<br />
-</pre><p>Create a storage volume within a pool based on an XML description. Not all pools support creation of volumes</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>xmldesc</tt></i>:</span></td><td>description of volume to create</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for creation (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the storage volume, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolDelete" id="virStorageVolDelete"></a>Function: virStorageVolDelete</h3><pre class="programlisting">int	virStorageVolDelete		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br />					 unsigned int flags)<br />
-</pre><p>Delete the storage volume from the pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><a name="virStorageVolFree" id="virStorageVolFree"></a>Function: virStorageVolFree</h3><pre class="programlisting">int	virStorageVolFree		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Release the storage volume handle. The underlying storage volume contains to exist</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetConnect" id="virStorageVolGetConnect"></a>Function: virStorageVolGetConnect</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virStorageVolGetConnect	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Provides the connection pointer associated with a storage volume. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the volume object together.</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to a poool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virStorageVolGetInfo" id="virStorageVolGetInfo"></a>Function: virStorageVolGetInfo</h3><pre class="programlisting">int	virStorageVolGetInfo		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br />					 <a href="libvirt-libvirt.html#virStorageVolInfoPtr">virStorageVolInfoPtr</a> info)<br />
-</pre><p>Fetches volatile information about the storage volume such as its current allocation</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer at which to store info</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on failure</td></tr></tbody></table></div><h3><a name="virStorageVolGetKey" id="virStorageVolGetKey"></a>Function: virStorageVolGetKey</h3><pre class="programlisting">const char *	virStorageVolGetKey	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Fetch the storage volume key. This is globally unique, so the same volume will hve the same key no matter what host it is accessed from</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the volume key, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetName" id="virStorageVolGetName"></a>Function: virStorageVolGetName</h3><pre class="programlisting">const char *	virStorageVolGetName	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Fetch the storage volume name. This is unique within the scope of a pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the volume name, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetPath" id="virStorageVolGetPath"></a>Function: virStorageVolGetPath</h3><pre class="programlisting">char *	virStorageVolGetPath		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
-</pre><p>Fetch the storage volume path. Depending on the pool configuration this is either persistent across hosts, or dynamically assigned at pool startup. Consult pool documentation for information on getting the persistent naming</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the storage volume path, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetXMLDesc" id="virStorageVolGetXMLDesc"></a>Function: virStorageVolGetXMLDesc</h3><pre class="programlisting">char *	virStorageVolGetXMLDesc		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br />					 unsigned int flags)<br />
-</pre><p>Fetch an XML document describing all aspects of the storage volume</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</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><h3><a name="virStorageVolLookupByKey" id="virStorageVolLookupByKey"></a>Function: virStorageVolLookupByKey</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	virStorageVolLookupByKey	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const char * key)<br />
-</pre><p>Fetch a pointer to a storage volume based on its globally unique key</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>key</tt></i>:</span></td><td>globally unique key</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div><h3><a name="virStorageVolLookupByName" id="virStorageVolLookupByName"></a>Function: virStorageVolLookupByName</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	virStorageVolLookupByName	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />							 const char * name)<br />
-</pre><p>Fetch a pointer to a storage volume based on its name within a pool</p>
-<div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name of storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div><h3><a name="virStorageVolLookupByPath" id="virStorageVolLookupByPath"></a>Function: virStorageVolLookupByPath</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	virStorageVolLookupByPath	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const char * path)<br />
-</pre><p>Fetch a pointer to a storage volume based on its locally (host) unique path</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>path</tt></i>:</span></td><td>locally unique path</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / 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://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>
+</pre></div><h3><a name="virStorageVolDeleteFlags" id="virStorageVolDeleteFlags"><code>virStorageVolDeleteFlags</code></a></h3><div class="api"><pre>enum virStorageVolDeleteFlags {
+</pre><table><tr><td><a name="VIR_STORAGE_VOL_DELETE_NORMAL" id="VIR_STORAGE_VOL_DELETE_NORMAL">VIR_STORAGE_VOL_DELETE_NORMAL</a></td><td> = </td><td>0</td><td> : Delete metadata only (fast)</td></tr><tr><td><a name="VIR_STORAGE_VOL_DELETE_ZEROED" id="VIR_STORAGE_VOL_DELETE_ZEROED">VIR_STORAGE_VOL_DELETE_ZEROED</a></td><td> = </td><td>1</td><td> : Clear all data to zeros (slow)</td></tr></table><pre>}
+</pre></div><h3><a name="virStorageVolInfo" id="virStorageVolInfo"><code>virStorageVolInfo</code></a></h3><div class="api"><pre>struct virStorageVolInfo{
+</pre><table><tr><td>int</td><td>type</td><td> : <a href="libvirt-libvirt.html#virStorageVolType">virStorageVolType</a> flags</td></tr><tr><td>unsigned long long</td><td>capacity</td><td> : Logical size bytes</td></tr><tr><td>unsigned long long</td><td>allocation</td><td> : Current allocation bytes</td></tr></table><pre>
+}
+</pre></div><h3><a name="virStorageVolType" id="virStorageVolType"><code>virStorageVolType</code></a></h3><div class="api"><pre>enum virStorageVolType {
+</pre><table><tr><td><a name="VIR_STORAGE_VOL_FILE" id="VIR_STORAGE_VOL_FILE">VIR_STORAGE_VOL_FILE</a></td><td> = </td><td>0</td><td> : Regular file based volumes</td></tr><tr><td><a name="VIR_STORAGE_VOL_BLOCK" id="VIR_STORAGE_VOL_BLOCK">VIR_STORAGE_VOL_BLOCK</a></td><td> = </td><td>1</td><td> : Block based volumes</td></tr></table><pre>}
+</pre></div><h3><a name="virVcpuInfo" id="virVcpuInfo"><code>virVcpuInfo</code></a></h3><div class="api"><pre>struct virVcpuInfo{
+</pre><table><tr><td>unsigned int</td><td>number</td><td> : virtual CPU number</td></tr><tr><td>int</td><td>state</td><td> : value from <a href="libvirt-libvirt.html#virVcpuState">virVcpuState</a></td></tr><tr><td>unsigned long long</td><td>cpuTime</td><td> : CPU time used, in nanoseconds</td></tr><tr><td>int</td><td>cpu</td><td> : real CPU number, or -1 if offline</td></tr></table><pre>
+}
+</pre></div><h3><a name="virVcpuState" id="virVcpuState"><code>virVcpuState</code></a></h3><div class="api"><pre>enum virVcpuState {
+</pre><table><tr><td><a name="VIR_VCPU_OFFLINE" id="VIR_VCPU_OFFLINE">VIR_VCPU_OFFLINE</a></td><td> = </td><td>0</td><td> : the virtual CPU is offline</td></tr><tr><td><a name="VIR_VCPU_RUNNING" id="VIR_VCPU_RUNNING">VIR_VCPU_RUNNING</a></td><td> = </td><td>1</td><td> : the virtual CPU is running</td></tr><tr><td><a name="VIR_VCPU_BLOCKED" id="VIR_VCPU_BLOCKED">VIR_VCPU_BLOCKED</a></td><td> = </td><td>2</td><td> : the virtual CPU is blocked on resource</td></tr></table><pre>}
+</pre></div><h3><a name="functions" id="functions">Functions</a></h3><h3><a name="virConnectAuthCallbackPtr" id="virConnectAuthCallbackPtr"><code>virConnectAuthCallbackPtr</code></a></h3><pre class="programlisting">typedef int	(*virConnectAuthCallbackPtr)	(<a href="libvirt-libvirt.html#virConnectCredentialPtr">virConnectCredentialPtr</a> cred, <br />					 unsigned int ncred, <br />					 void * cbdata)
+</pre><p></p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>cred</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>ncred</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>cbdata</tt></i>:</span></td><td></td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td></td></tr></tbody></table></div><br /><h3><a name="virConnectClose" id="virConnectClose"><code>virConnectClose</code></a></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><h3><a name="virConnectFindStoragePoolSources" id="virConnectFindStoragePoolSources"><code>virConnectFindStoragePoolSources</code></a></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><h3><a name="virConnectGetCapabilities" id="virConnectGetCapabilities"><code>virConnectGetCapabilities</code></a></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><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>NULL in case of error, or an XML string defining the capabilities. The client must free the returned string after use.</td></tr></tbody></table></div><h3><a name="virConnectGetHostname" id="virConnectGetHostname"><code>virConnectGetHostname</code></a></h3><pre class="programlisting">char *	virConnectGetHostname		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>This returns the system hostname on which the hypervisor is running (the result of the gethostname(2) system call). If we are connected to a remote system, then this returns the hostname of the remote system.</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 a hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the hostname which must be freed by the caller, or NULL if there was an error.</td></tr></tbody></table></div><h3><a name="virConnectGetMaxVcpus" id="virConnectGetMaxVcpus"><code>virConnectGetMaxVcpus</code></a></h3><pre class="programlisting">int	virConnectGetMaxVcpus		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * type)<br />
+</pre><p>Provides the maximum number of virtual CPUs supported for a guest VM of a specific type. The 'type' parameter here corresponds to the 'type' attribute in the &lt;domain&gt; element of the XML.</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>type</tt></i>:</span></td><td>value of the 'type' attribute in the &lt;domain&gt; element</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the maximum of virtual CPU or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virConnectGetType" id="virConnectGetType"><code>virConnectGetType</code></a></h3><pre class="programlisting">const char *	virConnectGetType	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Get the name of the Hypervisor software used.</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>NULL in case of error, a static zero terminated string otherwise. See also: http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html</td></tr></tbody></table></div><h3><a name="virConnectGetURI" id="virConnectGetURI"><code>virConnectGetURI</code></a></h3><pre class="programlisting">char *	virConnectGetURI		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>This returns the URI (name) of the hypervisor connection. Normally this is the same as or similar to the string passed to the virConnectOpen/virConnectOpenReadOnly call, but the driver may make the URI canonical. If name == NULL was passed to virConnectOpen, then the driver will return a non-NULL URI which can be used to connect to the same hypervisor later.</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 a hypervisor connection</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the URI string which must be freed by the caller, or NULL if there was an error.</td></tr></tbody></table></div><h3><a name="virConnectGetVersion" id="virConnectGetVersion"><code>virConnectGetVersion</code></a></h3><pre class="programlisting">int	virConnectGetVersion		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 unsigned long * hvVer)<br />
+</pre><p>Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with privileged access to the hypervisor, not with a Read-Only connection.</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>hvVer</tt></i>:</span></td><td>return value for the version of the running hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 otherwise. if the version can't be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release</td></tr></tbody></table></div><h3><a name="virConnectListDefinedDomains" id="virConnectListDefinedDomains"><code>virConnectListDefinedDomains</code></a></h3><pre class="programlisting">int	virConnectListDefinedDomains	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)<br />
+</pre><p>list the defined but inactive domains, stores the pointers to the names in @names</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>names</tt></i>:</span></td><td>pointer to an array to store the names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names provided in the array or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListDefinedNetworks" id="virConnectListDefinedNetworks"><code>virConnectListDefinedNetworks</code></a></h3><pre class="programlisting">int	virConnectListDefinedNetworks	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)<br />
+</pre><p>list the inactive networks, stores the pointers to the names in @names</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>names</tt></i>:</span></td><td>pointer to an array to store the names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names provided in the array or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListDefinedStoragePools" id="virConnectListDefinedStoragePools"><code>virConnectListDefinedStoragePools</code></a></h3><pre class="programlisting">int	virConnectListDefinedStoragePools	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 char ** const names, <br />						 int maxnames)<br />
+</pre><p>Provides the list of names of inactive storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</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>names</tt></i>:</span></td><td>array of char * to fill with pool names (allocated by caller)</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on error</td></tr></tbody></table></div><h3><a name="virConnectListDomains" id="virConnectListDomains"><code>virConnectListDomains</code></a></h3><pre class="programlisting">int	virConnectListDomains		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 int * ids, <br />					 int maxids)<br />
+</pre><p>Collect the list of active domains, and store their ID in @maxids</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>ids</tt></i>:</span></td><td>array to collect the list of IDs of active domains</td></tr><tr><td><span class="term"><i><tt>maxids</tt></i>:</span></td><td>size of @ids</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListNetworks" id="virConnectListNetworks"><code>virConnectListNetworks</code></a></h3><pre class="programlisting">int	virConnectListNetworks		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)<br />
+</pre><p>Collect the list of active networks, and store their names in @names</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>names</tt></i>:</span></td><td>array to collect the list of names of active networks</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 networks found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectListStoragePools" id="virConnectListStoragePools"><code>virConnectListStoragePools</code></a></h3><pre class="programlisting">int	virConnectListStoragePools	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 char ** const names, <br />					 int maxnames)<br />
+</pre><p>Provides the list of names of active storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</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>names</tt></i>:</span></td><td>array of char * to fill with pool names (allocated by caller)</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of the names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, -1 on error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedDomains" id="virConnectNumOfDefinedDomains"><code>virConnectNumOfDefinedDomains</code></a></h3><pre class="programlisting">int	virConnectNumOfDefinedDomains	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of defined but inactive 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>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedNetworks" id="virConnectNumOfDefinedNetworks"><code>virConnectNumOfDefinedNetworks</code></a></h3><pre class="programlisting">int	virConnectNumOfDefinedNetworks	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of inactive networks.</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>the number of networks found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDefinedStoragePools" id="virConnectNumOfDefinedStoragePools"><code>virConnectNumOfDefinedStoragePools</code></a></h3><pre class="programlisting">int	virConnectNumOfDefinedStoragePools	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of inactive storage pools</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>Returns</tt></i>:</span></td><td>the number of pools found, or -1 on error</td></tr></tbody></table></div><h3><a name="virConnectNumOfDomains" id="virConnectNumOfDomains"><code>virConnectNumOfDomains</code></a></h3><pre class="programlisting">int	virConnectNumOfDomains		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of active 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>Returns</tt></i>:</span></td><td>the number of domain found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfNetworks" id="virConnectNumOfNetworks"><code>virConnectNumOfNetworks</code></a></h3><pre class="programlisting">int	virConnectNumOfNetworks		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of active networks.</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>the number of network found or -1 in case of error</td></tr></tbody></table></div><h3><a name="virConnectNumOfStoragePools" id="virConnectNumOfStoragePools"><code>virConnectNumOfStoragePools</code></a></h3><pre class="programlisting">int	virConnectNumOfStoragePools	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>Provides the number of active storage pools</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>Returns</tt></i>:</span></td><td>the number of pools found, or -1 on error</td></tr></tbody></table></div><h3><a name="virConnectOpen" id="virConnectOpen"><code>virConnectOpen</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virConnectOpen		(const char * name)<br />
+</pre><p>This function should be called first to get a connection to the Hypervisor and xen store</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virConnectOpenAuth" id="virConnectOpenAuth"><code>virConnectOpenAuth</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virConnectOpenAuth	(const char * name, <br />					 <a href="libvirt-libvirt.html#virConnectAuthPtr">virConnectAuthPtr</a> auth, <br />					 int flags)<br />
+</pre><p>This function should be called first to get a connection to the Hypervisor. If necessary, authentication will be performed fetching credentials via the callback</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>auth</tt></i>:</span></td><td>Authenticate callback parameters</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>Open flags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virConnectOpenReadOnly" id="virConnectOpenReadOnly"><code>virConnectOpenReadOnly</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virConnectOpenReadOnly	(const char * name)<br />
+</pre><p>This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>URI of the hypervisor</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a pointer to the hypervisor connection or NULL in case of error URIs are documented at http://libvirt.org/uri.html</td></tr></tbody></table></div><h3><a name="virDomainAttachDevice" id="virDomainAttachDevice"><code>virDomainAttachDevice</code></a></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><h3><a name="virDomainBlockPeek" id="virDomainBlockPeek"><code>virDomainBlockPeek</code></a></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><h3><a name="virDomainBlockStats" id="virDomainBlockStats"><code>virDomainBlockStats</code></a></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><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>stats</tt></i>:</span></td><td>block device 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><h3><a name="virDomainCoreDump" id="virDomainCoreDump"><code>virDomainCoreDump</code></a></h3><pre class="programlisting">int	virDomainCoreDump		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * to, <br />					 int flags)<br />
+</pre><p>This method will dump the core of a domain on a given file for analysis. Note that for remote Xen Daemon the file path will be interpreted in the remote host.</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>to</tt></i>:</span></td><td>path for the core file</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>extra flags, currently unused</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><h3><a name="virDomainCreate" id="virDomainCreate"><code>virDomainCreate</code></a></h3><pre class="programlisting">int	virDomainCreate			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.</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><h3><a name="virDomainCreateLinux" id="virDomainCreateLinux"><code>virDomainCreateLinux</code></a></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. 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><h3><a name="virDomainDefineXML" id="virDomainDefineXML"><code>virDomainDefineXML</code></a></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. 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><h3><a name="virDomainDestroy" id="virDomainDestroy"><code>virDomainDestroy</code></a></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. 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><h3><a name="virDomainDetachDevice" id="virDomainDetachDevice"><code>virDomainDetachDevice</code></a></h3><pre class="programlisting">int	virDomainDetachDevice		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * xml)<br />
+</pre><p>Destroy 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><h3><a name="virDomainFree" id="virDomainFree"><code>virDomainFree</code></a></h3><pre class="programlisting">int	virDomainFree			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</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><h3><a name="virDomainGetAutostart" id="virDomainGetAutostart"><code>virDomainGetAutostart</code></a></h3><pre class="programlisting">int	virDomainGetAutostart		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int * autostart)<br />
+</pre><p>Provides a boolean value indicating whether the domain configured to be automatically started when the host machine boots.</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>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetConnect" id="virDomainGetConnect"><code>virDomainGetConnect</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virDomainGetConnect	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> dom)<br />
+</pre><p>Provides the connection pointer associated with a domain. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the domain object together.</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 a domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetID" id="virDomainGetID"><code>virDomainGetID</code></a></h3><pre class="programlisting">unsigned int	virDomainGetID		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Get the hypervisor ID number for the domain</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>the domain ID number or (unsigned int) -1 in case of error</td></tr></tbody></table></div><h3><a name="virDomainGetInfo" id="virDomainGetInfo"><code>virDomainGetInfo</code></a></h3><pre class="programlisting">int	virDomainGetInfo		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 <a href="libvirt-libvirt.html#virDomainInfoPtr">virDomainInfoPtr</a> info)<br />
+</pre><p>Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</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>info</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#virDomainInfo">virDomainInfo</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><h3><a name="virDomainGetMaxMemory" id="virDomainGetMaxMemory"><code>virDomainGetMaxMemory</code></a></h3><pre class="programlisting">unsigned long	virDomainGetMaxMemory	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Retrieve the maximum amount of physical memory allocated to a domain. If domain is NULL, then this get the amount of memory reserved to Domain0 i.e. the domain where the application runs.</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 or NULL</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the memory size in kilobytes or 0 in case of error.</td></tr></tbody></table></div><h3><a name="virDomainGetMaxVcpus" id="virDomainGetMaxVcpus"><code>virDomainGetMaxVcpus</code></a></h3><pre class="programlisting">int	virDomainGetMaxVcpus		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Provides the maximum number of virtual CPUs supported for the guest VM. If the guest is inactive, this is basically the same as virConnectGetMaxVcpus. If the guest is running this will reflect the maximum number of virtual CPUs the guest was booted with.</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>Returns</tt></i>:</span></td><td>the maximum of virtual CPU or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virDomainGetName" id="virDomainGetName"><code>virDomainGetName</code></a></h3><pre class="programlisting">const char *	virDomainGetName	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Get the public name for that domain</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>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.</td></tr></tbody></table></div><h3><a name="virDomainGetOSType" id="virDomainGetOSType"><code>virDomainGetOSType</code></a></h3><pre class="programlisting">char *	virDomainGetOSType		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Get the type of domain operation system.</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>the new string or NULL in case of error, the string must be freed by the caller.</td></tr></tbody></table></div><h3><a name="virDomainGetSchedulerParameters" id="virDomainGetSchedulerParameters"><code>virDomainGetSchedulerParameters</code></a></h3><pre class="programlisting">int	virDomainGetSchedulerParameters	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br />					 int * nparams)<br />
+</pre><p>Get the scheduler parameters, the @params array will be filled with the values.</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>params</tt></i>:</span></td><td>pointer to scheduler parameter object (return value)</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>pointer to number of scheduler parameter (this value should be same than the returned value nparams of virDomainGetSchedulerType)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success.</td></tr></tbody></table></div><h3><a name="virDomainGetSchedulerType" id="virDomainGetSchedulerType"><code>virDomainGetSchedulerType</code></a></h3><pre class="programlisting">char *	virDomainGetSchedulerType	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int * nparams)<br />
+</pre><p>Get the scheduler type.</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>nparams</tt></i>:</span></td><td>number of scheduler parameters(return value)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error. The caller must free the returned string.</td></tr></tbody></table></div><h3><a name="virDomainGetUUID" id="virDomainGetUUID"><code>virDomainGetUUID</code></a></h3><pre class="programlisting">int	virDomainGetUUID		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned char * uuid)<br />
+</pre><p>Get the UUID for a domain</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>uuid</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetUUIDString" id="virDomainGetUUIDString"><code>virDomainGetUUIDString</code></a></h3><pre class="programlisting">int	virDomainGetUUIDString		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 char * buf)<br />
+</pre><p>Get the UUID for a domain as string. For more information about UUID see RFC4122.</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>buf</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainGetVcpus" id="virDomainGetVcpus"><code>virDomainGetVcpus</code></a></h3><pre class="programlisting">int	virDomainGetVcpus		(<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)<br />
+</pre><p>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer isn't NULL.</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, 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><h3><a name="virDomainGetXMLDesc" id="virDomainGetXMLDesc"><code>virDomainGetXMLDesc</code></a></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><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><h3><a name="virDomainInterfaceStats" id="virDomainInterfaceStats"><code>virDomainInterfaceStats</code></a></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 />
+</pre><p>This function returns network interface stats for interfaces attached to the domain. The path parameter is the name of the network interface. Domains may have more than network interface. 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><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><h3><a name="virDomainLookupByID" id="virDomainLookupByID"><code>virDomainLookupByID</code></a></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 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><h3><a name="virDomainLookupByName" id="virDomainLookupByName"><code>virDomainLookupByName</code></a></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 />
+</pre><p>Try to lookup a domain on the given hypervisor based on 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>name 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><h3><a name="virDomainLookupByUUID" id="virDomainLookupByUUID"><code>virDomainLookupByUUID</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a>	virDomainLookupByUUID	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const unsigned char * uuid)<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>uuid</tt></i>:</span></td><td>the raw 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><h3><a name="virDomainLookupByUUIDString" id="virDomainLookupByUUIDString"><code>virDomainLookupByUUIDString</code></a></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><h3><a name="virDomainMemoryPeek" id="virDomainMemoryPeek"><code>virDomainMemoryPeek</code></a></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><h3><a name="virDomainMigrate" id="virDomainMigrate"><code>virDomainMigrate</code></a></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><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>dconn</tt></i>:</span></td><td>destination host (a connection object)</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags</td></tr><tr><td><span class="term"><i><tt>dname</tt></i>:</span></td><td>(optional) rename domain to this at destination</td></tr><tr><td><span class="term"><i><tt>uri</tt></i>:</span></td><td>(optional) dest hostname/URI as seen from the source host</td></tr><tr><td><span class="term"><i><tt>bandwidth</tt></i>:</span></td><td>(optional) specify migration bandwidth limit in Mbps</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the new domain object if the migration was successful, or NULL in case of error. Note that the new domain object exists in the scope of the destination connection (dconn).</td></tr></tbody></table></div><h3><a name="virDomainPinVcpu" id="virDomainPinVcpu"><code>virDomainPinVcpu</code></a></h3><pre class="programlisting">int	virDomainPinVcpu		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned int vcpu, <br />					 unsigned char * cpumap, <br />					 int maplen)<br />
+</pre><p>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</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, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>vcpu</tt></i>:</span></td><td>virtual CPU number</td></tr><tr><td><span class="term"><i><tt>cpumap</tt></i>:</span></td><td>pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.</td></tr><tr><td><span class="term"><i><tt>maplen</tt></i>:</span></td><td>number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen &lt; size, missing bytes are set to zero. If maplen &gt; size, failure code is returned.</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><h3><a name="virDomainReboot" id="virDomainReboot"><code>virDomainReboot</code></a></h3><pre class="programlisting">int	virDomainReboot			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned int flags)<br />
+</pre><p>Reboot a domain, the domain object is still usable there after but the domain OS is being stopped for a restart. Note that the guest OS may ignore the request.</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>extra flags for the reboot operation, not used yet</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><h3><a name="virDomainRestore" id="virDomainRestore"><code>virDomainRestore</code></a></h3><pre class="programlisting">int	virDomainRestore		(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * from)<br />
+</pre><p>This method will restore a domain saved to disk by virDomainSave().</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>from</tt></i>:</span></td><td>path to the</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><h3><a name="virDomainResume" id="virDomainResume"><code>virDomainResume</code></a></h3><pre class="programlisting">int	virDomainResume			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires 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><h3><a name="virDomainSave" id="virDomainSave"><code>virDomainSave</code></a></h3><pre class="programlisting">int	virDomainSave			(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 const char * to)<br />
+</pre><p>This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this may be a problem). Use virDomainRestore() to restore a domain after saving.</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>to</tt></i>:</span></td><td>path for the output file</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><h3><a name="virDomainSetAutostart" id="virDomainSetAutostart"><code>virDomainSetAutostart</code></a></h3><pre class="programlisting">int	virDomainSetAutostart		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 int autostart)<br />
+</pre><p>Configure the domain to be automatically started when the host machine boots.</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>autostart</tt></i>:</span></td><td>whether the domain should be automatically started 0 or 1</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virDomainSetMaxMemory" id="virDomainSetMaxMemory"><code>virDomainSetMaxMemory</code></a></h3><pre class="programlisting">int	virDomainSetMaxMemory		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned long memory)<br />
+</pre><p>Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function requires privileged access to the hypervisor.</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 or NULL</td></tr><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>the memory size in kilobytes</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><h3><a name="virDomainSetMemory" id="virDomainSetMemory"><code>virDomainSetMemory</code></a></h3><pre class="programlisting">int	virDomainSetMemory		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned long memory)<br />
+</pre><p>Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. 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>domain</tt></i>:</span></td><td>a domain object or NULL</td></tr><tr><td><span class="term"><i><tt>memory</tt></i>:</span></td><td>the memory size in kilobytes</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><h3><a name="virDomainSetSchedulerParameters" id="virDomainSetSchedulerParameters"><code>virDomainSetSchedulerParameters</code></a></h3><pre class="programlisting">int	virDomainSetSchedulerParameters	(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 <a href="libvirt-libvirt.html#virSchedParameterPtr">virSchedParameterPtr</a> params, <br />					 int nparams)<br />
+</pre><p>Change the scheduler parameters</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>params</tt></i>:</span></td><td>pointer to scheduler parameter objects</td></tr><tr><td><span class="term"><i><tt>nparams</tt></i>:</span></td><td>number of scheduler parameter (this value should be same or less than the returned value nparams of virDomainGetSchedulerType)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success.</td></tr></tbody></table></div><h3><a name="virDomainSetVcpus" id="virDomainSetVcpus"><code>virDomainSetVcpus</code></a></h3><pre class="programlisting">int	virDomainSetVcpus		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br />					 unsigned int nvcpus)<br />
+</pre><p>Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires privileged access to the hypervisor.</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, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>nvcpus</tt></i>:</span></td><td>the new number of virtual CPUs for this 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 failure.</td></tr></tbody></table></div><h3><a name="virDomainShutdown" id="virDomainShutdown"><code>virDomainShutdown</code></a></h3><pre class="programlisting">int	virDomainShutdown		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request. TODO: should we add an option for reboot, knowing it may not be doable in the general case ?</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><h3><a name="virDomainSuspend" id="virDomainSuspend"><code>virDomainSuspend</code></a></h3><pre class="programlisting">int	virDomainSuspend		(<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
+</pre><p>Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires 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><h3><a name="virDomainUndefine" id="virDomainUndefine"><code>virDomainUndefine</code></a></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><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><h3><a name="virGetVersion" id="virGetVersion"><code>virGetVersion</code></a></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><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>libVer</tt></i>:</span></td><td>return value for the library version (OUT)</td></tr><tr><td><span class="term"><i><tt>type</tt></i>:</span></td><td>the type of connection/driver looked at</td></tr><tr><td><span class="term"><i><tt>typeVer</tt></i>:</span></td><td>return value for the version of the hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.</td></tr></tbody></table></div><h3><a name="virInitialize" id="virInitialize"><code>virInitialize</code></a></h3><pre class="programlisting">int	virInitialize			(void)<br />
+</pre><p>Initialize the library. It's better to call this routine at startup in multithreaded applications to avoid potential race when initializing the library.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><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="virNetworkCreate" id="virNetworkCreate"><code>virNetworkCreate</code></a></h3><pre class="programlisting">int	virNetworkCreate		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.</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><h3><a name="virNetworkCreateXML" id="virNetworkCreateXML"><code>virNetworkCreateXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	virNetworkCreateXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * xmlDesc)<br />
+</pre><p>Create and start a new virtual network, based on an XML description similar to the one returned by virNetworkGetXMLDesc()</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>an XML description of the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure</td></tr></tbody></table></div><h3><a name="virNetworkDefineXML" id="virNetworkDefineXML"><code>virNetworkDefineXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	virNetworkDefineXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * xml)<br />
+</pre><p>Define a network, but does not create it</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 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><h3><a name="virNetworkDestroy" id="virNetworkDestroy"><code>virNetworkDestroy</code></a></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. 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><h3><a name="virNetworkFree" id="virNetworkFree"><code>virNetworkFree</code></a></h3><pre class="programlisting">int	virNetworkFree			(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Free the network object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</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><h3><a name="virNetworkGetAutostart" id="virNetworkGetAutostart"><code>virNetworkGetAutostart</code></a></h3><pre class="programlisting">int	virNetworkGetAutostart		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int * autostart)<br />
+</pre><p>Provides a boolean value indicating whether the network configured to be automatically started when the host machine boots.</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>autostart</tt></i>:</span></td><td>the value returned</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetBridgeName" id="virNetworkGetBridgeName"><code>virNetworkGetBridgeName</code></a></h3><pre class="programlisting">char *	virNetworkGetBridgeName		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Provides a bridge interface name to which a domain may connect a network interface in order to join the network.</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>a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.</td></tr></tbody></table></div><h3><a name="virNetworkGetConnect" id="virNetworkGetConnect"><code>virNetworkGetConnect</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virNetworkGetConnect	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> net)<br />
+</pre><p>Provides the connection pointer associated with a network. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the network object together.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>net</tt></i>:</span></td><td>pointer to a network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virNetworkGetName" id="virNetworkGetName"><code>virNetworkGetName</code></a></h3><pre class="programlisting">const char *	virNetworkGetName	(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
+</pre><p>Get the public name for that network</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>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the network object.</td></tr></tbody></table></div><h3><a name="virNetworkGetUUID" id="virNetworkGetUUID"><code>virNetworkGetUUID</code></a></h3><pre class="programlisting">int	virNetworkGetUUID		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 unsigned char * uuid)<br />
+</pre><p>Get the UUID for a network</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>uuid</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetUUIDString" id="virNetworkGetUUIDString"><code>virNetworkGetUUIDString</code></a></h3><pre class="programlisting">int	virNetworkGetUUIDString		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 char * buf)<br />
+</pre><p>Get the UUID for a network as string. For more information about UUID see RFC4122.</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>buf</tt></i>:</span></td><td>pointer to a <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkGetXMLDesc" id="virNetworkGetXMLDesc"><code>virNetworkGetXMLDesc</code></a></h3><pre class="programlisting">char *	virNetworkGetXMLDesc		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int flags)<br />
+</pre><p>Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().</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>flags</tt></i>:</span></td><td>and OR'ed set of extraction flags, not used yet</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><h3><a name="virNetworkLookupByName" id="virNetworkLookupByName"><code>virNetworkLookupByName</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	virNetworkLookupByName	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const char * name)<br />
+</pre><p>Try to lookup a network on the given hypervisor based on 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>name for the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkLookupByUUID" id="virNetworkLookupByUUID"><code>virNetworkLookupByUUID</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	virNetworkLookupByUUID	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />					 const unsigned char * uuid)<br />
+</pre><p>Try to lookup a network 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>uuid</tt></i>:</span></td><td>the raw UUID for the network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkLookupByUUIDString" id="virNetworkLookupByUUIDString"><code>virNetworkLookupByUUIDString</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a>	virNetworkLookupByUUIDString	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 const char * uuidstr)<br />
+</pre><p>Try to lookup a network 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 network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</td></tr></tbody></table></div><h3><a name="virNetworkSetAutostart" id="virNetworkSetAutostart"><code>virNetworkSetAutostart</code></a></h3><pre class="programlisting">int	virNetworkSetAutostart		(<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network, <br />					 int autostart)<br />
+</pre><p>Configure the network to be automatically started when the host machine boots.</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>autostart</tt></i>:</span></td><td>whether the network should be automatically started 0 or 1</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of error, 0 in case of success</td></tr></tbody></table></div><h3><a name="virNetworkUndefine" id="virNetworkUndefine"><code>virNetworkUndefine</code></a></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><h3><a name="virNodeGetCellsFreeMemory" id="virNodeGetCellsFreeMemory"><code>virNodeGetCellsFreeMemory</code></a></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><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>freeMems</tt></i>:</span></td><td>pointer to the array of unsigned long long</td></tr><tr><td><span class="term"><i><tt>startCell</tt></i>:</span></td><td>index of first cell to return freeMems info on.</td></tr><tr><td><span class="term"><i><tt>maxCells</tt></i>:</span></td><td>Maximum number of cells for which freeMems information can be returned.</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of entries filled in freeMems, or -1 in case of error.</td></tr></tbody></table></div><h3><a name="virNodeGetFreeMemory" id="virNodeGetFreeMemory"><code>virNodeGetFreeMemory</code></a></h3><pre class="programlisting">unsigned long long	virNodeGetFreeMemory	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn)<br />
+</pre><p>provides the free memory available on 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>Returns</tt></i>:</span></td><td>the available free memory in kilobytes or 0 in case of error</td></tr></tbody></table></div><h3><a name="virNodeGetInfo" id="virNodeGetInfo"><code>virNodeGetInfo</code></a></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><h3><a name="virStoragePoolBuild" id="virStoragePoolBuild"><code>virStoragePoolBuild</code></a></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><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 upon failure</td></tr></tbody></table></div><h3><a name="virStoragePoolCreate" id="virStoragePoolCreate"><code>virStoragePoolCreate</code></a></h3><pre class="programlisting">int	virStoragePoolCreate		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)<br />
+</pre><p>Starts an inactive storage pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be started</td></tr></tbody></table></div><h3><a name="virStoragePoolCreateXML" id="virStoragePoolCreateXML"><code>virStoragePoolCreateXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolCreateXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 const char * xmlDesc, <br />						 unsigned int flags)<br />
+</pre><p>Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted</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>xmlDesc</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStoragePoolDefineXML" id="virStoragePoolDefineXML"><code>virStoragePoolDefineXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolDefineXML	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />						 const char * xml, <br />						 unsigned int flags)<br />
+</pre><p>Define a new inactive storage pool based on its XML description. The pool is persistent, until explicitly undefined.</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>xml</tt></i>:</span></td><td>XML description for new pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStoragePoolDelete" id="virStoragePoolDelete"><code>virStoragePoolDelete</code></a></h3><pre class="programlisting">int	virStoragePoolDelete		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)<br />
+</pre><p>Delete the underlying pool resources. This is a non-recoverable operation. The <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object itself is not free'd.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for obliteration process</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be obliterate</td></tr></tbody></table></div><h3><a name="virStoragePoolDestroy" id="virStoragePoolDestroy"><code>virStoragePoolDestroy</code></a></h3><pre class="programlisting">int	virStoragePoolDestroy		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Destroy an active storage pool. This will deactivate the pool on the host, but keep any persistent config associated with it. If it has a persistent config it can later be restarted with virStoragePoolCreate(). This does not free the associated <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be destroyed</td></tr></tbody></table></div><h3><a name="virStoragePoolFree" id="virStoragePoolFree"><code>virStoragePoolFree</code></a></h3><pre class="programlisting">int	virStoragePoolFree		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Free a storage pool object, releasing all memory associated with it. Does not change the state of the pool on the host.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 if it could not be free'd.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetAutostart" id="virStoragePoolGetAutostart"><code>virStoragePoolGetAutostart</code></a></h3><pre class="programlisting">int	virStoragePoolGetAutostart	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 int * autostart)<br />
+</pre><p>Fetches the value of the autostart flag, which determines whether the pool is automatically started at boot time</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>location in which to store autostart flag</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><h3><a name="virStoragePoolGetConnect" id="virStoragePoolGetConnect"><code>virStoragePoolGetConnect</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virStoragePoolGetConnect	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Provides the connection pointer associated with a storage pool. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the pool object together.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to a pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetInfo" id="virStoragePoolGetInfo"><code>virStoragePoolGetInfo</code></a></h3><pre class="programlisting">int	virStoragePoolGetInfo		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 <a href="libvirt-libvirt.html#virStoragePoolInfoPtr">virStoragePoolInfoPtr</a> info)<br />
+</pre><p>Get volatile information about the storage pool such as free space / usage summary</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer at which to store info</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on failure.</td></tr></tbody></table></div><h3><a name="virStoragePoolGetName" id="virStoragePoolGetName"><code>virStoragePoolGetName</code></a></h3><pre class="programlisting">const char *	virStoragePoolGetName	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Fetch the locally unique name of the storage pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the name of the pool, or NULL on error</td></tr></tbody></table></div><h3><a name="virStoragePoolGetUUID" id="virStoragePoolGetUUID"><code>virStoragePoolGetUUID</code></a></h3><pre class="programlisting">int	virStoragePoolGetUUID		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned char * uuid)<br />
+</pre><p>Fetch the globally unique ID of the storage pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>uuid</tt></i>:</span></td><td>buffer of <a href="libvirt-libvirt.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes in size</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error;</td></tr></tbody></table></div><h3><a name="virStoragePoolGetUUIDString" id="virStoragePoolGetUUIDString"><code>virStoragePoolGetUUIDString</code></a></h3><pre class="programlisting">int	virStoragePoolGetUUIDString	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 char * buf)<br />
+</pre><p>Fetch the globally unique ID of the storage pool as a string</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>buf</tt></i>:</span></td><td>buffer of <a href="libvirt-libvirt.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes in size</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error;</td></tr></tbody></table></div><h3><a name="virStoragePoolGetXMLDesc" id="virStoragePoolGetXMLDesc"><code>virStoragePoolGetXMLDesc</code></a></h3><pre class="programlisting">char *	virStoragePoolGetXMLDesc	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)<br />
+</pre><p>Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the <a href="libvirt-libvirt.html#virStoragePoolCreateXML">virStoragePoolCreateXML</a> method.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for XML format options (set of virDomainXMLFlags)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a XML document, or NULL on error</td></tr></tbody></table></div><h3><a name="virStoragePoolListVolumes" id="virStoragePoolListVolumes"><code>virStoragePoolListVolumes</code></a></h3><pre class="programlisting">int	virStoragePoolListVolumes	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 char ** const names, <br />					 int maxnames)<br />
+</pre><p>Fetch list of storage volume names, limiting to at most maxnames.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>names</tt></i>:</span></td><td>array in which to storage volume names</td></tr><tr><td><span class="term"><i><tt>maxnames</tt></i>:</span></td><td>size of names array</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of names fetched, or -1 on error</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByName" id="virStoragePoolLookupByName"><code>virStoragePoolLookupByName</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolLookupByName	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const char * name)<br />
+</pre><p>Fetch a storage pool based on its unique 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 hypervisor connection</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByUUID" id="virStoragePoolLookupByUUID"><code>virStoragePoolLookupByUUID</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolLookupByUUID	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const unsigned char * uuid)<br />
+</pre><p>Fetch a storage pool based on its globally unique id</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>uuid</tt></i>:</span></td><td>globally unique id of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByUUIDString" id="virStoragePoolLookupByUUIDString"><code>virStoragePoolLookupByUUIDString</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolLookupByUUIDString	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const char * uuidstr)<br />
+</pre><p>Fetch a storage pool based on its globally unique id</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>uuidstr</tt></i>:</span></td><td>globally unique id of pool to fetch</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolLookupByVolume" id="virStoragePoolLookupByVolume"><code>virStoragePoolLookupByVolume</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a>	virStoragePoolLookupByVolume	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Fetch a storage pool which contains a particular volume</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if no matching pool is found</td></tr></tbody></table></div><h3><a name="virStoragePoolNumOfVolumes" id="virStoragePoolNumOfVolumes"><code>virStoragePoolNumOfVolumes</code></a></h3><pre class="programlisting">int	virStoragePoolNumOfVolumes	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Fetch the number of storage volumes within a pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the number of storage pools, or -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolRefresh" id="virStoragePoolRefresh"><code>virStoragePoolRefresh</code></a></h3><pre class="programlisting">int	virStoragePoolRefresh		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 unsigned int flags)<br />
+</pre><p>Request that the pool refresh its list of volumes. This may involve communicating with a remote server, and/or initializing new devices at the OS layer</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags to control refresh behaviour (currently unused, use 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if the volume list was refreshed, -1 on failure</td></tr></tbody></table></div><h3><a name="virStoragePoolSetAutostart" id="virStoragePoolSetAutostart"><code>virStoragePoolSetAutostart</code></a></h3><pre class="programlisting">int	virStoragePoolSetAutostart	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />					 int autostart)<br />
+</pre><p>Sets the autostart flag</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>autostart</tt></i>:</span></td><td>new flag setting</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><h3><a name="virStoragePoolUndefine" id="virStoragePoolUndefine"><code>virStoragePoolUndefine</code></a></h3><pre class="programlisting">int	virStoragePoolUndefine		(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool)<br />
+</pre><p>Undefine an inactive storage pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a <a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> object, or NULL if creation failed</td></tr></tbody></table></div><h3><a name="virStorageVolCreateXML" id="virStorageVolCreateXML"><code>virStorageVolCreateXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	virStorageVolCreateXML	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />						 const char * xmldesc, <br />						 unsigned int flags)<br />
+</pre><p>Create a storage volume within a pool based on an XML description. Not all pools support creation of volumes</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>xmldesc</tt></i>:</span></td><td>description of volume to create</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>flags for creation (unused, pass 0)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the storage volume, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolDelete" id="virStorageVolDelete"><code>virStorageVolDelete</code></a></h3><pre class="programlisting">int	virStorageVolDelete		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br />					 unsigned int flags)<br />
+</pre><p>Delete the storage volume from the pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>future flags, use 0 for now</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><a name="virStorageVolFree" id="virStorageVolFree"><code>virStorageVolFree</code></a></h3><pre class="programlisting">int	virStorageVolFree		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Release the storage volume handle. The underlying storage volume contains to exist</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetConnect" id="virStorageVolGetConnect"><code>virStorageVolGetConnect</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a>	virStorageVolGetConnect	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Provides the connection pointer associated with a storage volume. The reference counter on the connection is not increased by this call. WARNING: When writing libvirt bindings in other languages, do not use this function. Instead, store the connection and the volume object together.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to a pool</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the <a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</td></tr></tbody></table></div><h3><a name="virStorageVolGetInfo" id="virStorageVolGetInfo"><code>virStorageVolGetInfo</code></a></h3><pre class="programlisting">int	virStorageVolGetInfo		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br />					 <a href="libvirt-libvirt.html#virStorageVolInfoPtr">virStorageVolInfoPtr</a> info)<br />
+</pre><p>Fetches volatile information about the storage volume such as its current allocation</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>info</tt></i>:</span></td><td>pointer at which to store info</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 on success, or -1 on failure</td></tr></tbody></table></div><h3><a name="virStorageVolGetKey" id="virStorageVolGetKey"><code>virStorageVolGetKey</code></a></h3><pre class="programlisting">const char *	virStorageVolGetKey	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Fetch the storage volume key. This is globally unique, so the same volume will have the same key no matter what host it is accessed from</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the volume key, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetName" id="virStorageVolGetName"><code>virStorageVolGetName</code></a></h3><pre class="programlisting">const char *	virStorageVolGetName	(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Fetch the storage volume name. This is unique within the scope of a pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the volume name, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetPath" id="virStorageVolGetPath"><code>virStorageVolGetPath</code></a></h3><pre class="programlisting">char *	virStorageVolGetPath		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol)<br />
+</pre><p>Fetch the storage volume path. Depending on the pool configuration this is either persistent across hosts, or dynamically assigned at pool startup. Consult pool documentation for information on getting the persistent naming</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the storage volume path, or NULL on error</td></tr></tbody></table></div><h3><a name="virStorageVolGetXMLDesc" id="virStorageVolGetXMLDesc"><code>virStorageVolGetXMLDesc</code></a></h3><pre class="programlisting">char *	virStorageVolGetXMLDesc		(<a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a> vol, <br />					 unsigned int flags)<br />
+</pre><p>Fetch an XML document describing all aspects of the storage volume</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>vol</tt></i>:</span></td><td>pointer to storage volume</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><h3><a name="virStorageVolLookupByKey" id="virStorageVolLookupByKey"><code>virStorageVolLookupByKey</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	virStorageVolLookupByKey	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const char * key)<br />
+</pre><p>Fetch a pointer to a storage volume based on its globally unique key</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>key</tt></i>:</span></td><td>globally unique key</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div><h3><a name="virStorageVolLookupByName" id="virStorageVolLookupByName"><code>virStorageVolLookupByName</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	virStorageVolLookupByName	(<a href="libvirt-libvirt.html#virStoragePoolPtr">virStoragePoolPtr</a> pool, <br />							 const char * name)<br />
+</pre><p>Fetch a pointer to a storage volume based on its name within a pool</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>pool</tt></i>:</span></td><td>pointer to storage pool</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>name of storage volume</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div><h3><a name="virStorageVolLookupByPath" id="virStorageVolLookupByPath"><code>virStorageVolLookupByPath</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virStorageVolPtr">virStorageVolPtr</a>	virStorageVolLookupByPath	(<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br />							 const char * path)<br />
+</pre><p>Fetch a pointer to a storage volume based on its locally (host) unique path</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>path</tt></i>:</span></td><td>locally unique path</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a storage volume, or NULL if not found / error</td></tr></tbody></table></div></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/hvsupport.html.in

@@ -0,0 +1,618 @@
+<?xml version="1.0"?>
+<html>
+  <body>
+    <h1>Driver support matrix</h1>
+    <p>
+This page documents which <a href="html/">libvirt calls</a> work on
+which libvirt drivers / hypervisors, and which version the API appeared
+in.
+</p>
+    <p>
+This information changes frequently.  This page was last checked or
+updated on <i>2008-06-05</i>.
+</p>
+    <h3>Domain functions</h3>
+    <p> x = not supported; empty cell means no information </p>
+    <table class="top_table">
+      <tr>
+        <th> Function </th>
+        <th> Since </th>
+        <th><a href="drvxen.html">Xen</a></th>
+        <th><a href="drvqemu.html">QEMU</a></th>
+        <th><a href="drvkvm.html">KVM</a></th>
+        <th><a href="remote.html">Remote</a></th>
+      </tr>
+      <tr>
+        <td> virConnectClose </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectGetCapabilities </td>
+        <td> 0.2.1 </td>
+        <td> &#x2265; 0.2.1 </td>
+        <td> &#x2265; 0.2.1 </td>
+        <td> &#x2265; 0.2.1 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectGetHostname </td>
+        <td> 0.3.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+        <td> &#x2265; 0.3.3 </td>
+        <td> &#x2265; 0.3.3 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectGetMaxVcpus </td>
+        <td> 0.2.1 </td>
+        <td> &#x2265; 0.2.1 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectGetType </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectGetURI </td>
+        <td> 0.3.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectGetVersion </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectListDefinedDomains </td>
+        <td> 0.1.5 </td>
+        <td> &#x2265; 0.1.9 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectListDomains </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectNumOfDefinedDomains </td>
+        <td> 0.1.5 </td>
+        <td> &#x2265; 0.1.9 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectNumOfDomains </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectOpen </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectOpenAuth </td>
+        <td>  </td>
+        <td>  </td>
+        <td>  </td>
+        <td>  </td>
+        <td>  </td>
+      </tr>
+      <tr>
+        <td> virConnectOpenReadOnly </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainAttachDevice </td>
+        <td> 0.1.9 </td>
+        <td> &#x2265; 0.1.9 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainBlockPeek </td>
+        <td> 0.4.3 </td>
+        <td> 0.4.3 </td>
+        <td> 0.4.3 </td>
+        <td> 0.4.3 </td>
+        <td> x </td>
+      </tr>
+      <tr>
+        <td> virDomainBlockStats </td>
+        <td> 0.3.2 </td>
+        <td> &#x2265; 0.3.2 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.2 </td>
+      </tr>
+      <tr>
+        <td> virDomainCoreDump </td>
+        <td> 0.1.9 </td>
+        <td> &#x2265; 0.1.9 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainCreate </td>
+        <td> 0.1.5 </td>
+        <td> &#x2265; 0.1.9 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainCreateLinux </td>
+        <td> All </td>
+        <td> &#x2265; 0.0.5 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainDefineXML </td>
+        <td> 0.1.5 </td>
+        <td> &#x2265; 0.1.9 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainDestroy </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainDetachDevice </td>
+        <td> 0.1.9 </td>
+        <td> &#x2265; 0.1.9 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainFree </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetAutostart </td>
+        <td> 0.2.1 </td>
+        <td> x </td>
+        <td> &#x2265; 0.2.1 </td>
+        <td> &#x2265; 0.2.1 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetConnect </td>
+        <td> 0.3.0 </td>
+        <td colspan="4"> not a HV function </td>
+      </tr>
+      <tr>
+        <td> virDomainGetID </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetInfo </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetMaxMemory </td>
+        <td> All </td>
+        <td> All </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetMaxVcpus </td>
+        <td> 0.2.1 </td>
+        <td> &#x2265; 0.2.1 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetName </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetOSType </td>
+        <td> All </td>
+        <td> All </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetSchedulerParameters </td>
+        <td> 0.2.3 </td>
+        <td> &#x2265; 0.2.3 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetSchedulerType </td>
+        <td> 0.2.3 </td>
+        <td> &#x2265; 0.2.3 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetUUID </td>
+        <td> 0.1.10 </td>
+        <td> &#x2265; 0.1.10 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetUUIDString </td>
+        <td> 0.1.10 </td>
+        <td> &#x2265; 0.1.10 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetVcpus </td>
+        <td> 0.1.4 </td>
+        <td> &#x2265; 0.1.4 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainInterfaceStats </td>
+        <td> 0.3.2 </td>
+        <td> &#x2265; 0.3.2 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.2 </td>
+      </tr>
+      <tr>
+        <td> virDomainGetXMLDesc </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainLookupByID </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainLookupByName </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainLookupByUUID </td>
+        <td> 0.1.10 </td>
+        <td> &#x2265; 0.1.10 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainLookupByUUIDString </td>
+        <td> 0.1.10 </td>
+        <td> &#x2265; 0.1.10 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainMigrate </td>
+        <td> 0.3.2 </td>
+        <td> &#x2265; 0.3.2 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> 0.3.2 </td>
+      </tr>
+      <tr>
+        <td> virDomainPinVcpu </td>
+        <td> 0.1.4 </td>
+        <td> &#x2265; 0.1.4 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainReboot </td>
+        <td> 0.1.0 </td>
+        <td> &#x2265; 0.1.0 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainRestore </td>
+        <td> All </td>
+        <td> All </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.2 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainResume </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainSave </td>
+        <td> All </td>
+        <td> All </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.2 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainSetAutostart </td>
+        <td> 0.2.1 </td>
+        <td> x </td>
+        <td> &#x2265; 0.2.1 </td>
+        <td> &#x2265; 0.2.1 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainSetMaxMemory </td>
+        <td> All </td>
+        <td> All </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainSetMemory </td>
+        <td> 0.1.1 </td>
+        <td> &#x2265; 0.1.1 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainSetSchedulerParameters </td>
+        <td> 0.2.3 </td>
+        <td> &#x2265; 0.2.3 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainSetVcpus </td>
+        <td> 0.1.4 </td>
+        <td> &#x2265; 0.1.4 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainShutdown </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainSuspend </td>
+        <td> All </td>
+        <td> All </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virDomainUndefine </td>
+        <td> 0.1.5 </td>
+        <td> &#x2265; 0.1.9 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virGetVersion </td>
+        <td> All </td>
+        <td> All </td>
+        <td colspan="3"> Returns -1 if HV unsupported. </td>
+      </tr>
+      <tr>
+        <td> virInitialize </td>
+        <td> 0.1.0 </td>
+        <td colspan="4"> not a HV function </td>
+      </tr>
+      <tr>
+        <td> virDomainMemoryPeek </td>
+        <td> 0.4.3 </td>
+        <td> x </td>
+        <td> 0.4.3 </td>
+        <td> 0.4.3 </td>
+        <td> x </td>
+      </tr>
+      <tr>
+        <td> virNodeGetInfo </td>
+        <td> 0.1.0 </td>
+        <td> &#x2265; 0.1.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.2.0 </td>
+        <td> &#x2265; 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virNodeGetFreeMemory </td>
+        <td> 0.3.3 </td>
+        <td> &#x2265; 0.3.3 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> x </td>
+      </tr>
+      <tr>
+        <td> virNodeGetCellsFreeMemory </td>
+        <td> 0.3.3 </td>
+        <td> &#x2265; 0.3.3 </td>
+        <td> x </td>
+        <td> x </td>
+        <td> x </td>
+      </tr>
+    </table>
+    <h3>Network functions</h3>
+    <p>
+Network functions are not hypervisor-specific.They require the libvirtd
+daemon to be running. Most network functions first appeared in libvirt 0.2.0.
+</p>
+    <table class="top_table">
+      <tr>
+        <th> Function </th>
+        <th> Since </th>
+      </tr>
+      <tr>
+        <td> virConnectNumOfNetworks </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectListNetworks </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectNumOfDefinedNetworks </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virConnectListDefinedNetworks </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkCreate </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkCreateXML </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkDefineXML </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkDestroy </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkFree </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkGetAutostart </td>
+        <td> 0.2.1 </td>
+      </tr>
+      <tr>
+        <td> virNetworkGetConnect </td>
+        <td> 0.3.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkGetBridgeName </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkGetName </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkGetUUID </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkGetUUIDString </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkGetXMLDesc </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkLookupByName </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkLookupByUUID </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkLookupByUUIDString </td>
+        <td> 0.2.0 </td>
+      </tr>
+      <tr>
+        <td> virNetworkSetAutostart </td>
+        <td> 0.2.1 </td>
+      </tr>
+      <tr>
+        <td> virNetworkUndefine </td>
+        <td> 0.2.0 </td>
+      </tr>
+    </table>
+  </body>
+</html>

docs/index.html

@@ -1,143 +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">
+<!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 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="libvirt.css" />
-    <link rel="SHORTCUT ICON" href="/32favicon.png" />
-    <title>the virtualization API</title>
+    <link rel="stylesheet" type="text/css" href="main.css" />
+    <link rel="SHORTCUT ICON" href="32favicon.png" />
+    <title>libvirt: The virtualization API</title>
+    <meta name="description" content="libvirt, virtualization, virtualization API" />
   </head>
   <body>
-    <div id="container">
-      <div id="intro">
-        <div id="adjustments">
-          <p class="p1"></p>
-        </div>
-        <div id="content">
-          <h3>what is <span class="style1">libvirt?</span></h3>
-          <p>Libvirt is a C toolkit to interact with the virtualization capabilities
-of recent versions of Linux (and other OSes). It is free software available
-under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
-Lesser General Public License</a>. Virtualization of the Linux Operating
-System means the ability to run multiple instances of Operating Systems
-concurently on a single hardware system where the basic resources are driven
-by a Linux (or Solaris) instance. The library aims at providing a long term
-stable C API initially for <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen
-paravirtualization</a> but it can also integrate with other
-virtualization mechanisms. It currently also supports <a href="http://fabrice.bellard.free.fr/qemu/">QEMU</a>, <a href="http://kvm.qumranet.com/">KVM</a> and
-<a href="http://openvz.org/">OpenVZ</a>.</p>
-        </div>
+    <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 class="linkList">
-        <div class="llinks">
-          <h3 class="links">
-            <span>main menu</span>
-          </h3>
-          <ul>
-            <li>Home</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="llinks">
-          <h3 class="links">
-            <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://libvirt.org/CIM/">CIM provider</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="body">
+      <div id="menu">
+        <ul class="l0"><li>
+            <div>
+              <span class="active">Home</span>
+            </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="bottom">
-        <p class="p1"></p>
+      <div id="content">
+        <h1>The virtualization API</h1>
+        <h2>libvirt is:</h2>
+        <ul><li>
+	A toolkit to interact with the virtualization capabilities
+	of recent versions of Linux (and other OSes).
+      </li><li>
+	Free software available under the
+	<a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
+	  Lesser General Public License</a>.
+      </li><li>
+	A long term stable C API
+      </li><li>
+	A set of bindings for common languages
+      </li><li>
+	A <a href="CIM/">CIM provider</a> for the DMTF virtualization schema
+      </li></ul>
+        <h2>libvirt supports:</h2>
+        <ul><li>
+	The <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen</a> hypervisor
+	on Linux and Solaris hosts.
+      </li><li>
+	The <a href="http://fabrice.bellard.free.fr/qemu/">QEMU</a> emulator
+      </li><li>
+	The <a href="http://kvm.qumranet.com/kvmwiki">KVM</a> Linux hypervisor
+      </li><li>
+	The <a href="http://lxc.sourceforge.net/">LXC</a> Linux container system
+      </li><li>
+	The <a href="http://openvz.org/">OpenVZ</a> Linux container system
+      </li><li>
+	Storage on IDE/SCSI/USB disks, FibreChannel, LVM, iSCSI, NFS and filesystems
+      </li></ul>
+        <h2>libvirt provides:</h2>
+        <ul><li>Remote management using TLS encryption and x509 certificates</li><li>Remote management authenticating with Kerberos and SASL</li><li>Local access control using PolicyKit</li><li>Zero-conf discovery using Avahi multicast-DNS</li><li>Management of virtual machines, virtual networks and storage</li></ul>
+        <p class="image">
+      <img src="libvirtLogo.png" alt="libvirt Logo" /></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/index.html.in

@@ -0,0 +1,68 @@
+<?xml version="1.0"?>
+<html>
+  <body>
+    <h1>The virtualization API</h1>
+
+    <h2>libvirt is:</h2>
+
+    <ul>
+      <li>
+	A toolkit to interact with the virtualization capabilities
+	of recent versions of Linux (and other OSes).
+      </li>
+      <li>
+	Free software available under the
+	<a href="http://www.opensource.org/licenses/lgpl-license.html">GNU
+	  Lesser General Public License</a>.
+      </li>
+
+      <li>
+	A long term stable C API
+      </li>
+      <li>
+	A set of bindings for common languages
+      </li>
+      <li>
+	A <a href="CIM/">CIM provider</a> for the DMTF virtualization schema
+      </li>
+    </ul>
+
+    <h2>libvirt supports:</h2>
+
+    <ul>
+      <li>
+	The <a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen</a> hypervisor
+	on Linux and Solaris hosts.
+      </li>
+      <li>
+	The <a href="http://fabrice.bellard.free.fr/qemu/">QEMU</a> emulator
+      </li>
+      <li>
+	The <a href="http://kvm.qumranet.com/kvmwiki">KVM</a> Linux hypervisor
+      </li>
+      <li>
+	The <a href="http://lxc.sourceforge.net/">LXC</a> Linux container system
+      </li>
+      <li>
+	The <a href="http://openvz.org/">OpenVZ</a> Linux container system
+      </li>
+      <li>
+	Storage on IDE/SCSI/USB disks, FibreChannel, LVM, iSCSI, NFS and filesystems
+      </li>
+    </ul>
+
+    <h2>libvirt provides:</h2>
+
+    <ul>
+      <li>Remote management using TLS encryption and x509 certificates</li>
+      <li>Remote management authenticating with Kerberos and SASL</li>
+      <li>Local access control using PolicyKit</li>
+      <li>Zero-conf discovery using Avahi multicast-DNS</li>
+      <li>Management of virtual machines, virtual networks and storage</li>
+    </ul>
+
+    <p class="image">
+      <img src="libvirtLogo.png" alt="libvirt Logo"/>
+    </p>
+  </body>
+</html>

docs/index.py

@@ -15,7 +15,7 @@
 #    mysqladmin -u root password new_password
 # Create the new database libvir
 #    mysqladmin -p create libvir
-# Create a database user 'veillard' and give him passord access
+# Create a database user 'veillard' and give him password access
 # change veillard and abcde with the right user name and passwd
 #    mysql -p
 #    password:
@@ -34,7 +34,7 @@
 #    Bye
 #
 # Then run the script in the doc subdir, it will create the symbols and
-# word tables and populate them with informations extracted from
+# word tables and populate them with information extracted from
 # the libvirt-api.xml API description, and make then accessible read-only
 # by nobody@loaclhost the user expected to be Apache's one
 #
@@ -55,7 +55,7 @@ def callback(ctx, str):
 libxml2.registerErrorHandler(callback, None)
 
 #
-# The dictionnary of tables required and the SQL command needed
+# The dictionary of tables required and the SQL command needed
 # to create them
 #
 TABLES={
@@ -449,7 +449,7 @@ def updateWordArchive(name, id, relevance):
 
 #########################################################################
 #									#
-#                  Word dictionnary and analysis routines		#
+#                  Word dictionary and analysis routines		#
 #									#
 #########################################################################
 
@@ -1027,7 +1027,9 @@ def analyzeHTML(doc, resource):
 
 def analyzeHTMLPages():
     ret = 0
-    HTMLfiles = glob.glob("*.html") + glob.glob("tutorial/*.html")
+    HTMLfiles = glob.glob("*.html") + glob.glob("tutorial/*.html") + \
+                glob.glob("CIM/*.html") + glob.glob("ocaml/*.html") + \
+		glob.glob("ruby/*.html")
     for html in HTMLfiles:
 	if html[0:3] == "API":
 	    continue