From pepper@reppep.com Fri Nov 22 13:54:41 2002 Return-Path: Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 1B5C037B401 for ; Fri, 22 Nov 2002 13:54:41 -0800 (PST) Received: from www.reppep.com (www.reppep.com [66.92.104.200]) by mx1.FreeBSD.org (Postfix) with ESMTP id 683BD43E4A for ; Fri, 22 Nov 2002 13:54:40 -0800 (PST) (envelope-from pepper@reppep.com) Received: by www.reppep.com (Postfix, from userid 501) id 9DCCAAC7C; Fri, 22 Nov 2002 16:54:40 -0500 (EST) Message-Id: <20021122215440.9DCCAAC7C@www.reppep.com> Date: Fri, 22 Nov 2002 16:54:40 -0500 (EST) From: pepper@reppep.com (Chris Pepper) Reply-To: Chris Pepper To: FreeBSD-gnats-submit@freebsd.org Cc: Subject: Minor language fixes to syslog.conf.5 X-Send-Pr-Version: 3.113 X-GNATS-Notify: >Number: 45604 >Category: docs >Synopsis: Minor language fixes to syslog.conf.5 >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: closed >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Fri Nov 22 14:00:01 PST 2002 >Closed-Date: Mon Dec 23 21:34:40 PST 2002 >Last-Modified: Mon Dec 23 21:34:40 PST 2002 >Originator: Chris Pepper >Release: >Organization: >Environment: System: FreeBSD www.reppep.com 4.7-STABLE FreeBSD 4.7-STABLE #0: Wed Nov 20 01:10:47 EST 2002 root@www.reppep.com:/usr/obj/usr/src/sys/GENERIC i386 >Description: /usr/share/man/man5/syslog.conf.5.gz is a bit unclear. Following are a bunch of language fixes. In addition, I have a few further issues I can't propose fixes for: Is it possible to specify a host without + or - syntax? Is +host additive, or does it reset and add just that host? It would be helpful to include hostname selection examples here, and perhaps commented out in /etc/syslog.conf (commented out) as well. Are # lines comments, or host/prog separators, or both at different times? These two paragraphs appear to conflict: A program specification is a line beginning with `#!prog' or `!prog' (the former is for compatibility with the previous syslogd, if one is sharing syslog.conf files, for example) and the following blocks will be associ- ated with calls to syslog(3) from that specific program. A program spec- ification for `foo' will also match any message logged by the kernel with the prefix `foo: '. The `#!+prog' or `!+prog' specification works just like the previous one, and the `#!-prog' or `!-prog' specification will match any message but the ones from that program. A hostname specifica- tion of the form `#+hostname' or `+hostname' and the following blocks will be applied to messages received from the specified hostname. Alter- natively, a hostname specification `#-hostname' or `-hostname' causes the following blocks to be applied to messages from any host but the one specified. If the hostname is given as `@', the local hostname will be used. A program or hostname specification may be reset by giving the program or hostname as `*'. Blank lines and lines whose first non-blank character is a hash (``#'') character are ignored. >How-To-Repeat: man syslog.conf >Fix: --- syslog.conf.5.diff begins here --- --- syslog.conf.5 Mon Nov 18 14:50:24 2002 +++ syslog.conf.5.fixed Fri Nov 22 16:18:45 2002 @@ -51,7 +51,7 @@ .Em program and .Em hostname -specifications, +specifications (separations appear along on the line), with each line containing two fields: the .Em selector field which specifies the types of messages and priorities to which the @@ -69,12 +69,12 @@ Note that if you use spaces as separators, your .Nm might be incompatible with other Unices or Unix-like systems. -This functionality was added for the ease of configuration +This functionality was added for ease of configuration (e.g. it is possible to cut-and-paste into .Nm ) , and to avoid possible mistakes. This change however preserves -backwards compatibility with the old style of the +backwards compatibility with the old style of .Nm (i.e. tab characters only). .Pp @@ -101,7 +101,7 @@ the following keywords: auth, authpriv, console, cron, daemon, ftp, kern, lpr, mail, mark, news, ntp, security, syslog, user, uucp and local0 through local7. -These keywords (with the exception of mark) correspond to the +These keywords (with the exception of mark) correspond to similar .Dq Dv LOG_ values specified to the @@ -113,14 +113,14 @@ The .Em comparison flags may be used to specify exactly what is logged. -The default set of comparison flags are +The default comparison is .Dq => (or, if you prefer, .Dq >= ) , which means that messages from the specified .Em facility -list of a priority -level equal or greater than +list, and of a priority +level equal to or greater than .Em level will be logged. .Pp @@ -129,7 +129,7 @@ describes the severity of the message, and is a keyword from the following ordered list (higher to lower): emerg, alert, crit, err, warning, notice, info and debug. -These keywords correspond to the +These keywords correspond to similar .Dq Dv LOG_ values specified to the @@ -146,14 +146,14 @@ and .Em hostname specifications given. -Thus, a block which selects +Thus, with a block which selects .Ql ppp as the .Em program , directly followed by a block that selects messages from the .Em hostname .Ql dialhost , -then the second block will only log messages +the second block will only log messages from the .Xr ppp 8 program on dialhost. @@ -193,9 +193,9 @@ .Ql #+hostname or .Ql +hostname -and the following blocks will be applied to messages +means the following blocks will be applied to messages received from the specified hostname. -Alternatively, a +Alternatively, the .Em hostname specification .Ql #-hostname @@ -215,7 +215,7 @@ .Pp See .Xr syslog 3 -for a further descriptions of both the +for further descriptions of both the .Em facility and .Em level @@ -263,9 +263,9 @@ An asterisk .Pq Dq * can be used to specify all -.Em facilities +.Em facilities , all -.Em levels +.Em levels , or all .Em programs . .Pp @@ -359,7 +359,7 @@ A configuration file might appear as follows: .Bd -literal # Log all kernel messages, authentication messages of -# level notice or higher and anything of level err or +# level notice or higher, and anything of level err or # higher to the console. # Don't log private authentication messages! *.err;kern.*;auth.notice;authpriv.none /dev/console @@ -411,7 +411,7 @@ .Dq kern are usually translated to facility .Dq user . -This translation can be disabled, +This translation can be disabled; see .Xr syslogd 8 for details. --- syslog.conf.5.diff ends here --- >Release-Note: >Audit-Trail: State-Changed-From-To: open->patched State-Changed-By: trhodes State-Changed-When: Mon Dec 23 17:06:03 PST 2002 State-Changed-Why: Patched! I'll handle the MFC. Thanks! http://www.freebsd.org/cgi/query-pr.cgi?pr=45604 State-Changed-From-To: patched->closed State-Changed-By: trhodes State-Changed-When: Mon Dec 23 21:34:20 PST 2002 State-Changed-Why: MFC complete! Thanks for the submission! http://www.freebsd.org/cgi/query-pr.cgi?pr=45604 >Unformatted: