Added getmymbox function escape.

[nmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index bf7c40a3ffde8b1fc2c1a125c7f3088731d37d08..dfa5aacceffd0383dbb5e917a149be865b9a3efb 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,4 +1,4 @@
-.TH MHPARAM %manext1% "February 26, 2014" "%nmhversion%"
+.TH MHPARAM %manext1% "March 16, 2014" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %nmhwarning%
 .\"


@@ -44,21 +44,48 @@ If
 is specified, then all components in the nmh profile are
 displayed and other arguments are ignored.
 .PP
 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
+.B mhparam
+can provide other information, such as the
+.B nmh
+version identifier, the locations of the nmh

 .I etcdir
 and
 .I etcdir
 and

-.I libdir
+.I libexecdir

 install directories, all
 .I proc
 install directories, all
 .I proc

-settings, and the default 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
 .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, and
+.IR iconv (3),
+the following commands, respectively, will output a non-null string to
+indicate support:
+.PP
+.RS 5
+.nf
+mhparam\0sasl
+mhparam\0tls
+mhparam\0iconv
+.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
 .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
 Examples:
 .PP
 .RS 5


@@ -68,7 +95,7 @@ Examples:
 Mail
 
 % mhparam mhlproc
 Mail
 
 % mhparam mhlproc

-%libdir%/mhl
+%nmhlibexecdir%/mhl

 
 % mhparam \-component Path
 Path: Mail
 
 % mhparam \-component Path
 Path: Mail


@@ -85,17 +112,29 @@ rmmproc
 Path: Mail
 context: context
 
 Path: Mail
 context: context
 

+% mhparam version
+%nmhversion%
+

 % mhparam etcdir
 % mhparam etcdir

-%etcdir%
+%nmhetcdir%

 
 

-% mhparam libdir
-%libdir%
+% mhparam libexecdir
+%nmhlibexecdir%
+
+% mhparam spoollocking
+%default_locking%

 
 % mhparam datalocking
 fcntl
 
 
 % mhparam datalocking
 fcntl
 

-% mhparam spoollocking
-flock
+% mhparam sasl
+cyrus_sasl
+
+% mhparam tls
+tls
+
+% mhparam iconv
+iconv

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP


@@ -112,7 +151,7 @@ returns the number of components that were not found.
 .SH FILES
 .fc ^ ~
 .nf
 .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
 ^$HOME/.mh_profile~^The user profile
 ^or $MH~^Rather than the standard profile
 ^<mh-dir>/context~^The user context