aniani/icecast-server
1
0
Fork 0
mirror of https://gitlab.xiph.org/xiph/icecast-server.git synced 2024-06-23 06:25:24 +00:00
Code

initial documentation for the win32 port...Using HTML Help to build the win32 help file

Browse Source 
svn path=/trunk/icecast/; revision=3879
This commit is contained in:
oddsock 2002-08-26 12:40:29 +00:00
parent 7a519ab76e
commit a3f75f7c60
11 changed files with 169 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/Index.hhk Normal file
View File

@ -0,0 +1,9 @@
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<HTML>
<HEAD>
<meta name="GENERATOR" content="Microsoft&reg; HTML Help Workshop 4.1">
<!-- Sitemap 1.0 -->
</HEAD><BODY>
<UL>
</UL>
</BODY></HTML>

BIN
doc/icecast2.chm Normal file
View File

Binary file not shown.

30
doc/icecast2.hhc Normal file
View File

@ -0,0 +1,30 @@
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<HTML>
<HEAD>
<meta name="GENERATOR" content="Microsoft&reg; HTML Help Workshop 4.1">
<!-- Sitemap 1.0 -->
</HEAD><BODY>
<OBJECT type="text/site properties">
<param name="ImageType" value="Folder">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Icecast2 - Win32 Specific">
<param name="Local" value="index_win32.html">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Server Status Tab">
<param name="Local" value="win32_section1.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Editing A Config File">
<param name="Local" value="win32_section2.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Stats Tab">
<param name="Local" value="win32_section3.html">
</OBJECT>
</UL>
</UL>
</BODY></HTML>

19
doc/icecast2.hhp Normal file
View File

@ -0,0 +1,19 @@
[OPTIONS]
Auto Index=Yes
Compatibility=1.1 or later
Compiled file=icecast2.chm
Contents file=icecast2.hhc
Default Font=,8,0
Default topic=index_win32.html
Display compile progress=No
Full-text search=Yes
Index file=Index.hhk
Language=0x409 English (United States)
Title=Icecast 2
[FILES]
index_win32.html
[INFOTYPES]

19
doc/index_win32.html Normal file
View File

@ -0,0 +1,19 @@
<!doctype html public "-//w3c//dtd html 3.2//en">
<LINK REL=STYLESHEET TYPE= "text/css" HREF= "style.css">
<html>
<head>
<title>Icecast2 Win32</title>
</head>
<div class="boxtest">
<h1>Icecast 2 - Win32 Specific Documentation</h1>
<table width=100%><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table>
<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.
</p>
<p>
All of the features of icecast2 are available in the win32 port.
</p>
</div>
</body>
</html>

BIN
doc/stats1.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 51 KiB

40
doc/style.css Normal file
View File

@ -0,0 +1,40 @@
.ahem { display: none }
body { font-size:10px; font-family:Verdana,sans-serif bg-color:#efefef link:#0000ff text:#323232 vlink:#800080 alink:#ff0000 }
code,pre { font-size:11px; font-family:"Courier New",monospace;background:#cc9; padding:0 0.5em }
pre { padding:0.5em }
blockquote { margin:0.5em }
blockquote p { margin:0 }
.width300 { width:300px; background:red }
.width400 { width:400px; background:blue }
p.ruletest { color:red }
div.boxtest {
border:10px solid;
padding:30px;
background: #ffc;
width:600px;
}
div.content {
border:20px solid;
padding:30px;
background: #ffc;
}
div.content {
width:400px;
voice-family: "\"}\"";
voice-family:inherit;
width:300px;
}
/* CSS1 UAs should see and use 2nd width */
html>body .content { width:300px }
p.ruletest { color: blue }

34
doc/win32_section1.html Normal file
View File

@ -0,0 +1,34 @@
<LINK REL=STYLESHEET TYPE= "text/css" HREF= "style.css">
<div class=boxtest>
<body bgcolor="#efefef" text="#323232" link="#0000ff" vlink="#800080" alink="#ff0000">
<h1>Server Status Tab</h1>
<table width=100%><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table>
<h3>Overview</h3>
<p>
The server status tab contains information regarding statistics that are global to the server. There are two types of statistics in icecast2, source level and global statistics. Global statistics are those that are accumilations of stats from all sources offered by the server. Source level statistics are stats which apply only to a single source attached to the server.
</p>
<p>
Examples of global statistics are :
</p>
<pre>
The number of current sources connected
The number of sources that have attempted connections
Total number of attempted connections to the server
</pre>
</p>
<p>
The Server Status tab contains at a minimal the global stats for the server. Additionally, you may add source specific stats to this tab. The intent is to provide a single "dashboard view" of what's going on in the server. To add source statistics to the Server Status tab, see the section on the <a href="win32_section3.html">Stats</a> tab.
</p>
<h3>Adding stats to the window title</h3>
<p>
Any stat that is contained on the Server Status tab can be displayed as the icecast2 window title. This provides yet another mechanism by which you can view activities on the server. To enable this feature, right click on any stat in the Server Status tab as seen below :
</p>
<img src="windowtitle.jpg">
<p>
<h3>Removing source level stats from the Server Status Tab</h3>
<p>
To remove a source level stat that you have inserted onto the Server Status Tab, simple right click that statistic and select "Delete from Global Stats". The stat will be deleted from the Server Status tab, but will still remain on the source level Stats tab.
</p>
</p>
</div>

9
doc/win32_section2.html Normal file
View File

@ -0,0 +1,9 @@
<LINK REL=STYLESHEET TYPE= "text/css" HREF= "style.css">
<div class=boxtest>
<body bgcolor="#efefef" text="#323232" link="#0000ff" vlink="#800080" alink="#ff0000">
<h1>Editing A Config File</h1>
<table width=100%><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table>
<p>
Editing the icecast2 configuration file is a very simple process. For a description of what each field means, see the main icecast documenation. Changes to the icecast2 configuration can only be done while the server is stopped. To edit the current server configuration file, select "Configuration/Edit Configuration" from the main menu.
</p>
</div>

9
doc/win32_section3.html Normal file
View File

@ -0,0 +1,9 @@
<LINK REL=STYLESHEET TYPE= "text/css" HREF= "style.css">
<div class=boxtest>
<h1>Stats Tab</h1>
<table width=100%><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table>
<p>
Explanation of the stats tab here
</p>
<img src="stats1.jpg"><br>
</div>

BIN
doc/windowtitle.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 57 KiB