summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorGergely Nagy <algernon@balabit.hu>2012-03-22 13:44:59 +0100
committerGergely Nagy <algernon@balabit.hu>2012-03-22 13:44:59 +0100
commitb9721cce33d958bf31d763ece24a71d653ae15a9 (patch)
treeca59403b79fe98c796913d6104d83e833fe004b0 /README.rst
parentf2138b1e90bb11208b45a1050e769d60a2fcf45d (diff)
downloadlibumberlog-b9721cce33d958bf31d763ece24a71d653ae15a9.tar.gz
libumberlog-b9721cce33d958bf31d763ece24a71d653ae15a9.tar.xz
libumberlog-b9721cce33d958bf31d763ece24a71d653ae15a9.zip
README.rst: Add an usage section
Signed-off-by: Gergely Nagy <algernon@balabit.hu>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 79a7a50..23d1d1e 100644
--- a/README.rst
+++ b/README.rst
@@ -39,6 +39,19 @@ The library follows the usual autotools way of installation:
$ ./autogen.sh
$ ./configure && make && make install
+Usage
+-----
+
+The library can either be used as an LD_PRELOAD-able shared object, in
+which case it overrides the system-supplied syslog() calls with its
+own, or as a proper library. In the latter case, please see the
+libcee-syslog(3) manual page for more information.
+
+In the former case, using the library is as easy as setting LD_PRELOAD
+prior to executing a program (if one wants to control this on a
+per-program basis), or adding the path to the installed library to
+``/etc/ld.so.preload``.
+
License
-------