From 14ae7b7ba88a434ce069678c04f50cf05301cce8 Mon Sep 17 00:00:00 2001 From: Tzafrir Cohen Date: Wed, 23 Sep 2009 18:43:35 +0300 Subject: A man page for orkaudio --- orkaudio/orkaudio.8 | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 orkaudio/orkaudio.8 diff --git a/orkaudio/orkaudio.8 b/orkaudio/orkaudio.8 new file mode 100644 index 0000000..77fe0c4 --- /dev/null +++ b/orkaudio/orkaudio.8 @@ -0,0 +1,96 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH ORKAUDIO 8 "2009-09-07" +.SH NAME +orkaudio \- audio recording server of Oreka +.SH SYNOPSIS +.B orkaudio [ debug ] + +.B orkaudio transcode +.RI file.mcf + +.SH DESCRIPTION +.B orkaudio +in the first form runs the recording daemon of the Oreka recording server. + +If the option +.B debug +is provided it will not detach from the cosole and will run in debug mode. +In any case it remains in the current working directory. + +With the option +.B transcode +it will transcode a recording file (FILL IN DOCUMENTATION). + +A deamon listens on the followin ports: + +.B 59130 +.RS +A command-line interface (WHAT COMMANDS?) +.RE + +.B 59140 +.RS +A http server (that servers what exactly?) +.RE + +.B 59150 +.RS +Event streaming server (WHICH IS?) +.RE + +.SH OPTIONS +See above. + +.SH FILES +The +.B orkaudio +daemon uses configuration files from +.B /etc/orkaudio +but will look under a different directory if the environment variable +.B ORKAUDIO_CONFIG_PATH +is set. + +Before attempting to look for the files there it will try a name +specified by some environment variable as well as for the same variable +in the working directory. + +.B config.xml +.RS +The main configuration file. +.RE + +.B localpartymap.csv +.RS +.I [Fill in what this file does]. +Note that even if ORKAUDIO_CONFIG_PATH is set, this file will not be +looked for there. +.RE + +.B logging.properties +.RS +Logging settings, if the format used by log4cpp. +.RE + +Logs and audio files are saved under +.B /var/log/orkaudio +but may reside elsewhere if the environment variable +.B ORKAUDIO_LOGGING_PATH +is set. + + +.SH BUGS +No support for reloading configuration by e.g. SIGHUP. +I recon there are a few. Bugs are to be reported to +.I [TODO: please fill in] + +.SH SEE ALSO +http://oreka.sourceforge.org/ + +.SH AUTHOR +Orkaudio was written by orecx LLC (RIGHT?). +.PP +This manual page was written by Tzafrir Cohen , +for the Debian project (but may be used by others). -- cgit v1.2.3