source: archive/libosinfo.xml@ c339779

<?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 libosinfo-download-http
           "https://fedorahosted.org/releases/l/i/libosinfo/libosinfo-&libosinfo-version;.tar.gz">
  <!ENTITY libosinfo-download-ftp  " ">
  <!ENTITY libosinfo-md5sum        "2af9ba79b3f202032be45d2e6ed7b6e1">
  <!ENTITY libosinfo-size          "964 KB">
  <!ENTITY libosinfo-buildsize     "15 MB">
  <!ENTITY libosinfo-time          "0.2 SBU">
]>

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

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

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

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

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

    <para>
      The <application>libosinfo</application> package is a GObject
      based library for managing information about operating systems,
      hypervisors and the (virtual) hardware devices they can support.
    </para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libsoup"/> (built with GNOME components).
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="check"/> (required for the test suite) and
      <xref linkend="gtk-doc"/>
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr \
            --enable-vala \
            --disable-static &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>--enable-vala</option>: This option enables
      building of the Vala bindings. Remove if you don't have
      <xref linkend="vala"/> installed.
    </para>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          osinfo-db-validate, osinfo-detect and osinfo-query
        </seg>
        <seg>
          libosinfo-1.0.so
        </seg>
        <seg>
          /usr/include/libosinfo-1.0,
          /usr/share/gtk-doc/html/Libosinfo and
          /usr/share/libosinfo
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="osinfo-db-validate">
        <term><command>osinfo-db-validate</command></term>
        <listitem>
          <para>
            is used to check if all XML files comply with
            the libosinfo schema.
          </para>
          <indexterm zone="libosinfo osinfo-db-validate">
            <primary sortas="b-osinfo-db-validate">osinfo-db-validate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="osinfo-detect">
        <term><command>osinfo-detect</command></term>
        <listitem>
          <para>
            is used to examine the "PATH" or "URI" to
            determine what (if any) operating system it
            is for, and whether it is installable or is
            a Live image.
          </para>
          <indexterm zone="libosinfo osinfo-detect">
            <primary sortas="b-osinfo-detect">osinfo-detect</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="osinfo-query">
        <term><command>osinfo-query</command></term>
        <listitem>
          <para>
            is used to extract information from the database.
          </para>
          <indexterm zone="libosinfo osinfo-query">
            <primary sortas="b-osinfo-query">osinfo-query</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>