summaryrefslogtreecommitdiffstats
path: root/system/eventlog/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/eventlog/README')
-rw-r--r--system/eventlog/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/system/eventlog/README b/system/eventlog/README
new file mode 100644
index 0000000000..2a25c655ea
--- /dev/null
+++ b/system/eventlog/README
@@ -0,0 +1,10 @@
+The EventLog library aims to be a replacement of the simple syslog() API
+provided on UNIX systems. The major difference between EventLog and syslog
+is that EventLog tries to add structure to messages.
+
+Where you had a simple non-structrured string in syslog() you have a
+combination of description and tag/value pairs.
+
+EventLog provides an interface to build, format and output an event record.
+The exact format and output method can be customized by the administrator
+via a configuration file.