]> diplodocus.org Git - nmh/blobdiff - man/mhparam.man
h/prototypes.h: Remove mhlsbr() prototype; no such function.
[nmh] / man / mhparam.man
index 9719d7b9901bfc308a4da7b50b10bbb8c3ab3d15..656894db87dcee3b2cc5691db7d669b20ac4e8b1 100644 (file)
@@ -1,48 +1,45 @@
-.TH MHPARAM %manext1% "May 21, 2016" "%nmhversion%"
-.\"
+.TH MHPARAM %manext1% 2017-02-18 "%nmhversion%"
+.
 .\" %nmhwarning%
 .\" %nmhwarning%
-.\"
+.
 .SH NAME
 mhparam \- print nmh profile and context components
 .SH SYNOPSIS
 .HP 5
 .na
 .B mhparam
 .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 ]
 .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
 .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
 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
 .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
 .BR \-nocomponent .
 .PP
 If more than one component is specified in the
 .I components
-list, then
-the switch
+list, then the switch
 .B \-component
 .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
 .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
 .PP
 .B mhparam
 can provide other information, such as the
@@ -57,22 +54,23 @@ install directories, all
 .I proc
 settings, and the
 .I datalocking
 .I proc
 settings, and the
 .I datalocking
-method described in the
-.IR mh\-profile (5)
-man page.  Information about the configuration of the
+method described in
+.IR mh\-profile (5).
+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
 .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
@@ -82,61 +80,58 @@ 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
 .nf
 .ta \w'AliasFile:'u+2n
 Examples:
 .PP
 .RS 5
 .nf
 .ta \w'AliasFile:'u+2n
-% mhparam path
+$ mhparam path
 Mail
 
 Mail
 
-% mhparam mhlproc
+$ mhparam mhlproc
 %nmhlibexecdir%/mhl
 
 %nmhlibexecdir%/mhl
 
-% mhparam \-component Path
+$ mhparam \-component Path
 Path: Mail
 
 Path: Mail
 
-% mhparam AliasFile rmmproc
+$ mhparam AliasFile rmmproc
 AliasFile: aliases
 rmmproc: rmmproc
 
 AliasFile: aliases
 rmmproc: rmmproc
 
-% mhparam \-nocomponent AliasFile rmmproc
+$ mhparam \-nocomponent AliasFile rmmproc
 aliases
 rmmproc
 
 aliases
 rmmproc
 
-% mhparam path nonexistent context
+$ mhparam path nonexistent context
 Path: Mail
 context: context
 
 Path: Mail
 context: context
 
-% mhparam version
+$ mhparam version
 %nmhversion%
 
 %nmhversion%
 
-% mhparam etcdir
+$ mhparam etcdir
 %nmhetcdir%
 
 %nmhetcdir%
 
-% mhparam libexecdir
+$ mhparam libexecdir
 %nmhlibexecdir%
 
 %nmhlibexecdir%
 
-% mhparam spoollocking
+$ mhparam spoollocking
 %default_locking%
 
 %default_locking%
 
-% mhparam datalocking
+$ mhparam datalocking
 fcntl
 
 fcntl
 
-% mhparam sasl
+$ mhparam sasl
 cyrus_sasl
 
 cyrus_sasl
 
-% mhparam tls
+$ mhparam tls
 tls
 
 tls
 
-% mhparam iconv
+$ mhparam iconv
 iconv
 iconv
+
+$ mhparam oauth
+oauth
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP
@@ -145,11 +140,12 @@ is also useful in backquoted operations:
 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf
-% fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
+$ fgrep cornell.edu \`mhpath +\`/\`mhparam aliasfile\`
 .fi
 .SH "EXIT STATUS"
 .fi
 .SH "EXIT STATUS"
-.B mhparam
-returns the number of components that were not found.
+The exit status is zero if all components are found,
+or one if any are missing.
+.
 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf