Blame libao.conf.5

Packit 57f8ee
.\" Process this file with
Packit 57f8ee
.\" groff -man -Tascii libao.conf.5
Packit 57f8ee
.\"
Packit 57f8ee
.TH libao.conf 5 "September 1, 2003" "" "libao configuration"
Packit 57f8ee
Packit 57f8ee
.SH NAME
Packit 57f8ee
libao.conf \- configuration for libao.
Packit 57f8ee
Packit 57f8ee
.SH SYNOPSIS
Packit 57f8ee
Packit 57f8ee
.B /etc/libao.conf
Packit 57f8ee
Packit 57f8ee
.B ~/.libao
Packit 57f8ee
Packit 57f8ee
.SH DESCRIPTION
Packit 57f8ee
.B libao.conf
Packit 57f8ee
and
Packit 57f8ee
.B .libao
Packit 57f8ee
are configuration files for libao, the audio output library.  They
Packit 57f8ee
specify various options to libao, as described below.
Packit 57f8ee
.B libao.conf
Packit 57f8ee
sets system-wide options, whereas
Packit 57f8ee
.B ~/.libao
Packit 57f8ee
sets user-specific options.  When an option is set in 
Packit 57f8ee
both places, the option in
Packit 57f8ee
.B ~/.libao
Packit 57f8ee
takes precedence.
Packit 57f8ee
Packit 57f8ee
.SH FILE FORMAT
Packit 57f8ee
The file consists of comments and key-value pairs.  Comments are on separate lines that start with a
Packit 57f8ee
.B #
Packit 57f8ee
symbol.  The key-value pairs are of the form:
Packit 57f8ee
.RS
Packit 57f8ee
.BR
Packit 57f8ee
.B key=value
Packit 57f8ee
.RE
Packit 57f8ee
where
Packit 57f8ee
.B key
Packit 57f8ee
contains no whitespace and no equal signs.
Packit 57f8ee
.B value
Packit 57f8ee
will be all of the text after the equal sign until (but not including)
Packit 57f8ee
the ending newline.  Beware of extra spaces at the end of the line!
Packit 57f8ee
They will probably be interpreted as part of the option value.
Packit 57f8ee
Packit 57f8ee
The following is a list of valid global option keys. Any driver specific option
Packit 57f8ee
may be used as well as those keys.
Packit 57f8ee
.RS
Packit 57f8ee
.IP default_driver
Packit 57f8ee
The short name of the driver libao should use by default.  Valid values
Packit 57f8ee
include (not all are available on every platform): oss, esd, arts, alsa,
Packit 57f8ee
nas, irix, sun, roar and sndio.  Note that "sun" is used on many BSD
Packit 57f8ee
systems as well as Solaris.
Packit 57f8ee
.IP "debug (Value optional/ignored)"
Packit 57f8ee
Sets all the drivers as well as AO itself into debugging output mode.
Packit 57f8ee
Unlike passing the debug option to a driver, debug will also print
Packit 57f8ee
debugging information from driver loading and testing.
Packit 57f8ee
.IP "quiet (Value optional/ignored)"
Packit 57f8ee
Sets all the drivers as well as AO itself into silent mode.
Packit 57f8ee
Errors will return only error codes; neither ao nor the drivers will
Packit 57f8ee
print any output whatsoever to stderr.
Packit 57f8ee
.IP "verbose (Value optional/ignored)"
Packit 57f8ee
Sets all the drivers as well as AO itself into verbose mode.
Packit 57f8ee
.RE
Packit 57f8ee
Packit 57f8ee
.SH EXAMPLE
Packit 57f8ee
Packit 57f8ee
Here is an example
Packit 57f8ee
.B libao.conf
Packit 57f8ee
that forces the OSS driver to be used by default:
Packit 57f8ee
Packit 57f8ee
    # This is a comment.
Packit 57f8ee
    default_driver=oss
Packit 57f8ee
Packit 57f8ee
.SH BUGS
Packit 57f8ee
Packit 57f8ee
.B libao.conf
Packit 57f8ee
is missing a number of potentially useful options.
Packit 57f8ee
Packit 57f8ee
.SH AUTHORS
Packit 57f8ee
Packit 57f8ee
.br
Packit 57f8ee
Stan Seibert <volsung@xiph.org>