mhparam man page
mhparam — print nmh profile and context components
mhparam [-help] [-version] [components] [-all] [-component | -nocomponent] [-debug]
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.
If the switch -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 displayed and other arguments are ignored.
mhparam can provide other information, such as the nmh version identifier, the locations of the nmh bindir, libexecdir, etcdir, and docdir install directories, all proc settings, and the datalocking method described in the mh-profile(5) man page. Information about the configuration of the nmh installation is also available, including the default mail spool locking method. To test whether the configuration includes support for SASL, TLS, iconv(3), and oauth, the following commands, respectively, will output a non-null string to indicate support:
mhparam sasl mhparam tls mhparam iconv mhparam oauth
Conversely, no output means that the specified support is not included. The -debug switch displays all such other information available from mhparam.
Note that the internal libdir component has been replaced by libexecdir. The old form is deprecated and will be removed in a future release.
% mhparam path Mail % mhparam mhlproc /usr/libexec/nmh/mhl % mhparam -component Path Path: Mail % mhparam AliasFile rmmproc AliasFile: aliases rmmproc: rmmproc % mhparam -nocomponent AliasFile rmmproc aliases rmmproc % mhparam path nonexistent context Path: Mail context: context % mhparam version nmh-1.7.1 % mhparam etcdir /etc/nmh % mhparam libexecdir /usr/libexec/nmh % mhparam spoollocking fcntl % mhparam datalocking fcntl % mhparam sasl cyrus_sasl % mhparam tls tls % mhparam iconv iconv % mhparam oauth oauth
mhparam is also useful in backquoted operations:
% fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
mhparam returns the number of components that were not found, but limits 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.
|$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|
|context:||To determine the context file|
`-nocomponent' if only one component is specified `-component' if more than one component is specified `components' defaults to none
mhfixmsg(1), mh-folders(5), mh-mime(7), mhshow(1), nmh(7), send(1).