command/topXO.xml


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

<chapter id="CommandTop">
  <title>The Csound Command</title>

  <para>
    <emphasis>Csound</emphasis> is a command to generate a sound output from an <link linkend="OrchTop"><citetitle>orchestra</citetitle></link> and <link linkend="ScoreTop"><citetitle>score</citetitle></link> files (or a unified <link linkend="CommandUnifile"><citetitle>csd file</citetitle></link>). It is designed to be called from a terminal or DOS window, but can be called from an easier to use front-end. The score file can be in one of many different formats, according to user preference. Translation, sorting, and formatting into orchestra-readable numeric text is handled by various preprocessors; all or part of the score is then sent on to the orchestra. Orchestra performance is influenced by <link linkend="CommandFlagsCategory"><citetitle>command flags</citetitle></link>, which set the level of displays and console reports, specify I/0 filenames and sample formats, and declare the nature of real-time sensing and control.
  </para>

  <section id="CommandOrder">
    <title>Order of Precedence</title>

    <para>
      There are five places where options for Csound performance may be set. They are processed in the following order:

      <orderedlist>
        <listitem><para>Csound's own defaults</para></listitem>
        <listitem><para>File defined by CSOUNDRC <link linkend="CommandEnvironment"><citetitle>environment variable</citetitle></link>, or .csoundrc file in the HOME directory</para></listitem>
        <listitem><para><link linkend="CommandUnifileParFile"><citetitle>.csoundrc</citetitle></link> file in the current directory</para></listitem>
        <listitem><para>&lt;CsOptions&gt; tag in a <link linkend="CommandUnifile"><citetitle>.csd file</citetitle></link></para></listitem>
        <listitem><para>Csound <link linkend="CommandDesc"><citetitle>command</citetitle></link> line</para></listitem>
      </orderedlist>
    </para>

    <para>
      The lower options in the list will override any earlier ones.
      As of version 5.01, sample and control rate override flags
      (<link linkend="FlagsMinusLowerR"><citetitle>-r</citetitle></link> and
      <link linkend="FlagsMinusLowerK"><citetitle>-k</citetitle></link>)
      specified anywhere override sr, kr, and ksmps in the orchestra header.
    </para>
  </section>

  &commanddesc;
  &commandflags;
  &commandflagscategory;
  &commandenvironment;
  &commandunifile;
<!--   &commandpreproc; -->

</chapter>