diff --git a/ChangeLog b/ChangeLog index 6bb1114cdc..609eb4c361 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +Fri Dec 9 14:03:13 CET 2005 Daniel Veillard + + * docs/*: extended the documentation + Fri Dec 9 11:15:41 CET 2005 Daniel Veillard * configure.in: adding --without-depends to make dist on non diff --git a/docs/.cvsignore b/docs/.cvsignore new file mode 100644 index 0000000000..d348e16aa4 --- /dev/null +++ b/docs/.cvsignore @@ -0,0 +1 @@ +.memdump diff --git a/docs/APIchunk2.html b/docs/APIchunk2.html new file mode 100644 index 0000000000..e96a0a01b3 --- /dev/null +++ b/docs/APIchunk2.html @@ -0,0 +1,48 @@ + + +API Alphabetic Index v-z for libvir
Red Hat Logo

Libvir the Linux virtualization API

API Alphabetic Index v-z for libvir

Developer Menu
API Indexes
Related links

A-g +h-u +v-z +

Letter v:

value
virConnectGetVersion
+virGetVersion
+
values
virGetVersion
+
version
LIBVIR_VERSION_NUMBER
+virConnectGetVersion
+virGetVersion
+
virDomainFlags
_virDomainInfo
+virDomainCreateLinux
+
virDomainInfo
virDomainGetInfo
+
virDomainResume
virDomainSuspend
+
virSuspendDomain
virDomainResume
+

Letter w:

was
virDomainResume
+virGetVersion
+
what
_virDomainInfo
+
where
virDomainGetMaxMemory
+virDomainResume
+virDomainSetMaxMemory
+
which
virConnectClose
+virGetVersion
+
while
virGetVersion
+
will
virDomainGetName
+virDomainSuspend
+virGetVersion
+
with
_virDomainInfo
+virConnectClose
+virConnectGetVersion
+
without
virDomainSuspend
+
work
virConnectGetVersion
+

Letter x:

xen
virConnectOpen
+virConnectOpenReadOnly
+
xenstore
_virDomainInfo
+

Letter z:

zero
virConnectGetType
+

A-g +h-u +v-z +

Daniel Veillard

diff --git a/docs/FAQ.html b/docs/FAQ.html index a7a20c5726..7a7e2528e8 100644 --- a/docs/FAQ.html +++ b/docs/FAQ.html @@ -7,22 +7,24 @@ 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

Table of Contents:

  • License(s)
    • +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.

      +

      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. 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.

      +

      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.

    Installation

    1. Where can I get libvir ? -

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

      +

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

    2. I can't install the libvir/libvir-devel RPM packages due to failed dependencies @@ -30,9 +32,13 @@ library which is also licenced under the LGPL.

      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 + providing the shared libs and virsh, and the other one, the -devel package, providing includes, static libraries and scripts needed to build applications with libvir that you can install locally.

      +

      One can also rebuild the RPMs from a tarball:

      +

      rpmbuild -ta libdir-xxx.tar.gz

      +

      Or from a configured tree with:

      +

      make rpm

    Compilation

    1. What is the process to compile libvir ?

      As most UNIX libraries libvir follows the "standard":

      @@ -48,7 +54,7 @@ library which is also licenced under the LGPL.

    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.

      + packages as well as the public headers to compile against libxenstore.

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

      The configure script (and other Makefiles) are generated. Use the @@ -57,9 +63,9 @@ library which is also licenced under the LGPL.

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

    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

      +

      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

    Daniel Veillard

    diff --git a/docs/architecture.html b/docs/architecture.html new file mode 100644 index 0000000000..7200f88ca1 --- /dev/null +++ b/docs/architecture.html @@ -0,0 +1,10 @@ + + +libvir architecture
    Red Hat Logo

    Libvir the Linux virtualization API

    libvir architecture

    Developer Menu
    API Indexes
    Related links

    Daniel Veillard

    diff --git a/docs/bugs.html b/docs/bugs.html index 6d71ab1597..8f33caaad7 100644 --- a/docs/bugs.html +++ b/docs/bugs.html @@ -7,7 +7,12 @@ 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 } -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.

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

    Daniel Veillard

    +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. If possible generate the patches by using cvs diff -u in a CVS +checkout.

    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/downloads.html b/docs/downloads.html new file mode 100644 index 0000000000..f9ac261cb0 --- /dev/null +++ b/docs/downloads.html @@ -0,0 +1,16 @@ + + +Downloads
    Red Hat Logo

    Libvir the Linux virtualization API

    Downloads

    Main Menu
    Related links
    Made with Libxml2 Logo

    The latest versions of libvir can be found on the libvir.org server ( HTTP, FTP). You will find there the released +versions as well as snapshot +tarballs updated from CVS head every hour

    Anonymous CVS is also +available, first register onto the server:

    cvs -d :pserver:anoncvs@libvir.org:2401/data/cvs login

    it will request a password, enter anoncvs. Then you can +checkout the development tree with:

    cvs -d :pserver:anoncvs@libvir.org:2401/data/cvs co libvir

    Use ./autogen.sh to configure the local checkout, then make +and make install, as usual. All normal cvs commands are now +available except commiting to the base.

    Daniel Veillard

    diff --git a/docs/index.html b/docs/index.html index 8cecee2ea8..591de376dd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -67,9 +67,15 @@ A:link, A:visited, A:active { text-decoration: underline }
  • Home
    • +
  • + Releases +
  • Introduction
    • +
  • + Downloads +
  • FAQ
    • @@ -124,15 +130,14 @@ 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 (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 +

    Libvir is a C toolkit to interract with the virtualization capabilities 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 able to integrate other virtualization mechanisms.

    diff --git a/docs/intro.html b/docs/intro.html index e5b754c4ea..eae18327de 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -7,4 +7,4 @@ 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 } -Introduction
    Red Hat Logo

    Libvir the Linux virtualization API

    Introduction

    Main Menu
    Related links
    Made with Libxml2 Logo

    Daniel Veillard

    +Introduction
    Red Hat Logo

    Libvir the Linux virtualization API

    Introduction

    Main Menu
    Related links
    Made with Libxml2 Logo

    Daniel Veillard

    diff --git a/docs/libvir.html b/docs/libvir.html index e3906a285a..443887ce12 100644 --- a/docs/libvir.html +++ b/docs/libvir.html @@ -1,30 +1,72 @@ -Libvir the Linux virtualization API + + Libvir the Linux virtualization API +

    Libvir the Linux virtualization API

    -

    Note: this is the flat content of the web site

    +

    Note: this is the flat content of the web +site

    libvir

    -

    Libvir is a C toolkit to interract with the virtualization capabilities -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 +

    Libvir is a C toolkit to interract with the virtualization capabilities 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 able to integrate other virtualization mechanisms.

    +

    Releases

    + +

    There is no official release yet, just CVS state and snapshot, contact +the mailing list and check the ChangeLog to +gauge progresses.

    +
      +
    • Extending the API
      • +
    +

    Introduction

    +

    +

    libvir architecture

    + +

    + +

    Downloads

    + +

    The latest versions of libvir can be found on the libvir.org server ( HTTP, FTP). You will find there the released +versions as well as snapshot +tarballs updated from CVS head every hour

    + +

    Anonymous CVS is also +available, first register onto the server:

    + +

    cvs -d :pserver:anoncvs@libvir.org:2401/data/cvs login

    + +

    it will request a password, enter anoncvs. Then you can +checkout the development tree with:

    + +

    cvs -d :pserver:anoncvs@libvir.org:2401/data/cvs co libvir

    + +

    Use ./autogen.sh to configure the local checkout, then make +and make install, as usual. All normal cvs commands are now +available except commiting to the base.

    +

    FAQ

    +

    Table of Contents:

    • License(s)
      • @@ -37,14 +79,16 @@ virtualization mechanisms.

      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.

        + href="http://www.opensource.org/licenses/lgpl-license.html">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. 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.

        +

        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.

      @@ -52,7 +96,7 @@ library which is also licenced under the LGPL.

      1. Where can I get libvir ?

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

        + href="ftp://libvir.org/libvir/">ftp://libvir.org/libvir/.

      2. I can't install the libvir/libvir-devel RPM packages due to failed dependencies @@ -60,9 +104,13 @@ library which is also licenced under the LGPL.

        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 + providing the shared libs and virsh, and the other one, the -devel package, providing includes, static libraries and scripts needed to build applications with libvir that you can install locally.

        +

        One can also rebuild the RPMs from a tarball:

        +

        rpmbuild -ta libdir-xxx.tar.gz

        +

        Or from a configured tree with:

        +

        make rpm

      @@ -82,7 +130,7 @@ library which is also licenced under the LGPL.

    • 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.

      + packages as well as the public headers to compile against libxenstore.

    • I use the CVS version and there is no configure script

      The configure script (and other Makefiles) are generated. Use the @@ -95,23 +143,27 @@ library which is also licenced under the LGPL.

      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

        +

        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

      Reporting bugs and getting help

      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.

      -

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

      +href="mailto:libvir-list@redhat.com">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. If possible generate the patches by using cvs diff -u in a CVS +checkout.

      +

      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/news.html b/docs/news.html new file mode 100644 index 0000000000..b0d58d3a3e --- /dev/null +++ b/docs/news.html @@ -0,0 +1,13 @@ + + +Releases
      Red Hat Logo

      Libvir the Linux virtualization API

      Releases

      Main Menu
      Related links
      Made with Libxml2 Logo

      There is no official release yet, just CVS state and snapshot, contact +the mailing list and check the ChangeLog to +gauge progresses.

      • Extending the API
        • +

      Daniel Veillard