diff options
Diffstat (limited to 'opcodes/getcfg.xml')
| -rw-r--r-- | opcodes/getcfg.xml | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/opcodes/getcfg.xml b/opcodes/getcfg.xml index 2e895c6..d68152d 100644 --- a/opcodes/getcfg.xml +++ b/opcodes/getcfg.xml @@ -66,6 +66,35 @@ </para> </refsect1> +<refsect1> + <title>Examples</title> + <para> + Here is an example of the getcfg opcode. It uses the file <ulink url="examples/getcfg.csd"><citetitle>getcfg.csd</citetitle></ulink>. + + <example> + <title>Example of the getcfg opcode.</title> + + + + <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para> + <xi:include href="examples-xml/getcfg.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + </example> + + The output should include lines like these: + <screen> +------------------------------ +Max string len : 255 +Input file name (-i) : adc +Output file name (-o) : dac +RTaudio (-odac) : 1 +Beat mode (-t)? : 0 +Host Op. Sys. : Linux +Callback ? : 0 +------------------------------ + </screen> + </para> + </refsect1> + <refsect1> <title>Credits</title> <para> |