[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: how to get rid of [] in manpages?



also sprach Colin Watson <cjwatson@debian.org> [2002.09.15.0344 +0200]:
> That doesn't conform to the DTD anyway:
> 
> /usr/bin/nsgmls:manpage.example.sgml:61:15:E: character data is not allowed here
> /usr/bin/nsgmls:manpage.example.sgml:61:15: open elements: REFENTRY REFSYNOPSISDIV[1] CMDSYNOPSIS[1] GROUP[1]
> 
> (In my file, line 61 is '<group>-o
> <replaceable>outputfile</replaceable></group>'. You probably need an
> extra <arg>.)

Since I am changing it around in a trial and error fashion, and since
I noticed those errors before, I probably had it in another
configuration. Nevertheless, the brackets were always there...

> <group choice="opt"> means that the argument is optional, and therefore
> that you want brackets around it. You should probably remove it.
> However, even if you do you still get the brackets. A little debugging
> indicates that it occurs at this point in the transpec:
> 
>   GI:             ARG
>   AttValue:       CHOICE OPT
>   StartText:      \s[
>   EndText:        ${_attval REP REPEAT 505}]\s

(How'd you debug this. Sorry, but SGML and XML are too mysterious for
me).

> This really shouldn't fire when the <group choice="opt"> is removed - I
> suggest you file a bug against docbook-to-man.

Done.

> > I don't have the time to learn that too.
> 
> Then you don't get to have fine control of formatting. :)

Yeah well.

> > Aside, I believe in meta-formats.
> 
> This demonstrates that you haven't used groff much, I think ... look at
> the mdoc macro set, for instance. It provides an excellent logical
> formatting framework.

Mh. Do you have a nicely formatted example file you'd be willing to
share, which I can first use as a template, then go from there?

> Also, groff can generate text in various formats, DVI, PostScript, HTML,
> and output for various printers. How much more meta do you want? :) In
> my opinion, SGML's only advantage over groff for manual pages is that it
> provides a more systematic framework for validation, not that's it's a
> "meta-format". However, my validation usually consists of running groff
> over the page and making sure there are no errors, which is generally
> good enough.

You've got your foot in the door...

-- 
martin;              (greetings from the heart of the sun.)
  \____ echo mailto: !#^."<*>"|tr "<*> mailto:"; net@madduck
 
i am willing to make the mistakes
if someone else is willing to learn from them.

Attachment: pgptRCtFlD07T.pgp
Description: PGP signature


Reply to: