X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/1d08c1e0c0de0d321883ece1c36bce851fe893c7..6db45651:/man/mhparam.man?ds=sidebyside diff --git a/man/mhparam.man b/man/mhparam.man index 27e1b9b1..e4b6cb0b 100644 --- a/man/mhparam.man +++ b/man/mhparam.man @@ -1,48 +1,45 @@ -.TH MHPARAM %manext1% "May 21, 2016" "%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 .B mhparam can provide other information, such as the @@ -153,7 +150,11 @@ is also useful in backquoted operations: .fi .SH "EXIT STATUS" .B mhparam -returns the number of components that were not found. +returns the number of components that were not found, +but limits the return value to 120 to avoid ambiguity, +e.g.\& 127 is used by shells to indicate `command not found', +and 256 would wrap to 0, falsely indicating success. +. .SH FILES .fc ^ ~ .nf