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 May 13, 2008
  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 468ACcdknosuv
  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
  45 .Op Fl P Ar pid_file
  46 .Op Fl p Ar log_socket
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility reads and logs messages to the system console, log files, other
  51 machines and/or users as specified by its configuration file.
  52 .Pp
  53 The options are as follows:
  54 .Bl -tag -width indent
  55 .It Fl 4
  56 Force
  57 .Nm
  58 to use IPv4 addresses only.
  59 .It Fl 6
  60 Force
  61 .Nm
  62 to use IPv6 addresses only.
  63 .It Fl 8
  64 Tells
  65 .Nm
  66 not to interfere with 8-bit data.  Normally
  67 .Nm
  68 will replace C1 control characters
  69 .Pq ISO 8859 and Unicode characters
  70 with their
  71 .Dq M- Ns Em x
  72 equivalent.
  73 Note, this option does not change the way
  74 .Nm
  75 alters control characters
  76 .Pq see Xr iscntrl 3 .
  77 They will always be replaced with their
  78 .Dq ^ Ns Em x
  79 equivalent.
  80 .It Fl A
  81 Ordinarily,
  82 .Nm
  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,
  86 .Nm
  87 tries to send the message to all addresses.
  88 .It Fl a Ar allowed_peer
  89 Allow
  90 .Ar allowed_peer
  91 to log to this
  92 .Nm
  93 using UDP datagrams.
  94 Multiple
  95 .Fl a
  96 options may be specified.
  97 .Pp
  98 .Ar Allowed_peer
  99 can be any of the following:
 100 .Bl -tag -width "ipaddr/masklen[:service]XX"
 101 .It Xo
 102 .Sm off
 103 .Ar ipaddr
 104 .No / Ar masklen
 105 .Op : Ar service
 106 .Sm on
 107 .Xc
 108 Accept datagrams from
 109 .Ar ipaddr
 110 (in the usual dotted quad notation) with
 111 .Ar masklen
 112 bits being taken into account when doing the address comparison.
 113 .Ar ipaddr
 114 can be also IPv6 address by enclosing the address with
 115 .Ql \&[
 116 and
 117 .Ql \&] .
 118 If specified,
 119 .Ar service
 120 is the name or number of an UDP service (see
 121 .Xr services 5 )
 122 the source packet must belong to.
 123 A
 124 .Ar service
 125 of
 126 .Ql \&*
 127 allows packets being sent from any UDP port.
 128 The default
 129 .Ar service
 130 is
 131 .Ql syslog .
 132 If
 133 .Ar ipaddr
 134 is IPv4 address, a missing
 135 .Ar masklen
 136 will be substituted by the historic class A or class B netmasks if
 137 .Ar ipaddr
 138 belongs into the address range of class A or B, respectively, or
 139 by 24 otherwise.
 140 If
 141 .Ar ipaddr
 142 is IPv6 address, a missing
 143 .Ar masklen
 144 will be substituted by 128.
 145 .It Xo
 146 .Sm off
 147 .Ar domainname Op : Ar service
 148 .Sm on
 149 .Xc
 150 Accept datagrams where the reverse address lookup yields
 151 .Ar domainname
 152 for the sender address.
 153 The meaning of
 154 .Ar service
 155 is as explained above.
 156 .It Xo
 157 .Sm off
 158 .No * Ar domainname Op : Ar service
 159 .Sm on
 160 .Xc
 161 Same as before, except that any source host whose name
 162 .Em ends
 163 in
 164 .Ar domainname
 165 will get permission.
 166 .El
 167 .Pp
 168 The
 169 .Fl a
 170 options are ignored if the
 171 .Fl s
 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.
 177 .It Fl C
 178 Create log files that do not exist (permission is set to
 179 .Li 0600 ) .
 180 .It Fl c
 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.
 186 .It Fl d
 187 Put
 188 .Nm
 189 into debugging mode.
 190 This is probably only of use to developers working on
 191 .Nm .
 192 .It Fl f
 193 Specify the pathname of an alternate configuration file;
 194 the default is
 195 .Pa /etc/syslog.conf .
 196 .It Fl k
 197 Disable the translation of
 198 messages received with facility
 199 .Dq kern
 200 to facility
 201 .Dq user .
 202 Usually the
 203 .Dq kern
 204 facility is reserved for messages read directly from
 205 .Pa /dev/klog .
 206 .It Fl m
 207 Select the number of minutes between
 208 .Dq mark
 209 messages; the default is 20 minutes.
 210 .It Fl n
 211 Disable dns query for every request.
 212 .It Fl o
 213 Prefix kernel messages with the full kernel boot file as determined by
 214 .Xr getbootfile 3 .
 215 Without this, the kernel message prefix is always
 216 .Dq Li kernel: .
 217 .It Fl p
 218 Specify the pathname of an alternate log socket to be used instead;
 219 the default is
 220 .Pa /var/run/log .
 221 .It Fl P
 222 Specify an alternative file in which to store the process ID.
 223 The default is
 224 .Pa /var/run/syslog.pid .
 225 .It Fl S
 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 .
 229 .It Fl l
 230 Specify a location where
 231 .Nm
 232 should place an additional log socket.
 233 The primary use for this is to place additional log sockets in
 234 .Pa /var/run/log
 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.
 239 .It Fl s
 240 Operate in secure mode.
 241 Do not log messages from remote machines.
 242 If
 243 specified twice, no network socket will be opened at all, which also
 244 disables logging to remote machines.
 245 .It Fl u
 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
 250 .Dq =>
 251 to
 252 .Dq = .
 253 .It Fl v
 254 Verbose logging.
 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
 259 message.
 260 .El
 261 .Pp
 262 The
 263 .Nm
 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,
 267 see
 268 .Xr syslog.conf 5 .
 269 .Pp
 270 The
 271 .Nm
 272 utility reads messages from the
 273 .Ux
 274 domain sockets
 275 .Pa /var/run/log
 276 and
 277 .Pa /var/run/logpriv ,
 278 from an Internet domain socket specified in
 279 .Pa /etc/services ,
 280 and from the special device
 281 .Pa /dev/klog
 282 (to read kernel messages).
 283 .Pp
 284 The
 285 .Nm
 286 utility creates its process ID file,
 287 by default
 288 .Pa /var/run/syslog.pid ,
 289 and stores its process
 290 ID there.
 291 This can be used to kill or reconfigure
 292 .Nm .
 293 .Pp
 294 The message sent to
 295 .Nm
 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,
 299 .Sq Aq 5 .
 300 This priority code should map into the priorities defined in the
 301 include file
 302 .In sys/syslog.h .
 303 .Pp
 304 For security reasons,
 305 .Nm
 306 will not append to log files that do not exist (unless
 307 .Fl C
 308 option is specified);
 309 therefore, they must be created manually before running
 310 .Nm .
 311 .Sh FILES
 312 .Bl -tag -width /var/run/syslog.pid -compact
 313 .It Pa /etc/syslog.conf
 314 configuration file
 315 .It Pa /var/run/syslog.pid
 316 default process ID file
 317 .It Pa /var/run/log
 318 name of the
 319 .Ux
 320 domain datagram log socket
 321 .It Pa /var/run/logpriv
 322 .Ux
 323 socket for privileged applications
 324 .It Pa /dev/klog
 325 kernel log device
 326 .El
 327 .Sh SEE ALSO
 328 .Xr logger 1 ,
 329 .Xr syslog 3 ,
 330 .Xr services 5 ,
 331 .Xr syslog.conf 5 ,
 332 .Xr newsyslog 8
 333 .Sh HISTORY
 334 The
 335 .Nm
 336 utility appeared in
 337 .Bx 4.3 .
 338 .Pp
 339 The
 340 .Fl a ,
 341 .Fl s ,
 342 .Fl u ,
 343 and
 344 .Fl v
 345 options are
 346 .Fx 2.2
 347 extensions.
 348 .Sh BUGS
 349 The ability to log messages received in UDP packets is equivalent to
 350 an unauthenticated remote disk-filling service, and should probably be
 351 disabled by default.
 352 Some sort of
 353 .No inter- Ns Nm syslogd
 354 authentication mechanism ought to be worked out.
 355 To prevent the worst
 356 abuse, use of the
 357 .Fl a
 358 option is therefore highly recommended.
 359 .Pp
 360 The
 361 .Fl a
 362 matching algorithm does not pretend to be very efficient; use of numeric
 363 IP addresses is faster than domain name comparison.
 364 Since the allowed
 365 peer list is being walked linearly, peer groups where frequent messages
 366 are being anticipated from should be put early into the
 367 .Fl a
 368 list.
 369 .Pp
 370 The log socket was moved from
 371 .Pa /dev
 372 to ease the use of a read-only root file system.
 373 This may confuse
 374 some old binaries so that a symbolic link might be used for a
 375 transitional period.