Now only display text and inline content by default.

[nmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index 82b343ce131c11507be507a69aaf49399864beee..467f5b590fd049700293e1e0fc9ccaf3d7fc4661 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,7 +1,7 @@
+.TH MHPARAM %manext1% "March 16, 2014" "%nmhversion%"

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

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

 .SH NAME
 mhparam \- print nmh profile and context components
 .SH SYNOPSIS
 .SH NAME
 mhparam \- print nmh profile and context components
 .SH SYNOPSIS


@@ -13,6 +13,7 @@ mhparam \- print nmh profile and context components
 .RB [ \-component " | " \-nocomponent ]
 .RB [ \-version ]
 .RB [ \-help ]
 .RB [ \-component " | " \-nocomponent ]
 .RB [ \-version ]
 .RB [ \-help ]

+.RB [ \-debug ]

 .ad
 .SH DESCRIPTION
 .B mhparam
 .ad
 .SH DESCRIPTION
 .B mhparam


@@ -43,12 +44,41 @@ 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

-The locations of two nmh install directories are also available
-through
-.BR mhparam :
+.BR mhparam
+can provide other information, such as the
+.B nmh
+version identifier, the locations of the nmh

 .I etcdir
 and
 .I etcdir
 and

-.IR libdir .
+.I libdir
+install directories, all
+.I proc
+settings, and the
+.I datalocking
+method described in the
+.IR mh_profile (5)
+man page.  Information about the configuration of the
+.B nmh
+installation is also available, including the default mail spool
+locking method.  To test whether the configuration includes
+support for SASL, TLS, and
+.IR iconv (3),
+the following commands, respectively, will output a non-null string to
+indicate support:
+.PP
+.RS 5
+.nf
+mhparam\0sasl
+mhparam\0tls
+mhparam\0iconv
+.fi
+.RE
+.PP
+Conversely, no output means that the specified support is not included.
+The
+.B \-debug
+switch displays all such other information available from
+.BR mhparam .

 .PP
 Examples:
 .PP
 .PP
 Examples:
 .PP


@@ -76,36 +106,51 @@ rmmproc
 Path: Mail
 context: context
 
 Path: Mail
 context: context
 

+% mhparam version
+%nmhversion%
+

 % mhparam etcdir
 %etcdir%
 
 % mhparam libdir
 %libdir%
 % mhparam etcdir
 %etcdir%
 
 % mhparam libdir
 %libdir%

+
+% mhparam spoollocking
+%default_locking%
+
+% mhparam datalocking
+fcntl
+
+% mhparam sasl
+cyrus_sasl
+
+% mhparam tls
+tls
+
+% mhparam iconv
+iconv

 .fi
 .RE
 .PP
 .B mhparam
 .fi
 .RE
 .PP
 .B mhparam

-is also useful in back\-quoted operations:
+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

-

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

-

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'%etcdir%/ExtraBigFileName  'u
+.ta \w'ExtraBigProfileName  'u

 ^$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
 ^$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
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf


@@ -113,16 +158,13 @@ returns the number of components that were not found.
 .ta \w'ExtraBigProfileName  'u
 ^context:~^To determine the context file
 .fi
 .ta \w'ExtraBigProfileName  'u
 ^context:~^To determine the context file
 .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