1 .\" Copyright (c) 1983, 1986, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)syslogd.8 8.1 (Berkeley) 6/6/93
33 .\" $FreeBSD: src/usr.sbin/syslogd/syslogd.8,v 1.22.2.16 2003/03/12 22:08:15 trhodes Exp $
34 .\" $DragonFly: src/usr.sbin/syslogd/syslogd.8,v 1.2 2003/06/17 04:30:03 dillon Exp $
41 .Nd log systems messages
45 .Op Fl a Ar allowed_peer
46 .Op Fl b Ar bind_address
47 .Op Fl f Ar config_file
49 .Op Fl m Ar mark_interval
51 .Op Fl p Ar log_socket
55 utility reads and logs messages to the system console, log files, other
56 machines and/or users as specified by its configuration file.
58 The options are as follows:
59 .Bl -tag -width indent
63 to use IPv4 addresses only.
67 to use IPv6 addresses only.
71 tries to send the message to only one address
72 even if the host has more than one A or AAAA record.
73 If this option is specified,
75 tries to send the message to all addresses.
76 .It Fl a Ar allowed_peer
81 using UDP datagrams. Multiple
83 options may be specified.
86 can be any of the following:
87 .Bl -tag -width "ipaddr/masklen[:service]XX"
97 (in the usual dotted quad notation) with
99 bits being taken into account when doing the address comparison.
101 can be also IPv6 address by enclosing the address with
107 is the name or number of an UDP service (see
109 the source packet must belong to. A
113 allows packets being sent from any UDP port. The default
119 is IPv4 address, a missing
121 will be substituted by the historic class A or class B netmasks if
123 belongs into the address range of class A or B, respectively, or
126 is IPv6 address, a missing
128 will be substituted by 128.
131 .Ar domainname Op : Ar service
134 Accept datagrams where the reverse address lookup yields
136 for the sender address. The meaning of
138 is as explained above.
141 .No * Ar domainname Op : Ar service
144 Same as before, except that any source host whose name
153 options are ignored if the
155 option is also specified.
156 .It Fl b Ar bind_address
157 Specify one specific IP address or hostname to bind to.
158 If a hostname is specified,
159 the IPv4 or IPv6 address which corresponds to it is used.
161 Disable the compression of repeated instances of the same line
162 into a single line of the form
163 .Dq Li "last message repeated N times"
164 when the output is a pipe to another program.
165 If specified twice, disable this compression in all cases.
169 into debugging mode. This is probably only of use to developers working on
172 Specify the pathname of an alternate configuration file;
174 .Pa /etc/syslog.conf .
176 Disable the translation of
177 messages received with facility
183 facility is reserved for messages read directly from
186 Select the number of minutes between
188 messages; the default is 20 minutes.
190 Disable dns query for every request.
192 Specify the pathname of an alternate log socket to be used instead;
196 Specify an alternative file in which to store the process ID.
198 .Pa /var/run/syslog.pid .
200 Specify a location where
202 should place an additional log socket.
203 Up to 19 additional logging sockets can be specified.
204 The primary use for this is to place additional log sockets in
206 of various chroot filespaces.
208 Operate in secure mode. Do not log messages from remote machines. If
209 specified twice, no network socket will be opened at all, which also
210 disables logging to remote machines.
212 Unique priority logging. Only log messages at the specified priority.
213 Without this option, messages at the stated priority or higher are logged.
214 This option changes the default comparison from
219 Verbose logging. If specified once, the numeric facility and priority are
220 logged with each locally-written message. If specified more than once,
221 the names of the facility and priority are logged with each locally-written
227 utility reads its configuration file when it starts up and whenever it
228 receives a hangup signal.
229 For information on the format of the configuration file,
235 utility reads messages from the
239 from an Internet domain socket specified in
241 and from the special device
243 (to read kernel messages).
247 utility creates its process ID file,
249 .Pa /var/run/syslog.pid ,
250 and stores its process
252 This can be used to kill or reconfigure
257 should consist of a single line.
258 The message can contain a priority code, which should be a preceding
259 decimal number in angle braces, for example,
261 This priority code should map into the priorities defined in the
263 .Aq Pa sys/syslog.h .
265 For security reasons,
267 will not append to log files that do not exist;
268 therefore, they must be created manually before running
271 .Bl -tag -width /var/run/syslog.pid -compact
272 .It Pa /etc/syslog.conf
274 .It Pa /var/run/syslog.pid
275 default process ID file
279 domain datagram log socket
304 The ability to log messages received in UDP packets is equivalent to
305 an unauthenticated remote disk-filling service, and should probably be
306 disabled by default. Some sort of
307 .No inter- Ns Nm syslogd
308 authentication mechanism ought to be worked out. To prevent the worst
311 option is therefore highly recommended.
315 matching algorithm doesn't pretend to be very efficient; use of numeric
316 IP addresses is faster than domain name comparison. Since the allowed
317 peer list is being walked linearly, peer groups where frequent messages
318 are being anticipated from should be put early into the
322 The log socket was moved from
324 to ease the use of a read-only root file system.
326 some old binaries so that a symbolic link might be used for a