ao/libao.conf.5

   1 .\" Process this file with
   2 .\" groff -man -Tascii libao.conf.5
   3 .\"
   4 .TH libao.conf 5 "September 1, 2003" "" "libao configuration"
   5
   6 .SH NAME
   7 libao.conf \- configuration for libao.
   8
   9 .SH SYNOPSIS
  10
  11 .B /etc/libao.conf
  12
  13 .B ~/.libao
  14
  15 .SH DESCRIPTION
  16 .B libao.conf
  17 and
  18 .B .libao
  19 are configuration files for libao, the audio output library.  They
  20 specify various options to libao, as described below.
  21 .B libao.conf
  22 sets system-wide options, whereas
  23 .B ~/.libao
  24 sets user-specific options.  When an option is set in
  25 both places, the option in
  26 .B ~/.libao
  27 takes precedence.
  28
  29 .SH FILE FORMAT
  30 The file consists of comments and key-value pairs.  Comments are on separate lines that start with a
  31 .B #
  32 symbol.  The key-value pairs are of the form:
  33 .RS
  34 .BR
  35 .B key=value
  36 .RE
  37 where
  38 .B key
  39 contains no whitespace and no equal signs.
  40 .B value
  41 will be all of the text after the equal sign until (but not including)
  42 the ending newline.  Beware of extra spaces at the end of the line!
  43 They will probably be interpreted as part of the option value.
  44
  45 The following is a list of valid global option keys. Any driver specific option
  46 may be used as well as those keys.
  47 .RS
  48 .IP default_driver
  49 The short name of the driver libao should use by default.  Valid values
  50 include (not all are available on every platform): oss, esd, arts, alsa,
  51 nas, irix, sun, roar and sndio.  Note that "sun" is used on many BSD
  52 systems as well as Solaris.
  53 .IP "debug (Value optional/ignored)"
  54 Sets all the drivers as well as AO itself into debugging output mode.
  55 Unlike passing the debug option to a driver, debug will also print
  56 debugging information from driver loading and testing.
  57 .IP "quiet (Value optional/ignored)"
  58 Sets all the drivers as well as AO itself into silent mode.
  59 Errors will return only error codes; neither ao nor the drivers will
  60 print any output whatsoever to stderr.
  61 .IP "verbose (Value optional/ignored)"
  62 Sets all the drivers as well as AO itself into verbose mode.
  63 .RE
  64
  65 .SH EXAMPLE
  66
  67 Here is an example
  68 .B libao.conf
  69 that forces the OSS driver to be used by default:
  70
  71     # This is a comment.
  72     default_driver=oss
  73
  74 .SH BUGS
  75
  76 .B libao.conf
  77 is missing a number of potentially useful options.
  78
  79 .SH AUTHORS
  80
  81 .br
  82 Stan Seibert <volsung@xiph.org>