source: general/genutils/rarian.xml@ 300b4ee

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

Check some office stuff. Minor fixes for some packages. Merged trunk.

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