<parmname>
A parameter name is the name of a parameter that is passed to an API or a command-line interface (CLI).
Specialization hierarchy
The <parmname>
element is specialized from <keyword>. It is
defined in the programming domain module.
Content model
(Text |
<text>
)*
- Text
-
<text>
Attributes
The following attributes are
available on this element: universal
attributes and @keyref.
The following attributes are available on this element: universal attributes and the attributes defined below.
@keyref- Specifies a key
name that acts as a redirectable reference based on a key
definition within a map. See STUB CONTENT for information on using
this attribute.
For HDITA, the equivalent of
@keyrefis@data-keyref
Example
This section is non-normative.
The following code sample shows how the
<parmname> element can be used to identify
a parameter that is used with the config
command:
<p>You can use the <parmname>-env</parmname> parameter of the <cmdname>config</cmdname>
command to update the field value.</p>