usr.sbin/syslogd/syslogd.8

   1 .\" Copyright (c) 1983, 1986, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  15 .\"
  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
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)syslogd.8   8.1 (Berkeley) 6/6/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd November 8, 2004
  32 .Dt SYSLOGD 8
  33 .Os
  34 .Sh NAME
  35 .Nm syslogd
  36 .Nd log systems messages
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl 46Acdknosuv
  40 .Op Fl a Ar allowed_peer
  41 .Op Fl b Ar bind_address
  42 .Op Fl f Ar config_file
  43 .Oo
  44 .Fl l Op Ar mode: Ns
  45 .Ar path
  46 .Oc
  47 .Op Fl m Ar mark_interval
  48 .Op Fl P Ar pid_file
  49 .Op Fl p Ar log_socket
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 utility reads and logs messages to the system console, log files, other
  54 machines and/or users as specified by its configuration file.
  55 .Pp
  56 The options are as follows:
  57 .Bl -tag -width indent
  58 .It Fl 4
  59 Force
  60 .Nm
  61 to use IPv4 addresses only.
  62 .It Fl 6
  63 Force
  64 .Nm
  65 to use IPv6 addresses only.
  66 .It Fl A
  67 Ordinarily,
  68 .Nm
  69 tries to send the message to only one address
  70 even if the host has more than one A or AAAA record.
  71 If this option is specified,
  72 .Nm
  73 tries to send the message to all addresses.
  74 .It Fl a Ar allowed_peer
  75 Allow
  76 .Ar allowed_peer
  77 to log to this
  78 .Nm
  79 using UDP datagrams.
  80 Multiple
  81 .Fl a
  82 options may be specified.
  83 .Pp
  84 .Ar Allowed_peer
  85 can be any of the following:
  86 .Bl -tag -width "ipaddr/masklen[:service]XX"
  87 .It Xo
  88 .Sm off
  89 .Ar ipaddr
  90 .No / Ar masklen
  91 .Op : Ar service
  92 .Sm on
  93 .Xc
  94 Accept datagrams from
  95 .Ar ipaddr
  96 (in the usual dotted quad notation) with
  97 .Ar masklen
  98 bits being taken into account when doing the address comparison.
  99 .Ar ipaddr
 100 can be also IPv6 address by enclosing the address with
 101 .Ql \&[
 102 and
 103 .Ql \&] .
 104 If specified,
 105 .Ar service
 106 is the name or number of an UDP service (see
 107 .Xr services 5 )
 108 the source packet must belong to.
 109 A
 110 .Ar service
 111 of
 112 .Ql \&*
 113 allows packets being sent from any UDP port.
 114 The default
 115 .Ar service
 116 is
 117 .Ql syslog .
 118 If
 119 .Ar ipaddr
 120 is IPv4 address, a missing
 121 .Ar masklen
 122 will be substituted by the historic class A or class B netmasks if
 123 .Ar ipaddr
 124 belongs into the address range of class A or B, respectively, or
 125 by 24 otherwise.
 126 If
 127 .Ar ipaddr
 128 is IPv6 address, a missing
 129 .Ar masklen
 130 will be substituted by 128.
 131 .It Xo
 132 .Sm off
 133 .Ar domainname Op : Ar service
 134 .Sm on
 135 .Xc
 136 Accept datagrams where the reverse address lookup yields
 137 .Ar domainname
 138 for the sender address.
 139 The meaning of
 140 .Ar service
 141 is as explained above.
 142 .It Xo
 143 .Sm off
 144 .No * Ar domainname Op : Ar service
 145 .Sm on
 146 .Xc
 147 Same as before, except that any source host whose name
 148 .Em ends
 149 in
 150 .Ar domainname
 151 will get permission.
 152 .El
 153 .Pp
 154 The
 155 .Fl a
 156 options are ignored if the
 157 .Fl s
 158 option is also specified.
 159 .It Fl b Ar bind_address
 160 Specify one specific IP address or hostname to bind to.
 161 If a hostname is specified,
 162 the IPv4 or IPv6 address which corresponds to it is used.
 163 .It Fl c
 164 Disable the compression of repeated instances of the same line
 165 into a single line of the form
 166 .Dq Li "last message repeated N times"
 167 when the output is a pipe to another program.
 168 If specified twice, disable this compression in all cases.
 169 .It Fl d
 170 Put
 171 .Nm
 172 into debugging mode.
 173 This is probably only of use to developers working on
 174 .Nm .
 175 .It Fl f
 176 Specify the pathname of an alternate configuration file;
 177 the default is
 178 .Pa /etc/syslog.conf .
 179 .It Fl k
 180 Disable the translation of
 181 messages received with facility
 182 .Dq kern
 183 to facility
 184 .Dq user .
 185 Usually the
 186 .Dq kern
 187 facility is reserved for messages read directly from
 188 .Pa /dev/klog .
 189 .It Fl m
 190 Select the number of minutes between
 191 .Dq mark
 192 messages; the default is 20 minutes.
 193 .It Fl n
 194 Disable dns query for every request.
 195 .It Fl o
 196 Prefix kernel messages with the full kernel boot file as determined by
 197 .Xr getbootfile 3 .
 198 Without this, the kernel message prefix is always
 199 .Dq Li kernel: .
 200 .It Fl p
 201 Specify the pathname of an alternate log socket to be used instead;
 202 the default is
 203 .Pa /var/run/log .
 204 .It Fl P
 205 Specify an alternative file in which to store the process ID.
 206 The default is
 207 .Pa /var/run/syslog.pid .
 208 .It Fl l
 209 Specify a location where
 210 .Nm
 211 should place an additional log socket.
 212 The primary use for this is to place additional log sockets in
 213 .Pa /var/run/log
 214 of various chroot filespaces.
 215 File permissions for socket can be specified in octal representation
 216 before socket name, delimited with a colon.
 217 Path to socket location must be absolute.
 218 .It Fl s
 219 Operate in secure mode.
 220 Do not log messages from remote machines.
 221 If
 222 specified twice, no network socket will be opened at all, which also
 223 disables logging to remote machines.
 224 .It Fl u
 225 Unique priority logging.
 226 Only log messages at the specified priority.
 227 Without this option, messages at the stated priority or higher are logged.
 228 This option changes the default comparison from
 229 .Dq =>
 230 to
 231 .Dq = .
 232 .It Fl v
 233 Verbose logging.
 234 If specified once, the numeric facility and priority are
 235 logged with each locally-written message.
 236 If specified more than once,
 237 the names of the facility and priority are logged with each locally-written
 238 message.
 239 .El
 240 .Pp
 241 The
 242 .Nm
 243 utility reads its configuration file when it starts up and whenever it
 244 receives a hangup signal.
 245 For information on the format of the configuration file,
 246 see
 247 .Xr syslog.conf 5 .
 248 .Pp
 249 The
 250 .Nm
 251 utility reads messages from the
 252 .Ux
 253 domain sockets
 254 .Pa /var/run/log
 255 and
 256 .Pa /var/run/logpriv ,
 257 from an Internet domain socket specified in
 258 .Pa /etc/services ,
 259 and from the special device
 260 .Pa /dev/klog
 261 (to read kernel messages).
 262 .Pp
 263 The
 264 .Nm
 265 utility creates its process ID file,
 266 by default
 267 .Pa /var/run/syslog.pid ,
 268 and stores its process
 269 ID there.
 270 This can be used to kill or reconfigure
 271 .Nm .
 272 .Pp
 273 The message sent to
 274 .Nm
 275 should consist of a single line.
 276 The message can contain a priority code, which should be a preceding
 277 decimal number in angle braces, for example,
 278 .Sq Aq 5 .
 279 This priority code should map into the priorities defined in the
 280 include file
 281 .In sys/syslog.h .
 282 .Pp
 283 For security reasons,
 284 .Nm
 285 will not append to log files that do not exist;
 286 therefore, they must be created manually before running
 287 .Nm .
 288 .Sh FILES
 289 .Bl -tag -width /var/run/syslog.pid -compact
 290 .It Pa /etc/syslog.conf
 291 configuration file
 292 .It Pa /var/run/syslog.pid
 293 default process ID file
 294 .It Pa /var/run/log
 295 name of the
 296 .Ux
 297 domain datagram log socket
 298 .It Pa /var/run/logpriv
 299 .Ux
 300 socket for privileged applications
 301 .It Pa /dev/klog
 302 kernel log device
 303 .El
 304 .Sh SEE ALSO
 305 .Xr logger 1 ,
 306 .Xr syslog 3 ,
 307 .Xr services 5 ,
 308 .Xr syslog.conf 5 ,
 309 .Xr newsyslog 8
 310 .Sh HISTORY
 311 The
 312 .Nm
 313 utility appeared in
 314 .Bx 4.3 .
 315 .Pp
 316 The
 317 .Fl a ,
 318 .Fl s ,
 319 .Fl u ,
 320 and
 321 .Fl v
 322 options are
 323 .Fx 2.2
 324 extensions.
 325 .Sh BUGS
 326 The ability to log messages received in UDP packets is equivalent to
 327 an unauthenticated remote disk-filling service, and should probably be
 328 disabled by default.
 329 Some sort of
 330 .No inter- Ns Nm syslogd
 331 authentication mechanism ought to be worked out.
 332 To prevent the worst
 333 abuse, use of the
 334 .Fl a
 335 option is therefore highly recommended.
 336 .Pp
 337 The
 338 .Fl a
 339 matching algorithm doesn't pretend to be very efficient; use of numeric
 340 IP addresses is faster than domain name comparison.
 341 Since the allowed
 342 peer list is being walked linearly, peer groups where frequent messages
 343 are being anticipated from should be put early into the
 344 .Fl a
 345 list.
 346 .Pp
 347 The log socket was moved from
 348 .Pa /dev
 349 to ease the use of a read-only root file system.
 350 This may confuse
 351 some old binaries so that a symbolic link might be used for a
 352 transitional period.