adam
/
darkice
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated man pages to reflect IceCast2 support

This commit is contained in:
darkeye 2001-09-16 11:47:21 +00:00
parent afc8fe2ca9
commit 9a0ce10c13
2 changed files with 76 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
darkice/trunk/man/darkice.1
View File

@ -9,13 +9,18 @@ darkice \- an icecast / shoutcast live audio streamer
.B DarkIce
is an
.B IceCast
,
.B IceCast2
and
.B ShoutCast
live audio streamer. It takes audio input from a
sound card, encodes it into mp3, and sends the stream to one or more
sound card, encodes it into mp3 and/or Ogg Vorbis,
and sends the mp3 stream to one or more
.B IceCast
and / or
and/or
.B ShoutCast
servers, the Ogg Vorbis stream to one or more
.B IceCast2
servers.
.B DarkIce
@ -31,32 +36,22 @@ is run as root.
.B DarkIce
uses the
.B Lame
mp3 encoder as a library to encode audio intput to mp3.
mp3 encoder as a library to encode audio intput to mp3, and uses the
.B Ogg Vorbis
library to encode into Ogg Vorbis.
.SH OPTIONS
.TP
.BI "\-c " config.file
.br
.ns
.TP
.BI \-\-config= config.file
Specifies what configuration file to use.
.TP
.BI "\-v " n
.br
.ns
.TP
.BI \-\-verbosity= n
Sets the verbosity level, between 0 and 10. 0 is silent, 10 is loud.
Defaults to 1.
.TP
.BI "\-h "
.br
.ns
.TP
.BI \-\-help
Prints the help page and exists.
@ -78,6 +73,9 @@ Akos Maroy
Some contributions by Jim Crilly
.I <JCrilly@MSA.com>
Ogg Vorbis encoding code based on the contribution of aNa|0Gue
.I <analogue@glop.org>
.SH LINKS
Project homepage:
@ -95,3 +93,6 @@ homepage:
homepage:
.I http://www.mp3dev.org/mp3/
.B Ogg Vorbis
homepage:
.I http://www.xiph.org/ogg/vorbis/

62
darkice/trunk/man/darkice.cfg.5
View File

@ -25,11 +25,13 @@ configuration file contains the following sections:
[general]
[input]
[icecast-0] ... [icecast-7]
[icecast2-0] ... [icecast2-7]
[shoutcast-0] ... [shoutcast-7]
.fi
The order of the sections is not important. Sections [general] and [input]
are required, and at least one of [icecast-x] or [shoutcast-x] is needed.
are required, and at least one of [icecast-x], [icecast2-x]
or [shoutcast-x] is needed.
In particular, the following sections and values are recognized:
.PP
@ -45,7 +47,7 @@ Time for DarkIce to run, in seconds. If 0, run forever.
.TP
.I bufferSecs
Data read from the sound card is buffered before sent to
the mp3 encoder. Each buffer will be able to hold this
the encoder. Each buffer will be able to hold this
many seconds of samples.
.PP
@ -136,6 +138,59 @@ the encoder's default behaviour is used
Highpass filter setting for the lame encoder. If not set,
the encoder's default behaviour is used
.PP
.B [icecast2-x]
This section describes an output to an
.B IceCast2
server, while encoding
with the ogg vobis encoder.
There may be at most 8 outputs, numbered from 0 ... 7.
The number is included in the section name (e.g. [icecast2-0] ... [icecast2-7]).
The stream will be reachable at
.I http://<server>:<port>/<mountPoint>
Required values:
.TP
.I bitrate
Bit rate to encode to in kBits / sec (e.g. 96)
.TP
.I server
The
.B IceCast2
server's name (e.g. yp.yourserver.com)
.TP
.I port
The port to connect to the IceCast server (e.g. 8000)
.TP
.I password
The password to use to connect to the
.B IceCast2
server
.TP
.I mountPoint
Mount point for the stream on the server
.PP
Optional values:
.TP
.I name
Name of the stream
.TP
.I description
Description of the stream
.TP
.I url
Url related to the stream
.TP
.I genre
Genre of the stream
.TP
.I public
"yes" or "no", wether the stream is public
.PP
.B [shoutcast-x]
@ -341,3 +396,6 @@ homepage:
homepage:
.I http://www.mp3dev.org/mp3/
.B Ogg Vorbis
homepage:
.I http://www.xiph.org/ogg/vorbis/