X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fmhparam.man;h=b1903518494e72c96995ca76a9e191f0bf95ef46;hp=dcba16ecc09d470effa2074604cace4ef1a5fc32;hb=fb49dd82ec42997b9df97f221c920f6596102c0a;hpb=b36e2ab7892cdf30a8b33d02e00af70398013b5d diff --git a/man/mhparam.man b/man/mhparam.man index dcba16e..b190351 100644 --- a/man/mhparam.man +++ b/man/mhparam.man @@ -2,44 +2,51 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mhparam \- print nmh profile components .SH SYNOPSIS -.in +.5i -.ti -.5i -mhparam -\%[components] -\%[-all] -\%[-component] \%[-nocomponent] -.br -\%[\-version] -\%[\-help] -.in -.5i +.na +.B mhparam +.RI [ components ] +.RB [ \-all ] +.RB [ \-component " | " \-nocomponent ] +.RB [ \-version ] +.RB [ \-help ] +.ad .SH DESCRIPTION -\fIMhparam\fR writes the value of the specified profile component to the +.B Mhparam +writes the value of the specified profile component to the standard output separated by newlines. If the profile component is not present, the default value (or nothing if there is no default) is printed. - -If the switch `\-component' is given, then the component name is displayed +.PP +If the switch +.B \-component +is given, then the component name is displayed along with the profile components value. This can be disabled with the -switch `\-nocomponent'. - -If more than one component is specified in the `components' list, then -the switch `\-component' is on by default. If only one component is -specified, then the switch `\-nocomponent' is on by default. - -If `\-all' is specified, then all components in the nmh profile are +switch +.BR \-nocomponent . +.PP +If more than one component is specified in the +.I components +list, then +the switch +.B \-component +is on by default. If only one component is +specified, then the switch +.B \-nocomponent +is on by default. +.PP +If +.B \-all +is specified, then all components in the nmh profile are displayed and other arguments are ignored. - +.PP Examples: - +.PP +.RS 5 .nf .ta \w'AliasFile:'u+2n -.in +.5i % mhparam path Mail @@ -56,26 +63,35 @@ rmmproc: rmmproc % mhparam \-nocomponent AliasFile rmmproc aliases rmmproc -.in -.5i .fi - -\fIMhparam\fR is also useful in back\-quoted operations: - +.RE +.PP +.B Mhparam +is also useful in back\-quoted operations: +.PP +.RS 5 .nf -.in +.5i % fgrep cornell.edu `mhpath +`/`mhparam aliasfile` - -.in -.5i .fi -.Fi +.RE +.PP + +.SH FILES +.fc ^ ~ +.nf +.ta \w'%etcdir%/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile -.Sa -mh-profile\|(5) -.De -`\-nocomponent' if only one component is specified -`\-component' if more than one component is specified -.Ds -`components' defaults to none -.Co +.fi + +.SH "SEE ALSO" +mh-profile(5) + +.SH DEFAULTS +.nf +.RB ` \-nocomponent "' if only one component is specified" +.RB ` \-component "' if more than one component is specified" +.RB ` components "' defaults to none" +.fi + +.SH CONTEXT None -.En