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