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

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   5 .SH NAME
   6 mhparam \- print mmh 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 [ \-debug ]
  15 .RB [ \-Version ]
  16 .RB [ \-help ]
  17 .ad
  18 .SH DESCRIPTION
  19 .B mhparam
  20 writes the value of the specified profile component to the
  21 standard output separated by newlines.  If the profile component is not
  22 present, the default value (or nothing if there is no default) is printed.
  23 .PP
  24 If the switch
  25 .B \-component
  26 is given, then the component name is displayed
  27 along with the profile components value.  This can be disabled with the
  28 switch
  29 .BR \-nocomponent .
  30 .PP
  31 If more than one component is specified in the
  32 .I components
  33 list, then
  34 the switch
  35 .B \-component
  36 is on by default.  If only one component is
  37 specified, then the switch
  38 .B \-nocomponent
  39 is on by default.
  40 .PP
  41 If
  42 .B \-all
  43 is specified, then all components in the mmh profile and context
  44 (including comments) are displayed and other arguments are ignored.
  45 .PP
  46 If
  47 .B \-debug
  48 is specified, then a defined set of internal profile entries are
  49 displayed.
  50 .PP
  51 Examples:
  52 .PP
  53 .RS 5
  54 .nf
  55 .ta \w'LongEntry:'u+2n
  56 % mhparam path
  57 Mail
  58
  59 % mhparam editor
  60 vi
  61
  62 % mhparam \-component Path
  63 Path: Mail
  64
  65 % mhparam AliasFile sendmail
  66 AliasFile: aliases
  67 sendmail: /usr/sbin/sendmail
  68
  69 % mhparam \-nocomponent AliasFile sendmail
  70 aliases
  71 /usr/sbin/sendmail
  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/.mmh/profile~^The user profile
  96 ^or $MMHP~^Rather than the standard profile
  97 ^$HOME/.mmh/context~^The user context
  98 ^or $MMHC~^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