Separate out backquote expression to please Heirloom shell.

[nmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index 91a8d603031ca665aaea5a8cf36433cc0d73d720..df1de43e5f7d250866bf73b1dc821c7a244137c1 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,24 +1,26 @@
+.TH MHPARAM %manext1% "May 21, 2016" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %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
 .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
 .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
 .PP
 If the switch
 .B \-component


@@ -42,6 +44,51 @@ 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,
+.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 .
+.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 +98,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


@@ -67,31 +114,59 @@ rmmproc
 % mhparam path nonexistent context
 Path: Mail
 context: context
 % 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
+
+% 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
 .PP
 .RS 5
 .nf
 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 .fi

-

 .SH "EXIT STATUS"
 .B mhparam
 .SH "EXIT STATUS"
 .B mhparam

-returns the number of components that were not found.
-
+returns the number of components that were not found,
+but limits just the return value to 120 to avoid ambiguity,
+e.g.\& 127 is used by shells to indicate `command not found',
+and 256 would wrap to 0, falsely indicating success.
+.

 .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
 ^or $MHCONTEXT~^Rather than the standard context
 .fi
 ^$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
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf


@@ -99,16 +174,13 @@ returns the number of components that were not found.
 .ta \w'ExtraBigProfileName  'u
 ^context:~^To determine the context file
 .fi
 .ta \w'ExtraBigProfileName  'u
 ^context:~^To determine the context file
 .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