Bug 15557

Summary: man page for 'man' doesn't explain syntax for accessing "SEE ALSO" numbered pages.
Product: Documentation Reporter: johnpipe <johnpipe>
Component: Books & ArticlesAssignee: Jeroen Ruigrok van der Werven <asmodai>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description johnpipe 1999-12-19 06:20:01 UTC
As a novice user, I encountered the problem that I didn't know how to
 access man pages under "SEE ALSO" where those pages were given in the
 form:
   
    "SEE ALSO
         sysctl(3),  uname(3),  sysctl(8)"

the command 'man man' (i.e., the man page for 'man') ought to explain 
and give an example of the syntax, so new users can find how to access
 these pages; the syntax is not at all apparent, since parentheses are 
not used in the 'man' command, and the syntax is opposite of that 
implied above, i.e.,

   "man 3 sysctl".  

I only found out how to do this because a reply to a question posted to
 best.unix (local group on best.com) included a paste-in of the
 command format.

Fix: 

Add command syntax explanation and example for numbered man pages to 
the man page for 'man'.
Comment 1 Jeroen Ruigrok van der Werven freebsd_committer freebsd_triage 1999-12-19 10:07:22 UTC
Responsible Changed
From-To: freebsd-doc->asmodai

I'll take this. 

Comment 2 Jeroen Ruigrok van der Werven freebsd_committer freebsd_triage 1999-12-19 16:03:30 UTC
-On [19991219 08:00], johnpipe@nwserv.com (johnpipe@nwserv.com) wrote:
>>Fix:
>Add command syntax explanation and example for numbered man pages to 
>the man page for 'man'.

My current idea is to do include an Examples section in man.man which
gives two examples, one calling a manual page normally, and one with the
section number incorporated into it.

I welcome other people's ideas though.

-- 
Jeroen Ruigrok van der Werven/Asmodai           asmodai@[wxs.nl|bart.nl]
Documentation nutter.          *BSD: Technical excellence at its best...  
The BSD Programmer's Documentation Project <http://home.wxs.nl/~asmodai>
Atone me to my throes curtail...
Comment 3 Jeroen Ruigrok van der Werven freebsd_committer freebsd_triage 1999-12-20 14:49:51 UTC
State Changed
From-To: open->closed

Fixed in rev 1.10 of CURRENT's src/gnu/usr.bin/man/man/man.man. 
Fixed in rev 1.6.2.2 of STABLE's src/gnu/usr.bin/man/man/man.man. 

Thanks for noticing.