source: gnome/add/gnome2-user-docs.xml@ 9d2dc4e2

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY gnome2-user-docs-download-http "http://ftp.gnome.org/pub/GNOME/sources/gnome2-user-docs/2.6/gnome2-user-docs-&gnome2-user-docs-version;.tar.bz2">
<!ENTITY gnome2-user-docs-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gnome2-user-docs/2.6/gnome2-user-docs-&gnome2-user-docs-version;.tar.bz2">
<!ENTITY gnome2-user-docs-size "995 KB">
<!ENTITY gnome2-user-docs-buildsize "3.1 MB">
<!ENTITY gnome2-user-docs-time "0.01 SBU">

]>

<sect1 id="gnome2-user-docs" xreflabel="GNOME2 User Docs-&gnome2-user-docs-version;">
<?dbhtml filename="gnome2-user-docs.html"?>
<title>GNOME2 User Docs-&gnome2-user-docs-version;</title>

<sect2>
<title>Introduction to <application>GNOME2 User Docs</application></title>

<para>The <application>GNOME2 User Docs</application> package contains end user documents for
GNOME.</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink
url="&gnome2-user-docs-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink
url="&gnome2-user-docs-download-ftp;"/></para></listitem>
<listitem><para>Download size: &gnome2-user-docs-size;</para></listitem>
<listitem><para>Estimated Disk space required:
&gnome2-user-docs-buildsize;</para></listitem>
<listitem><para>Estimated build time:
&gnome2-user-docs-time;</para></listitem></itemizedlist>
</sect3>
                                                                                
<sect3><title><application>GNOME2 User Docs</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="scrollkeeper"/></para></sect4>
<sect4><title>Optional</title>
<para>
<ulink url="http://sources.redhat.com/docbook-tools/">docbook-utils</ulink>
</para></sect4>
</sect3>
</sect2>

<sect2>
<title>Installation of <application>GNOME2 User Docs</application></title>

<para>Install <application>GNOME2 User Docs</application> by running the following commands:</para>

<screen><userinput><command>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
    --localstatedir=/var/lib &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><parameter>--localstatedir=/var/lib</parameter>: This switch
puts <application>ScrollKeeper</application> files in <filename
class="directory">/var/lib/scrollkeeper</filename>
instead of <filename class="directory">$GNOME_PREFIX/var/scrollkeeper</filename>.</para>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>GNOME2 User Docs</application> package contains
<acronym>OMF</acronym> files.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>OMF files</title>
<para><acronym>OMF</acronym> files contain user documentation.  These include introductions and 
help on the core packages.</para></sect3>

</sect2>

</sect1>