[3b90fb78] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY devhelp-download-http "&gnome-download-http;/devhelp/3.2/devhelp-&devhelp-version;.tar.xz">
|
---|
| 8 | <!ENTITY devhelp-download-ftp "&gnome-download-ftp;/devhelp/3.2/devhelp-&devhelp-version;.tar.xz">
|
---|
| 9 | <!ENTITY devhelp-md5sum "f1b9eb558d8d85a50a4ecfcdb4545807">
|
---|
| 10 | <!ENTITY devhelp-size "476 KB">
|
---|
| 11 | <!ENTITY devhelp-buildsize "11 MB">
|
---|
| 12 | <!ENTITY devhelp-time "0.2 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="devhelp" xreflabel="devhelp-&devhelp-version;">
|
---|
| 16 | <?dbhtml filename="devhelp.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>devhelp-&devhelp-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="devhelp">
|
---|
| 26 | <primary sortas="a-devhelp">devhelp</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to devhelp</title>
|
---|
| 31 |
|
---|
| 32 | <para><application>Devhelp</application> is an API documentation browser for GTK+
|
---|
| 33 | and GNOME. It works natively with gtk-doc.</para>
|
---|
| 34 |
|
---|
| 35 | &lfs70_built;
|
---|
| 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>Download (HTTP): <ulink url="&devhelp-download-http;"/></para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>Download (FTP): <ulink url="&devhelp-download-ftp;"/></para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download MD5 sum: &devhelp-md5sum;</para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download size: &devhelp-size;</para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Estimated disk space required: &devhelp-buildsize;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Estimated build time: &devhelp-time;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | </itemizedlist>
|
---|
| 58 |
|
---|
| 59 | <bridgehead renderas="sect3">devhelp Dependencies</bridgehead>
|
---|
| 60 |
|
---|
| 61 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 62 | <para role="required"><!-- intltool is implicit for gtk3 -->
|
---|
| 63 | <xref linkend="gtk3"/>,
|
---|
| 64 | <xref linkend="GConf"/>, and
|
---|
| 65 | <xref linkend="webkitgtk"/></para>
|
---|
| 66 |
|
---|
| 67 | <para condition="html" role="usernotes">User Notes:
|
---|
| 68 | <ulink url="&blfs-wiki;/devhelp"/></para>
|
---|
| 69 |
|
---|
| 70 | </sect2>
|
---|
| 71 |
|
---|
| 72 | <sect2 role="installation">
|
---|
| 73 | <title>Installation of devhelp</title>
|
---|
| 74 |
|
---|
| 75 | <para>Install <application>devhelp</application> by running the following
|
---|
| 76 | commands:</para>
|
---|
| 77 |
|
---|
| 78 | <screen><userinput>./configure --prefix=$GNOME_PREFIX \
|
---|
| 79 | --sysconfdir=$GNOME_SYSCONFDIR &&
|
---|
| 80 | make</userinput></screen>
|
---|
| 81 |
|
---|
| 82 | <para>This package does not have a testsuite.</para>
|
---|
| 83 |
|
---|
| 84 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 85 |
|
---|
| 86 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 87 |
|
---|
| 88 | </sect2>
|
---|
| 89 |
|
---|
| 90 | <sect2 role="commands">
|
---|
| 91 | <title>Command Explanations</title>
|
---|
| 92 |
|
---|
| 93 | <para><parameter>--sysconfdir=$GNOME_SYSCONFDIR</parameter>: This parameter ensures
|
---|
| 94 | the <application>gconf</application> schema is located sensibly, particularly when
|
---|
| 95 | GNOME_PREFIX is <filename class="directory">/usr</filename>.</para>
|
---|
| 96 |
|
---|
| 97 | </sect2>
|
---|
| 98 |
|
---|
| 99 | <sect2 role="content">
|
---|
| 100 | <title>Contents</title>
|
---|
| 101 |
|
---|
| 102 | <segmentedlist>
|
---|
| 103 | <segtitle>Installed Programs</segtitle>
|
---|
| 104 | <segtitle>Installed Library</segtitle>
|
---|
| 105 | <segtitle>Installed Directories</segtitle>
|
---|
| 106 |
|
---|
| 107 | <seglistitem>
|
---|
| 108 | <seg>devhelp and devhelp.py</seg>
|
---|
| 109 | <seg>libdevhelp-3.so</seg>
|
---|
| 110 | <seg><envar>$GNOME_SYSCONFDIR</envar>/{include/devhelp-3.0/devhelp,lib/gedit/plugins,share/devhelp/{assistant,dtd,ui}}</seg>
|
---|
| 111 | </seglistitem>
|
---|
| 112 | </segmentedlist>
|
---|
| 113 |
|
---|
| 114 | <variablelist>
|
---|
| 115 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 116 | <?dbfo list-presentation="list"?>
|
---|
| 117 | <?dbhtml list-presentation="table"?>
|
---|
| 118 |
|
---|
| 119 | <varlistentry id="devhelp-prog">
|
---|
| 120 | <term><command>devhelp</command></term>
|
---|
| 121 | <listitem>
|
---|
| 122 | <para>GNOME Developers' help program.</para>
|
---|
| 123 | <indexterm zone="devhelp devhelp">
|
---|
| 124 | <primary sortas="b-devhelp">devhelp</primary>
|
---|
| 125 | </indexterm>
|
---|
| 126 | </listitem>
|
---|
| 127 | </varlistentry>
|
---|
| 128 |
|
---|
| 129 | <!--<varlistentry id="devhelp.py">
|
---|
| 130 | <term><command>devhelp.py</command></term>
|
---|
| 131 | <listitem>
|
---|
| 132 | <para>does this .....</para>
|
---|
| 133 | <indexterm zone="devhelp devhelp.py">
|
---|
| 134 | <primary sortas="b-devhelp.py">devhelp.py</primary>
|
---|
| 135 | </indexterm>
|
---|
| 136 | </listitem>
|
---|
| 137 | </varlistentry>-->
|
---|
| 138 |
|
---|
| 139 | <varlistentry id="libdevhelp-3">
|
---|
| 140 | <term><filename class='libraryfile'>libdevhelp-3.so</filename></term>
|
---|
| 141 | <listitem>
|
---|
| 142 | <para>library providing documentation browser functionality.</para>
|
---|
| 143 | <indexterm zone="devhelp libdevhelp-3">
|
---|
| 144 | <primary sortas="c-libdevhelp-3">libdevhelp-3.so</primary>
|
---|
| 145 | </indexterm>
|
---|
| 146 | </listitem>
|
---|
| 147 | </varlistentry>
|
---|
| 148 |
|
---|
| 149 | </variablelist>
|
---|
| 150 |
|
---|
| 151 | </sect2>
|
---|
| 152 |
|
---|
| 153 | </sect1>
|
---|