Man page for acpibat

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

Man page for acpibat

Dmitri Alenitchev
.Dd August 29, 2006
.Dt ACPIBAT 4
.Os
.Sh NAME
.Nm acpibat
.Nd ACPI Control Method Battery
.Sh SYNOPSIS
.Cd "acpibat* at acpi?"
.Sh DESCRIPTION
The
.Nm
driver supports ACPI Control Method Battery. The status can be
monitored by
.Xr sysctl 8
or
.Xr sensorsd 8 .
.Sh SEE ALSO
.Xr acpi 4 ,
.Xr intro 4 ,
.Xr sysctl 8 ,
.Xr sensorsd 8
.Sh HISTORY
The
.Nm
driver first appeared in
.Ox 3.8 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An Marco Peereboom Aq [hidden email] .
.Sh BUGS
Smart Battery Specification-based batteries are not supported.

And here is patch for adding this man-page to Makefile and
``See Also'' section of acpi(4) page.

Index: Makefile
===================================================================
RCS file: /cvs/src/share/man/man4/Makefile,v
retrieving revision 1.378
diff -u -r1.378 Makefile
--- Makefile    22 Aug 2006 18:36:55 -0000      1.378
+++ Makefile    29 Aug 2006 02:01:20 -0000
@@ -1,6 +1,6 @@
 #      $OpenBSD: Makefile,v 1.378 2006/08/22 18:36:55 deraadt Exp $
 
-MAN=   aac.4 ac97.4 acx.4 acphy.4 acpi.4 acpihpet.4 acpitimer.4 \
+MAN=   aac.4 ac97.4 acx.4 acphy.4 acpi.4 acpihpet.4 acpitimer.4 acpibat.4 \
        adc.4 addcom.4 admcts.4 admlc.4 admtemp.4 \
        admtm.4 admtmp.4 admtt.4 adt.4 adv.4 aha.4 ahb.4 ahc.4 ahd.4 aic.4 \
        akbd.4 alipm.4 amdiic.4 amdpm.4 ami.4 amphy.4 ams.4 \
Index: acpi.4
===================================================================
RCS file: /cvs/src/share/man/man4/acpi.4,v
retrieving revision 1.5
diff -u -r1.5 acpi.4
--- acpi.4      8 Mar 2006 17:45:19 -0000       1.5
+++ acpi.4      29 Aug 2006 02:01:20 -0000
@@ -51,9 +51,12 @@
 ACPI High Precision Event Timer
 .It Xr acpitimer 4
 ACPI power management timer
+.It Xr acpibat 4
+ACPI Control Method Battery
 .El
 .Sh SEE ALSO
 .Xr acpitimer 4 ,
+.Xr acpibat 4 ,
 .Xr intro 4
 .Sh HISTORY
 The

--
Dmitri A. Alenitchev
No place like $HOME

Reply | Threaded
Open this post in threaded view
|

Re: Man page for acpibat

Michael Knudsen-3
On Tue, Aug 29, 2006 at 06:04:48AM +0400, Dmitri Alenitchev wrote:

No license?  I suggest using /usr/share/misc/license.template but it's
your call.

> .Dd August 29, 2006
> .Dt ACPIBAT 4
> .Os
> .Sh NAME
> .Nm acpibat
> .Nd ACPI Control Method Battery
> .Sh SYNOPSIS
> .Cd "acpibat* at acpi?"
> .Sh DESCRIPTION
> The
> .Nm
> driver supports ACPI Control Method Battery. The status can be

New sentence, new line.

> monitored by
> .Xr sysctl 8
> or
> .Xr sensorsd 8 .
> .Sh SEE ALSO
> .Xr acpi 4 ,
> .Xr intro 4 ,

intro(4) doesn't mention acpi(4), so no point.

--
<dogs> i was dropped a lot as a child

Reply | Threaded
Open this post in threaded view
|

Re: Man page for acpibat

Miod Vallat
> > .Sh SEE ALSO
> > .Xr acpi 4 ,
> > .Xr intro 4 ,
>
> intro(4) doesn't mention acpi(4), so no point.

All manual pages in section 4 refer to intro(4). That's part of the fascist
documentation policy.

Miod

Reply | Threaded
Open this post in threaded view
|

Re: Man page for acpibat

Dmitri Alenitchev
Miod Vallat wrote:
> > > .Sh SEE ALSO
> > > .Xr acpi 4 ,
> > > .Xr intro 4 ,
> >
> > intro(4) doesn't mention acpi(4), so no point.
>
> All manual pages in section 4 refer to intro(4). That's part of the fascist
> documentation policy.

I already sent ansewer about intro(4) with changed man-page to Michael.
Thanks for answer.

Here is updated page:

.\" Copyright (c) 2006 Dmitri Alenitchev <[hidden email]>
.\"
.\" 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 August 29, 2006
.Dt ACPIBAT 4
.Os
.Sh NAME
.Nm acpibat
.Nd ACPI Control Method Battery
.Sh SYNOPSIS
.Cd "acpibat* at acpi?"
.Sh DESCRIPTION
The
.Nm
driver supports ACPI Control Method Battery.
The status can be monitored by
.Xr sysctl 8
or
.Xr sensorsd 8 .
.Sh SEE ALSO
.Xr acpi 4 ,
.Xr intro 4 ,
.Xr sysctl 8 ,
.Xr sensorsd 8
.Sh HISTORY
The
.Nm
driver first appeared in
.Ox 3.8 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver was written by
.An Marco Peereboom Aq [hidden email] .
.Sh BUGS
Smart Battery Specification-based batteries are not supported.