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

Re: Bug#164000: ITP: xmltoman -- simple XML to man converter



On Thu, Oct 10, 2002 at 10:10:59AM +0200, Michael Piefel wrote:
> Am  9.10.02 um 23:57:30 schrieb Colin Walters:
> > I just want to know if this "xmltoman" has any feature over docbook2man.
> 
> I guess the main feature would be that it's usable. ;-)

Right, that was my intention ;-)

> Actually, I really like the idea of docbook. Rather, I liked it when I
> just had had a quick look at it. I'm not so sure now. My docbook files
> all look so unreadable, and it's certainly hard to write:
>     <funcsynopsis>
>     <funcprototype>
>       <funcdef>int <function>max</function></funcdef>
>       <paramdef>int <parameter>int1</parameter></paramdef>
>       <paramdef>int <parameter>int2</parameter></paramdef>
>     </funcprototype>
>     </funcsynopsis>

You may want to compare this with these examples:

-*snip*-
<synopsis>
<cmd>xml2man <arg>file.1.xml</arg> > file.1</cmd>
</synopsis>
-*snip*-

and for an option:

-*snip*-
<option>
<p><opt>-bV </opt></p>
<optdesc><p>Show version information.</p>
</optdesc>
</option>
-*snip*-

Though we compare apples and pears here... my xmltoman does not (yet)
handle man pages for library functions. But when I designed the syntax,
I tried to make the tags short, but still descriptive.

Another feature are hyperlinks, which will be used by the html version:

<section name = "See also">
<p>
<manref name="masqmail.conf" section="5" href="masqmail.conf.5.html"/>, 
</p>
</section>


I did not look thoroughly at the other xml to man converters, but IMHO
they have way too much overhead. My scripts are 3K each, and depend on
perl and libxml-parser-perl only.

Greetings,
Oliver
-- 
debian/rules                                       http://zork.net/~nick/srom/

Attachment: pgpQbqfgWTPkr.pgp
Description: PGP signature


Reply to: