>Number:         14290
>Category:       bin
>Synopsis:       syslogd manual should explain what a log message contains
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bin-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Thu Oct 18 10:52:00 PDT 2001
>Closed-Date:
>Last-Modified:
>Originator:     
>Release:        not current
>Organization:
http://bsd.reedmedia.net/
>Environment:
	
System: NetBSD rainier 1.5.1_BETA NetBSD 1.5.1_BETA (JCR-1.5-20010407) #0: Sat Apr 7 01:44:35 PDT 2001 reed@rainier:/usr/src/sys/arch/i386/compile/JCR-1.5-20010407 i386


>Description:
Every so often I read or hear that someone doesn't understand the
info in a syslog log message; in particular the [pid]. I know this is not
related to syslogd, but maybe a quick explanation can help. 

While I was looking at this I see that syslogd's usage is slightly different
than the manual page. The usage() doesn't include -S and uses different
names for log_socket (vs. logpath). I didn't make a patch for that.
>How-To-Repeat:
man syslogd # what does [number] mean?
man syslog
>Fix:
Two patches below (are made against netbsd-1-5):

--- /usr/share/man/man3/syslog.3        Wed Apr 25 20:14:42 2001
+++ syslog.3    Thu Oct 18 10:44:50 2001
@@ -157,7 +157,8 @@
 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.
+instantiations of daemons. (This PID is placed within brackets
+between the ident and the message.)
 .El
 .Pp
 The


--- /usr/src/usr.sbin/syslogd/syslogd.8 Thu Jul 20 07:48:13 2000
+++ syslogd.8   Thu Oct 18 10:33:54 2001
@@ -129,6 +129,12 @@
 .Dl syslogd -p /var/run/log -p /web/var/run/log -p /ftp/var/run/log
 .Pp
 note: the normal log socket must now also be passed to syslogd.
+.Pp
+The logged message includes the date, time, and hostname (or pathname of
+the log socket). Commonly, the program name and the process id is
+included, but this depends on how
+.Xr openlog 3
+was used.
 .Sh SYSLOG PROTOCOL NOTES
 .Pp
 The message sent to

>Release-Note:
>Audit-Trail:
>Unformatted: