X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/fc18ad68f85f29c016667b7bf54d7e4b2f3b42c5..64a40afc7d83e7b1280905fce7bdfd3a2ec7f01a:/man/mhparam.man?ds=inline diff --git a/man/mhparam.man b/man/mhparam.man index 467f5b59..5c89ec57 100644 --- a/man/mhparam.man +++ b/man/mhparam.man @@ -1,76 +1,76 @@ -.TH MHPARAM %manext1% "March 16, 2014" "%nmhversion%" -.\" +.TH MHPARAM %manext1% 2017-02-18 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .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. Component name matching is +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. +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 +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 +list, then the switch .B \-component -is on by default. If only one component is -specified, then the switch +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. +is specified, then all components in the nmh profile are displayed +and other arguments are ignored. .PP -.BR mhparam +.B mhparam can provide other information, such as the .B nmh version identifier, the locations of the nmh -.I etcdir +.IR bindir , +.IR libexecdir , +.IR etcdir , and -.I libdir +.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 +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, and +support for SASL, TLS, .IR iconv (3), -the following commands, respectively, will output a non-null string to -indicate support: +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 @@ -89,7 +89,7 @@ Examples: Mail % mhparam mhlproc -%libdir%/mhl +%nmhlibexecdir%/mhl % mhparam \-component Path Path: Mail @@ -110,10 +110,10 @@ context: context %nmhversion% % mhparam etcdir -%etcdir% +%nmhetcdir% -% mhparam libdir -%libdir% +% mhparam libexecdir +%nmhlibexecdir% % mhparam spoollocking %default_locking% @@ -129,6 +129,9 @@ tls % mhparam iconv iconv + +% mhparam oauth +oauth .fi .RE .PP @@ -140,8 +143,9 @@ is also useful in backquoted operations: % fgrep cornell.edu `mhpath +`/`mhparam aliasfile` .fi .SH "EXIT STATUS" -.B mhparam -returns the number of components that were not found. +The exit status is zero if all components are found, +or one if any are missing. +. .SH FILES .fc ^ ~ .nf