From 175fe424ff9948791a67df09a47b31de7f89563d Mon Sep 17 00:00:00 2001 From: Henri Herscher Date: Thu, 24 Nov 2005 23:02:34 +0000 Subject: Version 0.3 documentation changes git-svn-id: https://oreka.svn.sourceforge.net/svnroot/oreka/trunk@73 09dcff7a-b715-0410-9601-b79a96267cd0 --- documentation/oreka-documentation.xml | 118 +++++++++++++++++++++++++--------- 1 file changed, 86 insertions(+), 32 deletions(-) diff --git a/documentation/oreka-documentation.xml b/documentation/oreka-documentation.xml index 38c738c..54db0db 100644 --- a/documentation/oreka-documentation.xml +++ b/documentation/oreka-documentation.xml @@ -49,20 +49,20 @@ install these packages first using your linux distribution packaging system or download sources tarballs from the listed websites. -log4cxx 0.9.7 - It is important to use this precise version for now - http://logging.apache.org/log4cxx/ ACE 5.4.2 - http://www.cs.wustl.edu/~schmidt/ACE.html -libpcap 0.7.2 - http://www.tcpdump.org/ + http://www.cs.wustl.edu/~schmidt/ACE.html (Debian/Ubuntu package: libace5.4) boost 1.31.0 - http://www.boost.org + http://www.boost.org (Debian/Ubuntu package: libboost-dev) xerces-c 2.6 - http://xml.apache.org/xerces-c/ + http://xml.apache.org/xerces-c/ (Debian/Ubuntu package: libxerces26-dev) +log4cxx 0.9.7 - It is important to use this precise version for now + http://logging.apache.org/log4cxx/ (Debian/Ubuntu package outdated) libsndfile 1.0.10 - http://www.mega-nerd.com/libsndfile/ + http://www.mega-nerd.com/libsndfile/ (Debian/Ubuntu package: libsndfile1-dev) +libpcap 0.7.2 + http://www.tcpdump.org/ (Debian/Ubuntu package: libpcap-dev). Only needed if you want to record VoIP calls portaudio v18 - http://www.portaudio.com + http://www.portaudio.com (Debian/Ubuntu package: libportaudio-dev). Only needed if you want to record from sound devices Build orkbasecxx on the command line: @@ -87,6 +87,7 @@ or download sources tarballs from the listed websites. make -f Makefile.cvs ./configure make +make install @@ -166,29 +167,17 @@ or download sources tarballs from the listed websites.
Installing Windows Libraries + This step is not needed when using the windows installer, the installer automatically installs winpcap. Download and install winpcap 3.1 (choose the windows installer version). This is a network packet capture library http://www.winpcap.org
- Installing OrkAudio from the win32 binary release - -Download the win32 binary realease from the oreka sourceforge project page -Unzip the package in a folder of your choice. -If you want to run OrkAudio as a windows service: - - Open a cmd box, navigate to the install directory - Issue the followig command: c:\oreka\orkaudio> OrkAudio.exe install - For uninstalling, do: c:\oreka\orkaudio> OrkAudio.exe uninstall - - - -
-
- Installing OrkAudio from a fresh build + Installing OrkAudio manually after a fresh win32 build -Follow the procedure in -Make sure you have compiled OrkAudio and OrkBase in release mode -Copy OrkAudio.dll and OrkBase.dll to your install folder, replacing old files +Download the win32 installer from the oreka sourceforge project page +Unzip and run the installer. This will set up the environment +Build your modified version of OrkAudio, or OrkAudio plugin in release mode +Copy the modified OrkAudio.dll, OrkBase.dll, VoIp.dll, SoundDevice.dll or Generator.dll to your install folder, replacing old files
@@ -245,15 +234,80 @@ or download sources tarballs from the listed websites.
Running OrkAudio + Windows: + + -To run on the command line, open a cmd box, navigate to the install directory and issue the following command: c:\oreka\orkaudio> OrkAudio.exe debug -To run as a service, issue the following command: c:\oreka\orkaudio> OrkAudio.exe install -To uninstall service, issue the following command: c:\oreka\orkaudio> OrkAudio.exe uninstall +To run on the windows command line, open a cmd box, navigate to the install directory and issue the following command: c:\Program Files\orkaudio> OrkAudio.exe debug +To install as an NT service, issue the following command (not needed if OrkAudio was deployed using the windows installer): c:\Program Files\orkaudio> OrkAudio.exe install +To run as an NT service, go start/run and enter services.msc pick the orkaudio service and start it +To uninstall service, issue the following command: c:\Program Files\orkaudio> OrkAudio.exe uninstall - -Audio files will be written in the OrkAudio install directory in date/time based subfolders according to the following scheme: yyyy/MM/dd/hh. Audio files themselves are named after the following scheme: yyyyMMdd_hhmmss_capturePort.extension. + + Linux: + + +To run attached to the tty, issue the following command: # orkaudio debug +To run as a daemon, issue the following command: # orkaudio + + +
+
+ File locations +
+ Audio Output Files + + Audio output files those will be written to the [install directory]/AudioRecordings under windows and in /var/log/orkaudio under Linux. They are classified according to the following scheme: + + + yyyy/MM/dd/hh + + + Audio file themselves are named after the following scheme: + + + yyyyMMdd_hhmmss_capturePort.extension + +
+
+ Configuration Files + + Configuration files are located in the install directory under Windows and in /etc/oreka under Linux. The files are: + + + + config.xml: this is the main OrkAudio configuration file. Plugins also read their configration parameters from subsections of this file. + logging.properties: this is the log4j logging configuration file which allows for great flexibility in logging scope and output format. + + +
+
+ Log Files + + Log files are located in the install directory under Windows and in /var/log/oreka under Linux. By default, Oreka produces the following output: + + + + orkaudio.log: this is the main OrkAudio logfile. + tapelist.log: this logfile contains the details (metadata) for each recording that was performed by OrkAudio + + +
+
+ Plugins Files + + Plugins exist as dll files under Windows and as DSO (Dynamic Shared Objects) with .so extensions under Linux. They are located in [install dir]/audiocaptureplugins under Windows and in /usr/lib under Linux. + + + + VoIp.dll - libvoip.so: VoIP recording plugin + SoundDevice.dll - libsounddevice.so: Sound Card based recording + Generator.dll - libgenerator.so: Audio generator for faking audio capture (useful when testing) + + +
Configuring OrkAudio -- cgit v1.2.3