summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorGergely Nagy <algernon@balabit.hu>2012-03-22 12:46:35 +0100
committerGergely Nagy <algernon@balabit.hu>2012-03-22 12:46:35 +0100
commit7e5af64a5a07a427a98d4ba2b73efd968230b050 (patch)
tree6ab5c77de7d98ea7212856d1a41eb0a04dfddd39 /README.rst
parent752618700ac94db3d8fd1ea8dfd9e1cb97a64e4e (diff)
downloadlibumberlog-7e5af64a5a07a427a98d4ba2b73efd968230b050.tar.gz
libumberlog-7e5af64a5a07a427a98d4ba2b73efd968230b050.tar.xz
libumberlog-7e5af64a5a07a427a98d4ba2b73efd968230b050.zip
README update
Removed the feature section, it's documented in the manual page, and it's enough to keep that up-to-date in one place. Signed-off-by: Gergely Nagy <algernon@balabit.hu>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst28
1 files changed, 4 insertions, 24 deletions
diff --git a/README.rst b/README.rst
index 403b992..363a872 100644
--- a/README.rst
+++ b/README.rst
@@ -4,31 +4,11 @@ libcee-syslog
The libcee-syslog library serves two purposes: it's either a drop-in
replacement for the ``syslog()`` system call, in which case it turns
the default syslog messages into CEE-enhanced messages, with a
-CEE-JSON payload, and some automatically discovered fields. Or, it can
-be used as a stand-alone library, that provides a ``syslog()``-like
-API, with the ability to add arbitrary key-value pairs to the
-resulting JSON payload.
+CEE-JSON payload, and some automatically discovered fields.
-Features
---------
-
-libcee-syslog is supposed to be a thin layer, that provides a few
-benefits over legacy ``syslog()``, within reason, and with
-limitations.
-
-* It overrides **openlog()**, to be able to store extra flags, and
- cache some stuff, if so need be. Currently, it caches the *pid* and
- the *ident*.
-* It overrides **syslog()** (and **vsyslog()**), but does NOT extend
- those APIs. It merely turns a legacy syslog message into something
- that has a CEE payload, and unless turned off, it adds a few
- automatically discovered fields.
-* It provides **cee_syslog()** (and **cee_vsyslog()**), which do the
- same as the `syslog()` call, have the same auto-discovery mechanism,
- but they also allow adding arbitrary key-value pairs.
-* It provides **cee_format()** (and **cee_vformat()**), which do the
- same as the syslog calls, except the result is a newly allocated
- string, that does not have a ``@cee:`` prefix.
+Or, it can be used as a stand-alone library, that provides a
+``syslog()``-like API, with the ability to add arbitrary key-value
+pairs to the resulting JSON payload.
Non-goals
---------