Aren/NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Various improvements: typo fixes, wording, formatting.

Browse Source
This commit is contained in:
wiz 2007-10-25 23:14:41 +00:00
parent 555e1d5a74
commit c06a095415
1 changed files with 58 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
usr.sbin/envstat/envsys.conf.5
View File

@ -1,4 +1,4 @@
.\" $NetBSD: envsys.conf.5,v 1.4 2007/10/09 08:00:46 xtraeme Exp $
.\" $NetBSD: envsys.conf.5,v 1.5 2007/10/25 23:14:41 wiz Exp $
.\"
.\" -
.\" Copyright (c) 2007 Juan Romero Pardines.
@ -24,7 +24,7 @@
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\"
.\"
.Dd October 7, 2007
.Dt ENVSYS.CONF 5
.Os
@ -32,26 +32,21 @@
.Nm envsys.conf
.Nd Configuration file for the envsys framework
.Sh SYNOPSIS
envstat
.Op Fl c Ar /etc/envsys.conf
.Nm envstat
.Op Fl S
.Op Fl c Ar /etc/envsys.conf
.Sh DESCRIPTION
The
.Nm
file configures all the features provided by the
.Xr envsys
.Xr envsys 4
framework.
It is composed by series of
.Em device
and
.Em sensor blocks .
Each
.Em sensor block
defines a group of
It consists of a series of device and sensor blocks .
Each sensor block defines a group of
.Em properties .
The file format is free-form: new line markers are ignored as well as
indentation.
Comments start with the
The file format is free-form: new line markers and indentation are
ignored.
Comments start with a
.Sq #
sign and extend until the end of line.
.Pp
@ -71,7 +66,7 @@ The value must be surrounded by double quotes if it contains whitespace.
There can be multiple groups of devices and multiple groups of sensors
in the configuration file.
.Pp
A device block consists of one or multiple sensor blocks.
A device block consists of one or more sensor blocks.
It has the following syntax:
.Bd -literal -offset indent
device_name {
@ -90,7 +85,7 @@ It has the following syntax:
.Pp
Device names are those shown by the
.Ql envstat -D
command; Sensor blocks are named by its index position in which they are shown.
command; sensor blocks are named by the index position in which they are shown.
.Pp
For example, if we have the following output from the
.Xr envstat 8
@ -117,13 +112,14 @@ sensor.
There is another way that will give you the correct index
sensor; the
.Ql envstat -x
command will print the raw XML property list. You only have to
find the
command will print the raw XML property list.
You only have to find the
.Em index
object in the appropiate dictionary. The object will be shown as:
object in the appropriate dictionary.
The object will be shown as:
.Bd -literal -offset indent
<key>index</key>
<string>sensor2</string>
\*[Lt]key\*[Gt]index\*[Lt]/key\*[Gt]
\*[Lt]string\*[Gt]sensor2\*[Lt]/string\*[Gt]
.Ed
.Pp
Invalid sensors and devices will be detected by the
@ -136,106 +132,112 @@ apply to all type of sensors):
.It critical-capacity = 10;
.Pp
Sets a critical capacity limit property of 10
.Em percent in a
.Em battery sensor .
percent in a battery sensor.
Battery sensors are those that report a percentage from the
.Xr envstat 8
output.
.Pp
It is also possible to know if the sensor accepts this property
It is possible to find out if the sensor accepts this property
by running
.Ql envstat -x
and looking if the
.Em want-percentage
object is defined as
.Em true
on its dictionary. For example:
on its dictionary.
For example:
.Bd -literal -offset indent
<key>want-percentage</key>
<true/>
\*[Lt]key\*[Gt]want-percentage\*[Lt]/key\*[Gt]
\*[Lt]true/\*[Gt]
.Ed
.Pp
Only a value between 0 and 100 is allowed. When the limit is reached in
the sensor, a
Only a value between 0 and 100 is allowed.
When the limit is reached in the sensor, a
.Em user-capacity
event will be sent to the
.Xr powerd 8
daemon (if running) and will execute the block for this event in the
daemon (if running) and will execute the block for this event in
.Pa /etc/powerd/scripts/sensor_battery .
.It critical-max = 70C;
.Pp
Sets a critical max limit property in a sensor. Note that in
this example, we are specifying the
Sets a critical max limit property in a sensor.
Note that in this example, we are specifying the
.Ql C
keyword at the end; that means that this will only be valid for
.Em temperature
sensors and that the value is specified as degrees
.Em Celsius .
If degrees Fahrenheit is wanted, just change it to a
If degrees Fahrenheit are wanted, just change use the letter
.Em F ,
like:
.Bd -literal -offset indent
critical-max = 140F;
.Ed
.Pp
To know the type of sensor, you have to look at the
To know sensor type, you have to look at the
.Em type
object in the XML property list. Remember: the XML property list has
all the information that the application uses to print the values!.
object in the XML property list.
Remember: the XML property list has
all the information that the application uses to print the values!
.Pp
Other sensors that are not of
.Em temperature
type, must not specify the final character for degrees. Also a dot
is allowed in the value, if that corresponds to the range that the
sensor is reporting. When the limit has been reached in the sensor,
a
type must not include the final character for the unit.
A dot is allowed in the value, if it corresponds to the
range that the sensor is reporting.
When the limit has been reached in the sensor, a
.Em critical-over
event will be sent to the
.Xr powerd 8
daemon (if running) and will execute the block for this event in
the appropiate
the appropriate
.Pa /etc/powerd/scripts/sensor_foo
script (depending of sensor's type).
script (depending on the sensor's type).
.Pp
Please note that this property cannot be set in battery sensors
(those that have the
.Em want-percentage
object on its dictionary), this same rule must be applied for the
object in their dictionary).
This rule applies for the
.Ql critical-min
property.
property too.
.It critical-min = 1.230;
.Pp
Sets a critical min limit property in a sensor. The rules for
Sets a critical min limit property in a sensor.
The rules for
.Em critical-max
and
.Em critical-min
are the same. When the limit has been reached in the sensor, a
are the same.
When the limit has been reached in the sensor, a
.Em critical-under
event will be sent to the
.Xr powerd 8
daemon (if running) and will execute the block for this event in
the appropiate
the appropriate
.Pa /etc/powerd/scripts/sensor_foo
script (depending of sensor's type).
script (depending on the sensor's type).
.It description = string
.Pp
Sets a new description in a sensor. You can set this property in
Sets a new description in a sensor.
You can set this property in
all sensors, except that you won't be able to set a description
that is currently used for the specified device.
.It rfact = 56000;
.Pp
Sets a new resistor factor property in a sensor. This property is
only allowed in
Sets a new resistor factor property in a sensor.
This property is only allowed in
.Em Voltage
sensors and
.Em only
if the driver has enabled the appropiate flag for the mentioned
sensor. The resistor factor may be used to change the behavior
if the driver 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.
.Pp
To know if the sensor supports this, the
If a sensor supports this, the
.Em allow-rfact
object must appear enabled (true) in the dictionary.
object appears enabled (true) in the dictionary.
.El
.Sh FILES
.Bl -tag -width /etc/envsys.conf -compact