X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fmhparam.man;h=4326d13d1cf6cb08a99078574365b94d484f42d1;hb=c897634e1c28697a6df572de00e66579567ad2a6;hp=a4af2b582af9a1f67a7474c702b34775745d6dfb;hpb=1691e80890e5d8ba258c51c214a3e91880e1db2b;p=mmh diff --git a/man/mhparam.man b/man/mhparam.man index a4af2b5..4326d13 100644 --- a/man/mhparam.man +++ b/man/mhparam.man @@ -1,52 +1,74 @@ .\" .\" %nmhwarning% -.\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" -.TH MHPARAM %manext1% MH.6.8 [%nmhversion%] +.TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME -mhparam \- print nmh profile components +mhparam \- print nmh profile and context components .SH SYNOPSIS -.in +.5i -.ti -.5i -mhparam -\%[components] -\%[-all] -\%[-component] \%[-nocomponent] -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.na +.B mhparam +.RI [ components ] +.RB [ \-all ] +.RB [ \-component " | " \-nocomponent ] +.RB [ \-version ] +.RB [ \-help ] +.RB [ \-debug ] +.ad .SH DESCRIPTION -\fIMhparam\fR 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 +.B mhparam +writes the value of the specified profile component to the standard +output separated by newlines. Component name matching is +case-insensitive. If the profile component is not present, the +default value (or nothing if there is no default) is printed. +.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 +.BR mhparam +can provide other information, such as +the locations of the nmh +.I etcdir +and +.I libdir +install directories and all +.I proc +settings. The +.B \-debug +switch displays all such other information available from +.BR mhparam . +.PP Examples: - +.PP +.RS 5 .nf .ta \w'AliasFile:'u+2n -.in +.5i % mhparam path Mail % mhparam mhlproc %libdir%/mhl -% mhparam \-component path +% mhparam \-component Path Path: Mail % mhparam AliasFile rmmproc @@ -56,26 +78,58 @@ rmmproc: rmmproc % mhparam \-nocomponent AliasFile rmmproc aliases rmmproc -.in -.5i -.fi -\fIMhparam\fR is also useful in back\-quoted operations: +% mhparam path nonexistent context +Path: Mail +context: context + +% mhparam etcdir +%etcdir% +% mhparam libdir +%libdir% +.fi +.RE +.PP +.B mhparam +is also useful in back\-quoted operations: +.PP +.RS 5 .nf -.in +.5i % fgrep cornell.edu `mhpath +`/`mhparam aliasfile` +.fi -.in -.5i +.SH "EXIT STATUS" +.B mhparam +returns the number of components that were not found. + +.SH FILES +.fc ^ ~ +.nf +.ta \w'%etcdir%/ExtraBigFileName 'u +^$HOME/.mh_profile~^The user profile +^or $MH~^Rather than the standard profile +^/context~^The user context +^or $MHCONTEXT~^Rather than the standard context +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u +^context:~^To determine the context file .fi -.Fi -^$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 + +.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