changes designed so that ESIS and ARP may use routing table
[unix-history] / usr / src / usr.sbin / syslogd / syslogd.8
index e535c5a..7cb04f6 100644 (file)
@@ -1,27 +1,36 @@
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1986 The Regents of the University of California.
+.\" All rights reserved.
 .\"
 .\"
-.\"    @(#)syslogd.8   6.1 (Berkeley) %G%
+.\" Redistribution and use in source and binary forms are permitted
+.\" provided that the above copyright notice and this paragraph are
+.\" duplicated in all such forms and that any documentation,
+.\" advertising materials, and other materials related to such
+.\" distribution and use acknowledge that the software was developed
+.\" by the University of California, Berkeley.  The name of the
+.\" University may not be used to endorse or promote products derived
+.\" from this software without specific prior written permission.
+.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+.\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 .\"
 .\"
-.\"    @(#)syslog.8    4.2             7/28/83
-.TH SYSLOG 8 ""
+.\"    @(#)syslogd.8   6.6 (Berkeley) %G%
+.\"
+.TH SYSLOGD 8 ""
 .UC 5
 .SH NAME
 syslogd \- log systems messages
 .SH SYNOPSIS
 .B /etc/syslogd
 [
 .UC 5
 .SH NAME
 syslogd \- log systems messages
 .SH SYNOPSIS
 .B /etc/syslogd
 [
-.BI \-m N
+.BI \-f configfile
 ] [
 ] [
-.BI \-f name
+.BI \-m markinterval
 ] [
 .B \-d
 ]
 .SH DESCRIPTION
 .I Syslogd
 ] [
 .B \-d
 ]
 .SH DESCRIPTION
 .I Syslogd
-reads a datagram socket
-and logs each line it reads into a set of files
+reads and logs messages into a set of files
 described by the configuration file
 /etc/syslog.conf.
 Each message is one line.
 described by the configuration file
 /etc/syslog.conf.
 Each message is one line.
@@ -29,74 +38,140 @@ A message can contain a priority code,
 marked by a number in angle braces
 at the beginning of the line.
 Priorities are defined in
 marked by a number in angle braces
 at the beginning of the line.
 Priorities are defined in
-.RI < syslog.h >.
+.RI < sys/syslog.h >.
+.I Syslogd
+reads from the UNIX domain socket
+.IR /dev/log ,
+from an Internet domain socket specified in
+.IR /etc/services ,
+and from the special device
+.I /dev/klog
+(to read kernel messages).
 .PP
 .I Syslogd
 configures when it starts up
 and whenever it receives a hangup signal.
 .PP
 .I Syslogd
 configures when it starts up
 and whenever it receives a hangup signal.
-The configuration file is in two sections
-separated by a blank line.
-The first section defines files that
+Lines in the configuration file have a
+.I selector
+to determine the message priorities to which the line applies
+and an
+.IR action .
+The
+.I action
+field are separated from the selector by one or more tabs.
+.PP
+Selectors are semicolon separated lists of priority specifiers.
+Each priority has a
+.I facility
+describing the part of the system that generated the message,
+a dot,
+and a
+.I level
+indicating the severity of the message.
+Symbolic names may be used.
+An asterisk selects all facilities.
+All messages of the specified level or higher (greater severity)
+are selected.
+More than one facility may be selected using commas to separate them.
+For example:
+.PP
+.ti +5
+*.emerg;mail,daemon.crit
+.PP
+Selects all facilities at the
+.I emerg
+level and the
+.I mail
+and
+.I daemon
+facilities at the
+.I crit
+level.
+.PP
+Known facilities and levels
+recognized by
 .I syslogd
 .I syslogd
-will log into or host names that
+are those listed in
+.IR syslog (3)
+without the leading ``LOG_''.
+The additional facility
+``mark'' has a message at priority LOG_INFO sent to it every
+20 minutes
+(this may be changed with the
+.B \-m
+flag).
+The ``mark'' facility is not enabled by a facility field containing an asterisk.
+The level ``none'' may be used to disable a particular facility.
+For example,
+.PP
+.ti +5
+*.debug;mail.none
+.PP
+Sends all messages
+.I except
+mail messages to the selected file.
+.PP
+The second part of each line describes where the message is to be logged
+if this line is selected.
+There are four forms:
+.IP \(bu 3n
+A filename (beginning with a leading slash).
+The file will be opened in append mode.
+.IP \(bu 3n
+A hostname preceeded by an at sign (``@'').
+Selected messages are forwarded to the
 .I syslogd
 .I syslogd
-will forward messages to.
-Each line contains
-a set of numbers which define the message priorities
-that this file or host will receive;
-an optional asterisk
-which guarantees that something gets output
-at least every 15 minutes;
-and a pathname or a hostname prefixed by `@'.
-The second part of the file
-contains a list of users who will receive messages if logged in.
-Each line contains an optional
-set of numbers which define the message priorities
-that this user will receive followed by the user's login name.
-The default priority level is LOG_SALERT if none is specified.
-Priority numbers may range from 1 to 31,
-and may be given in comma-separated lists
-and/or dash-separated ranges.
+on the named host.
+.IP \(bu 3n
+A comma separated list of users.
+Selected messages are written to those users
+if they are logged in.
+.IP \(bu 3n
+An asterisk.
+Selected messages are written to all logged-in users.
+.PP
+Blank lines and lines beginning with `#' are ignored.
 .PP
 For example, the configuration file:
 .PP
 For example, the configuration file:
+.PP
 .nf
 .nf
-
-       1-5*/dev/console
-       8-9,25/usr/spool/adm/syslog
-       1-3/usr/adm/critical
-       1-4@ucbarpa
-
-       eric
-       kridle
-       1-5,25ralph
-
+.ta 4m +\w'*.alert,auth.warning'u+3
+       kern,mark.debug /dev/console
+       *.notice;mail.info      /usr/spool/adm/syslog
+       *.crit  /usr/adm/critical
+       kern.err        @ucbarpa
+       *.emerg *
+       *.alert eric,kridle
+       *.alert;auth.warning    ralph
 .fi
 .fi
-logs all messages of priorities 1 through 5
-onto the system console,
-including timing marks every 15 minutes;
-all messages of priorities 8, 9 or 25
-into the file /usr/spool/adm/syslog;
-all messages of priorities 3 or higher
-into /usr/adm/critical and
-forwards all messages of priorities 4 or higher to ucbarpa.
-The users ``eric'' and ``kridle''
-will be informed on any subalert messages.
-The user ``ralph''
-will be informed on any message of priorities 5 or higher,
-and any message of priority 25.
+.PP
+logs all kernel messages
+and 20 minute marks onto the system console,
+all notice (or higher) level messages and all mail system messages
+except debug messages
+into the file /usr/spool/adm/syslog,
+and all critical messages
+into /usr/adm/critical;
+kernel messages of error severity or higher are forwarded
+to ucbarpa.
+All users will be informed of any emergency messages,
+the users ``eric'' and ``kridle''
+will be informed of any alert messages,
+and the user ``ralph''
+will be informed of any alert message,
+or any warning message (or higher)
+from the authorization system.
 .PP
 The flags are:
 .TP 0.5i
 .PP
 The flags are:
 .TP 0.5i
-.B \-m
-Set the mark interval to
-.I N
-(default 15 minutes).
-.TP
 .B \-f
 Specify an alternate configuration file.
 .TP
 .B \-f
 Specify an alternate configuration file.
 .TP
+.B \-m
+Select the number of minutes between mark messages.
+.TP
 .B \-d
 .B \-d
-Turn on debugging (if compiled in).
+Turn on debugging.
 .PP
 .I Syslogd
 creates the file /etc/syslog.pid, if possible,
 .PP
 .I Syslogd
 creates the file /etc/syslog.pid, if possible,
@@ -107,15 +182,14 @@ This can be used to kill or reconfigure
 To bring
 .I syslogd
 down,
 To bring
 .I syslogd
 down,
-it should be sent a terminate signal (e.g. kill `cat /etc/syslog.pid`).
+it should be sent a terminate signal (e.g. kill \`cat /etc/syslog.pid\`).
 .SH FILES
 .ta \w'/etc/syslog.conf    'u
 .nf
 /etc/syslog.conf       the configuration file
 /etc/syslog.pid        the process id
 .SH FILES
 .ta \w'/etc/syslog.conf    'u
 .nf
 /etc/syslog.conf       the configuration file
 /etc/syslog.pid        the process id
-/dev/log       UNIX domain datagram socket to listen to
+/dev/log       Name of the UNIX domain datagram log socket
+/dev/klog      The kernel log device
 .fi
 .fi
-.SH BUGS
-Kernel priorities should only be allowed to privileged programs.
-.SH "SEE ALSO"
-syslog(3)
+.SH SEE ALSO
+logger(1), syslog(3)