new.c: Order two return statements to match comment.

[nmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index 4c2ad889a942054fe7134492902042459440c339..5c89ec57b7ab92caac02cd468d48ef2531396d54 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,58 +1,81 @@
-.TH MHPARAM %manext1% "June 14, 2012" "%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
 .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
+.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
+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 .
 .B \-debug
 switch displays all such other information available from
 .BR mhparam .


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

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

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


@@ -83,28 +106,50 @@ 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 datalocking
+fcntl

 
 

-% mhparam libdir
-%libdir%
+% 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
 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 .fi
 .SH "EXIT STATUS"
 .PP
 .RS 5
 .nf
 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 .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

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