.\" Process this file with
.\" groff -man -Tascii ogg123.1
.\"
.TH ogg123 1 "July 22, 2001" "" "Vorbis Tools"

.SH NAME
ogg123 \- plays Ogg Vorbis files

.SH SYNOPSIS
.B ogg123 
[
.B -vqzVh
] [
.B -k
.I seconds 
] [
.B -b
.I buffer_size 
] [
.B -d
.I driver 
[
.B -o
.I option:value
] 
[
.B -f
.I filename
] ]
.I file
.B ...
|
.I URL
.B ...

.SH DESCRIPTION
.B ogg123
reads Ogg Vorbis audio files and decodes them to the devices specified
on the command line.  By default,
.B ogg123
writes to the standard sound device, but output can be sent to any
number of devices.  Files can be read from the file system, or URLs
can be streamed via HTTP.

.SH OPTIONS
.IP "-b n, --buffer n"
Use a buffer of approximately 'n' kilobytes.
.IP "-d device, --device device"
Specify output device.  See
.B DEVICES
section for a list of devices.  Any number of devices may be specified.
.IP "-f filename, --file filename"
Specify output file for file devices.  The filename "-" writes to standard
out.  If the file already exists,
.B ogg123
will abort.
.IP "-h, --help"
Show command help.
.IP "-k n, --skip n"
Skip the first 'n' seconds
.IP "-o option:value, --device-option option:value"
Assigns the option
.I option
to 
.I value
for the preceding device.  See
.B DEVICES
for a list of valid options for each device.
.IP "-q, --quiet"
Quiet mode.  No messages are displayed.
.IP "-V, --version"
Display version information.
.IP "-v, --verbose"
Increase verbosity.
.IP "-z, --shuffle"
Play files in pseudo-random order.

.SH DEVICES

.B ogg123
supports a variety of audio output devices through libao.  Only those
devices supported by the target platform will be available.  The
.B -f
option may only be used with devices that write to files.

.IP null
Null driver.  All audio data is discarded.  (Note: Audio data is not
written to 
.B /dev/null
!)  You could use this driver to test raw decoding speed without
output overhead. 

.IP oss
Open Sound System driver for Linux and FreeBSD.
.RS
Options:
.RS 
.IP dsp
DSP device for soundcard.  Defaults to  
.B /dev/dsp.
.RE
.RE

.IP sun
Sun Audio driver for NetBSD, OpenBSD, and Solaris.
.RS
Options:
.RS
.IP dev
Audio device for soundcard.  Defaults to  
.B /dev/audio.
.RE
.RE

.IP alsa
Advanced Linux Sound Architecture.
.RS
Options:
.RS
.IP card
Sound card number.  (Default = 0)
.IP dev
Device number on the sound card.  (Default = 0)
.IP buf_size
Override the default buffer size (in bytes).
.RE
.RE

.IP irix
IRIX audio driver.  Note that this driver has
.B not 
been tested!

.IP arts
aRts Sound Daemon.

.IP esd
Enlightened Sound Daemon.
.RS
Options:
.RS
.IP host
The hostname where esd is running.  This can include a port number
after a colon, as in "whizbang.com:555".  (Default = localhost)
.RE
.RE

.IP au
Sun audio file output.  Writes the audio samples in AU format.  The AU
format supports writing to unseekable files, like standard out.  In
such circumstances, the AU header will specify the sample format, but
not the length of the recording.

.IP raw
Raw sample output.  Writes raw audio samples to a file.
.RS
Options:
.RS
.IP byteorder
Choose big endian, little endian, or native byte order.  (Default = "native")
.RE
.RE

.IP wav
WAV file output.  Writes the sound data to disk in uncompressed form.
If multiple files are played, all of them will be concatenated into
the same WAV file.  WAV files cannot be written to unseekable files,
such as standard out.  Use the AU format instead.


.SH EXAMPLES

The
.B ogg123
command line is fairly flexible, perhaps confusingly so.  Here are
some sample command lines and an explanation of what they do.
.PP

Play on the default soundcard:
.RS
.B ogg123 test.ogg
.RE
.PP

Play using the OSS driver:
.RS
.B ogg123 -d oss test.ogg
.RE
.PP

Pass the "dsp" option to the OSS driver: 
.RS
.B ogg123 -d oss -o dsp:/dev/mydsp 
.RE
.PP

Use the ESD driver
.RS
.B ogg123 -d esd test.ogg
.RE
.PP

Use the WAV driver with the default output file, "output.wav":
.RS
.B ogg123 -d wav test.ogg
.RE
.PP

Listen to a file while you write it to a WAV file:
.RS
.B ogg123 -d oss -d wav -f test.wav test.ogg
.RE
.PP

Note that options apply to the device declared to the left:
.RS
.B ogg123 -d oss -o dsp:/dev/mydsp -d raw -f test2.raw -o byteorder:big test.ogg
.RE
.PP

Stress test your harddrive:
.RS
.B ogg123 -d oss -d wav -f 1.wav -d wav -f 2.wav -d wav -f 3.wav -d wav -f 4.wav -d wav -f 5.wav  test.ogg
.RE
.PP

Create an echo effect with esd and a slow computer:
.RS
.B ogg123 -d esd -d esd test.ogg
.RE
.PP

.SH INTERRUPT
You can abort
.B ogg123
at any time by pressing Ctrl-C.  If you are playing multiple
files, this will stop the current file and begin playing the
next one.  If you want to abort playing immediately instead
of skipping to the next file, press Ctrl-C within the first
second of the playback of a new file.
.P
Note that the result of pressing Ctrl-C might not be audible
immediately, due to audio data buffering in the audio device.
This delay is system dependent, but it is usually not more
than one or two seconds.

.SH NOTES

Configuration for many parameters can be specified in 
.B /etc/ogg123rc
and
.B ~/.ogg123rc.
To see the available configuration options, use:
.RS
.B ogg123 -c
.RS
This needs more documentation.


.SH FILES

.TP
/etc/libao.conf
Can be used to set the default output device for all libao programs.

.TP
~/.libao
Per-user config file to override the system wide output device settings.
.PP

.SH BUGS

Piped WAV files may cause strange behavior in other programs.  This is
because WAV files store the data length in the header.  However, the
output driver does not know the length when it writes the header, and
there is no value that means "length unknown".  Use the raw or au
output driver if you need to use ogg123 in a pipe.

.SH SEE ALSO
.BR libao.conf(5)

.SH AUTHORS

.TP
Program Authors:
.br
Kenneth Arnold <kcarnold@yahoo.com>
.br
Stan Seibert <indigo@aztec.asu.edu>
.br

.TP
Manpage Author:
.br
Stan Seibert <indigo@aztec.asu.edu>