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 tries to send the message to only one address
67 even if the host has more than one A or AAAA record.
68 If this option is specified,
70 tries to send the message to all addresses.
71 .It Fl a Ar allowed_peer
79 options may be specified.
82 can be any of the following:
83 .Bl -tag -width "ipaddr/masklen[:service]XX"
93 (in the usual dotted quad notation) with
95 bits being taken into account when doing the address comparison.
97 can be also IPv6 address by enclosing the address with
103 is the name or number of an UDP service (see
105 the source packet must belong to.
110 allows packets being sent from any UDP port.
117 is IPv4 address, a missing
119 will be substituted by the historic class A or class B netmasks if
121 belongs into the address range of class A or B, respectively, or
125 is IPv6 address, a missing
127 will be substituted by 128.
130 .Ar domainname Op : Ar service
133 Accept datagrams where the reverse address lookup yields
135 for the sender address.
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.
170 This is probably only of use to developers working on
173 Specify the pathname of an alternate configuration file;
175 .Pa /etc/syslog.conf .
177 Disable the translation of
178 messages received with facility
184 facility is reserved for messages read directly from
187 Select the number of minutes between
189 messages; the default is 20 minutes.
191 Disable dns query for every request.
193 Prefix kernel messages with the full kernel boot file as determined by
195 Without this, the kernel message prefix is always
198 Specify the pathname of an alternate log socket to be used instead;
202 Specify an alternative file in which to store the process ID.
204 .Pa /var/run/syslog.pid .
206 Specify a location where
208 should place an additional log socket.
209 The primary use for this is to place additional log sockets in
211 of various chroot filespaces.
212 File permissions for socket can be specified in octal representation
213 before socket name, delimited with a colon.
214 Path to socket location must be absolute.
216 Operate in secure mode.
217 Do not log messages from remote machines.
219 specified twice, no network socket will be opened at all, which also
220 disables logging to remote machines.
222 Unique priority logging.
223 Only log messages at the specified priority.
224 Without this option, messages at the stated priority or higher are logged.
225 This option changes the default comparison from
231 If specified once, the numeric facility and priority are
232 logged with each locally-written message.
233 If specified more than once,
234 the names of the facility and priority are logged with each locally-written
240 utility reads its configuration file when it starts up and whenever it
241 receives a hangup signal.
242 For information on the format of the configuration file,
248 utility reads messages from the
253 .Pa /var/run/logpriv ,
254 from an Internet domain socket specified in
256 and from the special device
258 (to read kernel messages).
262 utility creates its process ID file,
264 .Pa /var/run/syslog.pid ,
265 and stores its process
267 This can be used to kill or reconfigure
272 should consist of a single line.
273 The message can contain a priority code, which should be a preceding
274 decimal number in angle braces, for example,
276 This priority code should map into the priorities defined in the
280 For security reasons,
282 will not append to log files that do not exist;
283 therefore, they must be created manually before running
286 .Bl -tag -width /var/run/syslog.pid -compact
287 .It Pa /etc/syslog.conf
289 .It Pa /var/run/syslog.pid
290 default process ID file
294 domain datagram log socket
295 .It Pa /var/run/logpriv
297 socket for privileged applications
323 The ability to log messages received in UDP packets is equivalent to
324 an unauthenticated remote disk-filling service, and should probably be
327 .No inter- Ns Nm syslogd
328 authentication mechanism ought to be worked out.
332 option is therefore highly recommended.
336 matching algorithm does not pretend to be very efficient; use of numeric
337 IP addresses is faster than domain name comparison.
339 peer list is being walked linearly, peer groups where frequent messages
340 are being anticipated from should be put early into the
344 The log socket was moved from
346 to ease the use of a read-only root file system.
348 some old binaries so that a symbolic link might be used for a