[src/trunk]: src Various English usage, spelling and markup fixes for envstat...

[riz <riz%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/7fec0f2b8950
branches:  trunk
changeset: 773611:7fec0f2b8950
user:      riz <riz%NetBSD.org@localhost>
date:      Thu Feb 09 18:10:26 2012 +0000

description:
Various English usage, spelling and markup fixes for envstat(4)-related
things, from Snader_LB.

diffstat:

 share/man/man4/envsys.4        |  13 +++++++------
 usr.sbin/envstat/envstat.8     |  25 +++++++++++++------------
 usr.sbin/envstat/envstat.c     |   6 +++---
 usr.sbin/envstat/envsys.conf.5 |  13 ++++++++-----
 4 files changed, 31 insertions(+), 26 deletions(-)

diffs (211 lines):

diff -r 82576ed27499 -r 7fec0f2b8950 share/man/man4/envsys.4
--- a/share/man/man4/envsys.4   Thu Feb 09 17:53:56 2012 +0000
+++ b/share/man/man4/envsys.4   Thu Feb 09 18:10:26 2012 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: envsys.4,v 1.48 2010/03/14 14:47:03 pgoyette Exp $
+.\"    $NetBSD: envsys.4,v 1.49 2012/02/09 18:10:26 riz Exp $
 .\"
 .\" Copyright (c) 2007 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -52,7 +52,7 @@
 to set some properties on sensors:
 .Xr envstat 8 .
 .It
-The kernel part that is able to talk to the drivers providing sensor
+The kernel part that is able to talk to the devices providing sensor
 data:
 .Xr sysmon_envsys 9 .
 .El
@@ -209,12 +209,12 @@
 .It Fa min-value
 Current min value in the sensor.
 .It Fa monitoring-state-critical
-If true, the driver has enabled the flag to monitor a critical state.
+If true, the device has enabled the flag to monitor a critical state.
 .It Fa monitoring-state-hw-range-limits
-If true, the driver has enabled the flag to monitor warning or critical
+If true, the device has enabled the flag to monitor warning or critical
 limits.
 .It Fa monitoring-state-state-changed
-If true, the driver has enabled the flag to monitor for state changes in
+If true, the device has enabled the flag to monitor for state changes in
 a drive or Battery state sensor.
 .It Fa monitoring-supported
 If true, critical/warning capacity/max/min limits may be set by the
@@ -253,7 +253,7 @@
 is used to remove all properties that are currently set via the
 .Dv ENVSYS_SETDICTIONARY
 ioctl.
-The values will be set to defaults, the ones that the driver uses.
+The values will be set to defaults, the ones that the device uses.
 .Pp
 Only one object is allowed on this dictionary:
 .Bd -literal -offset ident
@@ -429,6 +429,7 @@
 }
 .Ed
 .Sh SEE ALSO
+.Xr envsys.conf 5 ,
 .Xr envstat 8 ,
 .Xr powerd 8 ,
 .Xr sysmon_envsys 9
diff -r 82576ed27499 -r 7fec0f2b8950 usr.sbin/envstat/envstat.8
--- a/usr.sbin/envstat/envstat.8        Thu Feb 09 17:53:56 2012 +0000
+++ b/usr.sbin/envstat/envstat.8        Thu Feb 09 18:10:26 2012 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: envstat.8,v 1.60 2011/06/07 17:47:24 wiz Exp $
+.\"    $NetBSD: envstat.8,v 1.61 2012/02/09 18:10:26 riz Exp $
 .\"
 .\" Copyright (c) 2000, 2007, 2008, 2009 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -65,11 +65,11 @@
 .Xr envsys.conf 5
 manual page for more information.
 .It Fl D
-Display the names of the drivers that were registered with
+Display the names of the devices that are currently registered with
 the
 .Xr envsys 4
-framework, one per line and some properties for the driver: refresh timeout
-value, for example.
+framework, one per line, along with some properties for the device
+(for example, its refresh timeout value).
 .It Fl d Ar device
 Display only the sensors for the given
 .Ar device .
@@ -79,7 +79,7 @@
 Display temperature values in degrees Fahrenheit.
 The default is to display temperature values in degrees Celsius.
 .It Fl I
-This flag skips the sensors with invalid state, these are normally
+This flag skips the sensors with invalid state; these are normally
 shown using the
 .Qq N/A
 string by default.
@@ -110,12 +110,13 @@
 This flag is used to restore defaults to all devices registered with
 the framework.
 This will remove all properties that were set in
-the configuration file to the setting that the drivers use by
+the configuration file to the setting that the devices use by
 default.
 .It Fl s Ar "device:sensor,..."
-Restrict the display to the named sensors.
+Restrict the display to the named devices and sensors.
 The pair device and sensor description must be supplied as a comma separated list.
 Device as well as sensor descriptions are case sensitive.
+Note that the order of the arguments given does not influence the order of output.
 .It Fl T
 Create and display max, min and average statistics for a sensor.
 Must be used with an
@@ -134,9 +135,9 @@
 This option has no effect.
 It is retained for historical reasons.
 .It Fl x
-Shows the property list used by the
+Shows the raw XML property list used by the
 .Xr sysmon_envsys 9
-framework that contains details about all registered drivers
+framework that contains details about all registered devices
 and sensors.
 .El
 .Sh UNITS
@@ -169,18 +170,18 @@
 .Sh EXAMPLES
 To display the
 .Dq charge
-sensor of the driver
+sensor of the device
 .Ar acpibat0
 in one line every ten seconds:
 .Pp
 .Dl $ envstat -s \*qacpibat0:charge\*q -i 10
 .Pp
-To list the drivers that are currently registered with
+To list the devices that are currently registered with
 .Xr envsys 4 :
 .Pp
 .Dl $ envstat -D
 .Pp
-To display the sensors of the driver
+To display the sensors of the device
 .Ar aibs0 :
 .Pp
 .Dl $ envstat -d aibs0
diff -r 82576ed27499 -r 7fec0f2b8950 usr.sbin/envstat/envstat.c
--- a/usr.sbin/envstat/envstat.c        Thu Feb 09 17:53:56 2012 +0000
+++ b/usr.sbin/envstat/envstat.c        Thu Feb 09 18:10:26 2012 +0000
@@ -1,4 +1,4 @@
-/* $NetBSD: envstat.c,v 1.89 2011/12/04 19:34:22 jmcneill Exp $ */
+/* $NetBSD: envstat.c,v 1.90 2012/02/09 18:10:26 riz Exp $ */
 
 /*-
  * Copyright (c) 2007, 2008 Juan Romero Pardines.
@@ -27,7 +27,7 @@
 
 #include <sys/cdefs.h>
 #ifndef lint
-__RCSID("$NetBSD: envstat.c,v 1.89 2011/12/04 19:34:22 jmcneill Exp $");
+__RCSID("$NetBSD: envstat.c,v 1.90 2012/02/09 18:10:26 riz Exp $");
 #endif /* not lint */
 
 #include <stdio.h>
@@ -186,7 +186,7 @@
                case 'x':       /* print the dictionary in raw format */
                        flags |= ENVSYS_XFLAG;
                        break;
-               case 'W':       /* No longer used, retained for campatability */
+               case 'W':       /* No longer used, retained for compatibility */
                        break;
                case '?':
                default:
diff -r 82576ed27499 -r 7fec0f2b8950 usr.sbin/envstat/envsys.conf.5
--- a/usr.sbin/envstat/envsys.conf.5    Thu Feb 09 17:53:56 2012 +0000
+++ b/usr.sbin/envstat/envsys.conf.5    Thu Feb 09 18:10:26 2012 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: envsys.conf.5,v 1.13 2010/02/15 23:04:11 pgoyette Exp $
+.\" $NetBSD: envsys.conf.5,v 1.14 2012/02/09 18:10:26 riz Exp $
 .\"
 .\" -
 .\" Copyright (c) 2007, 2008 Juan Romero Pardines.
@@ -30,7 +30,9 @@
 .Os
 .Sh NAME
 .Nm envsys.conf
-.Nd Configuration file for the envsys framework
+.Nd configuration file for the
+.Xr envsys 4
+framework
 .Sh SYNOPSIS
 .Nm envstat
 .Op Fl S
@@ -409,10 +411,10 @@
 .Em Voltage
 sensors and
 .Em only
-if the driver has enabled the appropriate flag for the mentioned
+if the device has enabled the appropriate flag for the mentioned
 sensor.
 The resistor factor may be used to change the behavior
-of the value returned by the driver.
+of the value returned by the device.
 .Pp
 If a sensor supports this, the
 .Em allow-rfact
@@ -423,7 +425,7 @@
 .Bl -tag -width ident
 .It refresh-timeout = 10s
 .Pp
-This property sets the refresh timeout value in a driver, and will be used
+This property sets the refresh timeout value in a device, and will be used
 to refresh data and check for critical conditions any time the timeout
 is met.
 The value may be specified in seconds, minutes or hours.
@@ -447,6 +449,7 @@
 .El
 .Sh SEE ALSO
 .Xr proplib 3 ,
+.Xr envsys 4 ,
 .Xr envstat 8 ,
 .Xr powerd 8
 .Sh HISTORY