Separate out backquote expression to please Heirloom shell.

[nmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index feb24498d05233ab7e5a79b3f735304b336c6d56..df1de43e5f7d250866bf73b1dc821c7a244137c1 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,4 +1,4 @@
-.TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MHPARAM %manext1% "May 21, 2016" "%nmhversion%"

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


@@ -8,11 +8,11 @@ mhparam \- print nmh profile and context components
 .HP 5
 .na
 .B mhparam
 .HP 5
 .na
 .B mhparam

+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ components ]
 .RB [ \-all ]
 .RB [ \-component " | " \-nocomponent ]
 .RI [ components ]
 .RB [ \-all ]
 .RB [ \-component " | " \-nocomponent ]

-.RB [ \-version ]
-.RB [ \-help ]

 .RB [ \-debug ]
 .ad
 .SH DESCRIPTION
 .RB [ \-debug ]
 .ad
 .SH DESCRIPTION


@@ -44,19 +44,51 @@ 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
-.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
 and

-.I libdir
-install directories and all
+.I docdir
+install directories, all

 .I proc
 .I proc

-settings.  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 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
 .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


@@ -66,7 +98,7 @@ Examples:
 Mail
 
 % mhparam mhlproc
 Mail
 
 % mhparam mhlproc

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

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


@@ -83,16 +115,37 @@ rmmproc
 Path: Mail
 context: context
 
 Path: Mail
 context: context
 

+% mhparam version
+%nmhversion%
+

 % mhparam etcdir
 % mhparam etcdir

-%etcdir%
+%nmhetcdir%
+
+% mhparam libexecdir
+%nmhlibexecdir%
+
+% mhparam spoollocking
+%default_locking%

 
 

-% mhparam libdir
-%libdir%
+% mhparam datalocking
+fcntl
+
+% mhparam sasl
+cyrus_sasl
+
+% mhparam tls
+tls
+
+% mhparam iconv
+iconv
+
+% mhparam oauth
+oauth

 .fi
 .RE
 .PP
 .B mhparam
 .fi
 .RE
 .PP
 .B mhparam

-is also useful in back\-quoted operations:
+is also useful in backquoted operations:

 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf


@@ -100,11 +153,15 @@ is also useful in back\-quoted operations:
 .fi
 .SH "EXIT STATUS"
 .B mhparam
 .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 just 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
 .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


@@ -118,7 +175,7 @@ returns the number of components that were not found.
 ^context:~^To determine the context file
 .fi
 .SH "SEE ALSO"
 ^context:~^To determine the context file
 .fi
 .SH "SEE ALSO"

-mh-profile(5)
+.IR mh-profile (5)

 .SH DEFAULTS
 .nf
 .RB ` \-nocomponent "' if only one component is specified"
 .SH DEFAULTS
 .nf
 .RB ` \-nocomponent "' if only one component is specified"