source: project/wiki/eggref/4/syslog-port @ 33610

Last change on this file since 33610 was 33610, checked in by evhan, 3 years ago

wiki/syslog-port: Add documentation

File size: 902 bytes
Line 
1[[tags: egg]]
2
3== syslog-port
4
5[[toc:]]
6
7== Description
8
9Write to syslog as an output port.
10
11The source for this extension is available
12[[http://git.foldling.org/chicken-syslog-port.git|here]].
13
14=== Requirements
15
16* [[/egg/module-declarations|module-declarations]]
17* [[/egg/syslog|syslog]]
18
19== API
20
21<procedure>(open-syslog identity priority #!optional (options opt/pid) (facility facility/user))</procedure>
22
23Creates an output port with the given syslog configuration.
24
25The resulting port will buffer output until a newline is encountered,
26at which point its contents will be flushed to the syslog.
27
28<parameter>current-syslog-port</parameter>
29
30This parameter provides a default syslog port.
31
32Its starting value is a port that uses {{(program-name)}} as its
33identity and {{prio/info}} as its message priority.
34
35== Author
36
37[[/users/evan-hanson|Evan Hanson]]
38
39== License
40
41Copyright (c) 2016, 3-Clause BSD.
Note: See TracBrowser for help on using the repository browser.