[Pkg-emboss-devel] Antwort: [EMBOSS] Manpage generator

Daniel Leidert daniel.leidert.spam at gmx.net
Sun Jul 15 20:35:49 UTC 2007


Because I don't get any answer on my PMs, I send this to the list
instead:

Am Sonntag, den 08.07.2007, 23:02 +0900 schrieb Charles Plessy:

[..]
> Thanks do David's suggestion, I managed to write a manpage generator for
> EMBOSS programs. It uses the EMBOSS::ACD library (which we ship in
> Debian in the package libemboss-acd-perl) to create a docbook XML
> document, which is transformed into a manpage with the xsltproc program.
> The reason why the generator does not directly write the manpage is
> simply that I do not know the nroff syntax.
> 
> You can download it from the following URI:
> http://svn.debian.org/wsvn/pkg-emboss/emboss/trunk/debian/acd2docbook.pl?op=file&rev=0&sc=0

About the dhdate entity: The date is automatically added when creating
the manpage via xsltproc (that's a part of the docbook-xsl features).
You don't need to create an entity nor use the <date> tag.

In debian/rules you write: xsltproc -''-nonet. The "-''-" is just a
workaround for the XML template. In XML it is not allowed to have "--"
inside a comment, so we use "-''-" as workaround for options. But you
can remove the "''" in debian/rules.

Further you use: -o debian/manpages/$$basename.1. This option doesn't
work for manpages. The basename is always determined from the manpage
source. You cannot change nor determine it via the -o option of
xsltproc. You can only use this option to set the output directory: `-o
debian/manpages/' but not the manpage name.

I further suggest to set the man.charmap.use.subset parameter to zero
when creating the manpages.

Another suggestion: There is a typo bug "developpers". It only contains
one "p", although the double "p" variant seems to be used in a few
locations. But AFAIK there is no official word with double p.

Then I would suggest to use

"[..] <package>EMBOSS</package> (<quote>European Molecular Biology Open
Software Suite</quote>) [..]" once per manpage - maybe in DESCRIPTION or
in <legalnotice> to determine, what EMBOSS stands for.

Then in the right lower corner of the manpage I find e.g. "edialign
4.1.0". Shouldn't this be "EMBOSS 4.1.0" and
"<productname>&dhproduct;</productname>"?

Regards, Daniel




More information about the Pkg-emboss-devel mailing list