[Bug 264054] Man page display on web site is confusing

From: <bugzilla-noreply_at_freebsd.org>
Date: Wed, 18 May 2022 00:36:22 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=264054

            Bug ID: 264054
           Summary: Man page display on web site is confusing
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Many People
          Priority: ---
         Component: Website
          Assignee: doc@FreeBSD.org
          Reporter: grog@FreeBSD.org

This is a resubmission of part of
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=264036

Currently the man page choice on the web site
(https://www.freebsd.org/cgi/man.cgi) defaults to ”13-1-RELEASE and Ports”. 
This causes several issues, illustrated by a search for the man page gpart(8):

1. Ports can have priority over the base system, so unless the person searching
for a man page in the base system knows the section number, he could end up
with the man page for a port.
2. There's no way for the user to know which port he has found.  In this
example, the man page carries the title “Scotch user's manual”, but that's the
only clue.
3. There's no way for the user to know that there are more man pages with the
same name in different sections.

My suggestion:

1.  In the short term, update the man page display to explain this situation,
something like

    There may be more than one man page with this name.  If you don't
    find what you're looking for, try 13.1-RELEASE without ports, or
    try selecting a specific section of the manual.

2.  Longer term, rearrange the priorities: base system first, then ports.

3.  When displaying port man pages, include information on the name of the
port.

-- 
You are receiving this mail because:
You are the assignee for the bug.