Skip to content

GitLab

Commit 3b899944 authored by Ed "oddsock" Zaleski's avatar Ed "oddsock" Zaleski
Browse files
Options

Make HTML title non-version specific.. Add a new "changes" page which... 

Make HTML title non-version specific.. Add a new "changes" page which enumerates major feature/fixes for each version.. We are starting with 2.3.

svn path=/icecast/trunk/icecast/; revision=9762
parent 0bf1163b
Hide whitespace changes
Inline Side-by-side
Showing with 85 additions and 35 deletions
doc/icecast2_admin.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
doc/icecast2_basicsetup.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
doc/icecast2_changes.html 0 → 100644
View file @ 3b899944
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<div class="boxtest">
<h1>Icecast 2 Changes</h1>
<hr id='titlebar' />
<p>
</p>
<h2>Version 2.3</h2>
<h3>New Features</h3>
<p>
<li> Streaming support for ogg speex, ogg flac, ogg midi
<li> intro file support - per mount settable
<li> on-demand relays, global and per-relay settable
<li> fallback to file, extends on the intro file handling.
<li> new mount-level settings
<ol>
<li>public, type/subtype, genre settings, stream description,
<li>stream url, stream name, bitrate
(override what is sent from the source client)
<li>mp3 metadata interval
<li>on-[dis]connect scripts can be stated per-mount, invoked at source
start/stop and take 1 arg which is the mountpoint.
</ol>
<li> New URL listener authenticator
.included is an example php-based application that can be used
in conjunction with the url authenticator to manage a simple
subscription-based broadcast.
<li> HTPasswd authenticator uses in-memory structures now.
<li> On demand files now can be fed through an authenticator
<li> Update to admin/web xslt interface
<h3>Fixes</h3>
<li> real/helix works
<li> win32 access log correct
<li> stats client is stable now (curl -X STATS http://admin@host:port/)
<li> show mountpoints on stats that are inactive but have an active fallback
<li> more updates over HUP possible
</p>
</div>
</body>
</html>
doc/icecast2_config_file.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......@@ -227,7 +227,7 @@ certain formats.
&lt;on-demand&gt;0&lt;/on-demand&gt;
&lt;/relay&gt;
</pre>
<p>This section contains the server's relay settings. There are two types of relays: a "Master server relay" or a "Specific Mountpoint relay." A Master server relay is only supported between icecast2 servers and is used to relays all mountpoints on a remote icecast2 server.
<p>This section contains the server's relay settings. There are two types of relays: a "Master server relay" or a "Specific Mountpoint relay." A Master server relay is only supported between icecast2 servers and is used to relays all mountpoints on a remote icecast2 server.
</p>
<h3>Master Relay</h3>
<p>
......@@ -238,13 +238,13 @@ The following diagram shows the basics of doing a Master relay. Note that Serve
| | all mountpoints | | /mount1
| | &lt;------------------- | | /mount2.ogg
|-----| |-----| /mount3
Icecast 2 Icecast 2
Icecast 2 Icecast 2
Server 1 Server 2
(RELAY SERVER) (MASTER SERVER)
configured with
&lt;master-server&gt;
settings
settings
</pre>
<p>
......@@ -253,7 +253,7 @@ A server is configured as a Master Server relay by specifying the &lt;master-ser
<h4>master-server</h4>
<div class="indentedbox">
This is the IP for the server which contains the mountpoints to be relayed (Master Server).
This is the IP for the server which contains the mountpoints to be relayed (Master Server).
</div>
<h4>master-server-port</h4>
<div class="indentedbox">
......@@ -296,7 +296,7 @@ The following diagram shows the basics of doing a Specific Mountpoint relay. No
configured with
&lt;relay&gt;
settings
settings
</pre>
......@@ -432,12 +432,12 @@ An optional value which will set the filename which will be a dump of the stream
This optional value specifies a mountpoint that clients are automatically moved to if the source
shuts down or is not streaming at the time a listener connects. Only one can be listed in each
mount and should refer to another mountpoint on the same server that is streaming in the same
streaming format.<br>
streaming format.<br>
If clients cannot fallback to another mountpoint, due to a missing fallback-mount or it states a
mountpoint that is just not available, then those clients will be disconnected.
If clients are falling back to a mountpoint and the fallback-mount is not actively streaming
but defines a fallback-mount itself then those clients may be moved there instead.
This multi-level fallback allows clients to cascade several mountpoints.
This multi-level fallback allows clients to cascade several mountpoints.
<p>A fallback mount can also state a file that is located in webroot. This is useful for
playing a pre-recorded file in the case of a stream going down. It will repeat until either
the listener disconnects or a stream comes back available and takes the listeners back.
......@@ -486,7 +486,7 @@ listening clients back from the fallback mount.
<h4>stream-url</h4>
<div class="indentedbox">
<p>Setting this will add the specified URL to the stats (and therefore YP) for this
mountpoint even if the source client/relay provide one. The URL is generally for
mountpoint even if the source client/relay provide one. The URL is generally for
directing people to a website.
</p>
</div>
......@@ -579,7 +579,7 @@ This path is used in conjunction with the chroot settings, and specified the bas
</div>
<h4>logdir</h4>
<div class="indentedbox">
This path specifies the base directory used for logging. Both the error.log and access.log will be created relative to this directory.
This path specifies the base directory used for logging. Both the error.log and access.log will be created relative to this directory.
</div>
<h4>pidfile</h4>
<div class="indentedbox">
......
doc/icecast2_faq.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
doc/icecast2_glossary.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
doc/icecast2_introduction.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
doc/icecast2_listenerauth.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
doc/icecast2_relay.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......@@ -35,7 +35,7 @@ In this example, this configuration is setup in the server which will be doing t
<br />
<h2>Setting Up A Single-Broadcast Relay</h2>
<p>In this case, the master server need not be an icecast2 server. Supported master servers for a single-broadcast relay are Shoutcast, Icecast1.x, and of course Icecast2. The following configuration snippet is used as an example:</p>
<pre>
<pre>
&lt;relay&gt;
&lt;server&gt;192.168.1.11&lt;/server&gt;
&lt;port&gt;8001&lt;/port&gt;
......
doc/icecast2_stats.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
doc/icecast2_win32.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......@@ -10,7 +10,7 @@
<h1>Icecast 2 - Win32 Specific Documentation</h1>
<hr id='titlebar' />
<p>
The win32 port of icecast2 is simply a UI framework around the core icecast2 server. The win32 version of icecast2 directly uses the main executable of icecast (statically included) and simply provides a GUI interface to icecast2.
The win32 port of icecast2 is simply a UI framework around the core icecast2 server. The win32 version of icecast2 directly uses the main executable of icecast (statically included) and simply provides a GUI interface to icecast2.
</p>
<p>
Most of the features of icecast2 are available in the win32 port.
......
doc/icecast2_yp.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
doc/index.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......@@ -10,6 +10,7 @@
<h1>Icecast 2 Documentation Table of Contents</h1>
<hr id='titlebar' />
<ul>
<li><a href="icecast2_changes.html">Changes</a></li>
<li><a href="icecast2_introduction.html">Introduction</a></li>
<li><a href="icecast2_basicsetup.html">Basic Setup</a></li>
<li><a href="icecast2_config_file.html">Icecast Config File</a></li>
......@@ -27,11 +28,11 @@
icecast 2.x - README
---------------------------------------------------------------------
Icecast is a streaming media server which currently supports Ogg
Vorbis and MP3 audio streams. It can be used to create an Internet
radio station or a privately running jukebox and many things in
between. It is very versatile in that new formats can be added
relatively easily and supports open standards for commuincation and
Icecast is a streaming media server which currently supports Ogg
Vorbis and MP3 audio streams. It can be used to create an Internet
radio station or a privately running jukebox and many things in
between. It is very versatile in that new formats can be added
relatively easily and supports open standards for commuincation and
interaction.
Icecast is distributed under the GNU GPL, version 2. A copy of this
......@@ -71,10 +72,10 @@ Run
To build and install this release.
A sample config file will be placed in /usr/local/etc (on UNIX) or in
A sample config file will be placed in /usr/local/etc (on UNIX) or in
the current working directory (on Win32) and is called icecast.xml
Documentation for icecast is available in the doc directory, by
Documentation for icecast is available in the doc directory, by
viewing doc/index.html in a browser.
Please email us at icecast@xiph.org or icecast-dev@xiph.org, or come and see
......
doc/index_win32.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation Win32</title>
<title>Icecast v2.x Documentation Win32</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......@@ -10,7 +10,7 @@
<h1>Icecast 2 - Win32 Specific Documentation</h1>
<hr id='titlebar' />
<p>
The win32 port of icecast2 is simply a UI framework around the core icecast2 server. The win32 version of icecast2 uses directly the main executable of icecast (statically included) and simply provides a nicer, friendlier interface to icecast2.
The win32 port of icecast2 is simply a UI framework around the core icecast2 server. The win32 version of icecast2 uses directly the main executable of icecast (statically included) and simply provides a nicer, friendlier interface to icecast2.
</p>
<p>
All of the features of icecast2 are available in the win32 port.
......
doc/win32_section1.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
doc/win32_section2.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
doc/win32_section3.html
View file @ 3b899944
......@@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Icecast v2.0 Documentation</title>
<title>Icecast v2.x Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment