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

   1 .TH MHPARAM %manext1% "March 16, 2014" "%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 .RI [ components ]
  12 .RB [ \-all ]
  13 .RB [ \-component " | " \-nocomponent ]
  14 .RB [ \-version ]
  15 .RB [ \-help ]
  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 .I etcdir
  53 and
  54 .I libexecdir
  55 install directories, all
  56 .I proc
  57 settings, and the
  58 .I datalocking
  59 method described in the
  60 .IR mh\-profile (5)
  61 man page.  Information about the configuration of the
  62 .B nmh
  63 installation is also available, including the default mail spool
  64 locking method.  To test whether the configuration includes
  65 support for SASL, TLS, and
  66 .IR iconv (3),
  67 the following commands, respectively, will output a non-null string to
  68 indicate support:
  69 .PP
  70 .RS 5
  71 .nf
  72 mhparam\0sasl
  73 mhparam\0tls
  74 mhparam\0iconv
  75 .fi
  76 .RE
  77 .PP
  78 Conversely, no output means that the specified support is not included.
  79 The
  80 .B \-debug
  81 switch displays all such other information available from
  82 .BR mhparam .
  83 .PP
  84 Note that the internal
  85 .B libdir
  86 component has been replaced by
  87 .BR libexecdir .
  88 The old form is deprecated and will be removed in a future release.
  89 .PP
  90 Examples:
  91 .PP
  92 .RS 5
  93 .nf
  94 .ta \w'AliasFile:'u+2n
  95 % mhparam path
  96 Mail
  97
  98 % mhparam mhlproc
  99 %nmhlibexecdir%/mhl
 100
 101 % mhparam \-component Path
 102 Path: Mail
 103
 104 % mhparam AliasFile rmmproc
 105 AliasFile: aliases
 106 rmmproc: rmmproc
 107
 108 % mhparam \-nocomponent AliasFile rmmproc
 109 aliases
 110 rmmproc
 111
 112 % mhparam path nonexistent context
 113 Path: Mail
 114 context: context
 115
 116 % mhparam version
 117 %nmhversion%
 118
 119 % mhparam etcdir
 120 %nmhetcdir%
 121
 122 % mhparam libexecdir
 123 %nmhlibexecdir%
 124
 125 % mhparam spoollocking
 126 %default_locking%
 127
 128 % mhparam datalocking
 129 fcntl
 130
 131 % mhparam sasl
 132 cyrus_sasl
 133
 134 % mhparam tls
 135 tls
 136
 137 % mhparam iconv
 138 iconv
 139 .fi
 140 .RE
 141 .PP
 142 .B mhparam
 143 is also useful in backquoted operations:
 144 .PP
 145 .RS 5
 146 .nf
 147 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 148 .fi
 149 .SH "EXIT STATUS"
 150 .B mhparam
 151 returns the number of components that were not found.
 152 .SH FILES
 153 .fc ^ ~
 154 .nf
 155 .ta \w'ExtraBigProfileName  'u
 156 ^$HOME/.mh_profile~^The user profile
 157 ^or $MH~^Rather than the standard profile
 158 ^<mh-dir>/context~^The user context
 159 ^or $MHCONTEXT~^Rather than the standard context
 160 .fi
 161 .SH "PROFILE COMPONENTS"
 162 .fc ^ ~
 163 .nf
 164 .ta 2.4i
 165 .ta \w'ExtraBigProfileName  'u
 166 ^context:~^To determine the context file
 167 .fi
 168 .SH "SEE ALSO"
 169 .IR mh-profile (5)
 170 .SH DEFAULTS
 171 .nf
 172 .RB ` \-nocomponent "' if only one component is specified"
 173 .RB ` \-component "' if more than one component is specified"
 174 .RB ` components "' defaults to none"
 175 .fi
 176 .SH CONTEXT
 177 None