If there’s no further work on upd(4) prior to 5.8, at least make the man page reflect present reality.
- Update list of supported sensors, re-sorted by source file occurrence - Explain why manual sensorsd.conf(5) intervention can be necessary - Link to HID power specs - Prefer “a UPS” over “an UPS”, matches HID docs above - Other misc linguistic bikeshedding Apologies, this is my first experience with mdoc(7). --david Index: upd.4 =================================================================== RCS file: /cvs/src/share/man/man4/upd.4,v retrieving revision 1.3 diff -u -p -r1.3 upd.4 --- upd.4 19 Mar 2014 09:22:25 -0000 1.3 +++ upd.4 26 Jun 2015 02:46:15 -0000 @@ -25,17 +25,23 @@ .Sh DESCRIPTION The .Nm -driver exposes data from USB Power Devices (such as an UPS), -as hardware sensors via -.Xr sysctl 3 . +driver provides support for monitoring various sensors provided by +USB Power Devices (such as a UPS). +Supported sensor values are made available via the +.Xr sysctl 8 interface. .Pp -The following sensors are provided by the -.Nm -driver, which can be monitored using -.Xr sensorsd 8 : +The following sensors are supported by the driver: .Pp .Bl -item -offset indent -compact .It +BatteryPresent +.It +ShutdownImminent +.It +ACPresent +.It +Overload +.It RelativeStateOfCharge .It AbsoluteStateOfCharge @@ -48,19 +54,23 @@ Charging .It Discharging .It -BatteryPresent +AtRateTimeToFull .It -ShutdownImminent +AtRateTimeToEmpty .It -ACPresent +RunTimeToEmpty .It -AtRateTimeToFull +NeedReplacement .El .Sh SEE ALSO .Xr intro 4 , .Xr uhidev 4 , .Xr sensorsd 8 , +.Xr sensorsd.conf 5 , .Xr sysctl 8 +.Pp +The USB Power Devices specification can be found at +.Lk http://www.usb.org/developers/hidpage/ .Sh HISTORY The .Nm @@ -71,3 +81,18 @@ The .Nm driver was written by .An Andre de Oliveira . +.Sh BUGS +The +.Nm +driver does not indicate device health via aggregate or +individual sensor status. +Users who wish to monitor +.Nm +status using +.Xr sensorsd 8 +must manually establish +.Dq high +and +.Dq low +limits for sensor values of interest via +.Xr sensorsd.conf 5 .
