On Sun, Sep 18, 2016 at 06:15 +0000, Visa Hankala wrote:
> On Sat, Sep 17, 2016 at 02:40:09PM +0100, Rafael Neves wrote:
> > Hi, 
> > 
> > Here follows a manpage for octuctl(4), based on dwctwo(4) manpage.
> > I am not sure if the title should stop in Controller or in Interface,
> > so I mantained the phrasing of commit.
> > 
> > Index: share/man/man4/octuctl.4
> > ===================================================================
> > RCS file: share/man/man4/octuctl.4
> > diff -N share/man/man4/octuctl.4
> > --- /dev/null       1 Jan 1970 00:00:00 -0000
> > +++ share/man/man4/octuctl.4        7 Sep 2016 21:55:30 -0000
> > @@ -0,0 +1,43 @@
> > +.\"        $OpenBSD: octuctl.4,v 1.3 2016/02/02 17:38:20 jmc Exp $
> > +.\"
> > +.\" Copyright (c) 2016 Visa Hankala
> > +.\"
> > +.\" 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: July 28 2016 $
> > +.Dt OCTUCTL 4
> > +.Os
> > +.Sh NAME
> > +.Nm octuctl
> > +.Nd Octeon II USB Controller Interface
> > +.Sh SYNOPSIS
> > +.Cd "octuctl0 at iobus? irq 56        " Pq "octeon"
> > +.Cd "ehci0    at octuctl?"
> > +.Cd "ohci0    at octuctl?"
> > +.Sh DESCRIPTION
> > +The
> > +.Nm octuctl
> > +driver provides support for the Octeon II USB Controller Interface,
> > +which provides an interface to
> > +.Xr ehci 4
> > +and
> > +.Xr ohci 4
> > +devices.
> > +.Sh SEE ALSO
> > +.Xr ehci 4 ,
> > +.Xr ohci 4
> > +.Sh HISTORY
> > +The
> > +.Nm
> > +driver first appeared in
> > +.Ox 6.0 .
> 
> My name does not belong to the copyright because I am not the author
> of this work.
> 
> Is it customary to write manual pages for driver glue?
> 

Traditionally, you'd add a line "echi* at octuctl?" to echi(4)
man page with a cross reference to octuctl(4) in the SEE ALSO
section and then add the description of what is octuctl into
it's own man page.

Just like usb(4) mentions dwctwo? attachment and then dwctwo(4)
describes what is it.

Reply via email to