source: gnome/core/gnome-user-docs.xml@ 7539d8f7

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

  <!ENTITY gnome-user-docs-download-http "&gnome-download-http;/gnome-user-docs/&gnome-version;/gnome-user-docs-&gnome-user-docs-version;.tar.bz2">
  <!ENTITY gnome-user-docs-download-ftp  "&gnome-download-ftp;/gnome-user-docs/&gnome-version;/gnome-user-docs-&gnome-user-docs-version;.tar.bz2">
  <!ENTITY gnome-user-docs-md5sum        "4f5a7114ccf9e4e31137da50b7333570">
  <!ENTITY gnome-user-docs-size          "2.0 MB">
  <!ENTITY gnome-user-docs-buildsize     "13.4 MB">
  <!ENTITY gnome-user-docs-time          "1.3 SBU">
]>

<sect1 id="gnome-user-docs"
       xreflabel="GNOME User Docs-&gnome-user-docs-version;">
  <?dbhtml filename="gnome-user-docs.html"?>

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

  <title>GNOME User Docs-&gnome-user-docs-version;</title>

  <indexterm zone="gnome-user-docs">
    <primary sortas="a-GNOME-User-Docs">GNOME User Docs</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME User Docs</title>

    <para>The <application>GNOME User Docs</application> package contains
    documentation for <application>GNOME</application>.</para>

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

    <bridgehead renderas="sect3">GNOME User Docs Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gnome-doc-utils"/> and
    <xref linkend="which"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of GNOME User Docs</title>

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

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

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --localstatedir=/var/lib &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>

    <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 role="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>None</seg>
        <seg>None</seg>
        <seg>$GNOME_PREFIX/share/{gnome/help/{gnome-access-guide,system-admin-guide,user-guide},
        omf/{gnome-user-docs,user-guide}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry>
        <term>OMF files</term>
        <listitem>
          <para>contain user documentation. These include introductions
          and help on the core packages.</para>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>