source: archive/scrollkeeper.xml@ 45ab6c7

11.0 qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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