cvs commit: src/share/man/man4 an.4 ath.4 aue.4 awi.4 axe.4 bfe.4 bge.4 cdce.4 cm.4 cue.4 dc.4 de.4 ed.4 em.4 en.4 fwe.4 fwip.4 fxp.4 hme.4 ipw.4 iwi.4 kue.4 lge.4 my.4 nge.4 nve.4 pcn.4 ral.4 re.4 rl.4 rue.4 sf.4 sis.4 sk.4 sn.4 ste.4 ti.4 tl.4 tx.4 txp.4 ...

[John Baldwin]

On Friday 07 October 2005 08:11 am, Ruslan Ermilov wrote:
> On Fri, Oct 07, 2005 at 06:25:37AM -0400, Tom Rhodes wrote:
> > On Fri, 7 Oct 2005 08:56:44 +0100
> >
> > Ceri Davies <ceri at submonkey.net> wrote:
> > > On Fri, Oct 07, 2005 at 02:32:16AM +0000, Tom Rhodes wrote:
> > > > trhodes     2005-10-07 02:32:16 UTC
> > > >
> > > >   FreeBSD src repository
> > > >
> > > >   Modified files:
> > > >     share/man/man4       an.4 ath.4 aue.4 awi.4 axe.4 bfe.4 bge.4
> > > >                          cdce.4 cm.4 cue.4 dc.4 de.4 ed.4 em.4
> > > >                          en.4 fwe.4 fwip.4 fxp.4 hme.4 ipw.4 iwi.4
> > > >                          kue.4 lge.4 my.4 nge.4 nve.4 pcn.4 ral.4
> > > >                          re.4 rl.4 rue.4 sf.4 sis.4 sk.4 sn.4
> > > >                          ste.4 ti.4 tl.4 tx.4 txp.4 udav.4 ural.4
> > > >                          vge.4 vlan.4 vr.4 wb.4 wi.4 xe.4 xl.4
> > > >     share/man/man4/man4.i386 arl.4 cp.4 cs.4 cx.4 ep.4 ex.4 fe.4
> > > >                              ie.4 lnc.4 ray.4 vx.4
> > > >   Log:
> > > >   Work around an apparent mdoc(7) bug.
> > >
> > > What's the bug?  You can only use .Nm once or something?
> > >
> > > Ceri
> >
> > DES has already followed up, Groff was inserting a line break
> > for some really stupid reason.  So, I guess this is a good
> > work around.  :)
>
> There's no bug (already told you about this when Marius noticed).
> This is an intended behavior.  The .Nm macro is special while in
> the SYNOPSIS section: it starts a new line and it sets up the
> indentation level to point after itself, to make the following
>
> work:
> : SYNOPSIS
> :      install [-bCcMpSsv] [-B suffix] [-f flags] [-g group] [-m mode]
> :              [-o owner] file1 file2
> :      install [-bCcMpSsv] [-B suffix] [-f flags] [-g group] [-m mode]
> :              [-o owner] file1 ... fileN directory
> :      install -d [-v] [-g group] [-m mode] [-o owner] directory ...
>
> Here, there are three synopses, so every .Nm asserts a new line.
> The indentation is set so that "[-o owner] ..." starts properly
> indented (to the length of "install" plus one space).
>
> The indentation is only set once, as can be demonstrated by the
>
> following example:
> : SYNOPSIS
> :      hexdump [-bcCdovx] [-e format_string] [-f format_file] [-n length]
> :              [-s skip] file ...
> :      hd [-bcdovx] [-e format_string] [-f format_file] [-n length] [-s
> : skip] file ...
>
> Cheers,

Sounds like synopsis is not the right section for this information (what 
device it is in a kernel config or what module to load).

-- 
John Baldwin <jhb at FreeBSD.org>  <><  http://www.FreeBSD.org/~jhb/
"Power Users Use the Power to Serve"  =  http://www.FreeBSD.org