Removed note from BUGS section of several man pages saying
[mmh] / man / mhparam.man
index debcb75..cc614ef 100644 (file)
@@ -1,22 +1,26 @@
+.TH MHPARAM %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
-.TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
-mhparam \- print nmh profile components
+mhparam \- print nmh profile and context components
 .SH SYNOPSIS
+.HP 5
+.na
 .B mhparam
 .RI [ components ]
 .RB [ \-all ]
 .RB [ \-component " | " \-nocomponent ]
 .RB [ \-version ]
 .RB [ \-help ]
+.RB [ \-debug ]
+.ad
 .SH DESCRIPTION
-.B Mhparam
-writes the value of the specified profile component to the
-standard output separated by newlines.  If the profile component is not
-present, the default value (or nothing if there is no default) is printed.
+.B mhparam
+writes the value of the specified profile component to the standard
+output separated by newlines.  Component name matching is
+case-insensitive.  If the profile component is not present, the
+default value (or nothing if there is no default) is printed.
 .PP
 If the switch
 .B \-component
@@ -40,6 +44,19 @@ If
 is specified, then all components in the nmh profile are
 displayed and other arguments are ignored.
 .PP
+.BR mhparam
+can provide other information, such as
+the locations of the nmh
+.I etcdir
+and
+.I libdir
+install directories and all
+.I proc
+settings.  The
+.B \-debug
+switch displays all such other information available from
+.BR mhparam .
+.PP
 Examples:
 .PP
 .RS 5
@@ -51,7 +68,7 @@ Mail
 % mhparam mhlproc
 %libdir%/mhl
 
-% mhparam \-component path
+% mhparam \-component Path
 Path: Mail
 
 % mhparam AliasFile rmmproc
@@ -61,35 +78,52 @@ rmmproc: rmmproc
 % mhparam \-nocomponent AliasFile rmmproc
 aliases
 rmmproc
+
+% mhparam path nonexistent context
+Path: Mail
+context: context
+
+% mhparam etcdir
+%etcdir%
+
+% mhparam libdir
+%libdir%
 .fi
 .RE
 .PP
-.B Mhparam
-is also useful in back\-quoted operations:
+.B mhparam
+is also useful in backquoted operations:
 .PP
 .RS 5
 .nf
 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 .fi
-.RE
-.PP
-
+.SH "EXIT STATUS"
+.B mhparam
+returns the number of components that were not found.
 .SH FILES
 .fc ^ ~
 .nf
-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+.ta \w'%etcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile
+^or $MH~^Rather than the standard profile
+^<mh-dir>/context~^The user context
+^or $MHCONTEXT~^Rather than the standard context
+.fi
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u
+^context:~^To determine the context file
 .fi
-
 .SH "SEE ALSO"
-mh-profile(5)
-
+.IR mh-profile (5)
 .SH DEFAULTS
 .nf
 .RB ` \-nocomponent "' if only one component is specified"
 .RB ` \-component "' if more than one component is specified"
 .RB ` components "' defaults to none"
 .fi
-
 .SH CONTEXT
 None