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 .na
   9 .B mhparam
  10 .RI [ components ]
  11 .RB [ \-all ]
  12 .RB [ \-component " | " \-nocomponent ]
  13 .RB [ \-debug ]
  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 If
  46 .B \-debug
  47 is specified, then all available components \(en those in
  48 the nmh profile and some internal ones \(en are
  49 displayed.
  50 .PP
  51 Examples:
  52 .PP
  53 .RS 5
  54 .nf
  55 .ta \w'AliasFile:'u+2n
  56 % mhparam path
  57 Mail
  58
  59 % mhparam mhlproc
  60 %libdir%/mhl
  61
  62 % mhparam \-component path
  63 Path: Mail
  64
  65 % mhparam AliasFile rmmproc
  66 AliasFile: aliases
  67 rmmproc: rmmproc
  68
  69 % mhparam \-nocomponent AliasFile rmmproc
  70 aliases
  71 rmmproc
  72
  73 % mhparam path nonexistent context
  74 Path: Mail
  75 context: context
  76 .fi
  77 .RE
  78 .PP
  79 .B mhparam
  80 is also useful in back\-quoted operations:
  81 .PP
  82 .RS 5
  83 .nf
  84 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
  85 .fi
  86
  87 .SH "EXIT STATUS"
  88 .B mhparam
  89 returns the number of components that were not found.
  90
  91 .SH FILES
  92 .fc ^ ~
  93 .nf
  94 .ta \w'%etcdir%/ExtraBigFileName  'u
  95 ^$HOME/.mh_profile~^The user profile
  96 ^or $MH~^Rather than the standard profile
  97 ^<mh-dir>/context~^The user context
  98 ^or $MHCONTEXT~^Rather than the standard context
  99 .fi
 100
 101 .SH "PROFILE COMPONENTS"
 102 .fc ^ ~
 103 .nf
 104 .ta 2.4i
 105 .ta \w'ExtraBigProfileName  'u
 106 ^context:~^To determine the context file
 107 .fi
 108
 109 .SH "SEE ALSO"
 110 mh-profile(5)
 111
 112 .SH DEFAULTS
 113 .nf
 114 .RB ` \-nocomponent "' if only one component is specified"
 115 .RB ` \-component "' if more than one component is specified"
 116 .RB ` components "' defaults to none"
 117 .fi
 118
 119 .SH CONTEXT
 120 None