eliminate use of fgets() in mhbuild.c

[nmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index ba00fc69e6303123008c2dec893064c6abe500ae..9629f582a73de89b10ce77a1628addf1d1d7d0e3 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,10 +1,11 @@
+.TH MHPARAM %manext1% "March 16, 2014" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
-.TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 mhparam \- print nmh profile and context components
 .SH SYNOPSIS
+.HP 5
 .na
 .B mhparam
 .RI [ components ]
@@ -12,12 +13,14 @@ mhparam \- print nmh profile and context components
 .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.  If the profile component is not
-present, the default value (or nothing if there is no default) is printed.
+writes the value of the specified profile component to the standard
+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.
 .PP
 If the switch
 .B \-component
@@ -41,6 +44,42 @@ If
 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
+.B nmh
+version identifier, the locations of the nmh
+.I etcdir
+and
+.I libdir
+install directories, all
+.I proc
+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, and
+.IR iconv (3),
+the following commands, respectively, will output a non-null string to
+indicate support:
+.PP
+.RS 5
+.nf
+mhparam\0sasl
+mhparam\0tls
+mhparam\0iconv
+.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
 Examples:
 .PP
 .RS 5
@@ -52,7 +91,7 @@ Mail
 % mhparam mhlproc
 %libdir%/mhl
 
-% mhparam \-component path
+% mhparam \-component Path
 Path: Mail
 
 % mhparam AliasFile rmmproc
@@ -66,31 +105,52 @@ rmmproc
 % mhparam path nonexistent context
 Path: Mail
 context: context
+
+% mhparam version
+%nmhversion%
+
+% mhparam etcdir
+%etcdir%
+
+% mhparam libdir
+%libdir%
+
+% mhparam spoollocking
+%default_locking%
+
+% mhparam datalocking
+fcntl
+
+% mhparam sasl
+cyrus_sasl
+
+% mhparam tls
+tls
+
+% mhparam iconv
+iconv
 .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"
 .B mhparam
 returns the number of components that were not found.
-
 .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
 ^or $MHCONTEXT~^Rather than the standard context
 .fi
-
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
@@ -98,16 +158,13 @@ returns the number of components that were not found.
 .ta \w'ExtraBigProfileName  'u
 ^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"
 .RB ` \-component "' if more than one component is specified"
 .RB ` components "' defaults to none"
 .fi
-
 .SH CONTEXT
 None