git.marmaro.de Git - mmh/blob - man/mhparam.man

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   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 .ad
  17 .SH DESCRIPTION
  18 .B mhparam
  19 writes the value of the specified profile component to the standard
  20 output separated by newlines.  Component name matching is
  21 case-insensitive.  If the profile component is not present, the
  22 default value (or nothing if there is no default) is printed.
  23 .PP
  24 If the switch
  25 .B \-component
  26 is given, then the component name is displayed
  27 along with the profile components value.  This can be disabled with the
  28 switch
  29 .BR \-nocomponent .
  30 .PP
  31 If more than one component is specified in the
  32 .I components
  33 list, then
  34 the switch
  35 .B \-component
  36 is on by default.  If only one component is
  37 specified, then the switch
  38 .B \-nocomponent
  39 is on by default.
  40 .PP
  41 If
  42 .B \-all
  43 is specified, then all components in the nmh profile are
  44 displayed and other arguments are ignored.
  45 .PP
  46 The locations of two nmh install directories are also available
  47 through
  48 .BR mhparam :
  49 .I etcdir
  50 and
  51 .IR libdir .
  52 .PP
  53 Examples:
  54 .PP
  55 .RS 5
  56 .nf
  57 .ta \w'AliasFile:'u+2n
  58 % mhparam path
  59 Mail
  60
  61 % mhparam mhlproc
  62 %libdir%/mhl
  63
  64 % mhparam \-component Path
  65 Path: Mail
  66
  67 % mhparam AliasFile rmmproc
  68 AliasFile: aliases
  69 rmmproc: rmmproc
  70
  71 % mhparam \-nocomponent AliasFile rmmproc
  72 aliases
  73 rmmproc
  74
  75 % mhparam path nonexistent context
  76 Path: Mail
  77 context: context
  78
  79 % mhparam etcdir
  80 %etcdir%
  81
  82 % mhparam libdir
  83 %libdir%
  84 .fi
  85 .RE
  86 .PP
  87 .B mhparam
  88 is also useful in back\-quoted operations:
  89 .PP
  90 .RS 5
  91 .nf
  92 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
  93 .fi
  94
  95 .SH "EXIT STATUS"
  96 .B mhparam
  97 returns the number of components that were not found.
  98
  99 .SH FILES
 100 .fc ^ ~
 101 .nf
 102 .ta \w'%etcdir%/ExtraBigFileName  'u
 103 ^$HOME/.mh_profile~^The user profile
 104 ^or $MH~^Rather than the standard profile
 105 ^<mh-dir>/context~^The user context
 106 ^or $MHCONTEXT~^Rather than the standard context
 107 .fi
 108
 109 .SH "PROFILE COMPONENTS"
 110 .fc ^ ~
 111 .nf
 112 .ta 2.4i
 113 .ta \w'ExtraBigProfileName  'u
 114 ^context:~^To determine the context file
 115 .fi
 116
 117 .SH "SEE ALSO"
 118 mh-profile(5)
 119
 120 .SH DEFAULTS
 121 .nf
 122 .RB ` \-nocomponent "' if only one component is specified"
 123 .RB ` \-component "' if more than one component is specified"
 124 .RB ` components "' defaults to none"
 125 .fi
 126
 127 .SH CONTEXT
 128 None