Man page for apt-get csound Command
This tutorial shows the man page for man csound in linux.
Open terminal with 'su' access and type the command as shown below:
Result of the Command Execution shown below:
CSOUND COMMAND LINE(1) The Canonical Csound Reference CSOUND COMMAND LINE(1)
csound Csound command.
The csound command executes Csound.
csound [flags] [orchname] [scorename]
csound [flags] [csdfilename]
CSOUND COMMAND LINE FLAGS
Listed below are the command line flags available in Csound5 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 Command line Flags (by Category).
The command line arguments are of 2 types: flags arguments (beginning with a " "," " or " +"), and name arguments (such as filenames). Certain flag
arguments take a following name or numeric argument. Flags that start with " " and " +" usually take an argument themselves using "=".
Command line Flags
Provide an extended command line in file "FILE"
Use 24 bit audio samples.
Use 8 bit unsigned character audio samples.
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. 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.
Write an AIFF format soundfile. Use with the c, s, l, or f flags.
Use a law audio samples.
Number of audio sample frames held in the DAC hardware buffer. This is a threshold on which software audio I/O (above) will wait before returning. A
small number reduces audio I/O delay; but the value is often hardware limited, and small values will risk data lates. In the case of portaudio output
(the default real time output), the B parameter (more precisely, B / sr) is passed as the "suggested latency" value. Other than that, Csound has no
control over how PortAudio interprets the parameter. The default is 1024 on Linux, 4096 on Mac OS X and 16384 on Windows.
Number of audio sample frames per sound i/o software buffer. Large is efficient, but small will reduce audio I/O delay and improve the accuracy of the
timing of real time events. The default is 256 on Linux, 1024 on MacOS X, and 4096 on Windows. In real time performance, Csound waits on audio I/O on NUM
boundaries. It also processes audio (and polls for other input like MIDI) on orchestra ksmps boundaries. The two can be made synchronous. For
convenience, if NUM is negative, the effective value is ksmps * NUM (audio synchronous with k period boundaries). With NUM small (e.g. 1) polling is
then frequent and also locked to fixed DAC sample boundaries.
Note: if both iadc and odac are used at the same time (full duplex real time audio), the b option should be set to an integer multiple of ksmps.
Use Cscore processing of the scorefile.
Use 8 bit signed character audio samples.
csd line nums=NUM.
Determines how line numbers are counted and displayed for error messages when processing a Csound Unified Document file (.csd). This flag has no effect
if separate orchestra and score files are used. (Csound 5.08 and later).
o 0 = line numbers are relative to the beginning of the orchestra or score sections of the CSD
o 1 = line numbers are relative to the beginning of the CSD file. This is the default as of Csound 5.08.
Defer GEN01 soundfile loads until performance time.
Suppress all displays.
Enables displays, reverting the effect of any previous d flag.
Reenables adding of directory of CSD/ORC/SCO to search paths, if it has been disabled by a previous no default paths (e.g. in .csoundrc).
Set environment variable NAME to VALUE. Note: not all environment variables can be set this way, because some are read before parsing the command
line. INCDIR, SADIR, SFDIR, and SSDIR are known to work.
Append VALUE to ';' separated list of search paths in environment variable NAME (should be INCDIR, SADIR, SFDIR, or SSDIR). If a file is found in
multiple directories, the last will be used.
Since Csound 5. Turns on some optimizations in expressions:
o Redundant assignment operations are eliminated whenever possible. This means that for example this line a1 = a2 + a3 will compile as a1 Add a2,
a3 instead of