diplodocus.org Git - nmh/blob - man/mhparam.man

   1 .TH MHPARAM %manext1% "May 21, 2016" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 mhparam \- print nmh profile and context components
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B mhparam
  11 .RB [ \-help ]
  12 .RB [ \-version ]
  13 .RI [ components ]
  14 .RB [ \-all ]
  15 .RB [ \-component " | " \-nocomponent ]
  16 .RB [ \-debug ]
  17 .ad
  18 .SH DESCRIPTION
  19 .B mhparam
  20 writes the value of the specified profile component to the standard
  21 output separated by newlines.  Component name matching is
  22 case-insensitive.  If the profile component is not present, the
  23 default value (or nothing if there is no default) is printed.
  24 .PP
  25 If the switch
  26 .B \-component
  27 is given, then the component name is displayed
  28 along with the profile components value.  This can be disabled with the
  29 switch
  30 .BR \-nocomponent .
  31 .PP
  32 If more than one component is specified in the
  33 .I components
  34 list, then
  35 the switch
  36 .B \-component
  37 is on by default.  If only one component is
  38 specified, then the switch
  39 .B \-nocomponent
  40 is on by default.
  41 .PP
  42 If
  43 .B \-all
  44 is specified, then all components in the nmh profile are
  45 displayed and other arguments are ignored.
  46 .PP
  47 .B mhparam
  48 can provide other information, such as the
  49 .B nmh
  50 version identifier, the locations of the nmh
  51 .IR bindir ,
  52 .IR libexecdir ,
  53 .IR etcdir ,
  54 and
  55 .I docdir
  56 install directories, all
  57 .I proc
  58 settings, and the
  59 .I datalocking
  60 method described in the
  61 .IR mh\-profile (5)
  62 man page.  Information about the configuration of the
  63 .B nmh
  64 installation is also available, including the default mail spool
  65 locking method.  To test whether the configuration includes
  66 support for SASL, TLS,
  67 .IR iconv (3),
  68 and oauth, the following commands, respectively, will output a non-null
  69 string to indicate support:
  70 .PP
  71 .RS 5
  72 .nf
  73 mhparam\0sasl
  74 mhparam\0tls
  75 mhparam\0iconv
  76 mhparam\0oauth
  77 .fi
  78 .RE
  79 .PP
  80 Conversely, no output means that the specified support is not included.
  81 The
  82 .B \-debug
  83 switch displays all such other information available from
  84 .BR mhparam .
  85 .PP
  86 Note that the internal
  87 .B libdir
  88 component has been replaced by
  89 .BR libexecdir .
  90 The old form is deprecated and will be removed in a future release.
  91 .PP
  92 Examples:
  93 .PP
  94 .RS 5
  95 .nf
  96 .ta \w'AliasFile:'u+2n
  97 % mhparam path
  98 Mail
  99
 100 % mhparam mhlproc
 101 %nmhlibexecdir%/mhl
 102
 103 % mhparam \-component Path
 104 Path: Mail
 105
 106 % mhparam AliasFile rmmproc
 107 AliasFile: aliases
 108 rmmproc: rmmproc
 109
 110 % mhparam \-nocomponent AliasFile rmmproc
 111 aliases
 112 rmmproc
 113
 114 % mhparam path nonexistent context
 115 Path: Mail
 116 context: context
 117
 118 % mhparam version
 119 %nmhversion%
 120
 121 % mhparam etcdir
 122 %nmhetcdir%
 123
 124 % mhparam libexecdir
 125 %nmhlibexecdir%
 126
 127 % mhparam spoollocking
 128 %default_locking%
 129
 130 % mhparam datalocking
 131 fcntl
 132
 133 % mhparam sasl
 134 cyrus_sasl
 135
 136 % mhparam tls
 137 tls
 138
 139 % mhparam iconv
 140 iconv
 141
 142 % mhparam oauth
 143 oauth
 144 .fi
 145 .RE
 146 .PP
 147 .B mhparam
 148 is also useful in backquoted operations:
 149 .PP
 150 .RS 5
 151 .nf
 152 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 153 .fi
 154 .SH "EXIT STATUS"
 155 .B mhparam
 156 returns the number of components that were not found,
 157 but limits just the return value to 120 to avoid ambiguity,
 158 e.g.\& 127 is used by shells to indicate `command not found',
 159 and 256 would wrap to 0, falsely indicating success.
 160 .
 161 .SH FILES
 162 .fc ^ ~
 163 .nf
 164 .ta \w'ExtraBigProfileName  'u
 165 ^$HOME/.mh_profile~^The user profile
 166 ^or $MH~^Rather than the standard profile
 167 ^<mh-dir>/context~^The user context
 168 ^or $MHCONTEXT~^Rather than the standard context
 169 .fi
 170 .SH "PROFILE COMPONENTS"
 171 .fc ^ ~
 172 .nf
 173 .ta 2.4i
 174 .ta \w'ExtraBigProfileName  'u
 175 ^context:~^To determine the context file
 176 .fi
 177 .SH "SEE ALSO"
 178 .IR mh-profile (5)
 179 .SH DEFAULTS
 180 .nf
 181 .RB ` \-nocomponent "' if only one component is specified"
 182 .RB ` \-component "' if more than one component is specified"
 183 .RB ` components "' defaults to none"
 184 .fi
 185 .SH CONTEXT
 186 None