fusionsoundrc.5.in

.\" -*-Nroff-*-
.\"
.\" This man page is Copyright (C) 2006 Claudio Ciccani <klan@users.sf.net>

.TH FUSIONSOUNDRC 5 "15 Jul 2006" "Version @FUSIONSOUND_VERSION@" "FusionSound Manual Pages"

.SH NAME
fusionsoundrc \- FusionSound configuration file


.SH DESCRIPTION

The
.B fusionsoundrc
file is a configuration file read by all FusionSound applications on startup.
There are two of these: a system-wide one stored in
.I /etc/fusionsoundrc
and a per-user
.I
\fB$HOME\fP/.fusionsoundrc
which may override system settings.

The same parameters that can be used in the
.B fusionsoundrc
file can also be passed to FusionSound applications on the command-line
by prefixing them with 
.BR --fs:
or by setting the environment variable
.BR FSARGS


.SH SYNTAX

The
.B fusionsoundrc
file contains one parameter per line. Comments are introduced by a
hash sign (#), and continue until the end of the line.  Blank lines
are ignored.


.SH PARAMETERS

The following parameters may be specified in the
.B fusionsoundrc
file:

.TP
.BI driver=<driver>
Specify the driver to use (e.g. "oss" or "alsa").

.TP
.BI device=<device>
Specify a driver specific audio output device to use
(e.g "/dev/dsp" if using oss or "default" if using alsa).

.TP
.BI channels=<channels>
Set the default number of channels to use.

.TP
.BI channelmode=<channelmode>
Set the default channel mode.
This options allows to specify a detailed channels configuration
and overrides the previous option. 
Possible values are MONO, STEREO, STEREO21, STEREO30, STEREO31,
SURROUND30, SURROUND31, SURROUND40_2F2R, SURROUND41_2F2R, 
SURROUND40_3F1R, SURROUND41_3F1R, SURROUND50, SURROUND51.

.TP
.BI sampleformat=<sampleformat>
Set the default sample format to use.
Possible values are U8, S16, S24, S32 and FLOAT.

.TP
.BI samplerate=<samplerate>
Set the default sample rate in Hz (e.g 48000).

.TP
.BI buffertime=<millisec>
Set the length of the output buffer in milliseconds.

.TP
.BI session=<num>
Selects the multi application world which is joined or created.
Negative values force creation of a new world using the lowest
unused session number. The default session number is 
DIRECTFB_SESSION + 1.

.TP
.BI quiet
Suppress console output. Only error messages will be displayed.

.TP
.BI [no-]banner
Enables the output of the FusionSound banner at startup. 
This is on by default.

.TP
.BI [no-]debug
Enable debug output.

.TP
.BI [no-]trace
Enable stack trace support.

.TP
.BI [no-]wait
If there are still slaves playing, the option will cause the master
to fork and wait until all playbacks are finished before releasing
resources.

.TP
.BI [no-]deinit-check
By default FusionSound checks if the application has released all allocated
resources on exit. If it didn't, it will clean up after the application.
This option allows to switch this feature on or off.

.TP
.BI [no-]dither
Enable dithered samples conversion. 

.TP
.BI [no]-dma
Turn on DMA if supported by the output device. Actually this is only supported
by the ALSA driver. Off by default.

.TP 
.BI remote=<host>[:<session>]
Select the remote session to connect to.

.TP
.BI remote-compression=<method>
Select compression method used for remote sessions. Supported values for
<method> are:

.BI none
No compression at all.

.BI dpack
A fast and loseless compression method based on delta coding.


.SH EXAMPLES

Here are some examples that demonstrates how the parameters described
above are passed to FusionSound application on the command-line.

.TP
.B fsmaster --fs:help
Lists the FusionSound options that can be passed to fsmaster.

.TP
.B fsmaster --fs:driver=alsa,device=intel8x0
Start fsmaster using ALSA driver with intel8x0 device.


.SH OTHER INFO

The canonical place to find informations about FusionSound is at
http://www.directfb.org/.  Here you can find the FAQ, tutorials,
mailing list archives, the CVS tree and can download the latest
version of the FusionSound library as well as a number of applications.


.SH FILES

.TP
.I /etc/fusionsoundrc
system-wide FusionSound configuration file
.TP
.I $HOME/.fusionsoundrc
per-user FusionSound configuration file


.SH SEE ALSO
.BR directfbrc (5)