On Wed, May 20, 2020 at 08:30:55AM +0200, Michael Kerrisk (man-pages) wrote:
> However, there's quite a wild variability in the order of some of
> these sections in individual pages, which can make it a little
> difficult to find a section. I suggest that the order of sections
> should be consistently something like:
>
> NAME
> SYNOPSIS
> CONFIGURATION
> DESCRIPTION
> OPTIONS
> EXIT STATUS
> RETURN VALUE
> ERRORS
> ENVIRONMENT
> FILES
> VERSIONS
> HISTORY
> ATTRIBUTES
> CONFORMING TO
> NOTES
> BUGS
> EXAMPLE
> AUTHORS
> COPYRIGHT
> SEE ALSO
> AVAILABILITY
>
>
> (Note that this list does not include all the sections listed above,
> but I'll ignore those for the moment.)
>
> Does that order sound reasonable to you. (It's an expanded version of
> the suggested order in man-pages(7), with some additions to allow for
> headings that are commonly used in util-linux manual pages.)
Looks good.
util-linux is collection from random authors and we (mostly) invested
our effort to code consolidation and unification in last years. So,
I'm happy to see that you want to do the same with man pages.
> I'd like to send some patches to fix that ordering. I would not do
> this all at once, but rather, one or section headers at a time,
> probably starting with SEE ALSO/AVAILABILITY. Does this sound okay to
> you?
Go ahead.
Karel
--
Karel Zak <kzak@xxxxxxxxxx>
http://karelzak.blogspot.com
