.\" generator: doxer.py 0.6
.\" generation: 2011\-04\-08T21:47:24
.TH "BSESCM" "1" "2011\-04\-08 02:30:18 +0200" "beast\-0.7.3" "BEAST Manual Pages"

.SH
NAME


.PP
bsescm \- A Guile based scheme shell for \fIBEAST\fP and \fIBSE\fP.
.SH
SYNOPSIS


.PP
\fBbsescm\fP [\fIOPTIONS\fP] [\fB\-\-\fP] \fB...\fP
.br
\fBbsescm\fP [\fIOPTIONS\fP] \fIinfile.bse\fP \fB...\fP
.SH
DESCRIPTION


.PP
\fBbsescm\fP is a Guile based scheme shell for \fIBSE\fP,
the Better Sound Engine.
.br

.br
\fBbsescm\fP provides a shell interface to all procedures exported by the
\fIBSE\fP library, so scripts are able to access the full range of functionality
provided by it, from simple playback of a \fI.bse\fP file to
full fledged automated creation or editing of synthesis networks.
.br

.br
Alternatively to the linked in \fIBSE\fP library, the \fBbsescm\fP language interface
can also talk to a remotely running \fIBSE\fP library host, for instance
beast(1).
By operating on a remotely running \fIBSE\fP core, \fBbsescm\fP can be used to script
arbitrary \fIBSE\fP programs. The shell is also used directly by the \fIBSE\fP library to
execute procedures on its behalf, this allows \fIBSE\fP procedures to be written in scheme.
.br

.br
When started, \fBbsescm\fP tests whether the first non\-option argument is a \fI.bse\fP
file and if the test succeeds, attempts to play the command line arguments as
\fI.bse\fP files.
.SH
OPTIONS


.PP
\fBbsescm\fP follows the usual GNU command line syntax, with long options starting with two dashes ('\-\-').
.br

.br



.TP
\fB\-\-bse\-pipe\fP \fIINFD\fP \fIOUTFD\fP 
.br
Provide the input and output communication filedescriptors
for remote operation.

.TP
\fB\-\-bse\-eval\fP \fISTRING\fP 
.br
Execute (eval\-string \fISTRING\fP) instead of going into interactive mode.

.TP
\fB\-\-bse\-enable\-register\fP 
.br
Allowes registration of procedures with the \fIBSE\fP core.

.TP
\fB\-\-bse\-no\-load\fP 
.br
Prevent automated loading of plugins and scripts at startup time in interactive mode.

.TP
\fB\-\-bse\-no\-play\fP 
.br
Prevent automated detection and playback of \fI.bse\fP file command line arguments.

.TP
\fB\-\-g\-fatal\-warnings\fP 
.br
Make runtime warnings fatal (abort).

.TP
\fB\-h\fP, \fB\-\-help\fP 
.br
Describe command line options and exit.

.TP
\fB\-v\fP, \fB\-\-version\fP 
.br
Display version and exit.

.TP
\fB\-n\fP=\fINICELEVEL\fP 
.br
Execute with priority NICELEVEL, this option only takes effect for the root suid wrapper 'beast'.

.TP
\fB\-N\fP 
.br
Disables renicing to execute with existing priority.

.TP
\fB\-\-bse\-latency\fP=\fIUSECONDS\fP 
.br
Set the allowed synthesis latency for \fIBSE\fP in milliseconds.

.TP
\fB\-\-bse\-mixing\-freq\fP=\fIFREQUENCY\fP 
.br
Set the desired synthesis mixing frequency in Hz.

.TP
\fB\-\-bse\-control\-freq\fP=\fIFREQUENCY\fP 
.br
Set the desired control frequency in Hz, this should be much smaller than the
synthesis mixing frequency to reduce CPU load. The default value of approximately
1000 Hz is usually a good choice.

.TP
\fB\-\-bse\-pcm\-driver\fP \fIDRIVER\-CONF\fP 
.br

.TP
\fB\-p\fP \fIDRIVER\-CONF\fP 
.br
This options results in an attempt to open the PCM driver \fIDRIVER\-CONF\fP
when playback is started.
Multiple options may be supplied to try a variety of drivers and
unless \fIDRIVER\-CONF\fP is specified as `auto', only the drivers
listed by options are used.
Each \fIDRIVER\-CONF\fP consists of a driver name and an optional comma
seperated list of arguments attached to the driver withan equal sign, e.g.:
\fB\-p oss=/dev/dsp2,rw \-p auto\fP

.TP
\fB\-\-bse\-midi\-driver\fP \fIDRIVER\-CONF\fP 
.br

.TP
\fB\-m\fP \fIDRIVER\-CONF\fP 
.br
This option is similar to the \fB\-\-bse\-pcm\-driver\fP option,
but applies to MIDI drivers and devices. It also may be specified multiple
times and features an `auto' driver.

.TP
\fB\-\-bse\-driver\-list\fP 
.br
Produce a list of all available PCM and MIDI drivers and available devices.

.PP


.SS
Guile Options:


.PP




.TP
\fB\-l\fP \fIFILE\fP 
.br
Load scheme source code from file.

.TP
\fB\-e\fP \fIFUNCTION\fP 
.br
After reading script, apply \fIFUNCTION\fP to command\-line arguments.

.TP
\fB\-ds\fP 
.br
Do \-s \fISCRIPT\fP at this point (note that this argument must be
used in conjuction with \-s).

.TP
\fB\-\-debug\fP 
.br
Start with debugging evaluator and backtraces enabled (useful for debugging scripts).

.TP
\fB\-\-emacs\fP 
.br
Enable emacs protocol for use from within emacs (experimental).

.PP

.br
The remaining Guile options stop argument processing, and pass all
remaining arguments as the value of (command\-line):
.br

.br



.TP
\fB\-\-\fP 
.br
Stop argument processing, start in interactive mode.

.TP
\fB\-c\fP \fIEXPR\fP 
.br
Stop argument processing, evaluate \fIEXPR\fP as a scheme expression.

.TP
\fB\-s\fP \fISCRIPT\fP 
.br
Load Scheme source from \fISCRIPT\fP and execute as a script.

.PP


.SH
SEE ALSO


.PP
beast(1),
bse(5),
BEAST/BSE Website (http://beast.testbit.eu),
Guile Documentation (http://www.gnu.org/software/guile/docs/)