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