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

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   6 .SH NAME
   7 mhparam \- print nmh profile components
   8 .SH SYNOPSIS
   9 .B mhparam
  10 .RI [ components ]
  11 .RB [ \-all ]
  12 .RB [ \-component " | " \-nocomponent ]
  13 .RB [ \-version ]
  14 .RB [ \-help ]
  15 .SH DESCRIPTION
  16 .B Mhparam
  17 writes the value of the specified profile component to the
  18 standard output separated by newlines.  If the profile component is not
  19 present, the default value (or nothing if there is no default) is printed.
  20 .PP
  21 If the switch
  22 .B \-component
  23 is given, then the component name is displayed
  24 along with the profile components value.  This can be disabled with the
  25 switch
  26 .BR \-nocomponent .
  27 .PP
  28 If more than one component is specified in the
  29 .I components
  30 list, then
  31 the switch
  32 .B \-component
  33 is on by default.  If only one component is
  34 specified, then the switch
  35 .B \-nocomponent
  36 is on by default.
  37 .PP
  38 If
  39 .B \-all
  40 is specified, then all components in the nmh profile are
  41 displayed and other arguments are ignored.
  42 .PP
  43 Examples:
  44 .PP
  45 .RS 5
  46 .nf
  47 .ta \w'AliasFile:'u+2n
  48 % mhparam path
  49 Mail
  50
  51 % mhparam mhlproc
  52 %libdir%/mhl
  53
  54 % mhparam \-component path
  55 Path: Mail
  56
  57 % mhparam AliasFile rmmproc
  58 AliasFile: aliases
  59 rmmproc: rmmproc
  60
  61 % mhparam \-nocomponent AliasFile rmmproc
  62 aliases
  63 rmmproc
  64 .fi
  65 .RE
  66 .PP
  67 .B Mhparam
  68 is also useful in back\-quoted operations:
  69 .PP
  70 .RS 5
  71 .nf
  72 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
  73 .fi
  74 .RE
  75 .PP
  76
  77 .SH FILES
  78 .fc ^ ~
  79 .nf
  80 .ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
  81 ^$HOME/\&.mh\(ruprofile~^The user profile
  82 .fi
  83
  84 .SH "SEE ALSO"
  85 mh-profile(5)
  86
  87 .SH DEFAULTS
  88 .nf
  89 .RB ` \-nocomponent "' if only one component is specified"
  90 .RB ` \-component "' if more than one component is specified"
  91 .RB ` components "' defaults to none"
  92 .fi
  93
  94 .SH CONTEXT
  95 None