]> diplodocus.org Git - nmh/blobdiff - man/mhparam.man
sbr/vector.c: Use new BVEC_BITS_BITS macro.
[nmh] / man / mhparam.man
index 3df2a9eda8128cac2d4f4ca4c4d7b9678dc6dc91..e4b6cb0b58f5e35205e5bd2d625c22535b345e26 100644 (file)
@@ -1,57 +1,55 @@
-.TH MHPARAM %manext1% "March 16, 2014" "%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
 .B nmh
 version identifier, the locations of the nmh
 .IR bindir ,
-.I etcdir
+.IR libexecdir ,
+.IR etcdir ,
 and
-.I libexecdir
+.I docdir
 install directories, all
 .I proc
 settings, and the
@@ -62,16 +60,17 @@ 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),
-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
+mhparam\0oauth
 .fi
 .RE
 .PP
@@ -136,6 +135,9 @@ tls
 
 % mhparam iconv
 iconv
+
+% mhparam oauth
+oauth
 .fi
 .RE
 .PP
@@ -148,7 +150,11 @@ 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