source: general/genutils/rarian.xml@ 242345d

7.6-blfs 7.6-systemd kde5-14269 kde5-14686 systemd-13485
Last change on this file since 242345d was 242345d, checked in by Krejzi <krejzi@…>, 8 years ago

Remove some static libs.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@14084 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 10.4 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 &lfs76_checked;
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"/>
65 (<command>rarian-sk-extract</command> will not be built without this) and
66 <xref linkend="DocBook"/> (without this, <application>Rarian</application>
67 scripts source DTDs from the net)</para>
68
69 <para condition="html" role="usernotes">User Notes:
70 <ulink url="&blfs-wiki;/rarian"/></para>
71
72 </sect2>
73
74 <sect2 role="installation">
75 <title>Installation of Rarian</title>
76
77 <para>Install <application>Rarian</application> by running the following
78 commands:</para>
79
80<screen><userinput>./configure --prefix=/usr \
81 --localstatedir=/var \
82 --disable-static &amp;&amp;
83make</userinput></screen>
84
85 <para>This package does not come with a test suite.</para>
86
87 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
88
89<screen role="root"><userinput>make install</userinput></screen>
90
91 </sect2>
92
93 <sect2 role="commands">
94 <title>Command Explanations</title>
95
96 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
97 href="../../xincludes/static-libraries.xml"/>
98
99 </sect2>
100
101 <sect2 role="content">
102 <title>Contents</title>
103
104 <segmentedlist>
105 <segtitle>Installed Programs</segtitle>
106 <segtitle>Installed Library</segtitle>
107 <segtitle>Installed Directories</segtitle>
108
109 <seglistitem>
110 <seg>rarian-example, rarian-sk-config, rarian-sk-extract,
111 rarian-sk-gen-uuid, rarian-sk-get-cl, rarian-sk-get-content-list,
112 rarian-sk-get-extended-content-list, rarian-sk-get-scripts,
113 rarian-sk-install, rarian-sk-migrate, rarian-sk-preinstall,
114 rarian-sk-rebuild, and rarian-sk-update</seg>
115 <seg>librarian.so</seg>
116 <seg>/usr/include/rarian, /usr/share/help, /usr/share/librarian/manual,
117 /usr/share/librarian/Templates/C, and /usr/var/lib/rarian</seg>
118 </seglistitem>
119 </segmentedlist>
120
121 <variablelist>
122 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
123 <?dbfo list-presentation="list"?>
124 <?dbhtml list-presentation="table"?>
125
126 <varlistentry id="rarian-example">
127 <term><command>rarian-example</command></term>
128 <listitem>
129 <para>prints a nice list of all available documents found by the
130 library.</para>
131 <indexterm zone="rarian rarian-example">
132 <primary sortas="b-rarian-example">rarian-example</primary>
133 </indexterm>
134 </listitem>
135 </varlistentry>
136
137 <varlistentry id="rarian-sk-config">
138 <term><command>rarian-sk-config</command></term>
139 <listitem>
140 <para>emulates <command>scrollkeeper-config</command>.</para>
141 <indexterm zone="rarian rarian-sk-config">
142 <primary sortas="b-rarian-sk-config">rarian-sk-config</primary>
143 </indexterm>
144 </listitem>
145 </varlistentry>
146
147 <varlistentry id="rarian-sk-extract">
148 <term><command>rarian-sk-extract</command></term>
149 <listitem>
150 <para>is a wrapper around xsltproc to mimic <command>
151 scrollkeeper-extract</command>.</para>
152 <indexterm zone="rarian rarian-sk-extract">
153 <primary sortas="b-rarian-sk-extract">rarian-sk-extract</primary>
154 </indexterm>
155 </listitem>
156 </varlistentry>
157
158 <varlistentry id="rarian-sk-gen-uuid">
159 <term><command>rarian-sk-gen-uuid</command></term>
160 <listitem>
161 <para>generates a unique (random) uuid.</para>
162 <indexterm zone="rarian rarian-sk-gen-uuid">
163 <primary sortas="b-rarian-sk-gen-uuid">rarian-sk-gen-uuid</primary>
164 </indexterm>
165 </listitem>
166 </varlistentry>
167
168 <varlistentry id="rarian-sk-get-cl">
169 <term><command>rarian-sk-get-cl</command></term>
170 <listitem>
171 <para>gets a content list (category tree).</para>
172 <indexterm zone="rarian rarian-sk-get-cl">
173 <primary sortas="b-rarian-sk-get-cl">rarian-sk-get-cl</primary>
174 </indexterm>
175 </listitem>
176 </varlistentry>
177
178 <varlistentry id="rarian-sk-get-content-list">
179 <term><command>rarian-sk-get-content-list</command></term>
180 <listitem>
181 <para>is a simple wrapper to make calling <command>scrollkeeper-get-cl
182 </command> easier.</para>
183 <indexterm zone="rarian rarian-sk-get-content-list">
184 <primary sortas="b-rarian-sk-get-content-list">
185 rarian-sk-get-content-list</primary>
186
187 </indexterm>
188 </listitem>
189 </varlistentry>
190
191 <varlistentry id="rarian-sk-get-extended-content-list">
192 <term><command>rarian-sk-get-extended-content-list</command></term>
193 <listitem>
194 <para>is a simple wrapper to make calling <command>scrollkeeper-get-cl
195 </command> (extended) easier.</para>
196 <indexterm zone="rarian rarian-sk-get-extended-content-list">
197 <primary sortas="b-rarian-sk-get-extended-content-list">
198 rarian-sk-get-extended-content-list</primary>
199 </indexterm>
200 </listitem>
201 </varlistentry>
202
203 <varlistentry id="rarian-sk-get-scripts">
204 <term><command>rarian-sk-get-scripts</command></term>
205 <listitem>
206 <para><!-- Does nothing. -->
207 emulates <command>scrollkeeper-get-index-from-index-from-docpath</command>,
208 <command>scrollkeeper-get-toc-from-docpath</command>, and
209 <command>scrollkeeper-get-toc-from-id</command>.</para>
210 <indexterm zone="rarian rarian-sk-get-scripts">
211 <primary sortas="b-rarian-sk-get-scripts">rarian-sk-get-scripts</primary>
212 </indexterm>
213 </listitem>
214 </varlistentry>
215
216 <varlistentry id="rarian-sk-install">
217 <term><command>rarian-sk-install</command></term>
218 <listitem>
219 <para><!--Does nothing.--> emulates <command>scrollkeeper-install
220 </command> and <command>scrollkeeper-uninstall</command>.</para>
221 <indexterm zone="rarian rarian-sk-install">
222 <primary sortas="b-rarian-sk-install">rarian-sk-install</primary>
223 </indexterm>
224 </listitem>
225 </varlistentry>
226
227 <varlistentry id="rarian-sk-migrate">
228 <term><command>rarian-sk-migrate</command></term>
229 <listitem>
230 <para>takes in a directory full of omf's, reads and parses them and
231 spews out an equivalent scroll file.</para>
232 <indexterm zone="rarian rarian-sk-migrate">
233 <primary sortas="b-rarian-sk-migrate">rarian-sk-migrate</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="rarian-sk-preinstall">
239 <term><command>rarian-sk-preinstall</command></term>
240 <listitem>
241 <para>creates the omf file by reading an existing omf file and
242 replacing the url for a resource with the url.</para>
243 <indexterm zone="rarian rarian-sk-preinstall">
244 <primary sortas="b-rarian-sk-preinstall">rarian-sk-preinstall</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="rarian-sk-rebuild">
250 <term><command>rarian-sk-rebuild</command></term>
251 <listitem>
252 <para>is a simple wrapper script to emulate <command>
253 scrollkeeper-rebuilddb</command>.</para>
254 <indexterm zone="rarian rarian-sk-rebuild">
255 <primary sortas="b-rarian-sk-rebuild">rarian-sk-rebuild</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="rarian-sk-update">
261 <term><command>rarian-sk-update</command></term>
262 <listitem>
263 <para>is compatible with the <command>scrollkeeper-update</command>
264 script that's required to be run when installing new omf files. It
265 converts the omf files into new-style scrolls.</para>
266 <indexterm zone="rarian rarian-sk-update">
267 <primary sortas="b-rarian-sk-update">rarian-sk-update</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272
273 <varlistentry id="librarian">
274 <term><filename class='libraryfile'>librarian.so</filename></term>
275 <listitem>
276 <para>is the API to build a list of available meta data files and
277 allows access to these.</para>
278 <indexterm zone="rarian librarian">
279 <primary sortas="c-librarian">librarian.so</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 </variablelist>
285
286 </sect2>
287
288</sect1>
Note: See TracBrowser for help on using the repository browser.