diff --git a/docs/FAQ.html b/docs/FAQ.html index 4e027e5f6a..a7a20c5726 100644 --- a/docs/FAQ.html +++ b/docs/FAQ.html @@ -7,4 +7,59 @@ H1 {font-family: Verdana,Arial,Helvetica} H2 {font-family: Verdana,Arial,Helvetica} H3 {font-family: Verdana,Arial,Helvetica} A:link, A:visited, A:active { text-decoration: underline } -FAQ
Red Hat Logo

Libvir the Linux virtualization API

FAQ

Main Menu
Related links
Made with Libxml2 Logo

Daniel Veillard

+FAQ
Red Hat Logo

Libvir the Linux virtualization API

FAQ

Main Menu
Related links
Made with Libxml2 Logo

Table of Contents:

License(s)

  1. Licensing Terms for libvir +

    libvir is released under the GNU Lesser General Public License, see the file COPYING.LIB in the distribution for the precise wording. The only library that libvir depends upon is the Xen store access +library which is also licenced under the LGPL.

    +
    2. +
  2. Can I embed libvir in a proprietary application ? +

    Yes. The LGPL allows you to embed libvir 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.

    +
    3. +

Installation

  1. Where can I get libvir ? +

    The original distribution comes from ftp://libvir.org/pub/libvir/.

    +
    2. +
  2. I can't install the libvir/libvir-devel RPM packages due to failed + dependencies +

    The most generic solution is to re-fetch the latest src.rpm , and + rebuild it locally with

    +

    rpm --rebuild libvir-xxx.src.rpm.

    +

    If everything goes well it will generate two binary rpm packages (one + providing the shared libs and xmllint, and the other one, the -devel + package, providing includes, static libraries and scripts needed to build + applications with libvir that you can install locally.

    +
    3. +

Compilation

  1. What is the process to compile libvir ? +

    As most UNIX libraries libvir follows the "standard":

    +

    gunzip -c libvir-xxx.tar.gz | tar xvf -

    +

    cd libvir-xxxx

    +

    ./configure --help

    +

    to see the options, then the compilation/installation proper

    +

    ./configure [possible options]

    +

    make

    +

    make install

    +

    At that point you may have to rerun ldconfig or a similar utility to + update your list of installed shared libs.

    +
    2. +
  2. What other libraries are needed to compile/install libvir ? +

    Libvir requires libxenstore, which is usually provided by the xen + packages as well as xen with its public headers.

    +
    3. +
  3. I use the CVS version and there is no configure script +

    The configure script (and other Makefiles) are generated. Use the + autogen.sh script to regenerate the configure script and Makefiles, + like:

    +

    ./autogen.sh --prefix=/usr --disable-shared

    +
    4. +

Developer corner

  1. Troubles compiling or linking programs using libvir +

    To simplify the process of reusing the library, libvir comes with + pkgconfig support, which can be used directly from autoconf support + or via the pkg-config command line tool, like:

    +

    pkg-config libvir --libs

    +
    2. +

Daniel Veillard

diff --git a/docs/bugs.html b/docs/bugs.html index ad2cbd73eb..6d71ab1597 100644 --- a/docs/bugs.html +++ b/docs/bugs.html @@ -9,4 +9,5 @@ H3 {font-family: Verdana,Arial,Helvetica} A:link, A:visited, A:active { text-decoration: underline } Reporting bugs and getting help
Red Hat Logo

Libvir the Linux virtualization API

Reporting bugs and getting help

Main Menu
Related links
Made with Libxml2 Logo

There is a mailing-list libvir-list@redhat.com for libvir, with an on-line archive. Please subscribe to this list before posting by visiting the associated Web page and follow the instructions. Patches with explanations and provided as attachments -are really appreciated and will be discussed on the mailing list.

Daniel Veillard

+are really appreciated and will be discussed on the mailing list.

We expect to use Red Hat Bugzilla +to track bugs for libvir, though there isn't yet a libvir software module.

Daniel Veillard

diff --git a/docs/html/libxml-libvir.html b/docs/html/libxml-libvir.html index c17d23ea47..221b807d83 100644 --- a/docs/html/libxml-libvir.html +++ b/docs/html/libxml-libvir.html @@ -10,7 +10,7 @@ A:link, A:visited, A:active { text-decoration: underline } Module libvir from libvir
Red Hat Logo

Module libvir from libvir

API Menu
API Indexes
Related links
UpAPI documentationHomeThe XML C parser and toolkit of Gnome

Provides the interfaces of the libvir library to handle Xen domains from a process running in domain 0

Table of Contents

#define LIBVIR_VERSION_NUMBER
Structure virConnect
struct _virConnect
+    Module libvir from libvir
Red Hat Logo
Module libvir from libvir
API Menu
API Indexes
Related links

-        
+        
 	  
UpAPI documentationHomeThe virtualization API
Provides the interfaces of the libvir library to handle Xen domains from a process running in domain 0 
Table of Contents
#define LIBVIR_VERSION_NUMBER
Structure virConnect
struct _virConnect
 The content of this structure is not made public by the API.
 
Typedef virConnect * virConnectPtr
 
Structure virDomain
struct _virDomain
diff --git a/docs/index.html b/docs/index.html
index c7332b65f2..8cecee2ea8 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -125,14 +125,15 @@ A:link, A:visited, A:active { text-decoration: underline }
                               

                                 
                                   
Libvir is a C toolkit to interract with the virtualization capabilities
-of recent versions of Linux. It is free software available under the 
+of recent versions of Linux (and other OSes). It is free software available
+under the 
 GNU Lesser
 General Public License. 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
 instance. The library aim at providing long term stable C API primarily for
 the Xen
-paravirtualization mechanism but should be adaptable to other
+paravirtualization mechanism but should be able to integrate other
 virtualization mechanisms.

                                   

                                     Daniel Veillard
diff --git a/docs/libvir.html b/docs/libvir.html
index 55031438b3..e3906a285a 100644
--- a/docs/libvir.html
+++ b/docs/libvir.html
@@ -10,21 +10,97 @@
 
libvir

 
 
Libvir is a C toolkit to interract with the virtualization capabilities
-of recent versions of Linux. It is free software available under the 
+of recent versions of Linux (and other OSes). It is free software available
+under the 
 GNU Lesser
 General Public License. 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
 instance. The library aim at providing long term stable C API primarily for
 the Xen
-paravirtualization mechanism but should be adaptable to other
+paravirtualization mechanism but should be able to integrate other
 virtualization mechanisms.

 
 
Introduction

 

 
 
FAQ

-

+
Table of Contents:

+
+
+
License(s)

+
    
+  
  1. Licensing Terms for libvir
+    
    libvir is released under the GNU Lesser General Public License, see the file COPYING.LIB in the distribution for the precise wording. The only library that libvir depends upon is the Xen store access
+library which is also licenced under the LGPL.
    
+  
    2. 
+  
  2. Can I embed libvir in a proprietary application ?
+    
    Yes. The LGPL allows you to embed libvir 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.
    
+  
    3. 
+

+
+
Installation

+
    
+  
  1. Where can I get libvir ?
+    
    The original distribution comes from ftp://libvir.org/pub/libvir/.
    
+  
    2. 
+  
  2. I can't install the libvir/libvir-devel RPM packages due to failed
+    dependencies
+    
    The most generic solution is to re-fetch the latest src.rpm , and
+    rebuild it locally with
    
+    
    rpm --rebuild libvir-xxx.src.rpm.
    
+    
    If everything goes well it will generate two binary rpm packages (one
+    providing the shared libs and xmllint, and the other one, the -devel
+    package, providing includes, static libraries and scripts needed to build
+    applications with libvir that you can install locally.
    
+  
    3. 
+

+
+
Compilation

+
    
+  
  1. What is the process to compile libvir ?
+    
    As most UNIX libraries libvir follows the "standard":
    
+    
    gunzip -c libvir-xxx.tar.gz | tar xvf -
    
+    
    cd libvir-xxxx
    
+    
    ./configure --help
    
+    
    to see the options, then the compilation/installation proper
    
+    
    ./configure [possible options]
    
+    
    make
    
+    
    make install
    
+    
    At that point you may have to rerun ldconfig or a similar utility to
+    update your list of installed shared libs.
    
+  
    2. 
+  
  2. What other libraries are needed to compile/install libvir ?
+    
    Libvir requires libxenstore, which is usually provided by the xen
+       packages as well as xen with its public headers.
    
+  
    3. 
+  
  3. I use the CVS version and there is no configure script
+    
    The configure script (and other Makefiles) are generated. Use the
+    autogen.sh script to regenerate the configure script and Makefiles,
+    like:
    
+    
    ./autogen.sh --prefix=/usr --disable-shared
    
+  
    4. 
+

+
+
Developer corner

+
    
+  
  1. Troubles compiling or linking programs using libvir
+      
    To simplify the process of reusing the library, libvir comes with
+         pkgconfig support, which can be used directly from autoconf support
+	 or via the pkg-config command line tool, like:
    
+      
    pkg-config libvir --libs
    
+  
    2. 
+

 
 
Reporting bugs and getting help

 
@@ -34,6 +110,8 @@ href="https://www.redhat.com/archives/libvir-list/">on-line archive. Please
 href="https://www.redhat.com/mailman/listinfo/libvir-list">associated Web page and
 follow the instructions. Patches with explanations and provided as attachments
 are really appreciated and will be discussed on the mailing list.

+
 We expect to use Red Hat Bugzilla
+to track bugs for libvir, though there isn't yet a libvir software module.

 
 
 
diff --git a/docs/newapi.xsl b/docs/newapi.xsl
index d6e350304b..418df71491 100644
--- a/docs/newapi.xsl
+++ b/docs/newapi.xsl
@@ -113,7 +113,7 @@
         		Up
 	API documentation
         HomeThe XML C parser and toolkit of GnomeThe virtualization API
         
           Next