Hi,

a few comments regarding the manual:

Andre de Oliveira wrote on Fri, Feb 14, 2014 at 02:07:29PM +0100:

> diff --git a/share/man/man4/upd.4 b/share/man/man4/upd.4
> new file mode 100644
> index 0000000..5a9054d
> --- /dev/null
> +++ b/share/man/man4/upd.4
> @@ -0,0 +1,96 @@
> +.\"  $OpenBSD$
> +.\"
> +.\" Copyright (c) 2014 Andre de Oliveira <deoliveira...@googlemail.com>
> +.\"
> +.\" Permission to use, copy, modify, and distribute this software for any
> +.\" purpose with or without fee is hereby granted, provided that the above
> +.\" copyright notice and this permission notice appear in all copies.
> +.\"
> +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
> +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
> +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
> +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
> +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
> +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
> +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
> +.\"
> +.Dd $Mdocdate: February 8 2014 $
> +.Dt UPD 4
> +.Os
> +.Sh NAME
> +.Nm upd
> +.Nd USB Power Devices battery voltage and load sensor
> +.Sh SYNOPSIS
> +.Cd "upd* at uhub?"
> +.Sh DESCRIPTION
> +The
> +.Nm

Maybe insert the word "driver" here?

> +exposes data from USB Power Devices (such as an UPS), as hardware sensors
> +via
> +.Xr sysctl 3 .
> +The following devices are supported by the
> +.Nm
> +driver:
> +.Bl -column

The following macro would be better:

  .Bl -bullet -offset indent

> +.Pp

  No .Pp inside .Bl, please; just remove this line.

> +.It Li "American Power Conversion Smart-UPS 750"
> +.It Li "American Power Conversion Back-UPS CS 350"

  No need for physical markup, just delete the Li's.

> +.El
> +.Pp
> +The following sensors are provided by the
> +.Nm
> +driver, which can be monitored using
> +.Xr sensorsd 8 :
> +.Bl -column
> +.Pp

Again, .Bl -bullet -offset indent and no .Pp.

> +.It Battery Nominal Voltage
> +.It Battery Current Voltage
> +.It Battery Charging
> +.It Battery Discharging
> +.It Battery Present
> +.It Shutdown Imminent
> +.It AC Power Present
> +.It Battery Current Load
> +.El
> +.Sh EXAMPLES
> +In this example, the upd0 device is a regular UPS.
> +We use an entry on
> +.Xr sensorsd 8
> +to take an action when the battery level is below a 70%:
> +.Pp
> +.Bd -literal -offset indent

Removing the "-offset indent" might avoid overrunning the line.

> +hw.sensors.upd0.percent0:low=70:command=/etc/sensorsd/lowbattwarn %l
> +.Ed
> +.Pp
> +The contents of lowbattwarn could be:
> +.Pp
> +.Bd -literal -offset indent
> +#!/bin/ksh
> +
> +if [ $# -lt 1 ]; then
> +        return;
> +fi
> +
> +if [ $1 -lt 70 ]; then
> +        logger "ups battery warning-level, halting"
> +        /sbin/halt -p
> +fi
> +.Ed
> +.Sh SEE ALSO
> +.Xr intro 4 ,
> +.Xr uhub 4 ,
> +.Xr sensorsd 8 ,
> +.Xr sysctl 8
> +.Sh HISTORY
> +The
> +.Nm
> +driver first appeared in .Ox

Break the line before ".Ox", and give the version, like this:

+driver first appeared in
+.Ox 5.6 .

> +.Sh AUTHORS
> +The
> +.Nm
> +driver was written by Andre de Oliveira <deoliveira...@googlemail.com>,

+driver was written by
+.An Andre de Oliveira Aq Mt deoliveira...@googlemail.com ,

Yours,
  Ingo

Reply via email to