Import Upstream version 20180207
[hcoop/debian/mlton.git] / doc / guide / localhost / MLtonSyslog
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <meta name="generator" content="AsciiDoc 8.6.9">
6 <title>MLtonSyslog</title>
7 <link rel="stylesheet" href="./asciidoc.css" type="text/css">
8 <link rel="stylesheet" href="./pygments.css" type="text/css">
9
10
11 <script type="text/javascript" src="./asciidoc.js"></script>
12 <script type="text/javascript">
13 /*<![CDATA[*/
14 asciidoc.install();
15 /*]]>*/
16 </script>
17 <link rel="stylesheet" href="./mlton.css" type="text/css">
18 </head>
19 <body class="article">
20 <div id="banner">
21 <div id="banner-home">
22 <a href="./Home">MLton 20180207</a>
23 </div>
24 </div>
25 <div id="header">
26 <h1>MLtonSyslog</h1>
27 </div>
28 <div id="content">
29 <div id="preamble">
30 <div class="sectionbody">
31 <div class="listingblock">
32 <div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">MLTON_SYSLOG</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
33 <span class="w"> </span><span class="k">sig</span><span class="w"></span>
34 <span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">openflag</span><span class="w"></span>
35
36 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">CONS</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">openflag</span><span class="w"></span>
37 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">NDELAY</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">openflag</span><span class="w"></span>
38 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">NOWAIT</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">openflag</span><span class="w"></span>
39 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">ODELAY</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">openflag</span><span class="w"></span>
40 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">PERROR</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">openflag</span><span class="w"></span>
41 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">PID</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">openflag</span><span class="w"></span>
42
43 <span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
44
45 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">AUTHPRIV</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
46 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">CRON</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
47 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">DAEMON</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
48 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">KERN</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
49 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">LOCAL0</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
50 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">LOCAL1</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
51 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">LOCAL2</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
52 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">LOCAL3</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
53 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">LOCAL4</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
54 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">LOCAL5</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
55 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">LOCAL6</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
56 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">LOCAL7</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
57 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">LPR</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
58 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">MAIL</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
59 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">NEWS</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
60 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">SYSLOG</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
61 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">USER</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
62 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">UUCP</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">facility</span><span class="w"></span>
63
64 <span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">loglevel</span><span class="w"></span>
65
66 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">EMERG</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">loglevel</span><span class="w"></span>
67 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">ALERT</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">loglevel</span><span class="w"></span>
68 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">CRIT</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">loglevel</span><span class="w"></span>
69 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">ERR</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">loglevel</span><span class="w"></span>
70 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">WARNING</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">loglevel</span><span class="w"></span>
71 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">NOTICE</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">loglevel</span><span class="w"></span>
72 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">INFO</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">loglevel</span><span class="w"></span>
73 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">DEBUG</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">loglevel</span><span class="w"></span>
74
75 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">closelog</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
76 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">log</span><span class="p">:</span><span class="w"> </span><span class="n">loglevel</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
77 <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">openlog</span><span class="p">:</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">openflag</span><span class="w"> </span><span class="n">list</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">facility</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
78 <span class="w"> </span><span class="k">end</span><span class="w"></span>
79 </pre></div></div></div>
80 <div class="paragraph"><p><span class="monospaced">MLton.Syslog</span> is a complete interface to the system logging
81 facilities. See <span class="monospaced">man 3 syslog</span> for more details.</p></div>
82 <div class="ulist"><ul>
83 <li>
84 <p>
85 <span class="monospaced">closelog ()</span>
86 </p>
87 <div class="paragraph"><p>closes the connection to the system logger.</p></div>
88 </li>
89 <li>
90 <p>
91 <span class="monospaced">log (l, s)</span>
92 </p>
93 <div class="paragraph"><p>logs message <span class="monospaced">s</span> at a loglevel <span class="monospaced">l</span>.</p></div>
94 </li>
95 <li>
96 <p>
97 <span class="monospaced">openlog (name, flags, facility)</span>
98 </p>
99 <div class="paragraph"><p>opens a connection to the system logger. <span class="monospaced">name</span> will be prefixed to
100 each message, and is typically set to the program name.</p></div>
101 </li>
102 </ul></div>
103 </div>
104 </div>
105 </div>
106 <div id="footnotes"><hr></div>
107 <div id="footer">
108 <div id="footer-text">
109 </div>
110 <div id="footer-badges">
111 </div>
112 </div>
113 </body>
114 </html>