diff options
Diffstat (limited to 'src/lib/librelib.7.ronn')
| -rw-r--r-- | src/lib/librelib.7.ronn | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/src/lib/librelib.7.ronn b/src/lib/librelib.7.ronn new file mode 100644 index 0000000..33b0c55 --- /dev/null +++ b/src/lib/librelib.7.ronn @@ -0,0 +1,49 @@ +librelib(7) -- Suite of Bash libraries +====================================== + +## SYNOPSIS + +Overview of 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 `/usr/bin` + +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) libraries 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) |