develooper Front page | perl.perl5.porters | Postings from December 2004

Re: perlpodtut

Thread Previous | Thread Next
December 24, 2004 13:07
Re: perlpodtut
Message ID:
> This should be =head1 COPYRIGHT AND LICENSE to fit what's done
> elsewhere

Google hit counts, with filetype:pod

"head1 license" -"head1 license and copyright"     183
"head1 copyright" -"head1 copyright and license"  4180
"head1 copyright and license"                      105
"head1 license and copyright"                        2

I don't think we should make it COPYRIGHT AND LICENSE.

> and it comes after AUTHOR so that it's the last thing in the man page
> except for HISTORY if any.  See the pod2man man page for the section
> ordering.

<< Section ordering varies, although NAME should always be the first
section (you'll break some man page systems otherwise), and NAME,
SYNOPSIS, DESCRIPTION, and OPTIONS generally always occur first and in
that order if present.  In general, SEE ALSO, AUTHOR, and similar
material should be left for last.  Some systems also move WARNINGS and
NOTES to last.  The order given above should be reasonable for most
purposes. >>

In practice, "SEE ALSO" is almost always the last section, pod2man.pod
puts it before AUTHOR even.

Most importantly, I think it's worth to note that the ordering of
sections doesn't matter as long as NAME's the first. I think discussing
this can be a waste of time.


Thread Previous | Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About