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

   1 .TH MHPARAM %manext1% "February 26, 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 .BR mhparam
  48 can provide other information, such as
  49 the locations of the nmh
  50 .I etcdir
  51 and
  52 .I libdir
  53 install directories, all
  54 .I proc
  55 settings, and the default locking method with which the
  56 .B nmh
  57 installation was configured.  The
  58 .B \-debug
  59 switch displays all such other information available from
  60 .BR mhparam .
  61 .PP
  62 Examples:
  63 .PP
  64 .RS 5
  65 .nf
  66 .ta \w'AliasFile:'u+2n
  67 % mhparam path
  68 Mail
  69
  70 % mhparam mhlproc
  71 %libdir%/mhl
  72
  73 % mhparam \-component Path
  74 Path: Mail
  75
  76 % mhparam AliasFile rmmproc
  77 AliasFile: aliases
  78 rmmproc: rmmproc
  79
  80 % mhparam \-nocomponent AliasFile rmmproc
  81 aliases
  82 rmmproc
  83
  84 % mhparam path nonexistent context
  85 Path: Mail
  86 context: context
  87
  88 % mhparam etcdir
  89 %etcdir%
  90
  91 % mhparam libdir
  92 %libdir%
  93
  94 % mhparam datalocking
  95 fcntl
  96
  97 % mhparam spoollocking
  98 flock
  99 .fi
 100 .RE
 101 .PP
 102 .B mhparam
 103 is also useful in backquoted operations:
 104 .PP
 105 .RS 5
 106 .nf
 107 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 108 .fi
 109 .SH "EXIT STATUS"
 110 .B mhparam
 111 returns the number of components that were not found.
 112 .SH FILES
 113 .fc ^ ~
 114 .nf
 115 .ta \w'%etcdir%/ExtraBigFileName  'u
 116 ^$HOME/.mh_profile~^The user profile
 117 ^or $MH~^Rather than the standard profile
 118 ^<mh-dir>/context~^The user context
 119 ^or $MHCONTEXT~^Rather than the standard context
 120 .fi
 121 .SH "PROFILE COMPONENTS"
 122 .fc ^ ~
 123 .nf
 124 .ta 2.4i
 125 .ta \w'ExtraBigProfileName  'u
 126 ^context:~^To determine the context file
 127 .fi
 128 .SH "SEE ALSO"
 129 .IR mh-profile (5)
 130 .SH DEFAULTS
 131 .nf
 132 .RB ` \-nocomponent "' if only one component is specified"
 133 .RB ` \-component "' if more than one component is specified"
 134 .RB ` components "' defaults to none"
 135 .fi
 136 .SH CONTEXT
 137 None