summaryrefslogtreecommitdiff
path: root/orkaudio/orkaudio.8
blob: 77fe0c43d8b469623b18e16401d81f4b7b604036 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
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 <tzafrir.cohen@xorcom.com>,
for the Debian project (but may be used by others).