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