source: gnome/add/devhelp.xml@ 3b90fb78

<?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 devhelp-download-http "&gnome-download-http;/devhelp/3.2/devhelp-&devhelp-version;.tar.xz">
  <!ENTITY devhelp-download-ftp  "&gnome-download-ftp;/devhelp/3.2/devhelp-&devhelp-version;.tar.xz">
  <!ENTITY devhelp-md5sum        "f1b9eb558d8d85a50a4ecfcdb4545807">
  <!ENTITY devhelp-size          "476 KB">
  <!ENTITY devhelp-buildsize     "11 MB">
  <!ENTITY devhelp-time          "0.2 SBU">
]>

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

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

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

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

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

    <para><application>Devhelp</application> is an API documentation browser for GTK+
    and GNOME. It works natively with gtk-doc.</para>

    &lfs70_built;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><!-- intltool is implicit for gtk3 -->
    <xref linkend="gtk3"/>,
    <xref linkend="GConf"/>, and
    <xref linkend="webkitgtk"/></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=$GNOME_PREFIX \
            --sysconfdir=$GNOME_SYSCONFDIR &amp;&amp;
make</userinput></screen>

    <para>This package does not have a testsuite.</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><parameter>--sysconfdir=$GNOME_SYSCONFDIR</parameter>: This parameter ensures
    the <application>gconf</application> schema is located sensibly, particularly when
    GNOME_PREFIX is <filename class="directory">/usr</filename>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>devhelp and devhelp.py</seg>
        <seg>libdevhelp-3.so</seg>
        <seg><envar>$GNOME_SYSCONFDIR</envar>/{include/devhelp-3.0/devhelp,lib/gedit/plugins,share/devhelp/{assistant,dtd,ui}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="devhelp-prog">
        <term><command>devhelp</command></term>
        <listitem>
          <para>GNOME Developers&apos; help program.</para>
          <indexterm zone="devhelp devhelp">
            <primary sortas="b-devhelp">devhelp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <!--<varlistentry id="devhelp.py">
        <term><command>devhelp.py</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="devhelp devhelp.py">
            <primary sortas="b-devhelp.py">devhelp.py</primary>
          </indexterm>
        </listitem>
      </varlistentry>-->

      <varlistentry id="libdevhelp-3">
        <term><filename class='libraryfile'>libdevhelp-3.so</filename></term>
        <listitem>
          <para>library providing documentation browser functionality.</para>
          <indexterm zone="devhelp libdevhelp-3">
            <primary sortas="c-libdevhelp-3">libdevhelp-3.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>