Module Name: src
Committed By: jruoho
Date: Thu May 13 18:04:58 UTC 2010
Modified Files:
src/lib/libc/gen: syslog.3
Log Message:
Move the structure inside the body text. Some additional markup improvements.
To generate a diff of this commit:
cvs rdiff -u -r1.27 -r1.28 src/lib/libc/gen/syslog.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libc/gen/syslog.3
diff -u src/lib/libc/gen/syslog.3:1.27 src/lib/libc/gen/syslog.3:1.28
--- src/lib/libc/gen/syslog.3:1.27 Mon Apr 5 21:29:47 2010
+++ src/lib/libc/gen/syslog.3 Thu May 13 18:04:58 2010
@@ -1,4 +1,4 @@
-.\" $NetBSD: syslog.3,v 1.27 2010/04/05 21:29:47 joerg Exp $
+.\" $NetBSD: syslog.3,v 1.28 2010/05/13 18:04:58 jruoho Exp $
.\" $OpenBSD: syslog.3,v 1.25 2005/07/22 03:16:58 jaredy Exp $
.\"
.\" Copyright (c) 1985, 1991, 1993
@@ -30,7 +30,7 @@
.\"
.\" @(#)syslog.3 8.1 (Berkeley) 6/4/93
.\"
-.Dd August 13, 2008
+.Dd May 3, 2010
.Dt SYSLOG 3
.Os
.Sh NAME
@@ -86,24 +86,6 @@
.Fn vsyslogp_r "int priority" "struct syslog_data *data" "const char *msgid" "const char *sdfmt" "const char *message" "va_list args"
.\" .Ft void
.\" .Fn vsyslog_ss "int priority" "struct syslog_data *data" "const char *message" "va_list args"
-.Bd -literal
-
-struct syslog_data {
- int log_file;
- int connected;
- int opened;
- int log_stat;
- const char *log_tag;
- int log_fac;
- int log_mask;
-};
-
-#define SYSLOG_DATA_INIT { \e
- .log_file = -1, \e
- .log_fac = LOG_USER, \e
- .log_mask = 0xff, \e
-}
-.Ed
.Sh DESCRIPTION
The
.Fn syslog
@@ -112,7 +94,7 @@
.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
+logged-in users, or forwarded to other machines as appropriate (see
.Xr syslogd 8 ) .
.Pp
The message is identical to a
@@ -129,6 +111,7 @@
.\" shouldn't the newline statement be removed?
.\" when logging through a socket a newline is
.\" not added nor is it required. -- ms
+.Pp
The
.Fn syslog_r
function is a multithread-safe version of the
@@ -146,24 +129,45 @@
constant is used for this purpose.
The
.Fa syslog_data
-structure is composed of the following elements:
-.Bl -tag -width connected
-.It Dv log_file
+structure and the
+.Dv SYSLOG_DATA_INIT
+constant are defined as:
+.Bd -literal -offset indent
+struct syslog_data {
+ int log_file;
+ int connected;
+ int opened;
+ int log_stat;
+ const char *log_tag;
+ int log_fac;
+ int log_mask;
+};
+
+#define SYSLOG_DATA_INIT { \e
+ .log_file = -1, \e
+ .log_fac = LOG_USER, \e
+ .log_mask = 0xff, \e
+}
+.Ed
+.Pp
+The structure is composed of the following elements:
+.Bl -tag -width connected -offset indent
+.It Va log_file
contains the file descriptor of the file where the message is logged
-.It Dv connected
+.It Va connected
indicates if connect has been done
-.It Dv opened
+.It Va opened
indicates if
.Fn openlog_r
has been called
-.It Dv log_stat
+.It Va log_stat
status bits, set by
.Fn openlog_r
-.It Dv log_tag
+.It Va log_tag
string to tag the entry with
-.It Dv log_fac
+.It Va log_fac
facility code
-.It Dv log_mask
+.It Va log_mask
mask of priorities to be logged
.El
.\" .Pp
