[Prev] [Next]

Arg

Name

Synopsis

  (#PCDATA | Arg | Group | Option | SynopFragmentRef
  | Replaceable
  | SBR)+

Attributes

This element has common and Role attributes.

Name	Value(s)	Type	Default Value
Choice	(Opt |Req |Plain)		Opt
Rep	(Norepeat |Repeat)		Norepeat

Tag Minimization

Both the start- and end-tags are required for this element.

Description

Argument in a CmdSynopsis. Arg may contain any number of Args, Groups, Options, SynopFragmentRefs, Replaceables, in any order, mixed with plain text. Arg has common, Choice, and Rep attributes.

Parents

These elements contain Arg: Arg, CmdSynopsis, Group, and SynopFragment.

Children

Arg contains these elements: Arg, Group, Option, #PCDATA, Replaceable, SBR, and SynopFragmentRef.

Attributes

Choice

Choice indicates whether the Arg must be supplied, and how it is to be rendered. Opt means it is optional (e.g., [arg]) and is the default; Req means that it is required, and is to be shown as such (e.g., {arg}); Plain means that it is required but is to be shown without decoration (e.g., arg).

Rep

Rep indicates whether the Arg or Group is repeatable. Repeat is commonly rendered by an ellipsis; the default, Norepeat, needs no redition.

Examples

<CMDSYNOPSIS>
<COMMAND>adepted.exe</COMMAND>
<ARG>-c '<REPLACEABLE>commandlist</REPLACEABLE>'</ARG>
<ARG>-C '<REPLACEABLE>commandlist</REPLACEABLE>'</ARG>
<ARG>-cc</ARG>
<ARG>-fosi <REPLACEABLE>name</REPLACEABLE></ARG>
<ARG>-h</ARG><ARG>-n'<REPLACEABLE>type</REPLACEABLE>'</ARG>
<ARG>-nocmd</ARG>
<ARG>-nocc</ARG>
<ARG>-q</ARG>
<ARG>-r</ARG>
<ARG>-sample</ARG>
<ARG>-subtype '<REPLACEABLE>typename</REPLACEABLE>'</ARG>
<ARG>-u</ARG>
<arg choice="plain"><REPLACEABLE>docname</REPLACEABLE></ARG>
</CMDSYNOPSIS>

<cmdsynopsis>
  <!-- This is a synopsis for the command foo.
       The options -a and -x are optional and exclusive
       The option -c takes a cheese and is optional and repeatable
       The options -t and -k are referred to in another fragment
       The options -i, -j, and -k are required and exclusive
       The option -f takes a filename and is required
       The -t and -k options specify the kind of milk and mold in an
           optional and repeatable group
  -->
  <command>foo</command>
  <group>
    <arg>-a</arg>
    <arg>-x</arg>
  </group>
  <group>
  <arg rep=repeat>-c <replaceable>cheese</replaceable></arg>
  <synopfragmentref linkend=cheesetype>cheesetype</synopfragmentref>
  </group>
  <group choice=req>
    <arg>-i</arg>
    <arg>-j</arg>
    <arg>-k</arg>
  </group>
  <arg choice=req>-f <replaceable>filename</replaceable></arg>
  <synopfragment id=cheesetype>
    <group rep=repeat>
       <arg>-t <replaceable>milk</replaceable></arg>
       <arg>-k <replaceable>mold</replaceable></arg>
    </group>
  </synopfragment>
</cmdsynopsis>

[Prev] AreaSpec
[Next] article.class
[Reference Home] [Davenport Group Home]