From f5b650a06cddd447ad7a75330e9e9c6baf23ccc4 Mon Sep 17 00:00:00 2001
From: Luke Shumaker <LukeShu@sbcglobal.net>
Date: Wed, 2 Oct 2013 15:32:45 -0400
Subject: Add documentation for lib/

 * Add a bunch of man-pages
 * Add some comments to conf.sh
 * Add more information to librelib:usage()
---
 src/lib/librelib.7.ronn | 50 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 src/lib/librelib.7.ronn

(limited to 'src/lib/librelib.7.ronn')

diff --git a/src/lib/librelib.7.ronn b/src/lib/librelib.7.ronn
new file mode 100644
index 0000000..e030f6a
--- /dev/null
+++ b/src/lib/librelib.7.ronn
@@ -0,0 +1,50 @@
+librelib(7) -- Suite of Bash libraries
+======================================
+
+## SYNOPSIS
+
+Overview ot the librelib Bash library suite.
+
+## DESCRIPTION
+
+There are three parts to librelib:
+
+ 1. The `librelib`(1) executable.
+ 2. The non-executable libraries installed in `/usr/lib/libretools`
+ 3. The executable libraries installed in both `/usr/bin` and
+    `/usr/lib/libretools`.
+
+The `librelib` executable isn't very exciting, it just finds the
+libraries installed in `/usr/lib/libretools`.  Think of it as a sort
+of dynamic-linker.
+
+The 'core' of librelib are the libraries installed in
+`/usr/lib/libretools`.  These are `Bash`(1) libaries that may be sourced in
+Bash programs.
+
+Some of these libraries also make sense as stand-alone programs, where
+if they are invoked directly, the first argument is the library
+routine to be executed.  For example, the `messages` library may be
+included, or executed:
+
+	. $(librelib messages)
+	msg2 "Foo was found: %s" "$foo"
+	# or
+	libremessages msg2 "Foo was found: %s" "$foo"
+
+The `blacklist` library is similar:
+
+	. $(librelib blacklist)
+	blacklist-update
+	# or
+	libreblacklist update
+
+
+
+## SEE ALSO
+
+ * librelib(1)
+ * libremessages(1)/messages.sh(3)
+ * libreblacklist(1)/blacklist.sh(3)
+ * conf.sh(3)
+ * common.sh(3)
-- 
cgit v1.2.3-54-g00ecf