[fdca4266] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[fdca4266] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[0536361] | 7 | <!ENTITY scrollkeeper-download-http "http://ftp.gnome.org/pub/GNOME/sources/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
|
---|
[51d7b70] | 8 | <!ENTITY scrollkeeper-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
|
---|
| 9 | <!ENTITY scrollkeeper-md5sum "b175e582a6cec3e50a9de73a5bb7455a">
|
---|
| 10 | <!ENTITY scrollkeeper-size "546 KB">
|
---|
| 11 | <!ENTITY scrollkeeper-buildsize "12 MB">
|
---|
| 12 | <!ENTITY scrollkeeper-time "0.1 SBU">
|
---|
[fdca4266] | 13 | ]>
|
---|
| 14 |
|
---|
[3b11616] | 15 | <sect1 id="scrollkeeper" xreflabel="ScrollKeeper-&scrollkeeper-version;">
|
---|
[0536361] | 16 | <?dbhtml filename="scrollkeeper.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
[b22e19bf] | 21 | <keywordset>
|
---|
| 22 | <keyword role="package">scrollkeeper-&scrollkeeper-version;.tar</keyword>
|
---|
[e7307aa1] | 23 | <keyword role="ftpdir">scrollkeeper</keyword>
|
---|
[b22e19bf] | 24 | </keywordset>
|
---|
[0536361] | 25 | </sect1info>
|
---|
| 26 |
|
---|
| 27 | <title>ScrollKeeper-&scrollkeeper-version;</title>
|
---|
| 28 |
|
---|
| 29 | <indexterm zone="scrollkeeper">
|
---|
| 30 | <primary sortas="a-ScrollKeeper">ScrollKeeper</primary>
|
---|
| 31 | </indexterm>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="package">
|
---|
| 34 | <title>Introduction to ScrollKeeper</title>
|
---|
| 35 |
|
---|
| 36 | <para>The <application>ScrollKeeper</application> package contains a
|
---|
| 37 | cataloging system for documentation. This is useful for managing
|
---|
| 38 | documentation metadata and providing an API to help browsers find, sort
|
---|
| 39 | and search the document catalog.</para>
|
---|
| 40 |
|
---|
| 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>Download (HTTP): <ulink url="&scrollkeeper-download-http;"/></para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download (FTP): <ulink url="&scrollkeeper-download-ftp;"/></para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download MD5 sum: &scrollkeeper-md5sum;</para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Download size: &scrollkeeper-size;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Estimated disk space required: &scrollkeeper-buildsize;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>Estimated build time: &scrollkeeper-time;</para>
|
---|
| 60 | </listitem>
|
---|
| 61 | </itemizedlist>
|
---|
| 62 |
|
---|
| 63 | <bridgehead renderas="sect3">ScrollKeeper Dependencies</bridgehead>
|
---|
| 64 |
|
---|
| 65 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[b22e19bf] | 66 | <para role="required"><xref linkend="intltool"/>,
|
---|
[0536361] | 67 | <xref linkend="libxslt"/> and
|
---|
| 68 | <xref linkend="DocBook"/></para>
|
---|
| 69 |
|
---|
| 70 | </sect2>
|
---|
| 71 |
|
---|
| 72 | <sect2 role="installation">
|
---|
| 73 | <title>Installation of ScrollKeeper</title>
|
---|
| 74 |
|
---|
| 75 | <para>Install <application>ScrollKeeper</application> by running the
|
---|
| 76 | following commands:</para>
|
---|
| 77 |
|
---|
| 78 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
|
---|
[fdca4266] | 79 | --localstatedir=/var --disable-static \
|
---|
[b9950b00] | 80 | --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
|
---|
[fdca4266] | 81 | /opt/kde-&kde-version;/share/omf:/opt/gnome-&gnome-version;/share/omf &&
|
---|
[0536361] | 82 | make</userinput></screen>
|
---|
| 83 |
|
---|
| 84 | <para>This package does not come with a test suite.</para>
|
---|
| 85 |
|
---|
| 86 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 87 |
|
---|
| 88 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 89 |
|
---|
| 90 | </sect2>
|
---|
| 91 |
|
---|
| 92 | <sect2 role="commands">
|
---|
| 93 | <title>Command Explanations</title>
|
---|
| 94 |
|
---|
| 95 | <para><parameter>--sysconfdir=/etc</parameter>: This switch puts the
|
---|
| 96 | configuration files in <filename class="directory">/etc</filename>
|
---|
| 97 | instead of <filename class='directory'>/usr/etc</filename>.</para>
|
---|
| 98 |
|
---|
| 99 | <para><parameter>--localstatedir=/var</parameter>: This switch puts
|
---|
| 100 | <application>ScrollKeeper</application>'s database directory in
|
---|
| 101 | <filename class="directory">/var/lib/scrollkeeper</filename>.</para>
|
---|
| 102 |
|
---|
| 103 | <para><parameter>--disable-static</parameter>: This switch prevents
|
---|
| 104 | the static library from being built.</para>
|
---|
| 105 |
|
---|
| 106 | <para><parameter>--with-omfdirs=...</parameter>: This switch defines the
|
---|
| 107 | locations of <filename>OMF</filename> files for
|
---|
[51d7b70] | 108 | <application>ScrollKeeper</application>. Change the locations if you have
|
---|
| 109 | <application>KDE</application> and/or <application>GNOME</application>-2
|
---|
| 110 | installed in a prefix other than the ones shown. This information is stored
|
---|
| 111 | in <filename>/etc/scrollkeeper.conf</filename> and can be updated manually,
|
---|
[0536361] | 112 | if necessary.</para>
|
---|
| 113 |
|
---|
| 114 | </sect2>
|
---|
| 115 |
|
---|
| 116 | <sect2 role="configuration">
|
---|
| 117 | <title>Configuring ScrollKeeper</title>
|
---|
| 118 |
|
---|
| 119 | <sect3 id="scrollkeeper-config">
|
---|
| 120 | <title>Config Files</title>
|
---|
| 121 |
|
---|
| 122 | <para><filename>/etc/scrollkeeper.conf</filename></para>
|
---|
| 123 |
|
---|
| 124 | <indexterm zone="scrollkeeper scrollkeeper-config">
|
---|
| 125 | <primary sortas="e-etc-scrollkeeper.conf">/etc/scrollkeeper.conf</primary>
|
---|
| 126 | </indexterm>
|
---|
| 127 |
|
---|
| 128 | </sect3>
|
---|
| 129 |
|
---|
| 130 | <sect3>
|
---|
| 131 | <title>Configuration Information</title>
|
---|
| 132 |
|
---|
| 133 | <para>The configuration file sets the <envar>OMF_DIR</envar> variable
|
---|
| 134 | to the location of all of the <filename class="directory">omf</filename>
|
---|
[51d7b70] | 135 | directories in the system. This was set in the
|
---|
| 136 | <command>configure</command> command so no further action is needed until
|
---|
| 137 | another <filename>OMF</filename> directory is created.</para>
|
---|
[0536361] | 138 |
|
---|
| 139 | </sect3>
|
---|
| 140 |
|
---|
| 141 | </sect2>
|
---|
| 142 |
|
---|
| 143 | <sect2 role="content">
|
---|
| 144 | <title>Contents</title>
|
---|
| 145 |
|
---|
| 146 | <segmentedlist>
|
---|
| 147 | <segtitle>Installed Programs</segtitle>
|
---|
| 148 | <segtitle>Installed Library</segtitle>
|
---|
| 149 | <segtitle>Installed Directories</segtitle>
|
---|
| 150 |
|
---|
| 151 | <seglistitem>
|
---|
| 152 | <seg>scrollkeeper-config, scrollkeeper-extract, scrollkeeper-gen-seriesid,
|
---|
| 153 | scrollkeeper-get-cl, scrollkeeper-get-content-list,
|
---|
| 154 | scrollkeeper-get-extended-content-list, scrollkeeper-get-index-from-docpath,
|
---|
| 155 | scrollkeeper-get-toc-from-docpath, scrollkeeper-get-toc-from-id,
|
---|
| 156 | scrollkeeper-install, scrollkeeper-preinstall, scrollkeeper-rebuilddb,
|
---|
| 157 | scrollkeeper-uninstall, and scrollkeeper-update</seg>
|
---|
| 158 | <seg>libscrollkeeper.so</seg>
|
---|
| 159 | <seg>/usr/share/doc/scrollkeeper-&scrollkeeper-version;,
|
---|
| 160 | /usr/share/omf/scrollkeeper, /usr/share/scrollkeeper,
|
---|
| 161 | /usr/share/xml/scrollkeeper, and /var/lib/scrollkeeper</seg>
|
---|
| 162 | </seglistitem>
|
---|
| 163 | </segmentedlist>
|
---|
| 164 |
|
---|
| 165 | <variablelist>
|
---|
| 166 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 167 | <?dbfo list-presentation="list"?>
|
---|
| 168 | <?dbhtml list-presentation="table"?>
|
---|
| 169 |
|
---|
| 170 | <varlistentry>
|
---|
| 171 | <term><command>ScrollKeeper utility programs</command></term>
|
---|
| 172 | <listitem>
|
---|
| 173 | <para>The <application>ScrollKeeper</application> utility programs
|
---|
| 174 | and scripts listed above are for performing installation, building,
|
---|
| 175 | getting and updating table of contents files.</para>
|
---|
| 176 | </listitem>
|
---|
| 177 | </varlistentry>
|
---|
| 178 |
|
---|
| 179 | <varlistentry id="libscrollkeeper">
|
---|
| 180 | <term><filename class='libraryfile'>libscrollkeeper.so</filename></term>
|
---|
| 181 | <listitem>
|
---|
| 182 | <para>provides the API necessary for help
|
---|
| 183 | browsers to interact with documentation written to utilize
|
---|
| 184 | <application>ScrollKeeper</application>.</para>
|
---|
| 185 | <indexterm zone="scrollkeeper libscrollkeeper">
|
---|
| 186 | <primary sortas="c-libscrollkeeper">libscrollkeeper.so</primary>
|
---|
| 187 | </indexterm>
|
---|
| 188 | </listitem>
|
---|
| 189 | </varlistentry>
|
---|
| 190 |
|
---|
| 191 | </variablelist>
|
---|
| 192 |
|
---|
| 193 | </sect2>
|
---|
[bc6254eb] | 194 |
|
---|
| 195 | </sect1>
|
---|