docs/149157: [patch] bsnmpd.1 fixes

[Warren Block]

>Number:         149157
>Category:       docs
>Synopsis:       [patch] bsnmpd.1 fixes
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Jul 31 17:00:12 UTC 2010
>Closed-Date:
>Last-Modified:
>Originator:     Warren Block
>Release:        8.1-stable
>Organization:
>Environment:
FreeBSD lightning 8.1-STABLE FreeBSD 8.1-STABLE #0: Fri Jul 30 21:09:47 MDT 2010     root at lightning:/usr/obj/usr/src/sys/LIGHTNING  i386
>Description:
bsnmpd.1 has inconsistent style for options descriptions.  Some say "This option is used for" while others just declare what the option does.  There are a couple of typos and some unnecessary use of "should" and "causes".
>How-To-Repeat:
man 1 bsnmpd
>Fix:
Apply attached patch.

Patch attached with submission follows:

--- contrib/bsnmp/snmpd/bsnmpd.1.orig	2006-02-27 09:16:17.000000000 -0700
+++ contrib/bsnmp/snmpd/bsnmpd.1	2010-07-31 10:48:58.000000000 -0600
@@ -49,7 +49,7 @@
 .Sh DESCRIPTION
 The
 .Nm
-daemon server the internet SNMP (Simple Network Management Protocol).
+daemon serves the internet SNMP (Simple Network Management Protocol).
 It is intended to serve only the absolute basic MIBs and implement all other
 MIBs through loadable modules.
 In this way the
@@ -59,11 +59,9 @@
 The options are as follows:
 .Bl -tag -width ".It Fl D Ar options"
 .It Fl d
-This option is used for debugging
-.Nm
-and causes it not to daemonize itself.
+Do not daemonize.  Used for debugging.
 .It Fl h
-This option prints a short usage message.
+Print a short usage message.
 .It Fl c Ar file
 Use
 .Ar file
@@ -75,33 +73,32 @@
 The following options are available.
 .Bl -tag -width ".It Cm trace Ns Cm = Ns Cm level"
 .It Cm dump
-This option causes all sent and received PDUs to be dumped to the terminal.
+Dump all sent and received PDUs to the terminal.
 .It Cm events
-This causes the debugging level of the event library (see
+Set the debugging level of the event library (see
 .Xr eventlib 3 )
-to be set to 10.
+to 10.
 .It Cm trace Ns Cm = Ns Cm level
-This option causes the snmp library trace flag to be set to the specified
+Set the snmp library trace flag to the specified
 value.
 The value can be specified in the usual C-syntax for numbers.
 .El
 .It Fl I Ar paths
-This option specifies a colon separated list of directories to search for
-configuration include files.
+Specify a colon separated list of directories to search for configuration
+include files.
 The default is
 .Pa /etc:/usr/etc/:/usr/local/etc .
 These paths are only searched for include specified within <> parentheses.
 .It Fl l Ar prefix
-The
+Use
 .Ar prefix
-is used as the default basename for the pid and the configuration files.
+as the default basename for the pid and the configuration files.
 .It Fl m Ar variable Ns Op = Ns Ar value
 Define a configuration variable.
 .It Fl p Ar file
 Specify an alternate pid file instead of the default one.
 .El
 .Sh CONFIGURATION
-The
 .Nm
 reads its configuration from either the default or the user specified
 configuration file.
@@ -218,7 +215,7 @@
 element is a hostname, the IP address of the host is looked up and the four
 elements of the IP address are appended to the oid.
 .Pp
-For example a oid of
+For example, an oid of
 .Bd -unfilled -offset indent
 myvariable.27.foooll.[localhost]."&^!"
 .Ed
@@ -253,13 +250,13 @@
 .It Pa /var/run/ Ns Ao Ar prefix Ac Ns \&.pid
 Default pid file.
 .It Pa /etc:/usr/etc/:/usr/local/etc
-This is the default search path for system include files.
+Default search path for system include files.
 .It Pa @MIBSPATH at FOKUS-MIB.txt
 .It Pa @MIBSPATH at BEGEMOT-MIB.txt
 .It Pa @MIBSPATH at BEGEMOT-SNMPD.txt
-The definitions for the MIBs implemented in the daemon.
+Definitions for the MIBs implemented in the daemon.
 .It Pa /etc/hosts.allow, /etc/hosts.deny
-Access controls that should be enforced by TCP wrappers should be defined here.
+Access controls that should be enforced by TCP wrappers are defined here.
 Further details are described in
 .Xr hosts_access 5 .
 .El


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