Permalink
Browse files

Merge branch 'vinoski-sv-driver-tweaks'

  • Loading branch information...
2 parents 8c086e3 + 7e45ff5 commit cdff9409333c50f995e9ed2057d2ee644d017279 @Vagabond committed Dec 11, 2012
Showing with 374 additions and 228 deletions.
  1. +27 −10 README.md
  2. +190 −121 c_src/syslog_drv.c
  3. +2 −2 src/syslog.app.src
  4. +154 −93 src/syslog.erl
  5. +1 −2 src/syslog_sup.erl
View
@@ -12,11 +12,11 @@ Installing it
Trying it
---------
-You should have a look at syslog.h
+You should have a look at syslog.h.
-In an other shell :
+In another shell :
- $ tail -f /var/log/sylsog
+ $ tail -f /var/log/syslog
Or, for mac users :
@@ -26,15 +26,16 @@ In erlang shell :
$ erl
> syslog:start().
- > syslog:open("Beuha", [cons, perror, pid], local0).
- > syslog:log(err, "Damned").
+ > {ok,Log} = syslog:open("Beuha", [cons, perror, pid], local0).
+ > syslog:log(Log, err, "Damned").
+ > syslog:log(Log, info, "process count: ~w", [length(processes())]).
API
---
-### syslog:open(Ident, Logopt, Facility) ###
+### syslog:open(Ident, Logopt, Facility) -> {ok, port()} ###
-_Ident_ is an arbitrary string
+_Ident_ is an arbitrary string
_Logopt_ is an atom or array of atom, you can use a number if you're brave enough :
* pid
@@ -70,8 +71,13 @@ _Facility_ is an atom :
* local6
* local7
-### syslog:log(Priority, Message) ###
+The `open` call returns either `{ok, Log}` where _Log_ is a syslog handle
+that can be passed to subsequent `log` and `close` calls, or it will throw
+{error, badarg}.
+### syslog:log(Log, Priority, Message) -> ok ###
+
+_Log_ is a syslog handle returned from `open`
_Priority_ can be a number or better, an atom :
* emerg
@@ -83,9 +89,20 @@ _Priority_ can be a number or better, an atom :
* info
* debug
-_Message_ is a String
+_Message_ is a string.
+
+### syslog:log(Log, Priority, FormatMsg, FormatArgs) -> ok ###
+
+Same as above, but allows for the construction of log messages similar to
+formatting strings via `io_lib:format/2`, where _FormatMsg_ indicates the
+formatting instructions and _FormatArgs_ is a list of arguments to be
+formatted.
+
+### syslog:close(Log) -> ok ###
+
+_Log_ is a syslog handle returned from `open`
BUGS
----
- * Not a full OTP application
+ * None known
Oops, something went wrong.

0 comments on commit cdff940

Please sign in to comment.