Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MHPARAM(1)		    General Commands Manual		    MHPARAM(1)

NAME
       mhparam - print nmh profile and context components

SYNOPSIS
       mhparam [-help] [-version] [components] [-all] [-component | -nocompo-
	    nent] [-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 spec-
       ified, then the switch -nocomponent is on by default.

       If  -all	 is specified, then all	components in the nmh profile are dis-
       played and other	arguments are ignored.

       mhparam can provide other information, such as the nmh version  identi-
       fier,  the  locations of	the nmh	bindir,	libexecdir, etcdir, and	docdir
       install directories, all	proc settings, and the datalocking method  de-
       scribed	in the mh-profile(5) man page.	Information about the configu-
       ration 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, re-
       spectively, 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	libex-
       ecdir.  The old form is deprecated and will be removed in a future  re-
       lease.

       Examples:

	    % mhparam path
	    Mail

	    % mhparam mhlproc
	    /usr/local/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
	    /usr/local/etc/nmh

	    % mhparam libexecdir
	    /usr/local/libexec/nmh

	    % mhparam spoollocking
	    flock

	    % 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`

EXIT STATUS
       mhparam	returns	the number of components that were not found, but lim-
       its 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.

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

SEE ALSO
       mh-profile(5)

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

CONTEXT
       None

nmh-1.7.1			  2017-02-18			    MHPARAM(1)

NAME | SYNOPSIS | DESCRIPTION | EXIT STATUS | FILES | PROFILE COMPONENTS | SEE ALSO | DEFAULTS | CONTEXT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=mhparam&sektion=1&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help