Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 20 Apr 2022 07:46:54 +0100
From:      Graham Perrin <grahamperrin@gmail.com>
To:        FreeBSD questions <freebsd-questions@freebsd.org>, FreeBSD documentation project <freebsd-doc@freebsd.org>
Subject:   Conventions for FreeBSD manual pages
Message-ID:  <3755196b-8803-ff72-364e-6b3b067f9702@gmail.com>

next in thread | raw e-mail | index | archive | help
Please: does FreeBSD have anything like the Linux manual page for 
conventions?

<https://man7.org/linux/man-pages/man7/man-pages.7.html>;

I can't find one.

Background
==========

For years, I assumed that SEE ALSO sections were disorderly.

For example:

* expecting a–z (alphabetical order)

* finding ne, sy, se, at et cetera (disorderly) under
<https://www.freebsd.org/cgi/man.cgi?query=tuning&sektion=7&manpath=FreeBSD#SEE_ALSO>;

Today I discovered that there is, at least for Linux, a convention to sort:

* first, by the section number (secondary)

* second, by the name of the page, which appears first.

I do see some logic to this, however – without first knowing the 
convention – I never found it helpful. The apparent disorder was unhelpful.

Whenever I look for a named thing, in a long string of names, with the 
intention of clicking (a link): I expect alphabetical order, by name.




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?3755196b-8803-ff72-364e-6b3b067f9702>