Name
parameter — A value or a symbolic reference to a value
Synopsis
parameter ::=
(text | phrase
db._phrase | replaceable
| Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*
Attribute synopsis
Common attributes and common linking attributes.
Additional attributes:
class
(enumeration) = “command” | “function” | “option”
Description
A parameter
identifies something passed from
one part of a computer system to another. In this regard
parameter
is fairly generic, but it may have a more
constrained semantic in some contexts (e.g., in a
paramdef
).
In a document that describes more than one kind of parameter—for
example, parameters to functions and commands—the class
attribute can be used to distinguish
between them, if necessary.
Processing expectations
Formatted inline.
Attributes
Common attributes and common linking attributes.
- class
Identifies the class of parameter
Enumerated values: “command” A command
“function” A function
“option” An option
See Also
computeroutput
, constant
, funcdef
, funcparams
, funcprototype
, funcsynopsisinfo
, function
, literal
, markup
, option
, optional
, paramdef
, prompt
, replaceable
, returnvalue
, tag
, userinput
, varargs
, varname
, void
Examples
<article xmlns='http://docbook.org/ns/docbook'> <title>Example parameter</title> <para>Using the <parameter class='command'>-l</parameter> parameter on the Linux <command>ls</command> command prints a long directory listing. </para> </article>
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.