source: general/genutils/rarian.xml@ cff5bba

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 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 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since cff5bba was cff5bba, checked in by Wayne Blaszczyk <wblaszcz@…>, 15 years ago

Fixed GDM greeter icon problem. Updated Rarian with correct localstatedir

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@8022 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 10.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 rarian-download-http "&gnome-download-http;/rarian/0.8/rarian-0.8.1.tar.bz2">
8 <!ENTITY rarian-download-ftp "&gnome-download-ftp;/rarian/0.8/rarian-0.8.1.tar.bz2">
9 <!ENTITY rarian-md5sum "75091185e13da67a0ff4279de1757b94">
10 <!ENTITY rarian-size "317 KB">
11 <!ENTITY rarian-buildsize "6 MB">
12 <!ENTITY rarian-time "0.2 SBU">
13]>
14
15<sect1 id="rarian" xreflabel="Rarian-&rarian-version;">
16 <?dbhtml filename="rarian.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Rarian-&rarian-version;</title>
24
25 <indexterm zone="rarian">
26 <primary sortas="a-Rarian">Rarian</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Rarian</title>
31
32 <para>The <application>Rarian</application> package is a documentation
33 metadata library based on the proposed Freedesktop.org spec. <application>
34 Rarian</application> is designed to be a replacement for <application>
35 ScrollKeeper</application>.</para>
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>Download (HTTP): <ulink url="&rarian-download-http;"/></para>
41 </listitem>
42 <listitem>
43 <para>Download (FTP): <ulink url="&rarian-download-ftp;"/></para>
44 </listitem>
45 <listitem>
46 <para>Download MD5 sum: &rarian-md5sum;</para>
47 </listitem>
48 <listitem>
49 <para>Download size: &rarian-size;</para>
50 </listitem>
51 <listitem>
52 <para>Estimated disk space required: &rarian-buildsize;</para>
53 </listitem>
54 <listitem>
55 <para>Estimated build time: &rarian-time;</para>
56 </listitem>
57 </itemizedlist>
58
59 <bridgehead renderas="sect3">Rarian Dependencies</bridgehead>
60
61 <bridgehead renderas="sect4">Recommended</bridgehead>
62 <para role="recommended"><xref linkend="libxslt"/>
63 (<command>rarian-sk-extract</command> will not be built without this) and
64 <xref linkend="DocBook"/> (without this, <application>Rarian</application>
65 scripts source DTDs from the net)</para>
66
67 <para condition="html" role="usernotes">User Notes:
68 <ulink url="&blfs-wiki;/rarian"/></para>
69
70 </sect2>
71
72 <sect2 role="installation">
73 <title>Installation of Rarian</title>
74
75 <para>Install <application>Rarian</application> by running the following
76 commands:</para>
77
78<screen><userinput>./configure --prefix=/usr \
79 --localstatedir=/var &amp;&amp;
80make</userinput></screen>
81
82 <para>This package does not come with a test suite.</para>
83
84 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
85
86<screen role="root"><userinput>make install</userinput></screen>
87
88 </sect2>
89
90 <sect2 role="content">
91 <title>Contents</title>
92
93 <segmentedlist>
94 <segtitle>Installed Programs</segtitle>
95 <segtitle>Installed Library</segtitle>
96 <segtitle>Installed Directories</segtitle>
97
98 <seglistitem>
99 <seg>rarian-example, rarian-sk-config, rarian-sk-extract,
100 rarian-sk-gen-uuid, rarian-sk-get-cl, rarian-sk-get-content-list,
101 rarian-sk-get-extended-content-list, rarian-sk-get-scripts,
102 rarian-sk-install, rarian-sk-migrate, rarian-sk-preinstall,
103 rarian-sk-rebuild, and rarian-sk-update</seg>
104 <seg>librarian.{so,a}</seg>
105 <seg>/usr/include/rarian, /usr/share/help, /usr/share/librarian/manual,
106 /usr/share/librarian/Templates/C, and /usr/var/lib/rarian</seg>
107 </seglistitem>
108 </segmentedlist>
109
110 <variablelist>
111 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
112 <?dbfo list-presentation="list"?>
113 <?dbhtml list-presentation="table"?>
114
115 <varlistentry id="rarian-example">
116 <term><command>rarian-example</command></term>
117 <listitem>
118 <para>prints a nice list of all available documents found by the
119 library.</para>
120 <indexterm zone="rarian rarian-example">
121 <primary sortas="b-rarian-example">rarian-example</primary>
122 </indexterm>
123 </listitem>
124 </varlistentry>
125
126 <varlistentry id="rarian-sk-config">
127 <term><command>rarian-sk-config</command></term>
128 <listitem>
129 <para>emulates <command>scrollkeeper-config</command>.</para>
130 <indexterm zone="rarian rarian-sk-config">
131 <primary sortas="b-rarian-sk-config">rarian-sk-config</primary>
132 </indexterm>
133 </listitem>
134 </varlistentry>
135
136 <varlistentry id="rarian-sk-extract">
137 <term><command>rarian-sk-extract</command></term>
138 <listitem>
139 <para>is a wrapper around xsltproc to mimic <command>
140 scrollkeeper-extract</command>.</para>
141 <indexterm zone="rarian rarian-sk-extract">
142 <primary sortas="b-rarian-sk-extract">rarian-sk-extract</primary>
143 </indexterm>
144 </listitem>
145 </varlistentry>
146
147 <varlistentry id="rarian-sk-gen-uuid">
148 <term><command>rarian-sk-gen-uuid</command></term>
149 <listitem>
150 <para>generates a unique (random) uuid.</para>
151 <indexterm zone="rarian rarian-sk-gen-uuid">
152 <primary sortas="b-rarian-sk-gen-uuid">rarian-sk-gen-uuid</primary>
153 </indexterm>
154 </listitem>
155 </varlistentry>
156
157 <varlistentry id="rarian-sk-get-cl">
158 <term><command>rarian-sk-get-cl</command></term>
159 <listitem>
160 <para>gets a content list (category tree).</para>
161 <indexterm zone="rarian rarian-sk-get-cl">
162 <primary sortas="b-rarian-sk-get-cl">rarian-sk-get-cl</primary>
163 </indexterm>
164 </listitem>
165 </varlistentry>
166
167 <varlistentry id="rarian-sk-get-content-list">
168 <term><command>rarian-sk-get-content-list</command></term>
169 <listitem>
170 <para>is a simple wrapper to make calling <command>scrollkeeper-get-cl
171 </command> easier.</para>
172 <indexterm zone="rarian rarian-sk-get-content-list">
173 <primary sortas="b-rarian-sk-get-content-list">
174 rarian-sk-get-content-list</primary>
175
176 </indexterm>
177 </listitem>
178 </varlistentry>
179
180 <varlistentry id="rarian-sk-get-extended-content-list">
181 <term><command>rarian-sk-get-extended-content-list</command></term>
182 <listitem>
183 <para>is a simple wrapper to make calling <command>scrollkeeper-get-cl
184 </command> (extended) easier.</para>
185 <indexterm zone="rarian rarian-sk-get-extended-content-list">
186 <primary sortas="b-rarian-sk-get-extended-content-list">
187 rarian-sk-get-extended-content-list</primary>
188 </indexterm>
189 </listitem>
190 </varlistentry>
191
192 <varlistentry id="rarian-sk-get-scripts">
193 <term><command>rarian-sk-get-scripts</command></term>
194 <listitem>
195 <para><!-- Does nothing. -->
196 emulates <command>scrollkeeper-get-index-from-index-from-docpath</command>,
197 <command>scrollkeeper-get-toc-from-docpath</command>, and
198 <command>scrollkeeper-get-toc-from-id</command>.</para>
199 <indexterm zone="rarian rarian-sk-get-scripts">
200 <primary sortas="b-rarian-sk-get-scripts">rarian-sk-get-scripts</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 <varlistentry id="rarian-sk-install">
206 <term><command>rarian-sk-install</command></term>
207 <listitem>
208 <para><!--Does nothing.--> emulates <command>scrollkeeper-install
209 </command> and <command>scrollkeeper-uninstall</command>.</para>
210 <indexterm zone="rarian rarian-sk-install">
211 <primary sortas="b-rarian-sk-install">rarian-sk-install</primary>
212 </indexterm>
213 </listitem>
214 </varlistentry>
215
216 <varlistentry id="rarian-sk-migrate">
217 <term><command>rarian-sk-migrate</command></term>
218 <listitem>
219 <para>takes in a directory full of omf's, reads and parses them and
220 spews out an equivalent scroll file.</para>
221 <indexterm zone="rarian rarian-sk-migrate">
222 <primary sortas="b-rarian-sk-migrate">rarian-sk-migrate</primary>
223 </indexterm>
224 </listitem>
225 </varlistentry>
226
227 <varlistentry id="rarian-sk-preinstall">
228 <term><command>rarian-sk-preinstall</command></term>
229 <listitem>
230 <para>creates the omf file by reading an existing omf file and
231 replacing the url for a resource with the url.</para>
232 <indexterm zone="rarian rarian-sk-preinstall">
233 <primary sortas="b-rarian-sk-preinstall">rarian-sk-preinstall</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="rarian-sk-rebuild">
239 <term><command>rarian-sk-rebuild</command></term>
240 <listitem>
241 <para>is a simple wrapper script to emulate <command>
242 scrollkeeper-rebuilddb</command>.</para>
243 <indexterm zone="rarian rarian-sk-rebuild">
244 <primary sortas="b-rarian-sk-rebuild">rarian-sk-rebuild</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="rarian-sk-update">
250 <term><command>rarian-sk-update</command></term>
251 <listitem>
252 <para>is compatible with the <command>scrollkeeper-update</command>
253 script that's required to be run when installing new omf files. It
254 converts the omf files into new-style scrolls.</para>
255 <indexterm zone="rarian rarian-sk-update">
256 <primary sortas="b-rarian-sk-update">rarian-sk-update</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261
262 <varlistentry id="librarian">
263 <term><filename class='libraryfile'>librarian.{so,a}</filename></term>
264 <listitem>
265 <para>is the API to build a list of available meta data files and
266 allows access to these.</para>
267 <indexterm zone="rarian librarian">
268 <primary sortas="c-librarian">librarian.{so,a}</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 </variablelist>
274
275 </sect2>
276
277</sect1>
Note: See TracBrowser for help on using the repository browser.