source: gnome/core/libgnome.xml@ 67325819

<?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 libgnome-download-http "&gnome-download-http;/libgnome/&gnome-version;/libgnome-&libgnome-version;.tar.bz2">
  <!ENTITY libgnome-download-ftp  "&gnome-download-ftp;/libgnome/&gnome-version;/libgnome-&libgnome-version;.tar.bz2">
  <!ENTITY libgnome-md5sum        "73426589d7c6fa3266fe4e8f3be2f5b5">
  <!ENTITY libgnome-size          "1.0 MB">
  <!ENTITY libgnome-buildsize     "24 MB">
  <!ENTITY libgnome-time          "0.3 SBU">
]>

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

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

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

  <indexterm zone="libgnome">
    <primary sortas="a-Libgnome">Libgnome</primary>
  </indexterm>

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

    <para>The <application>libgnome</application> package contains the
    <filename class="libraryfile">libgnome</filename> library.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libbonobo"/> and
    <xref linkend="gnome-vfs"/></para>

    <bridgehead renderas="sect4">Recommended (if you plan on installing the
    GNOME desktop)</bridgehead>
    <para role="recommended"><xref linkend="esound"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/> and
    <xref linkend="intltool"/></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --sysconfdir=&gnome-etc-dir; \
            --localstatedir=/var/lib \
            --mandir=$(pkg-config \
                --variable=prefix ORBit-2.0)/share/man \
            --disable-esd &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</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>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/gnome-prefix.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/gnome-sysconfdir.xml"/>

    <para><parameter>--localstatedir=/var/lib</parameter>: This
    parameter sets <envar>LIBGNOME_LOCALSTATEDIR</envar> to
    <filename class='directory'>/var/lib</filename> instead
    of <filename class='directory'>$GNOME_PREFIX/var</filename>
    to synchronize with the <application>GNOME Games</application>
    installation and properly record high scores in
    <filename class='directory'>/var/lib/games</filename>.</para>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/gnome-mandir.xml"/>

    <para><parameter>--disable-esd</parameter>: This parameter is required if
    <xref linkend="esound"/> is not installed. Remove it if the package is
    installed.</para>

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

  </sect2>

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

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

      <seglistitem>
        <seg>gnome-open</seg>
        <seg>libgnome-2.{so,a} and the libmoniker_extra_2.{so,a} bonobo
        library</seg>
        <seg>&gnome-etc-dir;/sound,
        and the following subdirectories of <envar>$GNOME_PREFIX</envar>/:
        include/libgnome-2.0, share/gtk-doc/html/libgnome</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgnome-2">
        <term><filename class='libraryfile'>libgnome-2.{so,a}</filename></term>
        <listitem>
          <para>are the non-GUI portion of the <application>GNOME</application>
          libraries.</para>
          <indexterm zone="libgnome libgnome-2">
            <primary sortas="c-libgnome-2">libgnome-2.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>