[icecast-dev] Icecast and Ices2 manual pages

[Keegan Quinn]

Hello everyone,

In the process of packaging Icecast and Ices2 for Debian, it was necessary
for me to write a set of minimal manual pages to satisfy policy
requirements.  Since I would be adding them to CVS as part of the debian/
directories anyway, I thought I would present them here, so they could
perhaps be integrated with the other forms of packaging.  They are very
simple but perhaps someone might find them useful, with very small changes.

I've attached the files to this message.

Thanks,

 - Keegan

-------------- next part --------------
.\"                                      Hey, EMACS: -*- nroff -*-
.TH ICECAST2 1 "July 28, 2003"
.SH NAME
icecast2 \- an MP3/Ogg Vorbis broadcast streaming media server
.SH SYNOPSIS
.B icecast2
-c 
.RI config.xml
.SH DESCRIPTION
\fBicecast2\fP is an audio broadcasting system that streams music in
Ogg Vorbis and/or MPEG 1 Layer III format.  It accepts stream input
from sources like ices0 and ices2, and broadcasts to clients like xmms.
.SH OPTIONS
\fBicecast2\fP has no command line options, except to specify the location
of an XML configuration file.  All operational aspects of the software
are controlled by this XML configuration file.
.SH SEE ALSO
The example configuration files, provided with the package documentation
are the only reliable source of information on this software.
It is still under very active development;
documentation will be written when it is possible to do so.
.SH AUTHOR
icecast2 was created by the icecast team <team at icecast.org>.
This manual page was written by Keegan Quinn <ice at thebasement.org>.

-------------- next part --------------
.\"                                      Hey, EMACS: -*- nroff -*-
.TH ICES2 1 "July 28, 2003"
.SH NAME
ices2 \- an Ogg Vorbis broadcast streaming source client
.SH SYNOPSIS
.B ices2
.RI config.xml
.SH DESCRIPTION
\fBices2\fP is a program that connects to Icecast 2
streaming media servers, and provides them with
audio streams.  It supports both live audio input from a
soundcard and re-encoding of Ogg Vorbis files from
a playlist.
.SH OPTIONS
\fBices2\fP has no command line options.  All aspects of its
operation are controlled by the XML configuration file, whose
path is specified by the sole argument.
.SH SEE ALSO
The example configuration files, provided with the package
documentation, are the only reliable source of information
on this software.  The software is still under very active
development; detailed documentation will be written when it is
possible to do so.
.SH AUTHOR
ices2 was written by Michael Smith <msmith at icecast.org>,
Karl Heyes <karl at pts.tele2.co.uk>, and others.
.br
This manual page was written by Keegan Quinn <ice at thebasement.org>.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: part
Type: application/pgp-signature
Size: 190 bytes
Desc: not available
Url : http://lists.xiph.org/pipermail/icecast-dev/attachments/20030728/9be9d226/part.pgp