source: archive/libvirt.xml@ 2015f9d

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libvirt-download-http "http://libvirt.org/sources/libvirt-&libvirt-version;.tar.gz">
  <!ENTITY libvirt-download-ftp  " ">
  <!ENTITY libvirt-md5sum        "5e842bc55733ceba60c64767580ff3e4">
  <!ENTITY libvirt-size          "19 MB">
  <!ENTITY libvirt-buildsize     "240 MB">
  <!ENTITY libvirt-time          "1.6 SBU">
]>

<sect1 id="libvirt" xreflabel="libvirt-&libvirt-version;">
  <?dbhtml filename="libvirt.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>libvirt-&libvirt-version;</title>

  <indexterm zone="libvirt">
    <primary sortas="a-libvirt">libvirt</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libvirt</title>

    <para>
      The <application>libvirt</application> is a C toolkit
      used to interact with the virtualization capabilities
      of recent versions of Linux (and other OSes).
    </para>

    &lfs71_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&libvirt-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&libvirt-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &libvirt-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &libvirt-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libvirt-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libvirt-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libvirt Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gnutls"/>,
      <xref linkend="libgcrypt"/>,
      <xref linkend="libtirpc"/>,
      <xref linkend="libxml2"/> and
      <xref linkend="lvm2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="polkit"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="avahi"/>,
      <xref linkend="curl"/>,
      <xref linkend="cyrus-sasl"/>,
      <ulink url="http://people.redhat.com/sgrubb/libcap-ng/">
      libcap-ng</ulink>,
      <xref linkend="libnl"/>,
      <ulink url="http://oss.sgi.com/projects/libnuma/">
      libnuma</ulink>,
      <xref linkend="libpcap"/>,
      <ulink url="http://www.libssh2.org/">libssh2</ulink>,
      <ulink url="https://fedorahosted.org/netcf/">NetCF</ulink>,
      <ulink url="http://www.open-iscsi.org/">Open iSCSI</ulink>,
      <ulink url="http://www.openswan.org/projects/openswan/">
      OpenSwan</ulink>,
      <xref linkend="parted"/>,
      <xref linkend="qemu-kvm"/>,
      <ulink url="https://www.virtualbox.org/">VirtualBox</ulink>,
      <ulink url="http://www.xen.org/">Xen</ulink>,
      <xref linkend="xorg7-lib"/> and
      <ulink url="http://lloyd.github.com/yajl/">YAYL</ulink>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/libvirt"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of libvirt</title>

    <para>
      Install <application>libvirt</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr \
            --libexecdir=/usr/lib/libvirt \
            --with-storage-lvm \
            --without-macvtap \
            --disable-static \
            CPPFLAGS="-I/usr/include/tirpc -I/usr/include/libnl3" &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <option>--with-storage-lvm</option>: This option enables LVM storage backend.
    </para>

    <para>
      <option>--without-macvtap</option>: This option disables macvtap device support.
      Remove if you have installed <xref linkend="libnl"/>.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          libvirtd, virsh, virt-host-validate,
          virt-pki-validate and virt-xml-validate
        </seg>
        <seg>
          libvirt.so and libvirt-qemu.so
        </seg>
        <seg>
          /etc/libvirt, /usr/include/libvirt, /usr/lib/libvirt,
          /usr/share/augeas/lenses,
          /usr/share/doc/{libvirt-0.9.11,libvirt-python-0.9.11},
          /usr/share/gtk-doc/html/libvirt,
          /usr/share/libvirt, /var/cache/libvirt, /var/lib/libvirt and
          /var/log/libvirt
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <!-- If the program or library name conflicts (is the same) as the
      package name, add -prog or -lib to the varlistentry entity id
      and the 2nd entry of the indexterm zone entity -->

      <varlistentry id="libvirtd">
        <term><command>libvirtd</command></term>
        <listitem>
          <para>
            is the server side daemon component of the libvirt
            virtualization management system.
          </para>
          <indexterm zone="libvirt libvirtd">
            <primary sortas="b-libvirtd">libvirtd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="virsh">
        <term><command>virsh</command></term>
        <listitem>
          <para>
            is the main interface for managing virsh guest domains.
          </para>
          <indexterm zone="libvirt virsh">
            <primary sortas="b-virsh">virsh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="virt-host-validate">
        <term><command>virt-host-validate</command></term>
        <listitem>
          <para>
            This tool validates that the host is configured in
            a suitable way to run libvirt hypervisor drivers.
          </para>
          <indexterm zone="libvirt virt-host-validate">
            <primary sortas="b-virt-host-validate">virt-host-validate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="virt-pki-validate">
        <term><command>virt-pki-validate</command></term>
        <listitem>
          <para>
            This tool validates that the necessary PKI files are
            configured for a secure libvirt server or client
            using the TLS encryption protocol.
          </para>
          <indexterm zone="libvirt virt-pki-validate">
            <primary sortas="b-virt-pki-validate">virt-pki-validate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="virt-xml-validate">
        <term><command>virt-xml-validate</command></term>
        <listitem>
          <para>
            is used to validate a libvirt XML for compliance with the
            published schema.
          </para>
          <indexterm zone="libvirt virt-xml-validate">
            <primary sortas="b-virt-xml-validate">virt-xml-validate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libvirt-lib">
        <term><filename class="libraryfile">libvirt.so</filename></term>
        <listitem>
          <para>
            contains the <application>libvirt</application> API functions.
          </para>
          <indexterm zone="libvirt libvirt-lib">
            <primary sortas="c-libvirt">libvirt.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>