mhparam(1)

1MHPARAM(1)                  General Commands Manual                 MHPARAM(1)
2
3
4

NAME

6       mhparam - print nmh profile and context components
7

SYNOPSIS

9       mhparam [-help] [-version] [components] [-all] [-component | -nocompo‐
10            nent] [-debug]
11

DESCRIPTION

13       mhparam writes the value of the  specified  profile  component  to  the
14       standard  output,  separated  by  newlines.  Component name matching is
15       case-insensitive.  If the profile component is not present, the default
16       value (or nothing, if there is no default) is printed.
17
18       If the switch -component is given, then the component name is displayed
19       along with the profile components value.  This can be disabled with the
20       switch -nocomponent.
21
22       If  more  than  one component is specified in the components list, then
23       the switch -component is on by default.  If only one component is spec‐
24       ified, then the switch -nocomponent is on by default.
25
26       If  -all  is specified, then all components in the nmh profile are dis‐
27       played and other arguments are ignored.
28
29       mhparam can provide other information, such as the nmh version  identi‐
30       fier,  the  locations of the nmh bindir, libexecdir, etcdir, and docdir
31       install directories, all proc settings, and the datalocking method  de‐
32       scribed  in  mh-profile(5).  Information about the configuration of the
33       nmh installation is also available, including the  default  mail  spool
34       locking method.  To test whether the configuration includes support for
35       SASL, TLS, iconv(3), and oauth, the following  commands,  respectively,
36       will output a non-null string to indicate support:
37
38            mhparam sasl
39            mhparam tls
40            mhparam iconv
41            mhparam oauth
42
43       Conversely, no output means that the specified support is not included.
44       The -debug switch displays all such other  information  available  from
45       mhparam.
46
47       Examples:
48
49            $ mhparam path
50            Mail
51
52            $ mhparam mhlproc
53            /usr/libexec/nmh/mhl
54
55            $ mhparam -component Path
56            Path: Mail
57
58            $ mhparam AliasFile rmmproc
59            AliasFile: aliases
60            rmmproc: rmmproc
61
62            $ mhparam -nocomponent AliasFile rmmproc
63            aliases
64            rmmproc
65
66            $ mhparam path nonexistent context
67            Path: Mail
68            context: context
69
70            $ mhparam version
71            nmh-1.8
72
73            $ mhparam etcdir
74            /etc/nmh
75
76            $ mhparam libexecdir
77            /usr/libexec/nmh
78
79            $ mhparam spoollocking
80            fcntl
81
82            $ mhparam datalocking
83            fcntl
84
85            $ mhparam sasl
86            cyrus_sasl
87
88            $ mhparam tls
89            tls
90
91            $ mhparam iconv
92            iconv
93
94            $ mhparam oauth
95            oauth
96
97       mhparam is also useful in backquoted operations:
98
99            $ fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
100

EXIT STATUS

102       The  exit status is zero if all components are found, or one if any are
103       missing.
104

FILES

106       $HOME/.mh_profile    The user profile
107       or $MH               Rather than the standard profile
108       <mh-dir>/context     The user context
109       or $MHCONTEXT        Rather than the standard context
110

PROFILE COMPONENTS

112       context:             To determine the context file
113

DEFAULTS

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

CONTEXT

123       None
124
125
126
127nmh-1.8                           2017-02-18                        MHPARAM(1)