Subject: misc/974: INSTALL documentation enhancement
To: None <gnats-admin@NetBSD.ORG>
From: Scott Reynolds <scottr@Plexus.COM>
List: netbsd-bugs
Date: 04/17/1995 08:20:02
>Number:         974
>Category:       misc
>Synopsis:       INSTALL document enhancement
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people (Misc Bug People)
>State:          open
>Class:          change-request
>Submitter-Id:   net
>Arrival-Date:   Mon Apr 17 08:20:01 1995
>Originator:     
>Organization:
>Release:        -current 15 Apr 95
>Environment:
	
System: NetBSD aqua 1.0A NetBSD 1.0A (TGI) #20: Wed Apr 12 17:19:55 CDT 1995 scottr@aqua:/a/src/sys/arch/i386/compile/TGI i386


>Description:
	The following change to the INSTALL document could be invaluable
	in helping to reduce the number of questions and in getting the
	relatively UN*X illiterate up to speed with their new NetBSD system.
>How-To-Repeat:
	N/A
>Fix:
*** distrib/notes/INSTALL.orig	Wed Oct 19 16:06:50 1994
--- distrib/notes/INSTALL	Mon Apr 17 09:57:32 1995
***************
*** 199,202 ****
--- 199,241 ----
  #include "upgrade"
  
+ Using online NetBSD documentation
+ ----- ------ ------ -------------
+ 
+ Documentation is available if you first install the "man10"
+ distribution set.  Traditionally, the UN*X "man pages" (documentation)
+ are denoted by 'name(section)'.  Some examples of this are
+ 
+ 	intro(1),
+ 	man(1),
+ 	apropros(1),
+ 	passwd(1), and
+ 	passwd(5).
+ 
+ The section numbers group the topics into several categories, but three
+ are of primary interest:  user commands are in section 1, file formats
+ are in section 5, and administrative information is in section 8.
+ 
+ The 'man' command is used to view the documentation on a topic, and is
+ started by entering 'man [section] topic'.  The brackets [] around the
+ section should not be entered, but rather indicate that the section is
+ optional.  If you don't ask for a particular section, the topic with the
+ least-numbered section name will be displayed.  For instance, after
+ logging in, enter 
+ 
+ 	man passwd
+ 
+ to read the documentation for passwd(1).  To view the documentation for
+ passwd(5), enter
+ 
+ 	man 5 passwd
+ 
+ instead.
+ 
+ If you are unsure of what man page you are looking for, enter
+ 
+ 	apropos subject-word
+ 
+ where "subject-word" is your topic of interest; a list of possibly 
+ related man pages will be displayed.
  
  Administrivia:
>Audit-Trail:
>Unformatted: