Bug#39830: PROPOSED]: get rid of undocumented(7) symlinks
On Jun 21, Roland Rosenfeld wrote:
> On Sun, 20 Jun 1999, Chris Lawrence wrote:
>
> > I would be willing to support this proposal with the following
> > additional sentence included:
> >
> > "It is not very hard to write a manual page; see the example manual
> > page provided by dh_make for a template."
>
> I fully agree with the first part of this sentence, but I'm not sure
> whether we should mention dh_make (which is only one alternative to
> create Debian packages) here. There are many alternative resources
> where you can find out, how to write a man page. I personally prefer
> the Man-Page-mini HOWTO (/usr/doc/HOWTO/mini/Man-Page.html), but you
> can alternatively read man(7) (quite formal, but everything you need)
> or you can try out pod2man (some people seem to prefer this way) or
> simply look into some other man page (there should be many on every
> system). So there are really many ways to learn writing man pages and
> I don't see, why we should expose the dh_make template here...
>
> On the other hand, I'm not sure, whether we need this guiding (telling
> the developer that it isn't hard to write a man page and where to find
> examples) in the policy document?
I think pointing people to examples is a good idea; I just specified
the dh_make template since many people use dh_make to debianize
packages anyway (and it dumps it in debian/manpage.1.ex or something
like that). Perhaps a few alternatives (perhaps duplicating some of
your list of resources) would be helpful (after all, I just learned
about man(7) from that paragraph ;-).
Chris
--
=============================================================================
| Chris Lawrence | Visit my home page! |
| <quango@watervalley.net> | http://www.lordsutch.com/chris/ |
| | |
| Grad Student, Pol. Sci. | Visit the Amiga Web Directory |
| University of Mississippi | http://www.cucug.org/amiga.html |
=============================================================================
Reply to: