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 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)syslogd.8 8.1 (Berkeley) 6/6/93
29 .\" $FreeBSD: src/usr.sbin/syslogd/syslogd.8,v 1.64 2008/12/07 18:45:30 trhodes Exp $
36 .Nd log systems messages
40 .Op Fl a Ar allowed_peer
41 .Op Fl b Ar bind_address
42 .Op Fl f Ar config_file
43 .Op Fl l Oo Ar mode : Oc Ns Ar path
44 .Op Fl m Ar mark_interval
46 .Op Fl p Ar log_socket
50 utility reads and logs messages to the system console, log files, other
51 machines and/or users as specified by its configuration file.
53 The options are as follows:
54 .Bl -tag -width indent
58 to use IPv4 addresses only.
62 to use IPv6 addresses only.
66 not to interfere with 8-bit data. Normally
68 will replace C1 control characters
69 .Pq ISO 8859 and Unicode characters
73 Note, this option does not change the way
75 alters control characters
76 .Pq see Xr iscntrl 3 .
77 They will always be replaced with their
83 tries to send the message to only one address
84 even if the host has more than one A or AAAA record.
85 If this option is specified,
87 tries to send the message to all addresses.
88 .It Fl a Ar allowed_peer
96 options may be specified.
100 option may be any of the following:
101 .Bl -tag -width "ipaddr/masklen[:service]XX"
109 Accept datagrams from
111 (in the usual dotted quad notation) with
113 bits being taken into account when doing the address comparison.
115 can be also IPv6 address by enclosing the address with
121 is the name or number of an UDP service (see
123 the source packet must belong to.
128 allows packets being sent from any UDP port.
135 is IPv4 address, a missing
137 will be substituted by the historic class A or class B netmasks if
139 belongs into the address range of class A or B, respectively, or
143 is IPv6 address, a missing
145 will be substituted by 128.
148 .Ar domainname Op : Ar service
151 Accept datagrams where the reverse address lookup yields
153 for the sender address.
156 is as explained above.
159 .No * Ar domainname Op : Ar service
162 Same as before, except that any source host whose name
171 options are ignored if the
173 option is also specified.
174 .It Fl b Ar bind_address
175 Specify one specific IP address or hostname to bind to.
176 If a hostname is specified,
177 the IPv4 or IPv6 address which corresponds to it is used.
179 Create log files that do not exist (permission is set to
182 Disable the compression of repeated instances of the same line
183 into a single line of the form
184 .Dq Li "last message repeated N times"
185 when the output is a pipe to another program.
186 If specified twice, disable this compression in all cases.
191 This is probably only of use to developers working on
194 Specify the pathname of an alternate configuration file;
196 .Pa /etc/syslog.conf .
198 Disable the translation of
199 messages received with facility
205 facility is reserved for messages read directly from
208 Select the number of minutes between
210 messages; the default is 20 minutes.
212 Disable dns query for every request.
214 Prefix kernel messages with the full kernel boot file as determined by
216 Without this, the kernel message prefix is always
219 Specify the pathname of an alternate log socket to be used instead;
223 Specify an alternative file in which to store the process ID.
225 .Pa /var/run/syslog.pid .
227 Specify the pathname of an alternate log socket for privileged
228 applications to be used instead; the default is
229 .Pa /var/run/logpriv .
231 Specify a location where
233 should place an additional log socket.
234 The primary use for this is to place additional log sockets in
236 of various chroot filespaces.
237 File permissions for socket can be specified in octal representation
238 before socket name, delimited with a colon.
239 Path to socket location must be absolute.
241 Operate in secure mode.
242 Do not log messages from remote machines.
244 specified twice, no network socket will be opened at all, which also
245 disables logging to remote machines.
247 Always use the local time and date for messages received from the network,
248 instead of the timestamp field supplied in the message by the remote host.
249 This is useful if some of the originating hosts can't keep time properly
250 or are unable to generate a correct timestamp.
252 Unique priority logging.
253 Only log messages at the specified priority.
254 Without this option, messages at the stated priority or higher are logged.
255 This option changes the default comparison from
261 If specified once, the numeric facility and priority are
262 logged with each locally-written message.
263 If specified more than once,
264 the names of the facility and priority are logged with each locally-written
270 utility reads its configuration file when it starts up and whenever it
271 receives a hangup signal.
272 For information on the format of the configuration file,
278 utility reads messages from the
283 .Pa /var/run/logpriv ,
284 from an Internet domain socket specified in
286 and from the special device
288 (to read kernel messages).
292 utility creates its process ID file,
294 .Pa /var/run/syslog.pid ,
295 and stores its process
297 This can be used to kill or reconfigure
302 should consist of a single line.
303 The message can contain a priority code, which should be a preceding
304 decimal number in angle braces, for example,
306 This priority code should map into the priorities defined in the
310 For security reasons,
312 will not append to log files that do not exist (unless
314 option is specified);
315 therefore, they must be created manually before running
318 The date and time are taken from the received message.
319 If the format of the timestamp field is incorrect,
320 time obtained from the local host is used instead.
321 This can be overridden by the
325 .Bl -tag -width /var/run/syslog.pid -compact
326 .It Pa /etc/syslog.conf
328 .It Pa /var/run/syslog.pid
329 default process ID file
333 domain datagram log socket
334 .It Pa /var/run/logpriv
336 socket for privileged applications
362 The ability to log messages received in UDP packets is equivalent to
363 an unauthenticated remote disk-filling service, and should probably be
366 .No inter- Ns Nm syslogd
367 authentication mechanism ought to be worked out.
371 option is therefore highly recommended.
375 matching algorithm does not pretend to be very efficient; use of numeric
376 IP addresses is faster than domain name comparison.
378 peer list is being walked linearly, peer groups where frequent messages
379 are being anticipated from should be put early into the
383 The log socket was moved from
385 to ease the use of a read-only root file system.
387 some old binaries so that a symbolic link might be used for a