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