Started ... not quite working yet.

[nmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index 00f38ac0b0941f48100e6d31462d2acc22267dff..9719d7b9901bfc308a4da7b50b10bbb8c3ab3d15 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,11 +1,11 @@
+.TH MHPARAM %manext1% "May 21, 2016" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\" %nmhwarning%

-.\" $Id$

 .\"
 .\"

-.TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 .SH NAME

-mhparam \- print nmh profile components
+mhparam \- print nmh profile and context components

 .SH SYNOPSIS
 .SH SYNOPSIS

+.HP 5

 .na
 .B mhparam
 .RI [ components ]
 .na
 .B mhparam
 .RI [ components ]


@@ -13,12 +13,14 @@ mhparam \- print nmh profile components
 .RB [ \-component " | " \-nocomponent ]
 .RB [ \-version ]
 .RB [ \-help ]
 .RB [ \-component " | " \-nocomponent ]
 .RB [ \-version ]
 .RB [ \-help ]

+.RB [ \-debug ]

 .ad
 .SH DESCRIPTION
 .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.
+.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
 .PP
 If the switch
 .B \-component


@@ -42,6 +44,50 @@ If
 is specified, then all components in the nmh profile are
 displayed and other arguments are ignored.
 .PP
 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 ,
+.IR libexecdir ,
+.IR etcdir ,
+and
+.I docdir
+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
+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
 Examples:
 .PP
 .RS 5


@@ -51,9 +97,9 @@ Examples:
 Mail
 
 % mhparam mhlproc
 Mail
 
 % mhparam mhlproc

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

 
 

-% mhparam \-component path
+% mhparam \-component Path

 Path: Mail
 
 % mhparam AliasFile rmmproc
 Path: Mail
 
 % mhparam AliasFile rmmproc


@@ -63,35 +109,70 @@ rmmproc: rmmproc
 % mhparam \-nocomponent AliasFile rmmproc
 aliases
 rmmproc
 % mhparam \-nocomponent AliasFile rmmproc
 aliases
 rmmproc

+
+% mhparam path nonexistent context
+Path: Mail
+context: context
+
+% mhparam version
+%nmhversion%
+
+% mhparam etcdir
+%nmhetcdir%
+
+% mhparam libexecdir
+%nmhlibexecdir%
+
+% mhparam spoollocking
+%default_locking%
+
+% mhparam datalocking
+fcntl
+
+% mhparam sasl
+cyrus_sasl
+
+% mhparam tls
+tls
+
+% mhparam iconv
+iconv

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-.B Mhparam
-is also useful in back\-quoted operations:
+.B mhparam
+is also useful in backquoted operations:

 .PP
 .RS 5
 .nf
 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 .fi
 .PP
 .RS 5
 .nf
 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 .fi

-.RE
-.PP
-
+.SH "EXIT STATUS"
+.B mhparam
+returns the number of components that were not found.

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+.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
 .fi

-

 .SH "SEE ALSO"
 .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 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
 .SH CONTEXT
 None