Beyond Linux® From Scratch (systemd Edition) - Version 9.1

Chapter 11. General Utilities

Rarian-0.8.1

Introduction to Rarian

The Rarian package is a documentation metadata library based on the proposed Freedesktop.org spec. Rarian is designed to be a replacement for ScrollKeeper.

This package is known to build and work properly using an LFS-9.1 platform.

Package Information

Rarian Dependencies

Recommended

libxslt-1.1.34 (rarian-sk-extract will not be built without this) and docbook-xml-4.5 (without this, Rarian scripts source DTDs from the net)

User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/rarian

Installation of Rarian

Install Rarian by running the following commands: 

./configure --prefix=/usr        \
            --disable-static     \
            --localstatedir=/var &&
make

This package does not come with a test suite.

Now, as the root user: 

make install

Command Explanations

--disable-static: This switch prevents installation of static versions of the libraries.

Contents

Installed Programs: 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
Installed Library: librarian.so
Installed Directories: /usr/include/rarian, /usr/share/help, /usr/share/librarian/manual, /usr/share/librarian/Templates/C, and /var/lib/rarian

Short Descriptions

rarian-example

prints a nice list of all available documents found by the library.

rarian-sk-config

emulates scrollkeeper-config.

rarian-sk-extract

is a wrapper around xsltproc to mimic scrollkeeper-extract.

rarian-sk-gen-uuid

generates a unique (random) uuid.

rarian-sk-get-cl

gets a content list (category tree).

rarian-sk-get-content-list

is a simple wrapper to make calling scrollkeeper-get-cl easier.

rarian-sk-get-extended-content-list

is a simple wrapper to make calling scrollkeeper-get-cl (extended) easier.

rarian-sk-get-scripts

emulates scrollkeeper-get-index-from-index-from-docpath, scrollkeeper-get-toc-from-docpath, and scrollkeeper-get-toc-from-id.

rarian-sk-install

emulates scrollkeeper-install and scrollkeeper-uninstall.

rarian-sk-migrate

takes in a directory full of omf's, reads and parses them and spews out an equivalent scroll file.

rarian-sk-preinstall

creates the omf file by reading an existing omf file and replacing the url for a resource with the url.

rarian-sk-rebuild

is a simple wrapper script to emulate scrollkeeper-rebuilddb.

rarian-sk-update

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.

librarian.{so,a}

is the API to build a list of available meta data files and allows access to these.

Last updated on 2020-02-19 16:31:22 -0800