mirror of
https://github.com/Zeckmathederg/glfs.git
synced 2025-01-23 22:42:14 +08:00
335 lines
11 KiB
XML
335 lines
11 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|
<!ENTITY % general-entities SYSTEM "../../general.ent">
|
|
%general-entities;
|
|
|
|
<!ENTITY rarian-download-http "&gnome-download-http;/rarian/0.8/rarian-0.8.1.tar.bz2">
|
|
<!ENTITY rarian-download-ftp "&gnome-download-ftp;/rarian/0.8/rarian-0.8.1.tar.bz2">
|
|
<!ENTITY rarian-md5sum "75091185e13da67a0ff4279de1757b94">
|
|
<!ENTITY rarian-size "317 KB">
|
|
<!ENTITY rarian-buildsize "6 MB">
|
|
<!ENTITY rarian-time "0.2 SBU">
|
|
]>
|
|
|
|
<sect1 id="rarian" xreflabel="Rarian-&rarian-version;">
|
|
<?dbhtml filename="rarian.html"?>
|
|
|
|
|
|
<title>Rarian-&rarian-version;</title>
|
|
|
|
<indexterm zone="rarian">
|
|
<primary sortas="a-Rarian">Rarian</primary>
|
|
</indexterm>
|
|
|
|
<sect2 role="package">
|
|
<title>Introduction to Rarian</title>
|
|
|
|
<para>
|
|
The <application>Rarian</application> package is a documentation
|
|
metadata library based on the proposed Freedesktop.org spec. <application>
|
|
Rarian</application> is designed to be a replacement for <application>
|
|
ScrollKeeper</application>.
|
|
</para>
|
|
|
|
&lfs110a_checked;
|
|
|
|
<bridgehead renderas="sect3">Package Information</bridgehead>
|
|
<itemizedlist spacing="compact">
|
|
<listitem>
|
|
<para>
|
|
Download (HTTP): <ulink url="&rarian-download-http;"/>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download (FTP): <ulink url="&rarian-download-ftp;"/>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download MD5 sum: &rarian-md5sum;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Download size: &rarian-size;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Estimated disk space required: &rarian-buildsize;
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
Estimated build time: &rarian-time;
|
|
</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
<bridgehead renderas="sect3">Rarian Dependencies</bridgehead>
|
|
|
|
<bridgehead renderas="sect4">Recommended</bridgehead>
|
|
<para role="recommended">
|
|
<xref linkend="libxslt"/> (<command>rarian-sk-extract</command> will not
|
|
be built without this) and
|
|
<xref linkend="DocBook"/> (without this, <application>Rarian
|
|
</application> scripts source DTDs from the net)
|
|
</para>
|
|
|
|
<para condition="html" role="usernotes">User Notes:
|
|
<ulink url="&blfs-wiki;/rarian"/></para>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="installation">
|
|
<title>Installation of Rarian</title>
|
|
|
|
<para>
|
|
Install <application>Rarian</application> by running the following
|
|
commands:
|
|
</para>
|
|
|
|
<screen><userinput>./configure --prefix=/usr \
|
|
--disable-static \
|
|
--localstatedir=/var &&
|
|
make</userinput></screen>
|
|
|
|
<para>
|
|
This package does not come with a test suite.
|
|
</para>
|
|
|
|
<para>
|
|
Now, as the <systemitem class="username">root</systemitem> user:
|
|
</para>
|
|
|
|
<screen role="root"><userinput>make install</userinput></screen>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="commands">
|
|
<title>Command Explanations</title>
|
|
|
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
href="../../xincludes/static-libraries.xml"/>
|
|
|
|
</sect2>
|
|
|
|
<sect2 role="content">
|
|
<title>Contents</title>
|
|
|
|
<segmentedlist>
|
|
<segtitle>Installed Programs</segtitle>
|
|
<segtitle>Installed Library</segtitle>
|
|
<segtitle>Installed Directories</segtitle>
|
|
|
|
<seglistitem>
|
|
<seg>rarian-example, rarian-sk-config, rarian-sk-extract,
|
|
rarian-sk-gen-uuid, rarian-sk-get-cl, rarian-sk-get-content-list,
|
|
rarian-sk-get-extended-content-list, rarian-sk-get-scripts,
|
|
rarian-sk-install, rarian-sk-migrate, rarian-sk-preinstall,
|
|
rarian-sk-rebuild, and rarian-sk-update</seg>
|
|
<seg>librarian.so</seg>
|
|
<seg>/usr/include/rarian, /usr/share/help, /usr/share/librarian/manual,
|
|
/usr/share/librarian/Templates/C, and /var/lib/rarian</seg>
|
|
</seglistitem>
|
|
</segmentedlist>
|
|
|
|
<variablelist>
|
|
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|
<?dbfo list-presentation="list"?>
|
|
<?dbhtml list-presentation="table"?>
|
|
|
|
<varlistentry id="rarian-example">
|
|
<term><command>rarian-example</command></term>
|
|
<listitem>
|
|
<para>
|
|
prints a nice list of all available documents found by the
|
|
library
|
|
</para>
|
|
<indexterm zone="rarian rarian-example">
|
|
<primary sortas="b-rarian-example">rarian-example</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-config">
|
|
<term><command>rarian-sk-config</command></term>
|
|
<listitem>
|
|
<para>
|
|
emulates <command>scrollkeeper-config</command>
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-config">
|
|
<primary sortas="b-rarian-sk-config">rarian-sk-config</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-extract">
|
|
<term><command>rarian-sk-extract</command></term>
|
|
<listitem>
|
|
<para>
|
|
is a wrapper around xsltproc to mimic <command>
|
|
scrollkeeper-extract</command>
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-extract">
|
|
<primary sortas="b-rarian-sk-extract">rarian-sk-extract</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-gen-uuid">
|
|
<term><command>rarian-sk-gen-uuid</command></term>
|
|
<listitem>
|
|
<para>
|
|
generates a unique (random) uuid
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-gen-uuid">
|
|
<primary sortas="b-rarian-sk-gen-uuid">rarian-sk-gen-uuid</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-get-cl">
|
|
<term><command>rarian-sk-get-cl</command></term>
|
|
<listitem>
|
|
<para>
|
|
gets a content list (category tree)
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-get-cl">
|
|
<primary sortas="b-rarian-sk-get-cl">rarian-sk-get-cl</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-get-content-list">
|
|
<term><command>rarian-sk-get-content-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
is a simple wrapper to make calling <command>scrollkeeper-get-cl
|
|
</command> easier
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-get-content-list">
|
|
<primary sortas="b-rarian-sk-get-content-list">
|
|
rarian-sk-get-content-list</primary>
|
|
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-get-extended-content-list">
|
|
<term><command>rarian-sk-get-extended-content-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
is a simple wrapper to make calling <command>scrollkeeper-get-cl
|
|
</command> (extended) easier
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-get-extended-content-list">
|
|
<primary sortas="b-rarian-sk-get-extended-content-list">
|
|
rarian-sk-get-extended-content-list</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-get-scripts">
|
|
<term><command>rarian-sk-get-scripts</command></term>
|
|
<listitem>
|
|
<para>
|
|
emulates <command>
|
|
scrollkeeper-get-index-from-index-from-docpath</command>, <command>
|
|
scrollkeeper-get-toc-from-docpath</command>, and <command>
|
|
scrollkeeper-get-toc-from-id</command>
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-get-scripts">
|
|
<primary sortas="b-rarian-sk-get-scripts">rarian-sk-get-scripts</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-install">
|
|
<term><command>rarian-sk-install</command></term>
|
|
<listitem>
|
|
<para>
|
|
emulates <command>scrollkeeper-install</command> and
|
|
<command>scrollkeeper-uninstall</command>
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-install">
|
|
<primary sortas="b-rarian-sk-install">rarian-sk-install</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-migrate">
|
|
<term><command>rarian-sk-migrate</command></term>
|
|
<listitem>
|
|
<para>
|
|
takes in a directory full of omf's, reads and parses them and
|
|
spews out an equivalent scroll file
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-migrate">
|
|
<primary sortas="b-rarian-sk-migrate">rarian-sk-migrate</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-preinstall">
|
|
<term><command>rarian-sk-preinstall</command></term>
|
|
<listitem>
|
|
<para>
|
|
creates the omf file by reading an existing omf file and
|
|
replacing the url for a resource with the url
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-preinstall">
|
|
<primary sortas="b-rarian-sk-preinstall">rarian-sk-preinstall</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-rebuild">
|
|
<term><command>rarian-sk-rebuild</command></term>
|
|
<listitem>
|
|
<para>
|
|
is a simple wrapper script to emulate <command>
|
|
scrollkeeper-rebuilddb</command>
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-rebuild">
|
|
<primary sortas="b-rarian-sk-rebuild">rarian-sk-rebuild</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry id="rarian-sk-update">
|
|
<term><command>rarian-sk-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
is compatible with the <command>scrollkeeper-update</command>
|
|
script that's required to be run when installing new omf files. It
|
|
converts the omf files into new-style scrolls
|
|
</para>
|
|
<indexterm zone="rarian rarian-sk-update">
|
|
<primary sortas="b-rarian-sk-update">rarian-sk-update</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
|
|
<varlistentry id="librarian">
|
|
<term><filename class="libraryfile">librarian.{so,a}</filename></term>
|
|
<listitem>
|
|
<para>
|
|
is the API to build a list of available meta data files and
|
|
allows access to these
|
|
</para>
|
|
<indexterm zone="rarian librarian">
|
|
<primary sortas="c-librarian">librarian.{so,a}</primary>
|
|
</indexterm>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect2>
|
|
|
|
</sect1>
|