Updated all man pages and renamed install-mh.man to mmh.man.

[mmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index eb8caec..11cac87 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -3,18 +3,19 @@
 .\"
 .TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
-mhparam \- print nmh profile components
+mhparam \- print nmh profile and context components
 .SH SYNOPSIS
 .na
 .B mhparam
 .RI [ components ]
 .RB [ \-all ]
 .RB [ \-component " | " \-nocomponent ]
+.RB [ \-debug ]
 .RB [ \-version ]
 .RB [ \-help ]
 .ad
 .SH DESCRIPTION
-.B Mhparam
+.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.
@@ -38,14 +39,19 @@ is on by default.
 .PP
 If
 .B \-all
-is specified, then all components in the nmh profile are
-displayed and other arguments are ignored.
+is specified, then all components in the mmh profile and context
+(including comments) are displayed and other arguments are ignored.
+.PP
+If
+.B \-debug
+is specified, then a defined set of internal profile entries are
+displayed.
 .PP
 Examples:
 .PP
 .RS 5
 .nf
-.ta \w'AliasFile:'u+2n
+.ta \w'LongEntry:'u+2n
 % mhparam path
 Mail
 
@@ -62,24 +68,41 @@ rmmproc: rmmproc
 % mhparam \-nocomponent AliasFile rmmproc
 aliases
 rmmproc
+
+% mhparam path nonexistent context
+Path: Mail
+context: context
 .fi
 .RE
 .PP
-.B Mhparam
+.B mhparam
 is also useful in back\-quoted 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'%etcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+^$HOME/.mmh/profile~^The user profile
+^or $MMHP~^Rather than the standard profile
+^$HOME/.mmh/context~^The user context
+^or $MMHC~^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"