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
32       described in the mh-profile(5) man page.  Information about the config‐
33       uration of the  nmh  installation  is  also  available,  including  the
34       default  mail  spool locking method.  To test whether the configuration
35       includes support for SASL, TLS, iconv(3), and oauth, the following com‐
36       mands, respectively, 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       Note  that  the  internal  libdir component has been replaced by libex‐
48       ecdir.  The old form is deprecated and will  be  removed  in  a  future
49       release.
50
51       Examples:
52
53            % mhparam path
54            Mail
55
56            % mhparam mhlproc
57            /usr/libexec/nmh/mhl
58
59            % mhparam -component Path
60            Path: Mail
61
62            % mhparam AliasFile rmmproc
63            AliasFile: aliases
64            rmmproc: rmmproc
65
66            % mhparam -nocomponent AliasFile rmmproc
67            aliases
68            rmmproc
69
70            % mhparam path nonexistent context
71            Path: Mail
72            context: context
73
74            % mhparam version
75            nmh-1.7.1
76
77            % mhparam etcdir
78            /etc/nmh
79
80            % mhparam libexecdir
81            /usr/libexec/nmh
82
83            % mhparam spoollocking
84            fcntl
85
86            % mhparam datalocking
87            fcntl
88
89            % mhparam sasl
90            cyrus_sasl
91
92            % mhparam tls
93            tls
94
95            % mhparam iconv
96            iconv
97
98            % mhparam oauth
99            oauth
100
101       mhparam is also useful in backquoted operations:
102
103            % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
104

EXIT STATUS

106       mhparam  returns the number of components that were not found, but lim‐
107       its the return value to 120 to avoid ambiguity, e.g.  127  is  used  by
108       shells  to  indicate  `command  not  found',  and  256 would wrap to 0,
109       falsely indicating success.
110

FILES

112       $HOME/.mh_profile    The user profile
113       or $MH               Rather than the standard profile
114       <mh-dir>/context     The user context
115       or $MHCONTEXT        Rather than the standard context
116

PROFILE COMPONENTS

118       context:             To determine the context file
119

SEE ALSO

121       mh-profile(5)
122

DEFAULTS

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

CONTEXT

129       None
130
131
132
133nmh-1.7.1                         2017-02-18                        MHPARAM(1)
Impressum