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 dcba16e..11cac87 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,45 +1,57 @@
 .\"
 .\" %nmhwarning%
-.\" $Id$
-.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
 .\"
 .TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
-mhparam \- print nmh profile components
+mhparam \- print nmh profile and context components
 .SH SYNOPSIS
-.in +.5i
-.ti -.5i
-mhparam
-\%[components]
-\%[-all]
-\%[-component] \%[-nocomponent]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.na
+.B mhparam
+.RI [ components ]
+.RB [ \-all ]
+.RB [ \-component " | " \-nocomponent ]
+.RB [ \-debug ]
+.RB [ \-version ]
+.RB [ \-help ]
+.ad
 .SH DESCRIPTION
-\fIMhparam\fR writes the value of the specified profile component to the
+.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.
-
-If the switch `\-component' is given, then the component name is displayed
+.PP
+If the switch
+.B \-component
+is given, then the component name is displayed
 along with the profile components value.  This can be disabled with the
-switch `\-nocomponent'.
-
-If more than one component is specified in the `components' list, then
-the switch `\-component' is on by default.  If only one component is
-specified, then the switch `\-nocomponent' is on by default.
-
-If `\-all' is specified, then all components in the nmh profile are
-displayed and other arguments are ignored.
-
+switch
+.BR \-nocomponent .
+.PP
+If more than one component is specified in the
+.I components
+list, then
+the switch
+.B \-component
+is on by default.  If only one component is
+specified, then the switch
+.B \-nocomponent
+is on by default.
+.PP
+If
+.B \-all
+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
-.in +.5i
+.ta \w'LongEntry:'u+2n
 % mhparam path
 Mail
 
@@ -56,26 +68,52 @@ rmmproc: rmmproc
 % mhparam \-nocomponent AliasFile rmmproc
 aliases
 rmmproc
-.in -.5i
+
+% mhparam path nonexistent context
+Path: Mail
+context: context
+.fi
+.RE
+.PP
+.B mhparam
+is also useful in back\-quoted operations:
+.PP
+.RS 5
+.nf
+% fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 .fi
 
-\fIMhparam\fR is also useful in back\-quoted operations:
+.SH "EXIT STATUS"
+.B mhparam
+returns the number of components that were not found.
 
+.SH FILES
+.fc ^ ~
 .nf
-.in +.5i
-% fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
+.ta \w'%etcdir%/ExtraBigFileName  'u
+^$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
 
-.in -.5i
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u
+^Context:~^To determine the context file
 .fi
-.Fi
-^$HOME/\&.mh\(ruprofile~^The user profile
-.Sa
-mh-profile\|(5)
-.De
-`\-nocomponent' if only one component is specified
-`\-component' if more than one component is specified
-.Ds
-`components' defaults to none
-.Co
+
+.SH "SEE ALSO"
+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
-.En