X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/1691e80890e5d8ba258c51c214a3e91880e1db2b..b539bd46de3f83ffaa486e8f58090f04beda44f7:/man/mhparam.man?ds=inline

diff --git a/man/mhparam.man b/man/mhparam.man
index a4af2b58..9629f582 100644
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,52 +1,97 @@
+.TH MHPARAM %manext1% "March 16, 2014" "%nmhversion%"
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH MHPARAM %manext1% MH.6.8 [%nmhversion%]
 .SH NAME
-mhparam \- print nmh profile components
+mhparam \- print nmh profile and context components
 .SH SYNOPSIS
-.in +.5i
-.ti -.5i
-mhparam
-\%[components]
-\%[-all]
-\%[-component] \%[-nocomponent]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B mhparam
+.RI [ components ]
+.RB [ \-all ]
+.RB [ \-component " | " \-nocomponent ]
+.RB [ \-version ]
+.RB [ \-help ]
+.RB [ \-debug ]
+.ad
 .SH DESCRIPTION
-\fIMhparam\fR 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.
-
-If the switch `\-component' is given, then the component name is displayed
+.B mhparam
+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
+is given, then the component name is displayed
 along with the profile components value.  This can be disabled with the
-switch `\-nocomponent'.
-
-If more than one component is specified in the `components' list, then
-the switch `\-component' is on by default.  If only one component is
-specified, then the switch `\-nocomponent' is on by default.
-
-If `\-all' is specified, then all components in the nmh profile are
+switch
+.BR \-nocomponent .
+.PP
+If more than one component is specified in the
+.I components
+list, then
+the switch
+.B \-component
+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.
-
+.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
 .nf
 .ta \w'AliasFile:'u+2n
-.in +.5i
 % mhparam path
 Mail
 
 % mhparam mhlproc
 %libdir%/mhl
 
-% mhparam \-component path
+% mhparam \-component Path
 Path: Mail
 
 % mhparam AliasFile rmmproc
@@ -56,26 +101,70 @@ rmmproc: rmmproc
 % mhparam \-nocomponent AliasFile rmmproc
 aliases
 rmmproc
-.in -.5i
-.fi
 
-\fIMhparam\fR is also useful in back\-quoted operations:
+% 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 backquoted operations:
+.PP
+.RS 5
 .nf
-.in +.5i
 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
-
-.in -.5i
 .fi
-.Fi
-^$HOME/\&.mh\(ruprofile~^The user profile
-.Sa
-mh-profile\|(5)
-.De
-`\-nocomponent' if only one component is specified
-`\-component' if more than one component is specified
-.Ds
-`components' defaults to none
-.Co
+.SH "EXIT STATUS"
+.B mhparam
+returns the number of components that were not found.
+.SH FILES
+.fc ^ ~
+.nf
+.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
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u
+^context:~^To determine the context file
+.fi
+.SH "SEE ALSO"
+.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
-.En