Re: [Refdb-devel] Makestyle changes

[David N. <dav...@sw...>]

Markus Hoenicka wrote:

>I've moved Makestyle.pm into the RefDB perl modules, and refdb-ms and
>document-dtd-entities into refdb/scripts.  I plan to integrate the refdb-ms README into
>the manual, but feel free to beat me here.
>


I'll put it on my todo list :-) .

>Two questions:
>
>1) what is the purpose of the document-dtd-entities script? It should
>   be mentioned on the cli.html page.
>


I've already sent an email about that -- it should be removed.

>2) I've moved the refdb-ms manpage into a local /man subdir which
>   doesn't exist in CVS yet. I've been planning to write man pages for
>   at least 4 years now. I'm not familiar with manpage
>   authoring. I thought of stub pages which simply point to the
>   locally installed HTML documentation. Could you send me a skeleton
>   manpage to this end? I'd then integrate a man subdirectory into the
>   build system.
>


Man pages are easy once you grok the syntax -- they're written in groff 
which is a primitive, but powerful, markup language.  You could try 
man(1) for an overview, man(7) for a brief outline of the syntax, 
groff(1) for a summary of the macro pre-processors, groff(7) for a 
language reference and groff_char(1) for special characters.

I've attached the manpage template I use.  I'm sure emacs handles groff 
easily.  You can always use 'man -l foo.1' to view the 'foo' manpage -- 
the '-l' tells man to look locally rather than in the system manpage 
directories.

Regards,
David.