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
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.
99 can be any of the following:
100 .Bl -tag -width "ipaddr/masklen[:service]XX"
108 Accept datagrams from
110 (in the usual dotted quad notation) with
112 bits being taken into account when doing the address comparison.
114 can be also IPv6 address by enclosing the address with
120 is the name or number of an UDP service (see
122 the source packet must belong to.
127 allows packets being sent from any UDP port.
134 is IPv4 address, a missing
136 will be substituted by the historic class A or class B netmasks if
138 belongs into the address range of class A or B, respectively, or
142 is IPv6 address, a missing
144 will be substituted by 128.
147 .Ar domainname Op : Ar service
150 Accept datagrams where the reverse address lookup yields
152 for the sender address.
155 is as explained above.
158 .No * Ar domainname Op : Ar service
161 Same as before, except that any source host whose name
170 options are ignored if the
172 option is also specified.
173 .It Fl b Ar bind_address
174 Specify one specific IP address or hostname to bind to.
175 If a hostname is specified,
176 the IPv4 or IPv6 address which corresponds to it is used.
178 Create log files that do not exist (permission is set to
181 Disable the compression of repeated instances of the same line
182 into a single line of the form
183 .Dq Li "last message repeated N times"
184 when the output is a pipe to another program.
185 If specified twice, disable this compression in all cases.
190 This is probably only of use to developers working on
193 Specify the pathname of an alternate configuration file;
195 .Pa /etc/syslog.conf .
197 Disable the translation of
198 messages received with facility
204 facility is reserved for messages read directly from
207 Select the number of minutes between
209 messages; the default is 20 minutes.
211 Disable dns query for every request.
213 Prefix kernel messages with the full kernel boot file as determined by
215 Without this, the kernel message prefix is always
218 Specify the pathname of an alternate log socket to be used instead;
222 Specify an alternative file in which to store the process ID.
224 .Pa /var/run/syslog.pid .
226 Specify the pathname of an alternate log socket for privileged
227 applications to be used instead; the default is
228 .Pa /var/run/logpriv .
230 Specify a location where
232 should place an additional log socket.
233 The primary use for this is to place additional log sockets in
235 of various chroot filespaces.
236 File permissions for socket can be specified in octal representation
237 before socket name, delimited with a colon.
238 Path to socket location must be absolute.
240 Operate in secure mode.
241 Do not log messages from remote machines.
243 specified twice, no network socket will be opened at all, which also
244 disables logging to remote machines.
246 Unique priority logging.
247 Only log messages at the specified priority.
248 Without this option, messages at the stated priority or higher are logged.
249 This option changes the default comparison from
255 If specified once, the numeric facility and priority are
256 logged with each locally-written message.
257 If specified more than once,
258 the names of the facility and priority are logged with each locally-written
264 utility reads its configuration file when it starts up and whenever it
265 receives a hangup signal.
266 For information on the format of the configuration file,
272 utility reads messages from the
277 .Pa /var/run/logpriv ,
278 from an Internet domain socket specified in
280 and from the special device
282 (to read kernel messages).
286 utility creates its process ID file,
288 .Pa /var/run/syslog.pid ,
289 and stores its process
291 This can be used to kill or reconfigure
296 should consist of a single line.
297 The message can contain a priority code, which should be a preceding
298 decimal number in angle braces, for example,
300 This priority code should map into the priorities defined in the
304 For security reasons,
306 will not append to log files that do not exist (unless
308 option is specified);
309 therefore, they must be created manually before running
312 .Bl -tag -width /var/run/syslog.pid -compact
313 .It Pa /etc/syslog.conf
315 .It Pa /var/run/syslog.pid
316 default process ID file
320 domain datagram log socket
321 .It Pa /var/run/logpriv
323 socket for privileged applications
349 The ability to log messages received in UDP packets is equivalent to
350 an unauthenticated remote disk-filling service, and should probably be
353 .No inter- Ns Nm syslogd
354 authentication mechanism ought to be worked out.
358 option is therefore highly recommended.
362 matching algorithm does not pretend to be very efficient; use of numeric
363 IP addresses is faster than domain name comparison.
365 peer list is being walked linearly, peer groups where frequent messages
366 are being anticipated from should be put early into the
370 The log socket was moved from
372 to ease the use of a read-only root file system.
374 some old binaries so that a symbolic link might be used for a