MHPARAM(1)

📦
version 1.8 · 7 versions
, in alpine 3.24, epel 10, epel 9, fedora 43, fedora 44

✨ NAME ✨

okay bestie, meet mhparam — the nmh glow-up tool that prints out your nmh profile and context components 💅 she reads your config and tells you what's in it, no cap.

🎀 SYNOPSIS 🎀

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

🦋 DESCRIPTION 🦋

so basically, mhparam writes the value of the profile component(s) you asked for to standard output, each one separated by newlines. Component name matching is case-insensitive — she does not care about your capitalisation era, fr fr. And if the profile component is not present? She prints the default value instead — or literally nothing, if there's no default. (iconic behaviour tbh)

If you pass the -component switch, then the component name gets displayed right alongside the profile component's value. You can turn that off again with -nocomponent. 🫶

Here's the little rule that trips people up, so pay attention bestie:

  • if more than one component is specified in the components list, then -component is on by default.
  • if only one component is specified, then -nocomponent is on by default.

If -all is specified, then all components in the nmh profile get displayed, and the other arguments are ignored. Periodt. 🔥

She can also hand over other info, and it's giving ✨ bonus content ✨: 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 mh-profile(5). Info about the configuration of the nmh installation is up for grabs too, including the default mail spool locking method.

Wanna know whether your configuration includes support for SASL, TLS, iconv(3), and oauth? Run these, respectively — a non-null string means the support is there:

mhparam sasl
mhparam tls
mhparam iconv
mhparam oauth

Conversely, no output means that support is not included. Not a single crumb. 😭 And the -debug switch displays all such other information available from mhparam. She's an open book, lowkey.

Examples, because we love receipts:

$ 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.8

$ 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

Also? She's the moment inside backquoted operations:

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

💀 EXIT STATUS 💀

The exit status is zero if all components are found, or one if any are missing. So if you script against her, check that number, bestie. 🙈

🍓 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

and that's the whole vibe check, bestie — this page is from nmh-1.8, dated 2017-02-18, so go forth and mhparam responsibly 💖✨🎀

📦 where this page comes from