source: xfce/core/garcon.xml@ 3441548

<?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 garcon-download-http
           "http://archive.xfce.org/src/xfce/garcon/0.7/garcon-&garcon-version;.tar.bz2">
  <!ENTITY garcon-download-ftp  " ">
  <!ENTITY garcon-md5sum        "a9c2116b0c34a022385f421b639df0f4">
  <!ENTITY garcon-size          "528 KB">
  <!ENTITY garcon-buildsize     "8.1 MB">
  <!ENTITY garcon-time          "0.1 SBU">
]>

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

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

  <title>Garcon-&garcon-version;</title>

  <indexterm zone="garcon">
    <primary sortas="a-Garcon">Garcon</primary>
  </indexterm>

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

    <para>
      The <application>Garcon</application> package contains a freedesktop.org
      compliant menu implementation based on <application>GLib</application> and
      <application>GIO</application>.
    </para>

    &lfs10_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libxfce4ui"/> and 
      <xref linkend="gtk3"/>
    </para>

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

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

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &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="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgarcon-1.so and
          libgarcon-gtk3-1.so
        </seg>
        <seg>
          /usr/include/garcon-1,
          /usr/include/garcon-gtk3-1, and
          /usr/share/gtk-doc/html/garcon
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgarcon-1">
        <term><filename class="libraryfile">libgarcon-1.so</filename></term>
        <listitem>
          <para>
            contains functions that provide a freedesktop.org compliant menu
            implementation based on <application>GLib</application> and
            <application>GIO</application>.
          </para>
          <indexterm zone="garcon libgarcon-1">
            <primary sortas="c-libgarcon-1">libgarcon-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>