envstat(8): use \(aq for literal ASCII single quote in examples

Literal ASCII single quote in the input becomes right single quote in
the PostScript output. While that is the look from the old dead tree
manuals that we know and love, it does the wrong thing when
copy-pasted from a PDF document, so make sure the examples come out
right with the literal ASCII single quotes in them.

envstat(8): tweak examples

Drop shell prompt, we don't show any sample output, so we don't need
to mark the command as input. Explicitly split longer commands with a
backslash continuation.

envstat(8): use .Bl -column for units

envstat(8): brush up markup

New features for envstat(8).

o The usual output of envstat(8) is meant for human consumption and it
is harder than it needs to be to extract the data and process it with
or for other systems or programs. There is a '-x' flag to output the
raw XML from the envsys(4) framework, but that doesn't run the data
though the conversions that envstat(8) does in the human output case.
So, provide a '-j' flag that outputs in JSON. Each execution of
envstat(8) will produce consistent JSON that can be piped directly
into the 'jq' command, for example. When used with the interval flag,
'-i', each interval will be consistent JSON with a separator string to
make it easier to split the input.

(as an aside, there is a '-n' option too, that just extracts the
current value from each sensor, but that is a little too terse for the
cases where a device provides multiple sensors or if you ask for
multiple devices, as you lose the ability to know what each value is
associated with)

o Provide a '-t' flag that will time stamp the output with the time
that the extraction was executed. This is only provided for the human
output, or JSON output. In the human output case, the first line is a
human readable date and time. In the JSON case, an object is included
in the output that contains the human readable date and time, and
another object that contains the Unix epoch version of the same. This
makes it possible to extract the data and have the data tell you when
it was executed.


I have been using this for a little while and it seems to work quite
well when one needs to pull a lot of sensors from the envsys(4)
framework at one time. It has ended up being much faster and less
error prone in a lot of cases then parsing the human output of
envstat(8) with regexs.

branches: 1.67.4;


A driver for the Bosch BMP280 / BME280 temperature, humidity and
atmospheric pressure sensor. This is an inexpensive to moderately
expensive chip available from a large number of places. The driver
supports all aspects of the two chips, except for the repeating read
mode which would allow for sub-second queries, such as fall detection
or perhaps even as an altimeter. This driver also only supports the
I2C interface and not the SPI interface.

The BME280, the one with humidity, is not fully tested at this point,
awaiting upon a breakout board and may not show proper humidity.

New sentence, new line.
Other whitespace fixes, and some Xr fixes.

Add option -n to print only the value of a sensor.
If statistics are selected with -T, then also display max, min and average.
The empty line between each display is skipped when one or more sensors are
selected with -s.

Allow to select raw output for a single device or a list of sensors.

For raw output (-x) allow to extract individual properties like drvctl -p.
E.g.

# envstat -x /vcmbox0/0/cur-value
328150000

add HYT-221/271/939 humidity/temperature I2C sensor
extend envsys(4) framework by %rH (relative humidity)

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

branches: 1.60.2;
Sort sections.

Add a BUGS section to point out that the statistic "average" is an
average only of the current, minimum, and maximum values, and not a
running average of all displayed current values.

branches: 1.58.4;
Add option k to synopsis.

Add brief explanations of unit abbreviations.
Add units(1) to see also.

Remove aiboost(4) as obsolete and redundant since the introduction of aibs(4).

http://mail-index.netbsd.org/tech-kern/2010/03/06/msg007458.html

Reviewed by <pgoyette>, <cegger>, <jruoho>, <tech-kern>.

Update cross-reference to refer to new aibs(4) instead of aiboost(4)

New aibs(4) driver for ASUSTeK AI Booster (ACPI ATK0110) hardware monitor
with limit support.

http://thread.gmane.org/gmane.os.netbsd.devel.kernel/35654

Reviewed by <pgoyette>, <jruoho> and <tech-kern>.

New sentence, new line.

Since we never have both a limit value and a limit %capacity value,
remove the Capacity column.

Reduce inter-column spacing, and display all four limits on one page,
rather than using the -W command line option to switch between critical
and warning limits. (The -W option is still permitted, but has no
effect.)

%capacity limits are displayed in the WarnMin and CritMin columns, but
have a trailing % sign.

Add missing apostrophe.

New sentence, new line. Bump date for previous.

Add support for showing temperatures in Kelvin.

branches: 1.48.4;
Ported alipm(4) and admtemp(4) from OpenBSD.

Update cross-references for addition of dbcool(4) and removal of adt7463c(4)
and adt7467c(4).

1. provide for warning-min and warning-max alarm levels in addition to
critical-min and critical-max; also, a battery warning-capacity is
added in addition to a critical-capacity.

2. usr.sbin/envstat is modified to introduce a -W command line switch to
display the warning-* values instead of the critical-* values, and
envstat(8) and envsys.conf(5) man pages are updated appropriately.

3. Treat user-defined limits as a single continuum and generate a single
event regardless of how many boundaries a change in sensor value
crosses; ditto for driver-defined limits.

Fixes my PR/39021
Fixes my PR/39022

OK'd by christos@ bouyer@ cube@

branches: 1.45.2;
Convert TNF licenses to new 2 clause variant

* Improve default display output by adding a header that will match
current value as well as critical limits set and sensor unit.

* Add a new flag: -T. When it's enabled statistics will be created for
the sensors. Max, min and average statistics as well as sensor unit
will be displayed. Must be used with an interval.

You can see the new code in action here:

http://www.netbsd.org/~xtraeme/envstat_stats.txt

Thanks to jmcneill@ for comments and ideas.

amdtemp(4): Driver for AMD CPU Temperature Sensors. Adopted from OpenBSD's kate(4).
Changes beyond OpenBSD's driver:
- Improved support for AMD K8
- Added support for AMD Barcelona, AMD Phenom and AMD Griffin
Tested on various single and multi-socket machines.
Review and OK xtreame

branches: 1.42.2;
* Add support to show output from specified sensors in multiple devices
via the -s flag (the requirement for -d is not there anymore). [1]

You can do something like the following now:

$ envstat -s "acpibat0:charge,acpibat0:charge state,acpitz0:temperature"
[acpibat0]
charge: 3.015 Ah (79.70%)
charge state: NORMAL
[acpitz0]
temperature: 54.000 degC
$

* As bonus, the code has been modified to use a simple queue for
the sensors, and this has simplified and improved some parts of the
code as well.

[1] Item requested by joerg@ yesterday.

Mention finsio(4).

Mention pic16lc(4).

Mention cac(4).

Mention adt7463c(4) and thinkpad(4) even if the manpages don't exist.

This is to have a reference about which drivers are using the envsys
framework.

Xref arcmsr(4).

branches: 1.36.2;
Xref battery_pmu(4).

Sort SEE ALSO.

Implement the 'refresh-timeout' property in device blocks for the
configuration files. This sets the timeout value that will be used
to check for critical limits.

The value can be viewed by the 'envstat -D' command.

Mention coretemp(4).

Another comment that is no more thanks to the new configuration file.

Modify a comment that is not valid anymore.

Xref envsys.conf(5)

New configuration file format for the envsys framework:

foo0 {
#
# CPU Temperature
#
sensor0 {
critical-max = 70C;
critical-min = 20C;
}
...
}
...

Removed the -m flag that was previously used to set properties for
sensors. Now the -c flag will process all properties specified in
the file (accepted as argument).

To remove all properties that were set, the new -S flag can be used.
This will restore default values for all devices.

Merge a patch from Iain Hibbert (plunky@):

- some unclear language cleaned up
- inconsistent usage of 'device' and 'driver' to refer to the same thing
- difficult error handling

And print the device name if -d flag is not specified for any driver
registered, e.g:

$ envstat
[aiboost0]
CPU Temperature: 36.000 degC max: 70.000 degC min: 15.000 degC
MB Temperature: 38.000 degC max: 50.000 degC min: 15.000 degC
Vcore Voltage: 1.232 V max: 1.350 V min: 1.150 V
+3.3 Voltage: 3.264 V max: 3.500 V min: 3.000 V
+5 Voltage: 5.017 V max: 5.600 V min: 4.500 V
+12 Voltage: 11.932 V max: 13.500 V min: 11.200 V
CPU FAN Speed: 1268 RPM
$

replace inadvertently removed N

sort options

Mention aps(4).

Fix typo in previous.

Add the -I flag that skips sensors with invalid state. They are shown
by default, but this is for users that don't want to print them.

branches: 1.22.2;
Fix typo.
Ok'ed by xtraeme@

Add the -r flag, which is a dummy flag... only added for compatibility
reasons.

tyop

Fix the example that used -s without -d, found by hira@.

Improve description about the -s flag, it must be used with -d.

Two grammar fixes from Zafer Aydogan.

Imported envsys 2, a brief description of the new features:
(Part 3: userland)

* Support for detachable sensors.
* Cleaned up the API for simplicity and efficiency.
* Ability to send capacity/critical/warning events to powerd(8).
* Adapted all the code to the new locking order.
* Compatibility with the old envsys API: the ENVSYS_GTREINFO
and ENVSYS_GTREDATA ioctl(2)s are supported.
* Added support for a 'dictionary based communication channel' between
sysmon_power(9) and powerd(8), that means there is no 32 bytes event
size restriction anymore.
* Binary compatibility with old envstat(8) and powerd(8) via COMPAT_40.
* All drivers with the n^2 gtredata bug were fixed, PR kern/36226.

Tested by:

blymn: smsc(4).
bouyer: ipmi(4), mfi(4).
kefren: ug(4).
njoly: viaenv(4), adt7463.c.
riz: owtemp(4).
xtraeme: acpiacad(4), acpibat(4), acpitz(4), aiboost(4), it(4), lm(4).

Mention mfi(4), bump date.

* tctrl(4) -> sparc/tctrl(4)
* Mention sparc64/envctrl(4) (hi tnn)

Erm add missing char.

Last one: mention adt7467c(4).

Mention ipmi(4), nsclpcsio(4), owtemp(4), tctrl(4) and tm121temp(4).

Mention aiboost(4), it(4), ug(4) and viaenv(4), bump date.

Bump date for previous. Remove trailing whitespace.

Add a useful example.

add references to ACPI man pages.

branches: 1.6.2;
Add -r to synopsis.

New sentence, new line. Bump date for -r description.

Document the -r flag.

Drop a trailing empty line.

If the `device' argument is not specified, attempt to open /dev/sysmon.

branches: 1.1.4;
Add envstat(8) for displaying sensor readings from any envsys(4)
compatible device.