]> diplodocus.org Git - nmh/blobdiff - man/mhparam.man
Separate out backquote expression to please Heirloom shell.
[nmh] / man / mhparam.man
index 467f5b590fd049700293e1e0fc9ccaf3d7fc4661..df1de43e5f7d250866bf73b1dc821c7a244137c1 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHPARAM %manext1% "March 16, 2014" "%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,33 +44,36 @@ 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
+.B mhparam
 can provide other information, such as the
 .B nmh
 version identifier, the locations of the nmh
 can provide other information, such as the
 .B nmh
 version identifier, the locations of the nmh
-.I etcdir
+.IR bindir ,
+.IR libexecdir ,
+.IR etcdir ,
 and
 and
-.I libdir
+.I docdir
 install directories, all
 .I proc
 settings, and the
 .I datalocking
 method described in the
 install directories, all
 .I proc
 settings, and the
 .I datalocking
 method described in the
-.IR mh_profile (5)
+.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
 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, and
+support for SASL, TLS,
 .IR iconv (3),
 .IR iconv (3),
-the following commands, respectively, will output a non-null string to
-indicate support:
+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
 .PP
 .RS 5
 .nf
 mhparam\0sasl
 mhparam\0tls
 mhparam\0iconv
+mhparam\0oauth
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP
@@ -80,6 +83,12 @@ The
 switch displays all such other information available from
 .BR mhparam .
 .PP
 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
@@ -89,7 +98,7 @@ Examples:
 Mail
 
 % mhparam mhlproc
 Mail
 
 % mhparam mhlproc
-%libdir%/mhl
+%nmhlibexecdir%/mhl
 
 % mhparam \-component Path
 Path: Mail
 
 % mhparam \-component Path
 Path: Mail
@@ -110,10 +119,10 @@ context: context
 %nmhversion%
 
 % mhparam etcdir
 %nmhversion%
 
 % mhparam etcdir
-%etcdir%
+%nmhetcdir%
 
 
-% mhparam libdir
-%libdir%
+% mhparam libexecdir
+%nmhlibexecdir%
 
 % mhparam spoollocking
 %default_locking%
 
 % mhparam spoollocking
 %default_locking%
@@ -129,6 +138,9 @@ tls
 
 % mhparam iconv
 iconv
 
 % mhparam iconv
 iconv
+
+% mhparam oauth
+oauth
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP
@@ -141,7 +153,11 @@ is also useful in backquoted 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