source: general/genutils/rarian.xml@ cf3ddc0c

10.0 10.1 11.0 11.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 krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since cf3ddc0c was cf3ddc0c, checked in by Bruce Dubbs <bdubbs@…>, 11 years ago

Updated to gtk-doc-1.18

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