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 .\" 3. 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: src/usr.sbin/syslogd/syslogd.8,v 1.64 2008/12/07 18:45:30 trhodes Exp $
  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 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 dns query for every request.
 213 .It Fl o
 214 Prefix kernel messages with the full kernel boot file as determined by
 215 .Xr getbootfile 3 .
 216 Without this, the kernel message prefix is always
 217 .Dq Li kernel: .
 218 .It Fl p
 219 Specify the pathname of an alternate log socket to be used instead;
 220 the default is
 221 .Pa /var/run/log .
 222 .It Fl P
 223 Specify an alternative file in which to store the process ID.
 224 The default is
 225 .Pa /var/run/syslog.pid .
 226 .It Fl S
 227 Specify the pathname of an alternate log socket for privileged
 228 applications to be used instead; the default is
 229 .Pa /var/run/logpriv .
 230 .It Fl l
 231 Specify a location where
 232 .Nm
 233 should place an additional log socket.
 234 The primary use for this is to place additional log sockets in
 235 .Pa /var/run/log
 236 of various chroot filespaces.
 237 File permissions for socket can be specified in octal representation
 238 before socket name, delimited with a colon.
 239 Path to socket location must be absolute.
 240 .It Fl s
 241 Operate in secure mode.
 242 Do not log messages from remote machines.
 243 If
 244 specified twice, no network socket will be opened at all, which also
 245 disables logging to remote machines.
 246 .It Fl T
 247 Always use the local time and date for messages received from the network,
 248 instead of the timestamp field supplied in the message by the remote host.
 249 This is useful if some of the originating hosts can't keep time properly
 250 or are unable to generate a correct timestamp.
 251 .It Fl u
 252 Unique priority logging.
 253 Only log messages at the specified priority.
 254 Without this option, messages at the stated priority or higher are logged.
 255 This option changes the default comparison from
 256 .Dq =>
 257 to
 258 .Dq = .
 259 .It Fl v
 260 Verbose logging.
 261 If specified once, the numeric facility and priority are
 262 logged with each locally-written message.
 263 If specified more than once,
 264 the names of the facility and priority are logged with each locally-written
 265 message.
 266 .El
 267 .Pp
 268 The
 269 .Nm
 270 utility reads its configuration file when it starts up and whenever it
 271 receives a hangup signal.
 272 For information on the format of the configuration file,
 273 see
 274 .Xr syslog.conf 5 .
 275 .Pp
 276 The
 277 .Nm
 278 utility reads messages from the
 279 .Ux
 280 domain sockets
 281 .Pa /var/run/log
 282 and
 283 .Pa /var/run/logpriv ,
 284 from an Internet domain socket specified in
 285 .Pa /etc/services ,
 286 and from the special device
 287 .Pa /dev/klog
 288 (to read kernel messages).
 289 .Pp
 290 The
 291 .Nm
 292 utility creates its process ID file,
 293 by default
 294 .Pa /var/run/syslog.pid ,
 295 and stores its process
 296 ID there.
 297 This can be used to kill or reconfigure
 298 .Nm .
 299 .Pp
 300 The message sent to
 301 .Nm
 302 should consist of a single line.
 303 The message can contain a priority code, which should be a preceding
 304 decimal number in angle braces, for example,
 305 .Sq Aq 5 .
 306 This priority code should map into the priorities defined in the
 307 include file
 308 .In sys/syslog.h .
 309 .Pp
 310 For security reasons,
 311 .Nm
 312 will not append to log files that do not exist (unless
 313 .Fl C
 314 option is specified);
 315 therefore, they must be created manually before running
 316 .Nm .
 317 .Pp
 318 The date and time are taken from the received message.
 319 If the format of the timestamp field is incorrect,
 320 time obtained from the local host is used instead.
 321 This can be overridden by the
 322 .Fl T
 323 flag.
 324 .Sh FILES
 325 .Bl -tag -width /var/run/syslog.pid -compact
 326 .It Pa /etc/syslog.conf
 327 configuration file
 328 .It Pa /var/run/syslog.pid
 329 default process ID file
 330 .It Pa /var/run/log
 331 name of the
 332 .Ux
 333 domain datagram log socket
 334 .It Pa /var/run/logpriv
 335 .Ux
 336 socket for privileged applications
 337 .It Pa /dev/klog
 338 kernel log device
 339 .El
 340 .Sh SEE ALSO
 341 .Xr logger 1 ,
 342 .Xr syslog 3 ,
 343 .Xr services 5 ,
 344 .Xr syslog.conf 5 ,
 345 .Xr newsyslog 8
 346 .Sh HISTORY
 347 The
 348 .Nm
 349 utility appeared in
 350 .Bx 4.3 .
 351 .Pp
 352 The
 353 .Fl a ,
 354 .Fl s ,
 355 .Fl u ,
 356 and
 357 .Fl v
 358 options are
 359 .Fx 2.2
 360 extensions.
 361 .Sh BUGS
 362 The ability to log messages received in UDP packets is equivalent to
 363 an unauthenticated remote disk-filling service, and should probably be
 364 disabled by default.
 365 Some sort of
 366 .No inter- Ns Nm syslogd
 367 authentication mechanism ought to be worked out.
 368 To prevent the worst
 369 abuse, use of the
 370 .Fl a
 371 option is therefore highly recommended.
 372 .Pp
 373 The
 374 .Fl a
 375 matching algorithm does not pretend to be very efficient; use of numeric
 376 IP addresses is faster than domain name comparison.
 377 Since the allowed
 378 peer list is being walked linearly, peer groups where frequent messages
 379 are being anticipated from should be put early into the
 380 .Fl a
 381 list.
 382 .Pp
 383 The log socket was moved from
 384 .Pa /dev
 385 to ease the use of a read-only root file system.
 386 This may confuse
 387 some old binaries so that a symbolic link might be used for a
 388 transitional period.