break configuration information out into syslog.conf.5

[unix-history] / usr / src / usr.sbin / syslogd / syslogd.8

diff --git a/usr/src/usr.sbin/syslogd/syslogd.8 b/usr/src/usr.sbin/syslogd/syslogd.8
index 80ec7d5..36c9bf1 100644 (file)
--- a/usr/src/usr.sbin/syslogd/syslogd.8
+++ b/usr/src/usr.sbin/syslogd/syslogd.8
@@ -1,185 +1,70 @@
-.\" 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   5.1 (Berkeley) %G%
+.\" %sccs.include.redist.man%

 .\"
 .\"

-.\"    @(#)syslog.8    4.2             7/28/83
-.TH SYSLOG 8 "7/28/83"
+.\"    @(#)syslogd.8   6.9 (Berkeley) %G%
+.\"
+.TH SYSLOGD 8 ""

 .UC 5
 .SH NAME
 .UC 5
 .SH NAME

-syslog \- log systems messages
+syslogd \- log systems messages

 .SH SYNOPSIS
 .SH SYNOPSIS

-/etc/syslog [
-.BI \-m N
-] [
-.BI \-f name
-] [
-.B \-d
-]
-.SH DESCRIPTION
-.I Syslog
-reads a datagram socket
-and logs each line it reads into a set of files
-described by the configuration file
-/etc/syslog.conf.
-.I Syslog
-configures when it starts up
-and whenever it receives a hangup signal.
-.PP
-Each message is one line.
-A message can contain a priority code,
-marked by a digit in angle braces
-at the beginning of the line.
-Priorities are defined in
-.RI < syslog.h >,
-as follows:
-.IP LOG_ALERT \w'LOG_WARNING'u+2n
-this priority should essentially never
-be used.  It applies only to messages that
-are so important that every user should be
-aware of them, e.g., a serious hardware failure.
-.IP LOG_SALERT
-messages of this priority should be
-issued only when immediate attention is needed
-by a qualified system person, e.g., when some
-valuable system resource dissappears.  They get
-sent to a list of system people.
-.IP LOG_EMERG
-Emergency messages are not sent to users,
-but represent major conditions.  An example
-might be hard disk failures.  These could be
-logged in a separate file so that critical
-conditions could be easily scanned.
-.IP LOG_ERR
-these represent error conditions, such as soft
-disk failures, etc.
-.IP LOG_CRIT
-such messages contain critical information,
-but which can not be classed as errors, for example,
-`su' attempts.
-Messages of this priority and higher
-are typically logged on the system console.
-.IP LOG_WARNING
-issued when an abnormal condition has been
-detected, but recovery can take place.
-.IP LOG_NOTICE
-something that falls in the class of
-``important information''; this class is informational
-but important enough that you don't want to throw
-it away casually.
-Messages without any priority assigned to them
-are typically mapped into this priority.
-.IP LOG_INFO
-information level messages.  These messages
-could be thrown away without problems, but should
-be included if you want to keep a close watch on
-your system.
-.IP LOG_DEBUG
-it may be useful to log certain debugging
-information.  Normally this will be thrown away.
-.PP
-It is expected that the kernel will not log anything below
-LOG_ERR priority.
-.PP
-The configuration file is in two sections
-separated by a blank line.
-The first section defines files that
-.I syslog
-will log into.
-Each line contains
-a single digit which defines the lowest priority
-(highest numbered priority)
-that this file will receive,
-an optional asterisk
-which guarantees that something gets output
-at least every 20 minutes,
-and a pathname.
-The second part of the file
-contains a list of users that will be
-informed on SALERT level messages.
-For example, the configuration file:

 .nf
 .nf

-
-       5*/dev/console
-       8/usr/spool/adm/syslog
-       3/usr/adm/critical
-
-       eric
-       kridle
-       kalash
-
+.ft B
+syslogd [\-f config_file] [\-m mark_interval] [\-p log_socket]

 .fi
 .fi

-logs all messages of priority 5 or higher
-onto the system console,
-including timing marks every 20 minutes;
-all messages of priority 8 or higher
-into the file /usr/spool/adm/syslog;
-and all messages of priority 3 or higher
-into /usr/adm/critical.
-The users ``eric'', ``kridle'', and ``kalash''
-will be informed on any subalert messages.
-.PP
-The flags are:
-.TP 0.5i
-.B \-m
-Set the mark interval to
-.I N
-(default 20 minutes).
+.ft R
+.SH DESCRIPTION
+.I Syslogd
+reads and logs messages to the system console, log files, other
+machines and/or users as specified by its configuration file.
+The options are as follows:
+.TP
+.I -f
+Specify the pathname of an alternate configuration file;
+the default is ``/etc/syslog.conf''.

 .TP
 .TP

-.B \-f
-Specify an alternate configuration file.
+.I \-m
+Select the number of minutes between ``mark'' messages;
+the default is 20 minutes.

 .TP
 .TP

-.B \-d
-Turn on debugging (if compiled in).
+.I \-p
+Specify the pathname of an alternate log socket;
+the default is ``/dev/log''.

 .PP
 .PP

-To bring
-.I syslog
-down,
-it should be sent a terminate signal.
-It logs that it is going down
-and then waits approximately 30 seconds
-for any additional messages to come in.
+.I Syslogd
+reads its configuration file when it starts up and whenever it
+receives a hangup signal.
+For information on the format of the configuration file,
+see
+.IR syslog.conf (5).

 .PP
 .PP

-There are some special messages that cause control functions.
-``<*>N'' sets the default message priority to
-.I N.
-``<$>'' causes
-.I syslog
-to reconfigure
-(equivalent to a hangup signal).
-This can be used in a shell file run automatically
-early in the morning to truncate the log.
+.I Syslogd
+reads messages from the UNIX domain socket ``/dev/log'',
+from an Internet domain socket specified in ``/etc/services'',
+and from the special device ``/dev/klog'' (to read kernel messages).

 .PP
 .PP

-.I Syslog
-creates the file
-/etc/syslog.pid
-if possible
-containing a single line
-with its process id.
+.I Syslogd
+creates the file ``/var/run/syslog.pid'', and stores its process
+id there.

 This can be used to kill or reconfigure
 This can be used to kill or reconfigure

-.I syslog.
-.\".PP
-.\".I Syslog
-.\"can also be compiled to use
-.\".IR mpx (2)
-.\"files instead of datagrams
-.\"if you are running V7.
-.\"In this case it creates and reads the file
-.\"/dev/log.
-.SH FILES
-/etc/syslog.conf \- the configuration file
-.br
-/etc/syslog.pid \- the process id
-.\".br
-.\"/dev/log \- under V7, the mpx file
-.SH BUGS
-LOG_ALERT and LOG_SUBALERT messages
-should only be allowed to privileged programs.
+.IR syslogd .

 .PP
 .PP

-Actually,
-.I syslog
-is not clever enough to deal with kernel error messages
-in the current implementation.
-.SH SEE\ ALSO
-syslog(3)
+The message sent to
+.I syslogd
+should consist of a single line.
+The message can contain a priority code, which should be a preceding
+decimal number in angle braces, for example, ``<5>''.
+This priority code should map into the priorities defined in the
+include file ``<sys/syslog.h>''.
+.SH FILES
+.ta \w'/etc/syslog.conf    'u
+.nf
+/etc/syslog.conf       The configuration file.
+/var/run/syslog.pid    The process id of current \fIsyslogd\fP.
+/dev/log       Name of the UNIX domain datagram log socket.
+/dev/klog      The kernel log device.
+.fi
+.SH SEE ALSO
+logger(1), syslog(3), services(5), syslog.conf(5)