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 468ACcdkNnosTuv
  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 The
  99 .Ar allowed_peer
 100 option may be any of the following:
 101 .Bl -tag -width "ipaddr/masklen[:service]XX"
 102 .It Xo
 103 .Sm off
 104 .Ar ipaddr
 105 .No / Ar masklen
 106 .Op : Ar service
 107 .Sm on
 108 .Xc
 109 Accept datagrams from
 110 .Ar ipaddr
 111 (in the usual dotted quad notation) with
 112 .Ar masklen
 113 bits being taken into account when doing the address comparison.
 114 .Ar ipaddr
 115 can be also IPv6 address by enclosing the address with
 116 .Ql \&[
 117 and
 118 .Ql \&] .
 119 If specified,
 120 .Ar service
 121 is the name or number of an UDP service (see
 122 .Xr services 5 )
 123 the source packet must belong to.
 124 A
 125 .Ar service
 126 of
 127 .Ql \&*
 128 allows packets being sent from any UDP port.
 129 The default
 130 .Ar service
 131 is
 132 .Ql syslog .
 133 If
 134 .Ar ipaddr
 135 is IPv4 address, a missing
 136 .Ar masklen
 137 will be substituted by the historic class A or class B netmasks if
 138 .Ar ipaddr
 139 belongs into the address range of class A or B, respectively, or
 140 by 24 otherwise.
 141 If
 142 .Ar ipaddr
 143 is IPv6 address, a missing
 144 .Ar masklen
 145 will be substituted by 128.
 146 .It Xo
 147 .Sm off
 148 .Ar domainname Op : Ar service
 149 .Sm on
 150 .Xc
 151 Accept datagrams where the reverse address lookup yields
 152 .Ar domainname
 153 for the sender address.
 154 The meaning of
 155 .Ar service
 156 is as explained above.
 157 .It Xo
 158 .Sm off
 159 .No * Ar domainname Op : Ar service
 160 .Sm on
 161 .Xc
 162 Same as before, except that any source host whose name
 163 .Em ends
 164 in
 165 .Ar domainname
 166 will get permission.
 167 .El
 168 .Pp
 169 The
 170 .Fl a
 171 options are ignored if the
 172 .Fl s
 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.
 178 .It Fl C
 179 Create log files that do not exist (permission is set to
 180 .Li 0600 ) .
 181 .It Fl c
 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.
 187 .It Fl d
 188 Put
 189 .Nm
 190 into debugging mode.
 191 This is probably only of use to developers working on
 192 .Nm .
 193 .It Fl f
 194 Specify the pathname of an alternate configuration file;
 195 the default is
 196 .Pa /etc/syslog.conf .
 197 .It Fl k
 198 Disable the translation of
 199 messages received with facility
 200 .Dq kern
 201 to facility
 202 .Dq user .
 203 Usually the
 204 .Dq kern
 205 facility is reserved for messages read directly from
 206 .Pa /dev/klog .
 207 .It Fl m
 208 Select the number of minutes between
 209 .Dq mark
 210 messages; the default is 20 minutes.
 211 .It Fl N
 212 Disable binding on UDP sockets.  RFC 3164 recommends that outgoing
 213 syslogd messages should originate from the privileged port, this
 214 option
 215 .Em disables
 216 the recommended behavior.  This option inherits
 217 .Fl s .
 218 .It Fl n
 219 Disable dns query for every request.
 220 .It Fl o
 221 Prefix kernel messages with the full kernel boot file as determined by
 222 .Xr getbootfile 3 .
 223 Without this, the kernel message prefix is always
 224 .Dq Li kernel: .
 225 .It Fl p
 226 Specify the pathname of an alternate log socket to be used instead;
 227 the default is
 228 .Pa /var/run/log .
 229 .It Fl P
 230 Specify an alternative file in which to store the process ID.
 231 The default is
 232 .Pa /var/run/syslog.pid .
 233 .It Fl S
 234 Specify the pathname of an alternate log socket for privileged
 235 applications to be used instead; the default is
 236 .Pa /var/run/logpriv .
 237 .It Fl l
 238 Specify a location where
 239 .Nm
 240 should place an additional log socket.
 241 The primary use for this is to place additional log sockets in
 242 .Pa /var/run/log
 243 of various chroot filespaces.
 244 File permissions for socket can be specified in octal representation
 245 before socket name, delimited with a colon.
 246 Path to socket location must be absolute.
 247 .It Fl s
 248 Operate in secure mode.
 249 Do not log messages from remote machines.
 250 If
 251 specified twice, no network socket will be opened at all, which also
 252 disables logging to remote machines.
 253 .It Fl T
 254 Always use the local time and date for messages received from the network,
 255 instead of the timestamp field supplied in the message by the remote host.
 256 This is useful if some of the originating hosts can't keep time properly
 257 or are unable to generate a correct timestamp.
 258 .It Fl u
 259 Unique priority logging.
 260 Only log messages at the specified priority.
 261 Without this option, messages at the stated priority or higher are logged.
 262 This option changes the default comparison from
 263 .Dq =>
 264 to
 265 .Dq = .
 266 .It Fl v
 267 Verbose logging.
 268 If specified once, the numeric facility and priority are
 269 logged with each locally-written message.
 270 If specified more than once,
 271 the names of the facility and priority are logged with each locally-written
 272 message.
 273 .El
 274 .Pp
 275 The
 276 .Nm
 277 utility reads its configuration file when it starts up and whenever it
 278 receives a hangup signal.
 279 For information on the format of the configuration file,
 280 see
 281 .Xr syslog.conf 5 .
 282 .Pp
 283 The
 284 .Nm
 285 utility reads messages from the
 286 .Ux
 287 domain sockets
 288 .Pa /var/run/log
 289 and
 290 .Pa /var/run/logpriv ,
 291 from an Internet domain socket specified in
 292 .Pa /etc/services ,
 293 and from the special device
 294 .Pa /dev/klog
 295 (to read kernel messages).
 296 .Pp
 297 The
 298 .Nm
 299 utility creates its process ID file,
 300 by default
 301 .Pa /var/run/syslog.pid ,
 302 and stores its process
 303 ID there.
 304 This can be used to kill or reconfigure
 305 .Nm .
 306 .Pp
 307 The message sent to
 308 .Nm
 309 should consist of a single line.
 310 The message can contain a priority code, which should be a preceding
 311 decimal number in angle braces, for example,
 312 .Sq Aq 5 .
 313 This priority code should map into the priorities defined in the
 314 include file
 315 .In sys/syslog.h .
 316 .Pp
 317 For security reasons,
 318 .Nm
 319 will not append to log files that do not exist (unless
 320 .Fl C
 321 option is specified);
 322 therefore, they must be created manually before running
 323 .Nm .
 324 .Pp
 325 The date and time are taken from the received message.
 326 If the format of the timestamp field is incorrect,
 327 time obtained from the local host is used instead.
 328 This can be overriden by the
 329 .Fl T
 330 flag.
 331 .Sh FILES
 332 .Bl -tag -width /var/run/syslog.pid -compact
 333 .It Pa /etc/syslog.conf
 334 configuration file
 335 .It Pa /var/run/syslog.pid
 336 default process ID file
 337 .It Pa /var/run/log
 338 name of the
 339 .Ux
 340 domain datagram log socket
 341 .It Pa /var/run/logpriv
 342 .Ux
 343 socket for privileged applications
 344 .It Pa /dev/klog
 345 kernel log device
 346 .El
 347 .Sh SEE ALSO
 348 .Xr logger 1 ,
 349 .Xr syslog 3 ,
 350 .Xr services 5 ,
 351 .Xr syslog.conf 5 ,
 352 .Xr newsyslog 8
 353 .Sh HISTORY
 354 The
 355 .Nm
 356 utility appeared in
 357 .Bx 4.3 .
 358 .Pp
 359 The
 360 .Fl a ,
 361 .Fl s ,
 362 .Fl u ,
 363 and
 364 .Fl v
 365 options are
 366 .Fx 2.2
 367 extensions.
 368 .Sh BUGS
 369 The ability to log messages received in UDP packets is equivalent to
 370 an unauthenticated remote disk-filling service, and should probably be
 371 disabled by default.
 372 Some sort of
 373 .No inter- Ns Nm syslogd
 374 authentication mechanism ought to be worked out.
 375 To prevent the worst
 376 abuse, use of the
 377 .Fl a
 378 option is therefore highly recommended.
 379 .Pp
 380 The
 381 .Fl a
 382 matching algorithm does not pretend to be very efficient; use of numeric
 383 IP addresses is faster than domain name comparison.
 384 Since the allowed
 385 peer list is being walked linearly, peer groups where frequent messages
 386 are being anticipated from should be put early into the
 387 .Fl a
 388 list.
 389 .Pp
 390 The log socket was moved from
 391 .Pa /dev
 392 to ease the use of a read-only root file system.
 393 This may confuse
 394 some old binaries so that a symbolic link might be used for a
 395 transitional period.