[hcoop/debian/mlton.git] / doc / guide / src / MLtonSyslog.adoc

MLtonSyslog
===========

[source,sml]
----
signature MLTON_SYSLOG =
   sig
      type openflag

      val CONS     : openflag
      val NDELAY   : openflag
      val NOWAIT   : openflag
      val ODELAY   : openflag
      val PERROR   : openflag
      val PID      : openflag

      type facility

      val AUTHPRIV : facility
      val CRON     : facility
      val DAEMON   : facility
      val KERN     : facility
      val LOCAL0   : facility
      val LOCAL1   : facility
      val LOCAL2   : facility
      val LOCAL3   : facility
      val LOCAL4   : facility
      val LOCAL5   : facility
      val LOCAL6   : facility
      val LOCAL7   : facility
      val LPR      : facility
      val MAIL     : facility
      val NEWS     : facility
      val SYSLOG   : facility
      val USER     : facility
      val UUCP     : facility

      type loglevel

      val EMERG    : loglevel
      val ALERT    : loglevel
      val CRIT     : loglevel
      val ERR      : loglevel
      val WARNING  : loglevel
      val NOTICE   : loglevel
      val INFO     : loglevel
      val DEBUG    : loglevel

      val closelog: unit -> unit
      val log: loglevel * string -> unit
      val openlog: string * openflag list * facility -> unit
   end
----

`MLton.Syslog` is a complete interface to the system logging
facilities.  See `man 3 syslog` for more details.

* `closelog ()`
+
closes the connection to the system logger.

* `log (l, s)`
+
logs message `s` at a loglevel `l`.

* `openlog (name, flags, facility)`
+
opens a connection to the system logger. `name` will be prefixed to
each message, and is typically set to the program name.
Commit	Line	Data
7f918cf1 CE	1	MLtonSyslog
	2	===========
	3
	4	[source,sml]
	5	----
	6	signature MLTON_SYSLOG =
	7	sig
	8	type openflag
	9
	10	val CONS : openflag
	11	val NDELAY : openflag
	12	val NOWAIT : openflag
	13	val ODELAY : openflag
	14	val PERROR : openflag
	15	val PID : openflag
	16
	17	type facility
	18
	19	val AUTHPRIV : facility
	20	val CRON : facility
	21	val DAEMON : facility
	22	val KERN : facility
	23	val LOCAL0 : facility
	24	val LOCAL1 : facility
	25	val LOCAL2 : facility
	26	val LOCAL3 : facility
	27	val LOCAL4 : facility
	28	val LOCAL5 : facility
	29	val LOCAL6 : facility
	30	val LOCAL7 : facility
	31	val LPR : facility
	32	val MAIL : facility
	33	val NEWS : facility
	34	val SYSLOG : facility
	35	val USER : facility
	36	val UUCP : facility
	37
	38	type loglevel
	39
	40	val EMERG : loglevel
	41	val ALERT : loglevel
	42	val CRIT : loglevel
	43	val ERR : loglevel
	44	val WARNING : loglevel
	45	val NOTICE : loglevel
	46	val INFO : loglevel
	47	val DEBUG : loglevel
	48
	49	val closelog: unit -> unit
	50	val log: loglevel * string -> unit
	51	val openlog: string * openflag list * facility -> unit
	52	end
	53	----
	54
	55	`MLton.Syslog` is a complete interface to the system logging
	56	facilities. See `man 3 syslog` for more details.
	57
	58	* `closelog ()`
	59	+
	60	closes the connection to the system logger.
	61
	62	* `log (l, s)`
	63	+
	64	logs message `s` at a loglevel `l`.
65
66	* `openlog (name, flags, facility)`
67	+
68	opens a connection to the system logger. `name` will be prefixed to
69	each message, and is typically set to the program name.