mhlsbr.c: Delete file-static function pointer mhl_action.

[nmh] / man / mhparam.man

diff --git a/man/mhparam.man b/man/mhparam.man
index a4af2b582af9a1f67a7474c702b34775745d6dfb..5c89ec57b7ab92caac02cd468d48ef2531396d54 100644 (file)
--- a/man/mhparam.man
+++ b/man/mhparam.man
@@ -1,52 +1,97 @@
-.\"
+.TH MHPARAM %manext1% 2017-02-18 "%nmhversion%"
+.

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

-.\" $Id$
-.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH MHPARAM %manext1% MH.6.8 [%nmhversion%]
+.

 .SH NAME
 .SH NAME

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

 .SH SYNOPSIS
 .SH SYNOPSIS

-.in +.5i
-.ti -.5i
-mhparam
-\%[components]
-\%[-all]
-\%[-component] \%[-nocomponent]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B mhparam
+.RB [ \-help ]
+.RB [ \-version ]
+.RI [ components ]
+.RB [ \-all ]
+.RB [ \-component " | " \-nocomponent ]
+.RB [ \-debug ]
+.ad

 .SH DESCRIPTION
 .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
-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
-displayed and other arguments are ignored.
-
+.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
+.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
+.B mhparam
+can provide other information, such as the
+.B nmh
+version identifier, the locations of the nmh
+.IR bindir ,
+.IR libexecdir ,
+.IR etcdir ,
+and
+.I docdir
+install directories, all
+.I proc
+settings, and the
+.I datalocking
+method described in
+.IR mh\-profile (5).
+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,
+.IR iconv (3),
+and oauth, the following commands, respectively, will output a non-null
+string to indicate support:
+.PP
+.RS 5
+.nf
+mhparam\0sasl
+mhparam\0tls
+mhparam\0iconv
+mhparam\0oauth
+.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:
 Examples:

-
+.PP
+.RS 5

 .nf
 .ta \w'AliasFile:'u+2n
 .nf
 .ta \w'AliasFile:'u+2n

-.in +.5i

 % mhparam path
 Mail
 
 % mhparam mhlproc
 % mhparam path
 Mail
 
 % mhparam mhlproc

-%libdir%/mhl
+%nmhlibexecdir%/mhl

 
 

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

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


@@ -56,26 +101,74 @@ rmmproc: rmmproc
 % mhparam \-nocomponent AliasFile rmmproc
 aliases
 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 version
+%nmhversion%
+
+% mhparam etcdir
+%nmhetcdir%
+
+% mhparam libexecdir
+%nmhlibexecdir%
+
+% mhparam spoollocking
+%default_locking%

 
 

+% mhparam datalocking
+fcntl
+
+% mhparam sasl
+cyrus_sasl
+
+% mhparam tls
+tls
+
+% mhparam iconv
+iconv
+
+% mhparam oauth
+oauth
+.fi
+.RE
+.PP
+.B mhparam
+is also useful in backquoted operations:
+.PP
+.RS 5

 .nf
 .nf

-.in +.5i

 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`
 % fgrep cornell.edu `mhpath +`/`mhparam aliasfile`

-
-.in -.5i

 .fi
 .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 "EXIT STATUS"
+The exit status is zero if all components are found,
+or one if any are missing.
+.
+.SH FILES
+.fc ^ ~
+.nf
+.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
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u
+^context:~^To determine the context file
+.fi
+.SH "SEE ALSO"
+.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 CONTEXT

 None
 None

-.En