summaryrefslogtreecommitdiff
path: root/src/lib/librelib.7.ronn
blob: 31164625f8ccfc81974845cd091063edc8717b7d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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 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) 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)