X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/d78c0f6ad595d04e13fd447cf2149fd886f2c99c..939dea68806ab22c29755091b16236b48876442f:/man/mhparam.man diff --git a/man/mhparam.man b/man/mhparam.man index 91a8d603..07da4ccd 100644 --- a/man/mhparam.man +++ b/man/mhparam.man @@ -1,24 +1,26 @@ +.TH MHPARAM %manext1% "May 21, 2016" "%nmhversion%" .\" .\" %nmhwarning% .\" -.TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mhparam \- print nmh profile and context components .SH SYNOPSIS .HP 5 .na .B mhparam +.RB [ \-help ] +.RB [ \-version ] .RI [ components ] .RB [ \-all ] .RB [ \-component " | " \-nocomponent ] -.RB [ \-version ] -.RB [ \-help ] +.RB [ \-debug ] .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. +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 @@ -42,6 +44,51 @@ If 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 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, +.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 +Note that the internal +.B libdir +component has been replaced by +.BR libexecdir . +The old form is deprecated and will be removed in a future release. +.PP Examples: .PP .RS 5 @@ -51,9 +98,9 @@ Examples: Mail % mhparam mhlproc -%libdir%/mhl +%nmhlibexecdir%/mhl -% mhparam \-component path +% mhparam \-component Path Path: Mail % mhparam AliasFile rmmproc @@ -67,31 +114,55 @@ rmmproc % 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 back\-quoted operations: +is also useful in backquoted operations: .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 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 ^/context~^The user context ^or $MHCONTEXT~^Rather than the standard context .fi - .SH "PROFILE COMPONENTS" .fc ^ ~ .nf @@ -99,16 +170,13 @@ returns the number of components that were not found. .ta \w'ExtraBigProfileName 'u ^context:~^To determine the context file .fi - .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 CONTEXT None