From kde-core-devel  Tue Jul 22 18:55:22 2003
From: Dominique Devriese <dominique.devriese () student ! kuleuven ! ac ! be>
Date: Tue, 22 Jul 2003 18:55:22 +0000
To: kde-core-devel
Subject: Re: KDE man page generator..
X-MARC-Message: https://marc.info/?l=kde-core-devel&m=105890022026825

Ben Burton writes:

> Hi.

>> In order to fix long-standing Debian bug #116485, I've written a
>> script that takes a KDE app, and generates a nice man page.

> Just a couple of suggestions.

> 1. OPTIONS section

> It would be very nice if the script could split the options into
> sections (APP OPTIONS, QT OPTIONS, KDE OPTIONS).  Otherwise it's
> quite difficult to find the app-specific options amongst the generic
> Qt/KDE options.
> <snip>

I committed a change recently, that outputs the headers as subsection
headers.  It is possible to reorder the sections too, but that would
require more effort, and I currently don't have too much time.

> 2. SEE ALSO section

> It may also be worth expanding the SEE ALSO section to make it clear
> that the help:/... URL needs to be typed into konqueror - some users
> of KDE apps don't run KDE as their primary desktop environment.

fixed, thanks.

Could you perhaps give me your opinion on what to do with the script ?
I think the generated man pages are pretty nice already, the most
important problem left is how to integrate this into the rest of
(Debian-) KDE.  And my current best bet would be to just add the
generated manpages to the respective Debian directories, mostly
because I don't think the complexity of somehow making this run
automatically on build or packaging time just doesn't seem worth the
trouble.. 

cheers
domi