r7883 - in trunk/BOOK: . general/genutils introduction/welcome

wblaszcz at linuxfromscratch.org wblaszcz at linuxfromscratch.org
Mon Jul 27 06:22:42 PDT 2009


Author: wblaszcz
Date: 2009-07-27 07:22:42 -0600 (Mon, 27 Jul 2009)
New Revision: 7883

Added:
   trunk/BOOK/general/genutils/rarian.xml
Modified:
   trunk/BOOK/general.ent
   trunk/BOOK/general/genutils/genutils.xml
   trunk/BOOK/introduction/welcome/changelog.xml
Log:
New package Rarian-0.8.1

Modified: trunk/BOOK/general/genutils/genutils.xml
===================================================================
--- trunk/BOOK/general/genutils/genutils.xml	2009-07-27 12:49:39 UTC (rev 7882)
+++ trunk/BOOK/general/genutils/genutils.xml	2009-07-27 13:22:42 UTC (rev 7883)
@@ -42,5 +42,6 @@
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="rxvt-unicode.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="pinentry.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="gperf.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="rarian.xml"/>
 
 </chapter>

Added: trunk/BOOK/general/genutils/rarian.xml
===================================================================
--- trunk/BOOK/general/genutils/rarian.xml	                        (rev 0)
+++ trunk/BOOK/general/genutils/rarian.xml	2009-07-27 13:22:42 UTC (rev 7883)
@@ -0,0 +1,265 @@
+<?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 "http://ftp.gnome.org/pub/gnome/sources/rarian/0.8/rarian-0.8.1.tar.bz2">
+  <!ENTITY rarian-download-ftp  "ftp://ftp.gnome.org/pub/gnome/sources/rarian/0.8/rarian-0.8.1.tar.bz2">
+  <!ENTITY rarian-md5sum        "75091185e13da67a0ff4279de1757b94">
+  <!ENTITY rarian-size          "317 KB">
+  <!ENTITY rarian-buildsize     "5.9 MB">
+  <!ENTITY rarian-time          "0.2 SBU">
+
+<!ENTITY TEMPLATE-version          "TEMPLATE-version">
+]>
+
+<sect1 id="rarian" xreflabel="Rarian-&rarian-version;">
+  <?dbhtml filename="rarian.html"?>
+
+  <sect1info>
+    <othername>$LastChangedBy$</othername>
+    <date>$Date$</date>
+  </sect1info>
+
+  <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>
+
+    <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"/> (rarian-sk-extract will not be built without this)</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 &&
+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="content">
+    <title>Contents</title>
+
+    <segmentedlist>
+      <segtitle>Installed Programs</segtitle>
+      <segtitle>Installed Libraries</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,a}</seg>
+        <seg>/usr/include/rarian, /usr/share/help, /usr/share/librarian/manual,
+        /usr/share/librarian/Templates/C, and /usr/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 scrollkeeper-config.</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>Wrapper around xsltproc to mimic scrollkeeper-extract.</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>Simple wrapper to make calling scrollkeeper-get-cl 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>Simple wrapper to make calling scrollkeeper-get-cl (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>Does nothing.
+          Emulates scrollkeeper-get-index-from-index-from-docpath,
+          scrollkeeper-get-toc-from-docpath, and
+          scrollkeeper-get-toc-from-id.</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>Does nothing. Emulates scrollkeeper-install and scrollkeeper-uninstall.</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>Simple wrapper script to emulate scrollkeeper-rebuilddb.</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>This is compatible with the scrollkeeper-update 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>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>


Property changes on: trunk/BOOK/general/genutils/rarian.xml
___________________________________________________________________
Name: svn:keywords
   + LastChangedBy Date

Modified: trunk/BOOK/general.ent
===================================================================
--- trunk/BOOK/general.ent	2009-07-27 12:49:39 UTC (rev 7882)
+++ trunk/BOOK/general.ent	2009-07-27 13:22:42 UTC (rev 7883)
@@ -204,6 +204,7 @@
 <!ENTITY rxvt-unicode-version         "9.06">
 <!ENTITY pinentry-version             "0.7.3">
 <!ENTITY gperf-version                "3.0.3">
+<!ENTITY rarian-version               "0.8.1">
 
 <!-- Chapter 11 -->
 <!ENTITY gpm-version                  "1.20.6">

Modified: trunk/BOOK/introduction/welcome/changelog.xml
===================================================================
--- trunk/BOOK/introduction/welcome/changelog.xml	2009-07-27 12:49:39 UTC (rev 7882)
+++ trunk/BOOK/introduction/welcome/changelog.xml	2009-07-27 13:22:42 UTC (rev 7883)
@@ -49,6 +49,9 @@
         <listitem>
           <para>[gdalziel] - Updated to libusb-1.0.2.</para>
         </listitem>
+        <listitem>
+          <para>[wblaszcz] - Added new package. Rarian-0.8.1</para>
+        </listitem>
       </itemizedlist>
     </listitem>
 




More information about the blfs-book mailing list