diff options
Diffstat (limited to 'command/flags.xml')
| -rw-r--r-- | command/flags.xml | 109 |
1 files changed, 86 insertions, 23 deletions
diff --git a/command/flags.xml b/command/flags.xml index cf531bd..5936b44 100644 --- a/command/flags.xml +++ b/command/flags.xml @@ -29,7 +29,7 @@ <refsect1> <title>Csound command line flags</title> <para> - Listed below are the command line flags available in Csound5 in alphabetical order. Various platform + Listed below are the command line flags available in Csound6 in alphabetical order. Various platform implementations may not react the same way to different flags! You can view the command line flags organized by category in <link linkend="CommandFlagsCategory"><citetitle>Command-line Flags (by Category)</citetitle></link>. </para> <para> @@ -68,8 +68,9 @@ <para> Set the audio file output format to one of the formats available in libsndfile. At present the list is - aiff, au, avr, caf, flac, htk, ircam, mat4, mat5, nis, paf, pvf, - raw, sd2, sds, svx, voc, w64, wav, wavex and xi. + aiff, au, avr, caf, flac, htk, ircam, mat4, mat5, MPC, + nist, ogg, paf, pvf, raw, sd2, sds, svx, voc, w64, W64, + wav, wavex, WVE, xi. Can also be used as --format=type:format or --format=format:type to set both the file type (wav, aiff, etc.) and sample format (short, long, float, etc.) at the same time. @@ -160,6 +161,16 @@ </listitem> </varlistentry> + <varlistentry id="FlagsDaemon"> + <term>-d<indexterm id="IndexDaemon"><primary>--daemon</primary></indexterm></term> + <listitem> + <para> + Run in daemon mode: do not exit if CSD/orchestra is not given, is empty or does not compile. + </para> + </listitem> + </varlistentry> + + <varlistentry id="FlagsMinusDisplays"> <term>--displays<indexterm id="IndexMinusDisplays"><primary>--displays</primary></indexterm></term> <listitem> @@ -823,38 +834,78 @@ </listitem> </varlistentry> - <varlistentry id="FlagsMinusOpcodeLib"> - <term>--opcode-lib=LIBNAME<indexterm id="IndexMinusOpcodeLib"><primary>--opcode-lib</primary></indexterm></term> - <listitem> - <para> - Load plugin library <emphasis>LIBNAME</emphasis>. - </para> - </listitem> - </varlistentry> - - <varlistentry id="FlagsMinusOmacro"> - <term>--omacro:XXX=YYY<indexterm id="IndexMinusOmacro"><primary>--omacro</primary></indexterm></term> + <varlistentry id="FlagsMinusMinusOgg"> + <term>--ogg<indexterm id="IndexMinusMinusOgg"><primary>--ogg</primary></indexterm></term> <listitem> <para> - Set orchestra macro XXX to value YYY + Set output file format to ogg. (csound 5.18 and later) </para> </listitem> </varlistentry> - <varlistentry id="FlagsMinusPlusOutputStream"> - <term>-+output_stream=string<indexterm id="IndexMinusPlusOutputStream"><primary>-+output_stream</primary></indexterm></term> + <varlistentry id="FlagsMinusOmacro"> + <term>--omacro:XXX=YYY<indexterm id="IndexMinusOmacro"><primary>--omacro</primary></indexterm></term> <listitem> <para> - Pulseaudio output stream name. + Set orchestra macro XXX to value YYY </para> </listitem> </varlistentry> - <varlistentry id="FlagsMinusUpperQ"> - <term>-Q DEVICE<indexterm id="IndexMinusUpperQ"><primary>-Q</primary></indexterm></term> - <listitem> - <para> - Enables MIDI OUT operations to device id <emphasis>DEVICE</emphasis>. This flag allows parallel MIDI OUT and DAC performance. Unfortunately the real-time timing implemented in Csound is completely managed by DAC buffer sample flow. So MIDI OUT operations can present some time irregularities. These irregularities can be reduced by using a lower value for the <link linkend="FlagsMinusLowerB"><citetitle>-b</citetitle></link> flag. + <varlistentry id="FlagsMinusOpcodeLib"> + <term>--opcode-lib=LIBNAME<indexterm id="IndexMinusOpcodeLib"><primary>--opcode-lib</primary></indexterm></term> + <listitem> + <para> + Load plugin library <emphasis>LIBNAME</emphasis>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="FlagMinuMinusOrc"> + <term>--orc orcname<indexterm id="IndexMinusMinusOrc"><primary>--orc</primary></indexterm></term> + <listitem> + <para> + Set the argument as the orchestrra file. Used when not + score is required>. (Csound 5.18 and later). + </para> + </listitem> + </varlistentry> + + <varlistentry id="FlagsMinusPlusOutputStream"> + <term>-+output_stream=string<indexterm id="IndexMinusPlusOutputStream"><primary>-+output_stream</primary></indexterm></term> + <listitem> + <para> + Pulseaudio output stream name. + </para> + </listitem> + </varlistentry> + + <varlistentry id="FlagsMinusPort"> + <term>--port=N<indexterm + id="IndexMinusPprt"><primary>--port</primary></indexterm></term> + <listitem> + <para> + Set UDP port on which to listen instruments/orchestra code + (implies --daemon) + </para> + </listitem> + </varlistentry> + + + <varlistentry id="FlagsMinusUpperQ"> + <term>-Q DEVICE<indexterm + id="IndexMinusUpperQ"><primary>-Q</primary></indexterm></term> + <listitem> + <para> + Enables MIDI OUT operations to device id + <emphasis>DEVICE</emphasis>. This flag allows parallel + MIDI OUT and DAC performance. Unfortunately the real-time + timing implemented in Csound is completely managed by DAC + buffer sample flow. So MIDI OUT operations can present + some time irregularities. These irregularities can be + reduced by using a lower value for the <link + linkend="FlagsMinusLowerB"><citetitle>-b</citetitle></link> + flag. </para> <para> If using ALSA MIDI (-+rtmidi=alsa), devices are selected by name and not number. So, you need to use an option like -Q hw:CARD,DEVICE where CARD and DEVICE are the card and device numbers (e.g. -Q hw:1,0). In the case of PortMidi and MME, DEVICE should be a number, and if it is out of range, an error occurs and the valid device numbers are printed. @@ -925,6 +976,18 @@ </listitem> </varlistentry> + <varlistentry id="FlagsSampleAccurate"> + <term>--sample-accurate<indexterm id="IndexSampleAccurate"><primary>--sample-accurate</primary></indexterm></term> + <listitem> + <para> + Start and stop instances of instruments at the nearest + sample to the requested time. This is in contrast to + traditional Csound which rounds the times to the nearest + k-cycle. Note that this does not work with tied notes. + </para> + </listitem> + </varlistentry> + <varlistentry id="FlagsMinusSched"> <term>--sched<indexterm id="IndexMinusSched"><primary>--sched</primary></indexterm></term> <listitem> |