source: gnome/core/scrollkeeper.xml@ ff769b8c

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 ff769b8c was ff769b8c, checked in by Manuel Canales Esparcia <manuel@…>, 18 years ago

Updated the XML sources to use DocBook XML DTD-4.4.

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

  • Property mode set to 100644
File size: 4.7 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 "534 KB">
11<!ENTITY scrollkeeper-buildsize "11.8 MB">
12<!ENTITY scrollkeeper-time "0.15 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
23<sect2>
24
25<title>Introduction to <application>ScrollKeeper</application></title>
26
27<para>The <application>ScrollKeeper</application> package contains a
28cataloging system for documentation. This is useful for managing documentation
29metadata and providing an <acronym>API</acronym> to help browsers find, sort
30and search the document catalog.</para>
31
32<sect3><title>Package information</title>
33<itemizedlist spacing='compact'>
34<listitem><para>Download (HTTP): <ulink
35url="&scrollkeeper-download-http;"/></para></listitem>
36<listitem><para>Download (FTP): <ulink
37url="&scrollkeeper-download-ftp;"/></para></listitem>
38<listitem><para>Download MD5 sum: &scrollkeeper-md5sum;</para></listitem>
39<listitem><para>Download size: &scrollkeeper-size;</para></listitem>
40<listitem><para>Estimated disk space required:
41&scrollkeeper-buildsize;</para></listitem>
42<listitem><para>Estimated build time:
43&scrollkeeper-time;</para></listitem></itemizedlist>
44</sect3>
45
46<sect3><title><application>ScrollKeeper</application> dependencies</title>
47<sect4><title>Required</title>
48<para><xref linkend="intltool"/>,
49<xref linkend="libxslt"/> and
50<xref linkend="DocBook"/></para>
51</sect4>
52</sect3>
53
54</sect2>
55
56<sect2>
57<title>Installation of <application>ScrollKeeper</application></title>
58
59<para>Install <application>ScrollKeeper</application> by running the following
60commands:</para>
61
62<screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc \
63 --localstatedir=/var --disable-static \
64 --with-omfdirs=/usr/share/omf:/opt/gnome/share/omf:\
65/opt/kde-&kde-version;/share/omf:/opt/gnome-&gnome-version;/share/omf &amp;&amp;
66make &amp;&amp;
67make install</command></userinput></screen>
68
69</sect2>
70
71<sect2>
72<title>Command explanations</title>
73
74<para><parameter>--sysconfdir=/etc</parameter>: This switch puts the
75configuration files in <filename class="directory">/etc</filename> instead of
76<filename class='directory'>/usr/etc</filename>.</para>
77
78<para><parameter>--localstatedir=/var</parameter>: This switch puts
79<application>ScrollKeeper</application>'s database directory in
80<filename class="directory">/var/lib/scrollkeeper</filename>.</para>
81
82<para><option>--disable-static</option>: This switch prevents
83the static library from being built.</para>
84
85<para><parameter>--omfdirs=...</parameter>: This switch defines the locations
86of <filename>OMF</filename> files for <application>ScrollKeeper</application>.
87This information is stored in <filename>/etc/scrollkeeper.conf</filename> and
88can be updated manually, if necessary.</para>
89</sect2>
90
91<sect2>
92<title>Configuring <application>ScrollKeeper</application></title>
93
94<sect3><title>Config files</title>
95<para><filename>/etc/scrollkeeper.conf</filename></para>
96</sect3>
97
98<sect3><title>Configuration Information</title>
99
100<para>The configuration file sets the <envar>OMF_DIR</envar> variable to the
101location of all of the <filename class="directory">omf</filename> directories
102in the system. This was set in the <command>configure</command> command so no
103futher action is needed until another <filename>OMF</filename> file is
104created.</para>
105</sect3>
106
107</sect2>
108
109<sect2>
110<title>Contents</title>
111
112<para>The <application>ScrollKeeper</application> package contains the
113<filename class="libraryfile">libscrollkeeper</filename> library, utility
114programs and scripts.</para>
115
116</sect2>
117
118<sect2><title>Description</title>
119
120<sect3><title><application>ScrollKeeper</application> library</title>
121<para>The <filename class="libraryfile">libscrollkeeper</filename> library
122provides the <acronym>API</acronym> necessary for help browsers to interact
123with documentation written to utilize
124<application>ScrollKeeper</application>.</para></sect3>
125
126<sect3><title>Utility programs and scripts</title>
127<para>The utility programs and scripts are for performing installation,
128building, getting and updating table of contents files.</para></sect3>
129
130</sect2>
131
132</sect1>
Note: See TracBrowser for help on using the repository browser.