Added note that suffixes were removed from filenames of temporary files.

[nmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index eb8caeca73010d423b56c5e859fb685228007176..6f51ffd9e8cd55fef46eebf8edaaa0c734d93e6b 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,10 +1,11 @@
+.TH MHPARAM %manext1% "November 6, 2012" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %nmhwarning%
 .\"

-.TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 .SH NAME

-mhparam \- print nmh profile components
+mhparam \- print nmh profile and context components

 .SH SYNOPSIS
 .SH SYNOPSIS

+.HP 5

 .na
 .B mhparam
 .RI [ components ]
 .na
 .B mhparam
 .RI [ components ]


@@ -12,12 +13,14 @@ mhparam \- print nmh profile components
 .RB [ \-component " | " \-nocomponent ]
 .RB [ \-version ]
 .RB [ \-help ]
 .RB [ \-component " | " \-nocomponent ]
 .RB [ \-version ]
 .RB [ \-help ]

+.RB [ \-debug ]

 .ad
 .SH DESCRIPTION
 .ad
 .SH DESCRIPTION

-.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.
+.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
 .PP
 If the switch
 .B \-component


@@ -41,6 +44,21 @@ If
 is specified, then all components in the nmh profile are
 displayed and other arguments are ignored.
 .PP
 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, all
+.I proc
+settings, and the locking method with which the
+.B nmh
+installation was configured.  The
+.B \-debug
+switch displays all such other information available from
+.BR mhparam .
+.PP

 Examples:
 .PP
 .RS 5
 Examples:
 .PP
 .RS 5


@@ -52,7 +70,7 @@ Mail
 % mhparam mhlproc
 %libdir%/mhl
 
 % mhparam mhlproc
 %libdir%/mhl
 

-% mhparam \-component path
+% mhparam \-component Path

 Path: Mail
 
 % mhparam AliasFile rmmproc
 Path: Mail
 
 % mhparam AliasFile rmmproc


@@ -62,35 +80,55 @@ rmmproc: rmmproc
 % mhparam \-nocomponent AliasFile rmmproc
 aliases
 rmmproc
 % mhparam \-nocomponent AliasFile rmmproc
 aliases
 rmmproc

+
+% mhparam path nonexistent context
+Path: Mail
+context: context
+
+% mhparam etcdir
+%etcdir%
+
+% mhparam libdir
+%libdir%
+
+% mhparam lockmethod
+fcntl

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-.B Mhparam
-is also useful in back\-quoted operations:
+.B mhparam
+is also useful in backquoted operations:

 .PP
 .RS 5
 .nf
 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 .fi
 .PP
 .RS 5
 .nf
 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 .fi

-.RE
-.PP
-
+.SH "EXIT STATUS"
+.B mhparam
+returns the number of components that were not found.

 .SH FILES
 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u
 .SH FILES
 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u

-^$HOME/\&.mh\(ruprofile~^The user profile
+^$HOME/.mh_profile~^The user profile
+^or $MH~^Rather than the standard profile
+^<mh-dir>/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

-

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-mh-profile(5)
-
+.IR 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 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
 .SH CONTEXT
 None