[fdca4266] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY scrollkeeper-download-http "http://ftp.gnome.org/pub/GNOME/sources/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
|
---|
| 8 | <!ENTITY scrollkeeper-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
|
---|
| 9 | <!ENTITY scrollkeeper-size "534 KB">
|
---|
| 10 | <!ENTITY scrollkeeper-buildsize "9.2 MB">
|
---|
| 11 | <!ENTITY scrollkeeper-time "0.20 SBU">
|
---|
| 12 |
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
[3b11616] | 15 | <sect1 id="scrollkeeper" xreflabel="ScrollKeeper-&scrollkeeper-version;">
|
---|
[dd3f20f0] | 16 | <?dbhtml filename="scrollkeeper.html"?>
|
---|
[3b11616] | 17 | <title>ScrollKeeper-&scrollkeeper-version;</title>
|
---|
[bc6254eb] | 18 |
|
---|
[fdca4266] | 19 | <sect2>
|
---|
| 20 |
|
---|
| 21 | <title>Introduction to <application>ScrollKeeper</application></title>
|
---|
| 22 |
|
---|
| 23 | <para>The <application>ScrollKeeper</application> package contains a cataloging system for
|
---|
| 24 | documentation. This is useful for managing documentation metadata and
|
---|
| 25 | providing an <acronym>API</acronym> to help browsers find, sort and search the document
|
---|
| 26 | catalog.</para>
|
---|
| 27 |
|
---|
| 28 | <sect3><title>Package information</title>
|
---|
| 29 | <itemizedlist spacing='compact'>
|
---|
| 30 | <listitem><para>Download (HTTP): <ulink
|
---|
| 31 | url="&scrollkeeper-download-http;"/></para></listitem>
|
---|
| 32 | <listitem><para>Download (FTP): <ulink
|
---|
| 33 | url="&scrollkeeper-download-ftp;"/></para></listitem>
|
---|
| 34 | <listitem><para>Download size: &scrollkeeper-size;</para></listitem>
|
---|
| 35 | <listitem><para>Estimated Disk space required:
|
---|
| 36 | &scrollkeeper-buildsize;</para></listitem>
|
---|
| 37 | <listitem><para>Estimated build time:
|
---|
| 38 | &scrollkeeper-time;</para></listitem></itemizedlist>
|
---|
| 39 | </sect3>
|
---|
| 40 |
|
---|
| 41 | <sect3><title><application>ScrollKeeper</application> dependencies</title>
|
---|
| 42 | <sect4><title>Required</title>
|
---|
| 43 | <para>
|
---|
| 44 | <xref linkend="intltool"/>,
|
---|
| 45 | <xref linkend="libxslt"/>,
|
---|
| 46 | <xref linkend="DocBook"/> and
|
---|
| 47 | <xref linkend="perl-modules"/>: XML-Parser-&XML-Parser-version;
|
---|
| 48 | </para></sect4>
|
---|
| 49 | </sect3>
|
---|
| 50 |
|
---|
| 51 | </sect2>
|
---|
| 52 |
|
---|
| 53 | <sect2>
|
---|
| 54 | <title>Installation of <application>ScrollKeeper</application></title>
|
---|
| 55 |
|
---|
| 56 | <para>Install <application>ScrollKeeper</application> by running the following commands:</para>
|
---|
| 57 |
|
---|
| 58 | <screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc \
|
---|
| 59 | --localstatedir=/var --disable-static \
|
---|
| 60 | --with-omfdirs=/usr/share/omf:/opt/gnome/share/omf:\
|
---|
| 61 | /opt/kde-&kde-version;/share/omf:/opt/gnome-&gnome-version;/share/omf &&
|
---|
| 62 | make &&
|
---|
| 63 | make install</command></userinput></screen>
|
---|
| 64 |
|
---|
| 65 | </sect2>
|
---|
| 66 |
|
---|
| 67 | <sect2>
|
---|
| 68 | <title>Command explanations</title>
|
---|
| 69 |
|
---|
| 70 | <para><parameter>--sysconfdir=/etc</parameter>: This switch puts the
|
---|
| 71 | configuration files in <filename class="directory">/etc/scrollkeeper</filename>.</para>
|
---|
| 72 |
|
---|
| 73 | <para><parameter>--localstatedir=/var</parameter>: This switch puts
|
---|
| 74 | <application>ScrollKeeper</application>'s database directory in
|
---|
| 75 | <filename class="directory">/var/lib/scrollkeeper</filename>.</para>
|
---|
| 76 |
|
---|
| 77 | <para><option>--disable-static</option>: This switch prevents
|
---|
| 78 | the static library from being built.</para>
|
---|
| 79 |
|
---|
| 80 | <para><parameter>--omfdirs=/usr/share/omf:/opt/kde-&kde-version;/share/omf:/opt/gnome-&gnome-version;/share/omf</parameter>:
|
---|
| 81 | This switch sets all the locations for <filename>OMF</filename> files for scrollkeeper.</para>
|
---|
| 82 | </sect2>
|
---|
| 83 |
|
---|
| 84 | <sect2>
|
---|
| 85 | <title>Configuring <application>ScrollKeeper</application></title>
|
---|
| 86 |
|
---|
| 87 | <sect3><title>Config files</title>
|
---|
| 88 | <para><filename>/etc/scrollkeeper.conf</filename></para>
|
---|
| 89 | </sect3>
|
---|
| 90 |
|
---|
| 91 | <sect3><title>Configuration Information</title>
|
---|
| 92 |
|
---|
| 93 | <para>The configuration file sets the <envar>OMF_DIR</envar> variable to the location
|
---|
| 94 | of all of the <filename class="directory">omf</filename> directories in the system. This was set in the
|
---|
| 95 | <command>configure</command> command so no futher action is needed until another
|
---|
| 96 | <filename>OMF</filename> file is created.</para>
|
---|
| 97 |
|
---|
| 98 | </sect3>
|
---|
| 99 |
|
---|
| 100 | </sect2>
|
---|
| 101 |
|
---|
| 102 | <sect2>
|
---|
| 103 | <title>Contents</title>
|
---|
| 104 |
|
---|
| 105 | <para>The <application>ScrollKeeper</application> package contains
|
---|
| 106 | <filename class="libraryfile">libscrollkeeper</filename> libraries and utility scripts.</para>
|
---|
| 107 |
|
---|
| 108 | </sect2>
|
---|
| 109 |
|
---|
| 110 | <sect2><title>Description</title>
|
---|
| 111 |
|
---|
| 112 | <sect3><title>scrollkeeper libraries</title>
|
---|
| 113 | <para><filename class="libraryfile">libscrollkeeper</filename> libraries provide the
|
---|
| 114 | <acronym>API</acronym> necessary for help browsers to
|
---|
| 115 | interact with documentation written to utilize
|
---|
| 116 | <application>ScrollKeeper</application>.</para></sect3>
|
---|
| 117 |
|
---|
| 118 | <sect3><title>utility scripts</title>
|
---|
| 119 | <para>Utility scripts for performing installation, building, getting
|
---|
| 120 | and updating table of contents files.</para></sect3>
|
---|
| 121 |
|
---|
| 122 | </sect2>
|
---|
[bc6254eb] | 123 |
|
---|
| 124 | </sect1>
|
---|