mhparam (1) - Linux Manuals

mhparam: print nmh profile and context components

Command to display mhparam manual in Linux: $ man 1 mhparam

NAME

mhparam - print nmh profile and context components

SYNOPSIS

mhparam [components] [-all] [-component | -nocomponent] [-version] [-help] [-debug]

DESCRIPTION

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 etcdir and libdir 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, and iconv(3), the following commands, respectively, will output a non-null string to indicate support:

mhparam sasl
mhparam tls
mhparam iconv

Conversely, no output means that the specified support is not included. The -debug switch displays all such other information available from mhparam.

Examples:

% 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.6

% mhparam etcdir
/etc/nmh

% mhparam libdir
/usr/libexec/nmh

% mhparam spoollocking
fcntl

% mhparam datalocking
fcntl

% mhparam sasl
cyrus_sasl

% mhparam tls
tls

% mhparam iconv
iconv

mhparam is also useful in backquoted operations:

% fgrep cornell.edu `mhpath +`/`mhparam aliasfile`

EXIT STATUS

mhparam returns the number of components that were not found.

FILES

^$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

PROFILE COMPONENTS

^context:~^To determine the context file

DEFAULTS

`-nocomponent' if only one component is specified
`-component' if more than one component is specified
`components' defaults to none

CONTEXT

None