<refentry id="synopsis.element">
<?dbhtml filename="synopsis.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>

<refmeta>
<indexterm><primary>elements</primary>
<secondary>synopsis</secondary></indexterm>
<refentrytitle>synopsis</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>synopsis</refname>
<refpurpose>&synopsis.purpose;</refpurpose>
</refnamediv>

&synopsis.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>

<para>
A <sgmltag>Synopsis</sgmltag> is a verbatim environment for displaying command,
function, and other syntax summaries.
</para>

<para>
Unlike <sgmltag>CmdSynopsis</sgmltag> and <sgmltag>FuncSynopsis</sgmltag> which have a
complex interior structure,
<sgmltag>Synopsis</sgmltag> is simply a verbatim environment.
</para>

<refsect2><title>Processing expectations</title>
<para>
&pexp.linespecific; <sgmltag>Synopsis</sgmltag> elements are usually
displayed in a fixed width font.
</para>
</refsect2> 

<refsect2 role='fu' revision="4.0"><title>&FutureChanges;</title>
<para>
<!--do not index this occurance-->
&fu.interfacedefinition;
</para>
</refsect2>


&synopsis.parents.gen;
&synopsis.children.gen;
</refsect1>
<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>format</term>
<listitem>
<para>
The <sgmltag class="attribute">Format</sgmltag> attribute applies the 
<literal>linespecific</literal> notation to all synopses.
All white space and line breaks must be preserved.
</para>
</listitem>
</varlistentry>
<varlistentry><term>label</term>
<listitem>
<para>
<sgmltag class='attribute'>Label</sgmltag> specifies an identifying number or string
that may be used in presentation.
</para>
</listitem>
</varlistentry>
<varlistentry><term>linenumbering</term>
<listitem>
<para revision="4.0">Line numbering indicates whether or not the lines
of a <sgmltag>Synopsis</sgmltag> are to be automatically numbered. The details
of numbering (every line or only selected lines, on the left or right, etc.)
are left up to the processing application. Be aware that not all processors
are capable of numbering lines.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
&synopsis.seealso.gen;
</refsect1>
<refsect1><title>Examples</title>

<informalexample role="example-source">
<programlisting>&synopsis.example.1.txt;</programlisting>
</informalexample>

<anchor id="ex.os.synopsis.1" role="HACK-ex.out.start"/>
&synopsis.example.1.gen;
<anchor id="ex.oe.synopsis.1" role="HACK-ex.out.end"/>

<informalexample role="example-source">
<programlisting>&synopsis.example.2.txt;</programlisting>
</informalexample>

<anchor id="ex.os.synopsis.2" role="HACK-ex.out.start"/>
&synopsis.example.2.gen;
<anchor id="ex.oe.synopsis.2" role="HACK-ex.out.end"/>

&synopsis.example.seealso.gen;
</refsect1>
</refentry>

