[Top][All Lists]

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

Re: Manpage generation

From: Karl Berry
Subject: Re: Manpage generation
Date: Mon, 8 Apr 2002 11:39:50 -0400

    @c man begin DESCRIPTION

Yes, the descriptions and synopses are no problem.

As Eli surmised, I was thinking more about the list of options, which
can be spread over many, many nodes.  Does your script translate
@itemize and the like?  We're talking about implementing another output
format, it would seem.  Sigh.

What about the author, reporting bugs, see also, etc., sections?  Those
texts seem like they would not work at all in the context of a manual.
Those "ancillary" things are the main reason that using the --help
output seems better to me.  There is a much closer match between --help
and man pages than Texinfo and man pages.

    To do it properly, I would suggest: @man <section> [<program>]... @end man

If we do this, seems like it's really just one command for all the
different sections that are needed, plus one for the man page itself
[emacs(1)], something like (I'm not happy with this syntax).

@mantitle [<section>] <programname>
@manpart synopsis ... @endmanpart synopsis
@manpart description ... @endmanpart description

Anyway ...

reply via email to

[Prev in Thread] Current Thread [Next in Thread]