X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/518dfa384e0c188a798134f3370c573ca307c51c..5ed8cd671b27e1388c0c7e881805775a8e5b353a:/man/mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index 6f51ffd9..e4b6cb0b 100644
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,64 +1,91 @@
-.TH MHPARAM %manext1% "November 6, 2012" "%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
-.BR mhparam
-can provide other information, such as
-the locations of the nmh
-.I etcdir
+.B mhparam
+can provide other information, such as the
+.B nmh
+version identifier, the locations of the nmh
+.IR bindir ,
+.IR libexecdir ,
+.IR etcdir ,
 and
-.I libdir
+.I docdir
 install directories, all
 .I proc
-settings, and the locking method with which the
+settings, and the
+.I datalocking
+method described in the
+.IR mh\-profile (5)
+man page.  Information about the configuration of the
 .B nmh
-installation was configured.  The
+installation is also available, including the default mail spool
+locking method.  To test whether the configuration includes
+support for SASL, TLS,
+.IR iconv (3),
+and oauth, the following commands, respectively, will output a non-null
+string to indicate support:
+.PP
+.RS 5
+.nf
+mhparam\0sasl
+mhparam\0tls
+mhparam\0iconv
+mhparam\0oauth
+.fi
+.RE
+.PP
+Conversely, no output means that the specified support is not included.
+The
 .B \-debug
 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
@@ -68,7 +95,7 @@ Examples:
 Mail
 
 % mhparam mhlproc
-%libdir%/mhl
+%nmhlibexecdir%/mhl
 
 % mhparam \-component Path
 Path: Mail
@@ -85,14 +112,32 @@ rmmproc
 Path: Mail
 context: context
 
+% mhparam version
+%nmhversion%
+
 % mhparam etcdir
-%etcdir%
+%nmhetcdir%
+
+% mhparam libexecdir
+%nmhlibexecdir%
 
-% mhparam libdir
-%libdir%
+% mhparam spoollocking
+%default_locking%
 
-% mhparam lockmethod
+% mhparam datalocking
 fcntl
+
+% mhparam sasl
+cyrus_sasl
+
+% mhparam tls
+tls
+
+% mhparam iconv
+iconv
+
+% mhparam oauth
+oauth
 .fi
 .RE
 .PP
@@ -105,11 +150,15 @@ is also useful in backquoted operations:
 .fi
 .SH "EXIT STATUS"
 .B mhparam
-returns the number of components that were not found.
+returns the number of components that were not found,
+but limits the return value to 120 to avoid ambiguity,
+e.g.\& 127 is used by shells to indicate `command not found',
+and 256 would wrap to 0, falsely indicating success.
+.
 .SH FILES
 .fc ^ ~
 .nf
-.ta \w'%etcdir%/ExtraBigFileName  'u
+.ta \w'ExtraBigProfileName  'u
 ^$HOME/.mh_profile~^The user profile
 ^or $MH~^Rather than the standard profile
 ^<mh-dir>/context~^The user context