[vorbis-dev] Manpages
volsung at asu.edu
volsung at asu.edu
Sun Aug 13 07:15:16 PDT 2000
I wrote up some manpages for ogg123 and vorbize. They need to be committed to
the vorbis/vorbis-tools directory. I've also have attached a patch to
vorbis/vorbis-tools/Makefile.in that will install the manpages when "make
install" is run.
If someone could please commit these, it would be much appreciated.
---
Stan Seibert
.\" Process this file with
.\" groff -man -Tascii vorbize.1
.\"
.TH vorbize 1 "August 13, 2000" "" "Vorbis Tools"
.SH NAME
vorbize \- encode audio into the Ogg Vorbis format
.SH SYNOPSIS
.B vorbize
[
.B -hrvq
]
[
.B -m
.I mode
]
[
.B -w
.I output_file
]
[
.B -n
|
.B -c
.I comment
|
.B -a
.I artist
.B -t
.I title
.B -l
.I album
]
[
.I input_file
]
.SH DESCRIPTION
.B vorbize
reads audio data in either raw or WAV format and encodes it into an
Ogg Vorbis stream. The audio data is taken from
.I input_file
or
.I stdin
if no input file is given. The Ogg Vorbis stream is written to
.I stdout
unless the
.B -w
option is used.
.SH OPTIONS
.IP "-h, --help"
Show command help.
.IP "-r, --raw"
Assume input data is raw 44.1 kHz, 16 bit, little-endian audio data with no
header information.
.IP "-q, --quiet"
Quiet mode. No messages are displayed.
.IP "-v, --verbose"
Increase verbosity.
.IP "-m mode, --mode mode"
Set encoding mode to
.I mode
(0-6).
.IP "-w output_file, --write output_file"
Write the Ogg Vorbis stream to
.I output_file.
.B vorbize
defaults to
.I stdout
if the -w option is not given.
.IP "-n, --nocomment"
Do not put any comments in the Ogg Vorbis header.
.IP "-c comment, --comment comment"
Write the string
.I comment
into the Ogg Vorbis header. This is just a single comment without any
special formatting.
.IP "-a artist, --artist artist"
Set the artist comment field in the comments to
.I artist.
Note that you cannot use this with the
.B -c
option.
.IP "-t title, --title title"
Set the track title comment field to
.I title.
Note that you cannot use this with the
.B -c
option.
.IP "-l album, --album album"
Set the album comment field to
.I album.
Note that you cannot use this with the
.B -c
option.
.SH BUGS
Bugs? There are no bgus.
.SH AUTHORS
.TP
Program Author:
.br
Kenneth Arnold <kcarnold at yahoo.com>
.TP
Manpage Author:
.br
Stan Seibert <indigo at aztec.asu.edu>
.SH SEE ALSO
.BR ogg123 (1)
.\" Process this file with
.\" groff -man -Tascii ogg123.1
.\"
.TH ogg123 1 "July 29, 2000" "" "Vorbis Tools"
.SH NAME
ogg123 \- plays Ogg Vorbis files
.SH SYNOPSIS
.B ogg123
[
.B -vqzVh
] [
.B -d
.I driver
[
.B -o
.I option:value
] ]
.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 "-d device, --device device"
Specify output device. See
.B DEVICES
section for a list of devices. Any number of devices may be specified.
.IP "-h, --help"
Show command help.
.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. (Currently not implemented.)
.IP "-V, --version"
Display version information.
.IP "-v, --verbose"
Increase verbosity. (Currently not implemented.)
.IP "-z, --shuffle"
Play files in random order.
.SH DEVICES
.B ogg123
supports a variety of audio output devices. Only those devices
supported by the target platform will be compiled in.
.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 {Net,Free,Open}BSD.
.RS
Options:
.RS
.IP dsp
DSP device for soundcard. Defaults to
.B /dev/dsp.
.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 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 solaris
Solaris audio driver. Note that this driver has
.B not
been tested!
.IP irix
IRIX audio driver. Note that this driver has
.B not
been tested!
.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.
.RS
Options:
.RS
.IP file
Sets the output WAV file. (Default = "output.wav")
.RE
.RE
.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, "ouput.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 -o file: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 wav -o file:test2.wav test.ogg
.RE
.PP
Stress test your harddrive:
.RS
.B ogg123 -d oss -d wav -o file:1.wav -d wav -o file:2.wav -d wav -o file:3.wav -d wav -o file:4.wav -d wav -o file: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 BUGS
The WAV driver does not interpret the file "-" as stdout.
.SH AUTHORS
.TP
Program Authors:
.br
Kenneth Arnold <kcarnold at yahoo.com>
.br
Stan Seibert <indigo at aztec.asu.edu>
.br
.TP
Manpage Author:
.br
Stan Seibert <indigo at aztec.asu.edu>
.SH SEE ALSO
.BR vorbize (1)
Index: Makefile.in
===================================================================
RCS file: /usr/local/cvsroot/vorbis/vorbis-tools/Makefile.in,v
retrieving revision 1.10
diff -u -r1.10 Makefile.in
--- Makefile.in 2000/08/05 00:27:52 1.10
+++ Makefile.in 2000/08/13 13:51:03
@@ -1,6 +1,10 @@
# Makefile for Vorbize
# modified from autoconf-generated Makefile in Vorbis CVS tree
#
+# 2000-08-13 make install now copies manpages
+#
+# 2000-07-22 libao integrated for ogg123 audio output
+#
# 2000-05-25 Added ogg123
#
# 2000-05-12 Fixed an include file location error.
@@ -70,3 +74,7 @@
$(INSTALL) -b -m 711 mp3tovorbis @prefix@/bin/
$(INSTALL) -b -m 711 ogg123 @prefix@/bin/
$(INSTALL) -b -m 711 vorbiscomment @prefix@/bin/
+ @echo "Installing manpages to @prefix@/man/"
+ $(INSTALL) -b -m 644 ogg123.1 @prefix@/man/man1/
+ $(INSTALL) -b -m 644 vorbize.1 @prefix@/man/man1/
+
--- >8 ----
List archives: http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
More information about the Vorbis-dev
mailing list