arg

arg — An argument in a cmdsynopsis.

Synopsis

arg ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • choice (enumeration) [default=“opt”]
    • “opt”
    • “plain”
    • “req”
  • rep (enumeration) [default=“norepeat”]
    • “norepeat”
    • “repeat”

Description

Used in cmdsynopsis for command arguments. See cmdsynopsis for more information and examples.

Processing expectations

May be formatted inline or as a displayed block, depending on context.

Attributes

Common attributes and common linking attributes.

choice

Indicates optionality.

Enumerated values:
“opt”

Formatted to indicate that it is optional.

“plain”

Formatted without indication.

“req”

Formatted to indicate that it is required.

rep

Indicates whether or not repetition is possible.

Enumerated values:
“norepeat”

Can not be repeated.

“repeat”

Can be repeated.

Parents

These elements contain arg: arg, cmdsynopsis, group (db.group), synopfragment.

Children

The following elements occur in arg: text, abbrev, acronym, alt, anchor, annotation, arg, biblioref, coref, date, emphasis (db._emphasis), firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), glossterm (db._glossterm), group (db.group), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, option, phrase (db._phrase), quote (db._quote), remark, replaceable, sbr, subscript, superscript, synopfragmentref, trademark, wordasword, xref.

Last revised by Norman Walsh on (git hash: 32232d73aaed8bf7134470f3f72f9e1dc6874d38 68abf83671c42c0ef5e0aed2f171edf1c3b1bdcd)