Added tests of MMDF mailbox format to test-eom-align.

[nmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index 27e1b9b160901138a16e796d5328f3f1d86eb598..656894db87dcee3b2cc5691db7d669b20ac4e8b1 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,48 +1,45 @@
-.TH MHPARAM %manext1% "May 21, 2016" "%nmhversion%"
-.\"
+.TH MHPARAM %manext1% 2017-02-18 "%nmhversion%"
+.
 .\" %nmhwarning%
-.\"
+.
 .SH NAME
 mhparam \- print nmh profile and context components
 .SH SYNOPSIS
 .HP 5
 .na
 .B mhparam
+.RB [ \-help ]
+.RB [ \-version ]
 .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.  Component name matching is
+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.
+default value (or nothing, if there is no default) is printed.
 .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
+is given, then the component name is displayed along with the profile
+components value.  This can be disabled with the switch
 .BR \-nocomponent .
 .PP
 If more than one component is specified in the
 .I components
-list, then
-the switch
+list, then the switch
 .B \-component
-is on by default.  If only one component is
-specified, then the switch
+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 nmh profile are
-displayed and other arguments are ignored.
+is specified, then all components in the nmh profile are displayed
+and other arguments are ignored.
 .PP
 .B mhparam
 can provide other information, such as the
@@ -57,9 +54,9 @@ install directories, all
 .I proc
 settings, and the
 .I datalocking
-method described in the
-.IR mh\-profile (5)
-man page.  Information about the configuration of the
+method described in
+.IR mh\-profile (5).
+Information about the configuration of the
 .B nmh
 installation is also available, including the default mail spool
 locking method.  To test whether the configuration includes
@@ -83,63 +80,57 @@ The
 switch displays all such other information available from
 .BR mhparam .
 .PP
-Note that the internal
-.B libdir
-component has been replaced by
-.BR libexecdir .
-The old form is deprecated and will be removed in a future release.
-.PP
 Examples:
 .PP
 .RS 5
 .nf
 .ta \w'AliasFile:'u+2n
-% mhparam path
+$ mhparam path
 Mail
 
-% mhparam mhlproc
+$ mhparam mhlproc
 %nmhlibexecdir%/mhl
 
-% mhparam \-component Path
+$ mhparam \-component Path
 Path: Mail
 
-% mhparam AliasFile rmmproc
+$ mhparam AliasFile rmmproc
 AliasFile: aliases
 rmmproc: rmmproc
 
-% mhparam \-nocomponent AliasFile rmmproc
+$ mhparam \-nocomponent AliasFile rmmproc
 aliases
 rmmproc
 
-% mhparam path nonexistent context
+$ mhparam path nonexistent context
 Path: Mail
 context: context
 
-% mhparam version
+$ mhparam version
 %nmhversion%
 
-% mhparam etcdir
+$ mhparam etcdir
 %nmhetcdir%
 
-% mhparam libexecdir
+$ mhparam libexecdir
 %nmhlibexecdir%
 
-% mhparam spoollocking
+$ mhparam spoollocking
 %default_locking%
 
-% mhparam datalocking
+$ mhparam datalocking
 fcntl
 
-% mhparam sasl
+$ mhparam sasl
 cyrus_sasl
 
-% mhparam tls
+$ mhparam tls
 tls
 
-% mhparam iconv
+$ mhparam iconv
 iconv
 
-% mhparam oauth
+$ mhparam oauth
 oauth
 .fi
 .RE
@@ -149,11 +140,12 @@ is also useful in backquoted operations:
 .PP
 .RS 5
 .nf
-% fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
+$ fgrep cornell.edu \`mhpath +\`/\`mhparam aliasfile\`
 .fi
 .SH "EXIT STATUS"
-.B mhparam
-returns the number of components that were not found.
+The exit status is zero if all components are found,
+or one if any are missing.
+.
 .SH FILES
 .fc ^ ~
 .nf