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