a4af2b582af9a1f67a7474c702b34775745d6dfb
[mmh] / man / mhparam.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .\" include the -mh macro file
6 .so %etcdir%/tmac.h
7 .\"
8 .TH MHPARAM %manext1% MH.6.8 [%nmhversion%]
9 .SH NAME
10 mhparam \- print nmh profile components
11 .SH SYNOPSIS
12 .in +.5i
13 .ti -.5i
14 mhparam
15 \%[components]
16 \%[-all]
17 \%[-component] \%[-nocomponent]
18 .br
19 \%[\-version]
20 \%[\-help]
21 .in -.5i
22 .SH DESCRIPTION
23 \fIMhparam\fR writes the value of the specified profile component to the
24 standard output separated by newlines.  If the profile component is not
25 present, the default value (or nothing if there is no default) is printed.
26
27 If the switch `\-component' is given, then the component name is displayed
28 along with the profile components value.  This can be disabled with the
29 switch `\-nocomponent'.
30
31 If more than one component is specified in the `components' list, then
32 the switch `\-component' is on by default.  If only one component is
33 specified, then the switch `\-nocomponent' is on by default.
34
35 If `\-all' is specified, then all components in the nmh profile are
36 displayed and other arguments are ignored.
37
38 Examples:
39
40 .nf
41 .ta \w'AliasFile:'u+2n
42 .in +.5i
43 % mhparam path
44 Mail
45
46 % mhparam mhlproc
47 %libdir%/mhl
48
49 % mhparam \-component path
50 Path: Mail
51
52 % mhparam AliasFile rmmproc
53 AliasFile: aliases
54 rmmproc: rmmproc
55
56 % mhparam \-nocomponent AliasFile rmmproc
57 aliases
58 rmmproc
59 .in -.5i
60 .fi
61
62 \fIMhparam\fR is also useful in back\-quoted operations:
63
64 .nf
65 .in +.5i
66 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
67
68 .in -.5i
69 .fi
70 .Fi
71 ^$HOME/\&.mh\(ruprofile~^The user profile
72 .Sa
73 mh-profile\|(5)
74 .De
75 `\-nocomponent' if only one component is specified
76 `\-component' if more than one component is specified
77 .Ds
78 `components' defaults to none
79 .Co
80 None
81 .En