BSD 4_3_Net_2 release

[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 29d82f9..3ec0959 100644 (file)
--- a/usr/src/usr.sbin/syslogd/syslogd.8
+++ b/usr/src/usr.sbin/syslogd/syslogd.8
@@ -1,197 +1,122 @@
-.\" Copyright (c) 1983, 1986 The Regents of the University of California.
+.\" Copyright (c) 1983, 1986, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" 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
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)syslogd.8   6.8 (Berkeley) 6/27/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH SYSLOGD 8 "June 27, 1990"
-.UC 5
-.SH NAME
-syslogd \- log systems messages
-.SH SYNOPSIS
-.B syslogd
-[
-.BI \-f configfile
-] [
-.BI \-m markinterval
-] [
-.B \-d
-]
-.SH DESCRIPTION
-.I Syslogd
-reads and logs messages into a set of files
-described by the configuration file
-/etc/syslog.conf.
-Each message is one line.
-A message can contain a priority code,
-marked by a number in angle braces
-at the beginning of the line.
-Priorities are defined in
-.RI < sys/syslog.h >.
-.I Syslogd
-reads from the UNIX domain socket
-.IR /dev/log ,
+.\"     @(#)syslogd.8  6.10 (Berkeley) 3/16/91
+.\"
+.Dd March 16, 1991
+.Dt SYSLOGD 8
+.Os BSD 4.2
+.Sh NAME
+.Nm syslogd
+.Nd log systems messages
+.Sh SYNOPSIS
+.Nm syslogd
+.Op Fl f Ar config_file
+.Op Fl m Ar mark_interval
+.Op Fl p Ar log_socket
+.Sh DESCRIPTION
+.Nm 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:
+.Bl -tag -width Ds
+.It Fl f
+Specify the pathname of an alternate configuration file;
+the default is
+.Pa /etc/syslog.conf .
+.It Fl m
+Select the number of minutes between ``mark'' messages;
+the default is 20 minutes.
+.It Fl p
+Specify the pathname of an alternate log socket;
+the default is
+.Pa /dev/log .
+.El
+.Pp
+.Nm 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
+.Xr syslog.conf 5 .
+.Pp
+.Nm Syslogd
+reads messages from the
+.Tn UNIX
+domain socket
+.Pa /dev/log ,

 from an Internet domain socket specified in
 from an Internet domain socket specified in

-.IR /etc/services ,
+.Pa /etc/services ,

 and from the special device
 and from the special device

-.I /dev/klog
+.Pa /dev/klog

 (to read kernel messages).
 (to read kernel messages).

-.PP
-.I Syslogd
-configures when it starts up
-and whenever it receives a hangup signal.
-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
-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
-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
-.nf
-.ta 4m +\w'*.alert,auth.warning'u+3
-       kern,mark.debug /dev/console
-       *.notice;mail.info      /var/log/maillog
-       *.crit  /var/log/critical
-       kern.err        @ucbarpa
-       *.emerg *
-       *.alert eric,kridle
-       *.alert;auth.warning    ralph
-.fi
-.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 /var/log/maillog,
-and all critical messages
-into /var/log/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
-.B \-f
-Specify an alternate configuration file.
-.TP
-.B \-m
-Select the number of minutes between mark messages.
-.TP
-.B \-d
-Turn on debugging.
-.PP
-.I Syslogd
-creates the file /var/run/syslog.pid, if possible,
-containing a single line with its process id.
+.Pp
+.Nm Syslogd
+creates the file
+.Pa /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 syslogd.
-.PP
-To bring
-.I syslogd
-down,
-it should be sent a terminate signal (e.g. kill \`cat /var/run/syslog.pid\`).
-.SH FILES
-.ta \w'/etc/syslog.conf    'u
-.nf
-/etc/syslog.conf       the configuration file
-/var/run/syslog.pid    the process id
-/dev/log       Name of the UNIX domain datagram log socket
-/dev/klog      The kernel log device
-.fi
-.SH SEE ALSO
-logger(1), syslog(3)
+.Nm syslogd .
+.Pp
+The message sent to
+.Nm 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,
+.Sq Aq 5.
+This priority code should map into the priorities defined in the
+include file
+.Aq Pa sys/syslog.h .
+.Sh FILES
+.Bl -tag -width /var/run/syslog.pid -compact
+.It Pa /etc/syslog.conf
+The configuration file.
+.It Pa /var/run/syslog.pid
+The process id of current
+.Nm syslogd .
+.It Pa /dev/log
+Name of the
+.Tn UNIX
+domain datagram log socket.
+.It Pa /dev/klog
+The kernel log device.
+.El
+.Sh SEE ALSO
+.Xr logger 1 ,
+.Xr syslog 3 ,
+.Xr services 5 ,
+.Xr syslog.conf 5
+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.3 .