source: archive/scrollkeeper.xml@ d0cf396

10.0 10.1 11.0 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 krejzi/svn nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since d0cf396 was d0cf396, checked in by Bruce Dubbs <bdubbs@…>, 9 years ago

Clean up III. General Libraries and Utilities

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@10189 af4574ff-66df-0310-9fd7-8a98e5e911e0

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