BSD 4_4 release

[unix-history] / usr / src / lib / libc / gen / syslog.3

diff --git a/usr/src/lib/libc/gen/syslog.3 b/usr/src/lib/libc/gen/syslog.3
index 2cb7e5c..8a46d05 100644 (file)
--- a/usr/src/lib/libc/gen/syslog.3
+++ b/usr/src/lib/libc/gen/syslog.3
@@ -1,230 +1,251 @@
-.\" Copyright (c) 1985 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1985, 1991, 1993
+.\"    The Regents of the University of California.  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.

 .\"
 .\"

-.\"    @(#)syslog.3    6.13 (Berkeley) 6/23/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 SYSLOG 3 "June 23, 1990"
-.UC 5
-.SH NAME
-syslog, openlog, closelog, setlogmask, vsyslog \- control system log
-.SH SYNOPSIS
-.B "#include <syslog.h>
-.PP
-.B "openlog(ident, logopt, facility)
-.br
-.B "char *ident;
-.PP
-.B "syslog(priority, message, parameters ... )
-.br
-.B "int priority;
-.br
-.B "char *message;
-.PP
-.B "#include <varargs.h>
-.br
-.B "vsyslog(priority, message, args)
-.br
-.B "int priority;
-.br
-.B "char *message;
-.br
-.B "va_list args;
-.PP
-.B "closelog()
-.PP
-.B "setlogmask(maskpri)
-.SH DESCRIPTION
-.I Syslog
-arranges to write
-.I message
-onto the system log maintained by
-.IR syslogd (8).
-The message is tagged with
-.IR priority .
-The message looks like a
-.IR printf (3)
-string except that
-.B %m
-is replaced by the current error message (as referenced by
-.IR errno ).
-A trailing newline is added if needed.
-An alternate form, in which the arguments have already been captured
+.\"     @(#)syslog.3   8.1 (Berkeley) 6/4/93
+.\"
+.Dd June 4, 1993
+.Dt SYSLOG 3
+.Os BSD 4.2
+.Sh NAME
+.Nm syslog ,
+.Nm vsyslog ,
+.Nm openlog ,
+.Nm closelog ,
+.Nm setlogmask
+.Nd control system log
+.Sh SYNOPSIS
+.Fd #include <syslog.h>
+.Fd #include <varargs.h>
+.Ft void
+.Fn syslog "int priority" "const char *message" "..."
+.Ft void
+.Fn vsyslog "int priority" "const char *message" "va_list args"
+.Ft void
+.Fn openlog "const char *ident" "int logopt" "int facility"
+.Ft void
+.Fn closelog void
+.Ft int
+.Fn setlogmask "int maskpri"
+.Sh DESCRIPTION
+The
+.Fn syslog
+function
+writes
+.Fa message
+to the system message logger.
+The message is then written to the system console, log files,
+logged-in users, or forwarded to other machines as appropriate. (See
+.Xr syslogd 8 . )
+.Pp
+The message is identical to a
+.Xr printf 3
+format string, except that
+.Ql %m
+is replaced by the current error
+message. (As denoted by the global variable
+.Va errno ;
+see
+.Xr strerror 3 . )
+A trailing newline is added if none is present.
+.Pp
+The
+.Fn vsyslog
+function
+is an alternate form in which the arguments have already been captured

 using the variable-length argument facilities of
 using the variable-length argument facilities of

-.IR varargs (3),
-is available under the name
-.IR vsyslog .
-.PP
-This message will be read by
-.IR syslogd (8)
-and written to the system console, log files, or forwarded to
-.I syslogd
-on another host as appropriate.
-.PP
+.Xr varargs 3 .
+.Pp
+The message is tagged with
+.Fa priority .

 Priorities are encoded as a
 Priorities are encoded as a

-.I facility
+.Fa facility

 and a
 and a

-.IR level .
+.Em level .

 The facility describes the part of the system
 generating the message.
 The facility describes the part of the system
 generating the message.

-The level is selected from an ordered list:
-.TP
-LOG_ALERT
-A condition that should be corrected immediately,
-such as a corrupted system database.
-.TP
-LOG_CRIT
-Critical conditions,
-e.g., hard device errors.
-.TP
-LOG_DEBUG
-Messages that contain information
-normally of use only when debugging a program.
-.TP
-LOG_EMERG
+The level is selected from the following
+.Em ordered
+(high to low) list:
+.Bl -tag -width LOG_AUTHPRIV
+.It Dv LOG_EMERG

 A panic condition.
 This is normally broadcast to all users.
 A panic condition.
 This is normally broadcast to all users.

-.TP
-LOG_ERR
+.It Dv LOG_ALERT
+A condition that should be corrected immediately, such as a corrupted
+system database.
+.It Dv LOG_CRIT
+Critical conditions, e.g., hard device errors.
+.It Dv LOG_ERR

 Errors.
 Errors.

-.TP
-LOG_INFO
-Informational messages.
-.TP
-LOG_NOTICE
+.It Dv LOG_WARNING
+Warning messages.
+.It Dv LOG_NOTICE

 Conditions that are not error conditions,
 but should possibly be handled specially.
 Conditions that are not error conditions,
 but should possibly be handled specially.

-.TP
-LOG_WARNING
-Warning messages.
-.PP
+.It Dv LOG_INFO
+Informational messages.
+.It Dv LOG_DEBUG
+Messages that contain information
+normally of use only when debugging a program.
+.El
+.Pp
+The
+.Fn openlog
+function
+provides for more specialized processing of the messages sent
+by
+.Fn syslog
+and
+.Fn vsyslog .
+The parameter
+.Fa ident
+is a string that will be prepended to every message.
+The
+.Fa logopt
+argument
+is a bit field specifying logging options, which is formed by
+.Tn OR Ns 'ing
+one or more of the following values:
+.Bl -tag -width LOG_AUTHPRIV
+.It Dv LOG_CONS

 If
 If

-.I syslog
+.Fn syslog

 cannot pass the message to
 cannot pass the message to

-.IR syslogd ,
-it will attempt to write the message to the console (``/dev/console'')
-if the LOG_CONS option is set (see below).
-.PP
-If special processing is needed,
-.I openlog
-can be called to initialize the log file.
-The parameter
-.I ident
-is a string that is prepended to every message.
-.I Logopt
-is a bit field indicating logging options.
-Current values for
-.I logopt
-are:
-.TP
-LOG_CONS
-If unable to send the message to
-.IR syslogd ,
-write it to the console.
-.TP
-LOG_NDELAY 
+.Xr syslogd
+it will attempt to write the message to the console
+.Pq Dq Pa /dev/console.
+.It Dv LOG_NDELAY 

 Open the connection to
 Open the connection to

-.I syslogd
+.Xr syslogd

 immediately.
 immediately.

-Normally the open is delayed
-until the first message is logged.
-Useful for programs that need to manage the
-order in which file descriptors are allocated.
-.TP
-LOG_PERROR
-Write the message to stderr as well to the system log.
-.TP
-LOG_PID
-Log the process id with each message:
-useful for identifying instantiations of daemons.
-.PP
+Normally the open is delayed until the first message is logged.
+Useful for programs that need to manage the order in which file
+descriptors are allocated.
+.It Dv LOG_PERROR
+Write the message to standard error output as well to the system log.
+.It Dv LOG_PID
+Log the process id with each message: useful for identifying
+instantiations of daemons.
+.El
+.Pp

 The
 The

-.I facility
+.Fa facility

 parameter encodes a default facility to be assigned to all messages
 that do not have an explicit facility encoded:
 parameter encodes a default facility to be assigned to all messages
 that do not have an explicit facility encoded:

-.TP
-LOG_AUTH
+.Bl -tag -width LOG_AUTHPRIV
+.It Dv LOG_AUTH

 The authorization system:
 The authorization system:

-.IR login (1),
-.IR su (1),
-.IR getty (8),
+.Xr login 1 ,
+.Xr su 1 ,
+.Xr getty 8 ,

 etc.
 etc.

-.TP
-LOG_CRON
+.It Dv LOG_AUTHPRIV
+The same as
+.Dv LOG_AUTH ,
+but logged to a file readable only by
+selected individuals.
+.It Dv LOG_CRON

 The clock daemon.
 The clock daemon.

-.TP
-LOG_DAEMON
+.It Dv LOG_DAEMON

 System daemons, such as
 System daemons, such as

-.IR ftpd (8),
-.IR routed (8),
-etc, that are not provided for explicitly by other facilities.
-.TP
-LOG_KERN
+.Xr routed 8 ,
+that are not provided for explicitly by other facilities.
+.It Dv LOG_KERN

 Messages generated by the kernel.
 These cannot be generated by any user processes.
 Messages generated by the kernel.
 These cannot be generated by any user processes.

-.TP
-LOG_LPR
+.It Dv LOG_LPR

 The line printer spooling system:
 The line printer spooling system:

-.IR lpr (1),
-.IR lpc (8),
-.IR lpd (8),
+.Xr lpr 1 ,
+.Xr lpc 8 ,
+.Xr lpd 8 ,

 etc.
 etc.

-.TP
-LOG_MAIL
+.It Dv LOG_MAIL

 The mail system.
 The mail system.

-.TP
-LOG_NEWS
+.It Dv LOG_NEWS

 The network news system.
 The network news system.

-.TP
-LOG_SYSLOG
+.It Dv LOG_SYSLOG

 Messages generated internally by
 Messages generated internally by

-.IR syslogd (8).
-.TP
-LOG_USER
+.Xr syslogd 8 .
+.It Dv LOG_USER

 Messages generated by random user processes.
 This is the default facility identifier if none is specified.
 Messages generated by random user processes.
 This is the default facility identifier if none is specified.

-.TP
-LOG_UUCP
+.It Dv LOG_UUCP

 The uucp system.
 The uucp system.

-.TP
-LOG_LOCAL0
+.It Dv LOG_LOCAL0

 Reserved for local use.
 Reserved for local use.

-Similarly for LOG_LOCAL1 through LOG_LOCAL7.
-.PP
-.I Closelog
+Similarly for
+.Dv LOG_LOCAL1
+through
+.Dv LOG_LOCAL7 .
+.El 
+.Pp
+The
+.Fn closelog
+function

 can be used to close the log file.
 can be used to close the log file.

-.PP
-.I Setlogmask
+.Pp
+The
+.Fn setlogmask
+function

 sets the log priority mask to
 sets the log priority mask to

-.I maskpri
+.Fa maskpri

 and returns the previous mask.
 Calls to
 and returns the previous mask.
 Calls to

-.I syslog
+.Fn syslog

 with a priority not set in
 with a priority not set in

-.I maskpri
+.Fa maskpri

 are rejected.
 The mask for an individual priority
 are rejected.
 The mask for an individual priority

-.I pri
-is calculated by the macro LOG_MASK(\fIpri\fP);
+.Fa pri
+is calculated by the macro
+.Fn LOG_MASK pri ;

 the mask for all priorities up to and including
 the mask for all priorities up to and including

-.I toppri
-is given by the macro LOG_UPTO(\fItoppri\fP).
+.Fa toppri
+is given by the macro
+.Fn LOG_UPTO toppri ; .

 The default allows all priorities to be logged.
 The default allows all priorities to be logged.

-.SH EXAMPLES
-.nf
+.Sh RETURN VALUES
+The routines
+.Fn closelog ,
+.Fn openlog ,
+.Fn syslog
+and
+.Fn vsyslog
+return no value.
+.Pp
+The routine
+.Fn setlogmask
+always returns the previous log mask level.
+.Sh EXAMPLES
+.Bd -literal -offset indent -compact

 syslog(LOG_ALERT, "who: internal error 23");
 
 openlog("ftpd", LOG_PID, LOG_DAEMON);
 syslog(LOG_ALERT, "who: internal error 23");
 
 openlog("ftpd", LOG_PID, LOG_DAEMON);


@@ -232,7 +253,11 @@ setlogmask(LOG_UPTO(LOG_ERR));
 syslog(LOG_INFO, "Connection from host %d", CallingHost);
 
 syslog(LOG_INFO|LOG_LOCAL2, "foobar error: %m");
 syslog(LOG_INFO, "Connection from host %d", CallingHost);
 
 syslog(LOG_INFO|LOG_LOCAL2, "foobar error: %m");

-.fi
-.SH "SEE ALSO"
-logger(1),
-syslogd(8)
+.Ed
+.Sh SEE ALSO
+.Xr logger 1 ,
+.Xr syslogd 8
+.Sh HISTORY
+These
+functions appeared in 
+.Bx 4.2 .