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