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