[Bug 193460] New: Suggestion: add a section resume in man manpage

bugzilla-noreply at freebsd.org bugzilla-noreply at freebsd.org
Mon Sep 8 10:07:09 UTC 2014


https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=193460

            Bug ID: 193460
           Summary: Suggestion: add a section resume in man manpage
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: Needs Triage
          Severity: Affects Only Me
          Priority: ---
         Component: Documentation
          Assignee: freebsd-doc at FreeBSD.org
          Reporter: mazhe at alkumuna.eu

Maybe it is a bit silly, but I recently needed some kind of "official
reference" on manpage sections in FreeBSD and realized that no manpage provided
it. The best I could come up with was to do `for i in {1..9}; do man $i
intro|head -n1; done`.

Would it be considered useful to add such a list in the DESCRIPTION part of
man(1)? Maybe reformat the beginning to something like:

------------------------------------------------------------------------------
DESCRIPTION
     The man utility finds and displays online manual documentation pages.  If
     mansect is provided, man restricts the search to the specific section of
     the manual.

     The currently available sections are:
          1   general commands (tools and utilities)
          2   system calls and error numbers
          3   C libraries
          4   devices and device drivers
          5   file formats
          6   games
          7   miscellaneous
          8   system maintenance procedures and commands
          9   system kernel interfaces

     Options that man understands:
     [...]
------------------------------------------------------------------------------

(of course, feel free to reword as needed)

thanks for your time

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


More information about the freebsd-doc mailing list