source: gnome/core/scrollkeeper.xml@ 846fba1

10.0 10.1 11.0 11.1 11.2 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 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 lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 846fba1 was 846fba1, checked in by Randy McMurchy <randy@…>, 17 years ago

Updated build entities and added indexing tags to the Scrollkeeper instructions

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

  • Property mode set to 100644
File size: 6.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/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-md5sum "b175e582a6cec3e50a9de73a5bb7455a">
10<!ENTITY scrollkeeper-size "546 KB">
11<!ENTITY scrollkeeper-buildsize "12.3 MB">
12<!ENTITY scrollkeeper-time "0.14 SBU">
13]>
14
15<sect1 id="scrollkeeper" xreflabel="ScrollKeeper-&scrollkeeper-version;">
16<sect1info>
17<othername>$LastChangedBy$</othername>
18<date>$Date$</date>
19</sect1info>
20<?dbhtml filename="scrollkeeper.html"?>
21<title>ScrollKeeper-&scrollkeeper-version;</title>
22<indexterm zone="scrollkeeper">
23<primary sortas="a-ScrollKeeper">ScrollKeeper</primary></indexterm>
24
25<sect2>
26
27<title>Introduction to <application>ScrollKeeper</application></title>
28
29<para>The <application>ScrollKeeper</application> package contains a
30cataloging system for documentation. This is useful for managing documentation
31metadata and providing an <acronym>API</acronym> to help browsers find, sort
32and search the document catalog.</para>
33
34<sect3><title>Package information</title>
35<itemizedlist spacing='compact'>
36<listitem><para>Download (HTTP): <ulink
37url="&scrollkeeper-download-http;"/></para></listitem>
38<listitem><para>Download (FTP): <ulink
39url="&scrollkeeper-download-ftp;"/></para></listitem>
40<listitem><para>Download MD5 sum: &scrollkeeper-md5sum;</para></listitem>
41<listitem><para>Download size: &scrollkeeper-size;</para></listitem>
42<listitem><para>Estimated disk space required:
43&scrollkeeper-buildsize;</para></listitem>
44<listitem><para>Estimated build time:
45&scrollkeeper-time;</para></listitem></itemizedlist>
46</sect3>
47
48<sect3><title><application>ScrollKeeper</application> dependencies</title>
49<sect4><title>Required</title>
50<para><xref linkend="intltool"/>,
51<xref linkend="libxslt"/> and
52<xref linkend="DocBook"/></para>
53</sect4>
54</sect3>
55
56</sect2>
57
58<sect2>
59<title>Installation of <application>ScrollKeeper</application></title>
60
61<para>Install <application>ScrollKeeper</application> by running the following
62commands:</para>
63
64<screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc \
65 --localstatedir=/var --disable-static \
66 --with-omfdirs=/usr/share/omf:/opt/gnome/share/omf:\
67/opt/kde-&kde-version;/share/omf:/opt/gnome-&gnome-version;/share/omf &amp;&amp;
68make</command></userinput></screen>
69
70<para>Now, as the root user:</para>
71
72<screen><userinput role='root'><command>make install</command></userinput></screen>
73
74</sect2>
75
76<sect2>
77<title>Command explanations</title>
78
79<para><parameter>--sysconfdir=/etc</parameter>: This switch puts the
80configuration files in <filename class="directory">/etc</filename> instead of
81<filename class='directory'>/usr/etc</filename>.</para>
82
83<para><parameter>--localstatedir=/var</parameter>: This switch puts
84<application>ScrollKeeper</application>'s database directory in
85<filename class="directory">/var/lib/scrollkeeper</filename>.</para>
86
87<para><option>--disable-static</option>: This switch prevents
88the static library from being built.</para>
89
90<para><parameter>--omfdirs=...</parameter>: This switch defines the locations
91of <filename>OMF</filename> files for <application>ScrollKeeper</application>.
92This information is stored in <filename>/etc/scrollkeeper.conf</filename> and
93can be updated manually, if necessary.</para>
94</sect2>
95
96<sect2>
97<title>Configuring <application>ScrollKeeper</application></title>
98
99<sect3 id="scrollkeeper-config"><title>Config files</title>
100<para><filename>/etc/scrollkeeper.conf</filename></para>
101<indexterm zone="scrollkeeper scrollkeeper-config">
102<primary sortas="e-etc-scrollkeeper.conf">/etc/scrollkeeper.conf</primary>
103</indexterm>
104</sect3>
105
106<sect3><title>Configuration Information</title>
107
108<para>The configuration file sets the <envar>OMF_DIR</envar> variable to the
109location of all of the <filename class="directory">omf</filename> directories
110in the system. This was set in the <command>configure</command> command so no
111futher action is needed until another <filename>OMF</filename> directory is
112created.</para>
113</sect3>
114
115</sect2>
116
117<sect2>
118<title>Contents</title>
119
120<segmentedlist>
121<segtitle>Installed Programs</segtitle>
122<segtitle>Installed Library</segtitle>
123<segtitle>Installed Directories</segtitle>
124
125<seglistitem>
126<seg>scrollkeeper-config, scrollkeeper-extract, scrollkeeper-gen-seriesid,
127scrollkeeper-get-cl, scrollkeeper-get-content-list,
128scrollkeeper-get-extended-content-list, scrollkeeper-get-index-from-docpath,
129scrollkeeper-get-toc-from-docpath, scrollkeeper-get-toc-from-id,
130scrollkeeper-install, scrollkeeper-preinstall, scrollkeeper-rebuilddb,
131scrollkeeper-uninstall and scrollkeeper-update</seg>
132<seg>libscrollkeeper.so</seg>
133<seg>/usr/share/doc/scrollkeeper-&scrollkeeper-version;,
134/usr/share/omf/scrollkeeper, /usr/share/scrollkeeper,
135/usr/share/xml/scrollkeeper and /var/lib/scrollkeeper</seg>
136</seglistitem>
137</segmentedlist>
138
139<variablelist>
140<bridgehead renderas="sect3">Short Descriptions</bridgehead>
141<?dbfo list-presentation="list"?>
142
143<varlistentry>
144<term><command>ScrollKeeper utility programs</command></term>
145<listitem><para>The <application>ScrollKeeper</application> utility programs
146and scripts listed above are for performing installation, building, getting
147and updating table of contents files.</para>
148</listitem>
149</varlistentry>
150
151<varlistentry id="libscrollkeeper">
152<term><filename class='libraryfile'>libscrollkeeper.so</filename></term>
153<listitem><para>provides the <acronym>API</acronym> necessary for help
154browsers to interact with documentation written to utilize
155<application>ScrollKeeper</application>.</para>
156<indexterm zone="scrollkeeper libscrollkeeper">
157<primary sortas="c-libscrollkeeper">libscrollkeeper.so</primary>
158</indexterm></listitem>
159</varlistentry>
160</variablelist>
161
162</sect2>
163
164</sect1>
Note: See TracBrowser for help on using the repository browser.