Update release date.
[aox:aox.git] / doc / logd.man
1 .\" Copyright 2009 The Archiveopteryx Developers <info@aox.org>
2 .TH logd 8 2009-07-13 aox.org "Archiveopteryx Documentation"
3 .SH NAME
4 logd - logging server for Archiveopteryx.
5 .SH SYNOPSIS
6 .B $SBINDIR/logd [-f] [-c configfile]
7 .SH DESCRIPTION
8 .nh
9 .PP
10 The Archiveopteryx
11 .B logd
12 is an internal server which receives, buffers and filters log entries
13 from other parts of Archiveopteryx, so that useful messages are logged, while
14 noise is suppressed.
15 .PP
16 Archiveopteryx's log system uses four log levels:
17 .IR Disaster ,
18 .IR Error ,
19 .I Info
20 and
21 .IR Debug .
22 Each program in Archiveopteryx sends its log messages to
23 .BR logd ,
24 which writes them to a logfile.
25 .PP
26 If a message is logged with severity
27 .IR log-level
28 (set to
29 .I Info
30 by default) or greater, it is immediately written to the log file. All
31 messages of lower severity are discarded.
32 .PP
33 If
34 .B logd
35 receives the SIGHUP signal, it closes and reopens its logfile.
36 .PP
37 After startup,
38 .B logd
39 changes root to the directory where
40 .I logfile
41 is located, and changes uid and gid to
42 .I jail-user
43 and
44 .IR  jail-group .
45 Therefore,
46 .I jail-user
47 must have the right to open
48 .IR logfile .
49 .SH OPTIONS
50 .IP "-c filename"
51 Read configuration variables from
52 .I filename
53 instead of from
54 .IR $CONFIGDIR/archiveopteryx.conf .
55 .IP -f
56 Fork into background during startup.
57 .SH CONFIGURATION
58 .B logd
59 is configured using
60 .BR archiveopteryx.conf (5).
61 .PP
62 .B logd
63 uses the following configuration variables:
64 .IR log-address ,
65 .IR log-port ,
66 .I logfile
67 (default $LOGFILE),
68 .I log-level
69 (default
70 .IR info ),
71 .I jail-user
72 (default
73 .IR $AOXUSER ),
74 .I jail-group
75 (default
76 .IR $AOXGROUP ).
77 .SH DIAGNOSTICS
78 In case of error,
79 .B smtpd
80 exits with exit code 1, an error message on stderr and (usually more
81 detailed) information in the log file.
82 .SH FILES
83 $CONFIGDIR/archiveopteryx.conf
84 .br
85 $SBINDIR/logd
86 .SH AUTHOR
87 The Archiveopteryx Developers, info@aox.org.
88 .SH VERSION
89 This man page covers Archiveopteryx version 3.1.2, released 2009-07-13,
90 http://www.archiveopteryx.org/3.1.2
91 .SH SEE ALSO
92 .BR archiveopteryx (8),
93 .BR archiveopteryx.conf (5),
94 .BR deliver (8),
95 .BR aox (8),
96 .BR tlsproxy (8),
97 http://www.archiveopteryx.org