diff options
| author | Henri Herscher <henri@oreka.org> | 2005-10-25 14:45:32 +0000 |
|---|---|---|
| committer | Henri Herscher <henri@oreka.org> | 2005-10-25 14:45:32 +0000 |
| commit | 9fdbe7e609dcad5e2abcd27be5c83578de5069d8 (patch) | |
| tree | 734c4b100bc680c3788ecfaa674d89c430261b37 /documentation | |
| parent | c8aa4d6529a7dafbf03f7f46049102db8d3a4612 (diff) | |
first checkin
git-svn-id: https://oreka.svn.sourceforge.net/svnroot/oreka/trunk@15 09dcff7a-b715-0410-9601-b79a96267cd0
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/oreka-documentation.xml | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/documentation/oreka-documentation.xml b/documentation/oreka-documentation.xml new file mode 100644 index 0000000..05e7445 --- /dev/null +++ b/documentation/oreka-documentation.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<book> + <title>Oreka</title> + + <chapter> + <title>Introduction</title> + <section> + <title>What is Oreka ?</title> + <para> +Modular and cross-platform system for recording and retrieval of audio streams. The project currently supports VoIP and sound device based capture. + </para> + <para> +The platform currently comprises of three services: + <itemizedlist> + <listitem> +<emphasis>OrkAudio</emphasis>: the audio capture and storage daemon with pluggable capture modules currently comes with modules for VoIP and sound device recording. This service is written in C++. + </listitem> + <listitem> +<emphasis>OrkTrack</emphasis>: logs all activity from one or more orkaudio services to any mainstream database. This service is implemented as a J2EE servlet based application. + </listitem> + <listitem> +<emphasis>OrkWeb</emphasis>: Web based user interface for retrieval. This service is implemented as a J2EE servlet based application using the Tapestry web development framework. + </listitem> + </itemizedlist>. + </para> + </section> + <section> + <title>License</title> + <para> +This program is free software, distributed under the terms of the GNU General Public License. Please refer to <link linkend='http://www.gnu.org/copyleft/gpl.html'>http://www.gnu.org/copyleft/gpl.html</link> for more information. + </para> + </section> + + </chapter> + <chapter> + <title>Building</title> + <para>If you only want to run Oreka sofware, you can safely skip this section.</para> + <section> + <title>Building OrkAudio</title> + </section> + <section> + <title>Building OrkTrack and OrkWeb</title> + </section> + </chapter> + <chapter> + <title>Installing</title> + <section> + <title>Installing Prerequisite Software for OrkAudio</title> + <section> + <title>Installing Linux Libraries</title> + </section> + <section> + <title>Installing Windows Libraries</title> + </section> + <section> + <title>Installing Java and Tomcat</title> + </section> + <section> + <title>Installing a database</title> + </section> + </section> + <section> + <title>Installing OrkAudio</title> + </section> + <section> + <title>Installing Prerequisite Software for OrkTrack and OrkWeb</title> + </section> + <section> + <title>Installing OrkTrack and OrkWeb</title> + </section> + </chapter> + <chapter> + <title>Running</title> + <section> + <title>Running OrkAudio</title> + </section> + <section> + <title>Running OrkTrack and OrkWeb</title> + </section> + </chapter> +</book>
\ No newline at end of file |