summaryrefslogtreecommitdiff
path: root/scoregens/e.xml
blob: c428af687c97c5cbc16a8cbf5d34fb45df53b7b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<refentry id="e">
      <indexterm id="IndexEStatement"><primary>e statement</primary></indexterm>
  <refmeta>
    <refentrytitle>e Statement</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>e statement</refname>
    <refpurpose>
      This statement may be used to mark the end of the last section of the score.
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      This statement may be used to mark the end of the last section of the score.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>e</command> [time]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      The first p-field <emphasis>time</emphasis> is optional and if present determines the end time (length in beats) of the final section of the score.  This time must be after the end of the last event otherwise it will have no effect. "Always on" instruments will end at the given time. Extending the section in this way is useful to avoid prematurely cutting off reverb tails or other effects.
    </para>

    <refsect2>
      <title>Special Considerations</title>
      <para>
        The <emphasis>e statement</emphasis> is contextually identical to an <link linkend="s"><citetitle>s statement</citetitle></link>. Additionally, the <emphasis>e statement</emphasis> terminates all signal generation (including indefinite performance) and closes all input and output files.
      </para>

      <para>
        If an <emphasis>e statement</emphasis> occurs before the end of a score, all subsequent score lines will be ignored.
      </para>

      <para>
        The <emphasis>e statement</emphasis> is optional in a score file yet to be sorted. If a score file has no <emphasis>e statement</emphasis>, then Sort processing will supply one.
      </para>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the e statement. It uses the file <ulink url="examples/e.csd"><citetitle>e.csd</citetitle></ulink>.
      <example>
        <title>Example of the e statement.</title>
        <xi:include href="examples-xml/e.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
 
</refentry>