[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">
|
---|
[fce871e1] | 11 | <!ENTITY rarian-buildsize "6.0 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 | <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 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>Download (HTTP): <ulink url="&rarian-download-http;"/></para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>Download (FTP): <ulink url="&rarian-download-ftp;"/></para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download MD5 sum: &rarian-md5sum;</para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download size: &rarian-size;</para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Estimated disk space required: &rarian-buildsize;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Estimated build time: &rarian-time;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | </itemizedlist>
|
---|
| 58 |
|
---|
| 59 | <bridgehead renderas="sect3">Rarian Dependencies</bridgehead>
|
---|
| 60 |
|
---|
| 61 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[fce871e1] | 62 | <para role="recommended"><xref linkend="libxslt"/>
|
---|
| 63 | (rarian-sk-extract will not be built without this)</para>
|
---|
[2bc2e4a] | 64 |
|
---|
| 65 | <para condition="html" role="usernotes">User Notes:
|
---|
| 66 | <ulink url="&blfs-wiki;/rarian"/></para>
|
---|
| 67 |
|
---|
| 68 | </sect2>
|
---|
| 69 |
|
---|
| 70 | <sect2 role="installation">
|
---|
| 71 | <title>Installation of Rarian</title>
|
---|
| 72 |
|
---|
| 73 | <para>Install <application>Rarian</application> by running the following
|
---|
| 74 | commands:</para>
|
---|
| 75 |
|
---|
| 76 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 77 | make</userinput></screen>
|
---|
| 78 |
|
---|
| 79 | <para>This package does not come with a test suite.</para>
|
---|
| 80 |
|
---|
| 81 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 82 |
|
---|
| 83 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 84 |
|
---|
| 85 | </sect2>
|
---|
| 86 |
|
---|
| 87 | <sect2 role="content">
|
---|
| 88 | <title>Contents</title>
|
---|
| 89 |
|
---|
| 90 | <segmentedlist>
|
---|
| 91 | <segtitle>Installed Programs</segtitle>
|
---|
[7d1cb9fd] | 92 | <segtitle>Installed Library</segtitle>
|
---|
[2bc2e4a] | 93 | <segtitle>Installed Directories</segtitle>
|
---|
| 94 |
|
---|
| 95 | <seglistitem>
|
---|
| 96 | <seg>rarian-example, rarian-sk-config, rarian-sk-extract,
|
---|
| 97 | rarian-sk-gen-uuid, rarian-sk-get-cl, rarian-sk-get-content-list,
|
---|
| 98 | rarian-sk-get-extended-content-list, rarian-sk-get-scripts,
|
---|
| 99 | rarian-sk-install, rarian-sk-migrate, rarian-sk-preinstall,
|
---|
| 100 | rarian-sk-rebuild, and rarian-sk-update</seg>
|
---|
| 101 | <seg>librarian{so,a}</seg>
|
---|
| 102 | <seg>/usr/include/rarian, /usr/share/help, /usr/share/librarian/manual,
|
---|
| 103 | /usr/share/librarian/Templates/C, and /usr/var/lib/rarian</seg>
|
---|
| 104 | </seglistitem>
|
---|
| 105 | </segmentedlist>
|
---|
| 106 |
|
---|
| 107 | <variablelist>
|
---|
| 108 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 109 | <?dbfo list-presentation="list"?>
|
---|
| 110 | <?dbhtml list-presentation="table"?>
|
---|
| 111 |
|
---|
| 112 | <varlistentry id="rarian-example">
|
---|
| 113 | <term><command>rarian-example</command></term>
|
---|
| 114 | <listitem>
|
---|
[fce871e1] | 115 | <para>prints a nice list of all available documents found by the
|
---|
[2bc2e4a] | 116 | library.</para>
|
---|
| 117 | <indexterm zone="rarian rarian-example">
|
---|
| 118 | <primary sortas="b-rarian-example">rarian-example</primary>
|
---|
| 119 | </indexterm>
|
---|
| 120 | </listitem>
|
---|
| 121 | </varlistentry>
|
---|
| 122 |
|
---|
| 123 | <varlistentry id="rarian-sk-config">
|
---|
| 124 | <term><command>rarian-sk-config</command></term>
|
---|
| 125 | <listitem>
|
---|
[fce871e1] | 126 | <para>emulates scrollkeeper-config.</para>
|
---|
[2bc2e4a] | 127 | <indexterm zone="rarian rarian-sk-config">
|
---|
| 128 | <primary sortas="b-rarian-sk-config">rarian-sk-config</primary>
|
---|
| 129 | </indexterm>
|
---|
| 130 | </listitem>
|
---|
| 131 | </varlistentry>
|
---|
| 132 |
|
---|
| 133 | <varlistentry id="rarian-sk-extract">
|
---|
| 134 | <term><command>rarian-sk-extract</command></term>
|
---|
| 135 | <listitem>
|
---|
[fce871e1] | 136 | <para>is a wrapper around xsltproc to mimic scrollkeeper-extract.</para>
|
---|
[2bc2e4a] | 137 | <indexterm zone="rarian rarian-sk-extract">
|
---|
| 138 | <primary sortas="b-rarian-sk-extract">rarian-sk-extract</primary>
|
---|
| 139 | </indexterm>
|
---|
| 140 | </listitem>
|
---|
| 141 | </varlistentry>
|
---|
| 142 |
|
---|
| 143 | <varlistentry id="rarian-sk-gen-uuid">
|
---|
| 144 | <term><command>rarian-sk-gen-uuid</command></term>
|
---|
| 145 | <listitem>
|
---|
[fce871e1] | 146 | <para>generates a unique (random) uuid.</para>
|
---|
[2bc2e4a] | 147 | <indexterm zone="rarian rarian-sk-gen-uuid">
|
---|
| 148 | <primary sortas="b-rarian-sk-gen-uuid">rarian-sk-gen-uuid</primary>
|
---|
| 149 | </indexterm>
|
---|
| 150 | </listitem>
|
---|
| 151 | </varlistentry>
|
---|
| 152 |
|
---|
| 153 | <varlistentry id="rarian-sk-get-cl">
|
---|
| 154 | <term><command>rarian-sk-get-cl</command></term>
|
---|
| 155 | <listitem>
|
---|
[fce871e1] | 156 | <para>gets a content list (category tree).</para>
|
---|
[2bc2e4a] | 157 | <indexterm zone="rarian rarian-sk-get-cl">
|
---|
| 158 | <primary sortas="b-rarian-sk-get-cl">rarian-sk-get-cl</primary>
|
---|
| 159 | </indexterm>
|
---|
| 160 | </listitem>
|
---|
| 161 | </varlistentry>
|
---|
| 162 |
|
---|
| 163 | <varlistentry id="rarian-sk-get-content-list">
|
---|
| 164 | <term><command>rarian-sk-get-content-list</command></term>
|
---|
| 165 | <listitem>
|
---|
[fce871e1] | 166 | <para>is a simple wrapper to make calling scrollkeeper-get-cl easier.</para>
|
---|
[2bc2e4a] | 167 | <indexterm zone="rarian rarian-sk-get-content-list">
|
---|
| 168 | <primary sortas="b-rarian-sk-get-content-list">rarian-sk-get-content-list</primary>
|
---|
| 169 | </indexterm>
|
---|
| 170 | </listitem>
|
---|
| 171 | </varlistentry>
|
---|
| 172 |
|
---|
| 173 | <varlistentry id="rarian-sk-get-extended-content-list">
|
---|
| 174 | <term><command>rarian-sk-get-extended-content-list</command></term>
|
---|
| 175 | <listitem>
|
---|
[fce871e1] | 176 | <para>is a simple wrapper to make calling scrollkeeper-get-cl (extended) easier.</para>
|
---|
[2bc2e4a] | 177 | <indexterm zone="rarian rarian-sk-get-extended-content-list">
|
---|
| 178 | <primary sortas="b-rarian-sk-get-extended-content-list">rarian-sk-get-extended-content-list</primary>
|
---|
| 179 | </indexterm>
|
---|
| 180 | </listitem>
|
---|
| 181 | </varlistentry>
|
---|
| 182 |
|
---|
| 183 | <varlistentry id="rarian-sk-get-scripts">
|
---|
| 184 | <term><command>rarian-sk-get-scripts</command></term>
|
---|
| 185 | <listitem>
|
---|
[fce871e1] | 186 | <para><!-- Does nothing. -->
|
---|
| 187 | emulates scrollkeeper-get-index-from-index-from-docpath,
|
---|
[2bc2e4a] | 188 | scrollkeeper-get-toc-from-docpath, and
|
---|
| 189 | scrollkeeper-get-toc-from-id.</para>
|
---|
| 190 | <indexterm zone="rarian rarian-sk-get-scripts">
|
---|
| 191 | <primary sortas="b-rarian-sk-get-scripts">rarian-sk-get-scripts</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
| 196 | <varlistentry id="rarian-sk-install">
|
---|
| 197 | <term><command>rarian-sk-install</command></term>
|
---|
| 198 | <listitem>
|
---|
[fce871e1] | 199 | <para><!--Does nothing.--> emulates scrollkeeper-install and scrollkeeper-uninstall.</para>
|
---|
[2bc2e4a] | 200 | <indexterm zone="rarian rarian-sk-install">
|
---|
| 201 | <primary sortas="b-rarian-sk-install">rarian-sk-install</primary>
|
---|
| 202 | </indexterm>
|
---|
| 203 | </listitem>
|
---|
| 204 | </varlistentry>
|
---|
| 205 |
|
---|
| 206 | <varlistentry id="rarian-sk-migrate">
|
---|
| 207 | <term><command>rarian-sk-migrate</command></term>
|
---|
| 208 | <listitem>
|
---|
[fce871e1] | 209 | <para>takes in a directory full of omf's, reads and parses them and
|
---|
| 210 | spews out an equivalent scroll file.</para>
|
---|
[2bc2e4a] | 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>
|
---|
[fce871e1] | 220 | <para>creates the omf file by reading an existing omf file and
|
---|
[2bc2e4a] | 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>
|
---|
[fce871e1] | 231 | <para>is a simple wrapper script to emulate scrollkeeper-rebuilddb.</para>
|
---|
[2bc2e4a] | 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>
|
---|
[fce871e1] | 241 | <para>is compatible with the scrollkeeper-update script that's
|
---|
[2bc2e4a] | 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>
|
---|
[fce871e1] | 254 | <para>is the API to build a list of available meta data files and
|
---|
| 255 | allows access to these.</para>
|
---|
[2bc2e4a] | 256 | <indexterm zone="rarian librarian">
|
---|
| 257 | <primary sortas="c-librarian">librarian.{so,a}</primary>
|
---|
| 258 | </indexterm>
|
---|
| 259 | </listitem>
|
---|
| 260 | </varlistentry>
|
---|
| 261 |
|
---|
| 262 | </variablelist>
|
---|
| 263 |
|
---|
| 264 | </sect2>
|
---|
| 265 |
|
---|
| 266 | </sect1>
|
---|