From ef6e7076b8a9845e16f5d30c48a3702017b7e4b4 Mon Sep 17 00:00:00 2001
From: Izaya <redtailedairways@gmail.com>
Date: Wed, 8 Aug 2018 08:58:29 +1000
Subject: [PATCH] added a readme to the OpenOS version of syslog

---
 syslog/OpenOS/README.md | 70 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 syslog/OpenOS/README.md

diff --git a/syslog/OpenOS/README.md b/syslog/OpenOS/README.md
new file mode 100644
index 0000000..c786f7f
--- /dev/null
+++ b/syslog/OpenOS/README.md
@@ -0,0 +1,70 @@
+# syslog for OpenOS
+
+This package contains a syslog library, and a syslog daemon, for OpenOS. These are separated, as the daemon is optional.
+
+## Installation
+
+### Library
+
+```
+oppm install libsyslog
+```
+
+### Daemon
+
+```
+oppm install syslogd
+```
+
+## Usage
+
+### Library
+
+The syslog library only provides one function, so the library can be called. In addition, the library provides a number of pre-configured event levels:
+
+ - syslog.emergency 
+ - syslog.alert 
+ - syslog.critical 
+ - syslog.error 
+ - syslog.warning 
+ - syslog.notice 
+ - syslog.info 
+ - syslog.debug 
+
+An example using syslog as both a function and a table:
+
+```
+local syslog = require "syslog"
+syslog("message", syslog.emergency, "service name")
+```
+
+### Daemon
+
+The syslog daemon lives in */etc/rc.d/syslogd.lua*, and as such is managed as an rc program:
+
+```
+rc syslogd enable
+rc syslogd start
+rc syslogd reload
+```
+
+In addition, the daemon keeps a configuration file in */etc/syslogd.cfg*. This is stored as a Lua table and may be edited in whatever way you see fit. It has the following fields and default values:
+
+ - port: 514
+ - relay: false
+ - relayhost: ""
+ - receive: false
+ - write: true
+ - destination: "/dev/null"
+ - minlevel: 6
+ - beeplevel: -1
+ - displevel: 2
+ - filter: {}
+
+## Technical details
+
+The syslog library and daemon communicate via events, namely a *syslog* event. The format is as follows:
+
+```
+"syslog", message, level, service
+```