~ubuntu-branches/ubuntu/wily/ecasound/wily-proposed

« back to all changes in this revision

Viewing changes to .pc/01_fix-manpages-errors.patch/Documentation/ecasoundrc.5

  • Committer: Package Import Robot
  • Author(s): Alessandro Ghedini, Alessandro Ghedini, Alessio Treglia
  • Date: 2012-05-22 21:31:25 UTC
  • Revision ID: package-import@ubuntu.com-20120522213125-f14ecq0rlvp6boes
Tags: 2.8.1-7
[ Alessandro Ghedini ]
* Adjust Ruby bindings package name in the dh_fixperms override
  (fixes executable-not-elf-or-script)
* ecasound-el is Section: lisp
* Update ecasound.rb install path as per new Ruby Policy
* Update emacsen install and remove scripts (Closes: #671568)
* Drop 1001-disable_python_tests.patch (the tests are not run anyway)
* Use debian-pkg-add-load-path-item in emacsen startup script
  (Closes: #671551)
* Set up ecasound-ewf-mode with .ewf files (Closes: #672184)
* Add more DEP3 headers to the patches
* Add 04_fix-ecasound.el-ewf-regexp.patch
* Check if the elisp package dir exists in the startup script
* Build depend on python-all and not python-all-dev since we only ship the
  native Python module
* Remove misleading paragraph from long descriptions

[ Alessio Treglia ]
* Remove myself from the Uploaders field.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "ecasoundrc" "5" "22\&.03\&.2009" "" "Multimedia software"
 
2
 
 
3
.PP 
 
4
.SH "NAME"
 
5
ecasoundrc \- ecasound rcfile
 
6
.PP 
 
7
.SH "SYNOPSIS"
 
8
{prefix}/share/ecasound/ecasoundrc (for instance \&'/usr/local/share/ecasound/ecasoundrc\&')
 
9
$HOME/\&.ecasound/ecasoundrc
 
10
.PP 
 
11
.SH "DESCRIPTION"
 
12
 
 
13
.PP 
 
14
\fBecasoundrc\fP is the main configuration file for ecasound\&. 
 
15
Any user-specific modification should be done to 
 
16
$HOME/\&.ecasound/ecasoundrc, not to the global resource file\&. Ecasound 
 
17
also allows to disable the normal policy and only read from a specific
 
18
resource file (see ecasound (1) and documentation for the \fB-R\fP option)\&.
 
19
.PP 
 
20
The format is quite simple\&. One line consists of 
 
21
a configuration variable and its value\&. Variable and value 
 
22
are separated with either \&'=\&' or \&' \&'\&. Lines beginning with a
 
23
"#" are ignored (comment lines)\&. 
 
24
.PP 
 
25
.SH "VARIABLES"
 
26
 
 
27
.PP 
 
28
.IP "midi-device"
 
29
MIDI-device\&. If the device name is given in \fIrawmidi,/dev/midi*\fP 
 
30
format, OSS/Linux or OSS/Lite drivers are used\&. 
 
31
Device \fIrawmidi,/dev/snd/midiCxDy\fP opens an ALSA raw-MIDI 
 
32
device with card number \&'x\&' and device number \&'y\&'\&. 
 
33
See ecasound (1) man page (the \&'-Md option) for more info\&.
 
34
Defaults to \fIrawmidi,/dev/midi\fP\&.
 
35
.IP 
 
36
.IP "default-output"
 
37
Output device to use by default\&. If a chainsetup with zero
 
38
outputs, but with one or more inputs, is connected, a default output
 
39
is added and all the chains are connected to it\&. If the special-case
 
40
value \&'autodetect\&' is specified, ecasound will try to auto-detect 
 
41
a suitable device (JACK -> ALSA -> OSS -> rtnull)\&. 
 
42
Defaults to \fIautodetect\fP\&.
 
43
.IP 
 
44
.IP "default-audio-format"
 
45
Default values for sample format, channel count, sampling rate
 
46
and channel interleaving\&. Syntax is the same as used by
 
47
ecasound\&'s \fI-f\fP option (see ecasound (1))\&. 
 
48
Defaults to \fIs16_le,2,44100,i\fP\&.
 
49
.IP 
 
50
.IP "default-to-precise-sample-rates"
 
51
Whether to ignore sample rate differences (and possibly avoid 
 
52
resampling)\&. Currently only affects OSS-devices\&. Defaults to \fIfalse\fP\&.
 
53
.IP 
 
54
.IP "default-mix-mode"
 
55
If \fIdefault-mix-mode\fP is \fIsum\fP, engine will mix multiple channels into
 
56
one output channel by summing all input channels\&. In mode \fIavg\fP, 
 
57
mixing is done by taking the average of all input channels\&. The
 
58
\fIavg\fP mode is safe from clipping, while \fIsum\fP is closer
 
59
to the way analog mixers work\&. Defaults to \fIavg\fP\&.
 
60
.IP 
 
61
.IP "bmode-defaults-nonrt"
 
62
Selects the default parameters to use with buffering 
 
63
mode \&'nonrt\&' (other modes are \&'rt\&' and \&'rtlowlatency)\&. 
 
64
Parameters are given as a comma-separated tuple of values:
 
65
1) buffersize (number,-b), 2) raised priority (true/false,-r), 
 
66
3) sched_priority (number,-r:X), 4) double buffering
 
67
(true/false,-z:db), 5) db-bufsize (number,-z:db,X), and
 
68
6) max intbuf (true/false,-z:intbuf)\&. Defaults to
 
69
\fI1024,false,50,false,100000,true\fP\&.
 
70
.IP 
 
71
.IP "bmode-defaults-rt"
 
72
See \&'bmode-defaults-nonrt\&'\&. Defaults to 
 
73
\fI1024,true,50,true,100000,true\fP\&.
 
74
.IP 
 
75
.IP "bmode-defaults-rtlowlatency"
 
76
See \&'bmode-defaults-nonrt\&'\&. Defaults to 
 
77
\fI256,true,50,true,100000,false\fP\&.
 
78
.IP 
 
79
.IP "resource-directory"
 
80
Directory for global ecasound configuration files\&. 
 
81
Defaults to \fI{prefix-dir}/share/ecasound\fP\&.
 
82
Note! User-specific resource files can be be stored 
 
83
to \&'$(HOME)/\&.ecasound/\&'\&. For instance you can 
 
84
add your own presets definitions to 
 
85
\&'$(HOME)/\&.ecasound/effect_presets\&'\&.
 
86
.IP 
 
87
.IP "resource-file-genosc-envelopes"
 
88
Configuration file for generic oscillators\&. Is located in the 
 
89
resource directory\&. Defaults to \fIgeneric_oscillators\fP\&.
 
90
.IP 
 
91
.IP "resource-file-effect-presets"
 
92
Configuration file for effect presets\&. Is located in the 
 
93
resource directory\&. Defaults to \fIeffect_presets\fP\&.
 
94
.IP 
 
95
.IP "ladspa-plugin-directory"
 
96
Directory containing LADSPA effect plugins\&. Defaults to \fI{prefix-dir}/lib/ladspa\fP\&.
 
97
If environment variable \fILADSPA_PATH\fP exists, directories
 
98
specified in it are automatically searched for plugins\&.
 
99
Note! To match the syntax of the \fILADSPA_PATH\fP environment 
 
100
variable, \&'ladspa-plugin-directory\&' can contain multiple
 
101
directories, separated by \&':\&' characters\&.
 
102
.IP 
 
103
.IP "ext-cmd-text-editor"
 
104
If \fIext-cmd-text-editor-use-getenv\fP is \fIfalse\fP or "EDITOR" 
 
105
is null, value of this field is used\&.
 
106
.IP 
 
107
.IP "ext-cmd-text-editor-use-getenv"
 
108
Should ecasound try to query environment variable "EDITOR"\&.
 
109
Defaults to \fItrue\fP\&.
 
110
.IP 
 
111
.IP "ext-cmd-mp3-input"
 
112
Command for starting mp3 input\&. Ecasound expects to read signed,
 
113
16bit, little-endian stereo audio samples from its standard
 
114
input\&. Ecsound will query other audio format parameters by parsing 
 
115
the mp3 file header\&. Before execution, %f is replaced with
 
116
path to the input mp3\&. If exists, "%o" is replaced with he
 
117
start offset in mp3 frames\&. Double-quotes and backslash-espacing 
 
118
can be used to include white-space to individual parameters\&.
 
119
By default, \fImpg123\fP is launched\&.
 
120
.IP 
 
121
.IP "ext-cmd-mp3-output"
 
122
Command for starting mp3 output\&. Ecasound will write stereo, 
 
123
signed, 16bit, little-endian samples to standard output\&. Sample
 
124
rate is configurable\&. Before execution, %f is replaced with 
 
125
path to the output mp3, %S with sample rate in kHz, and 
 
126
%B with encoding bitrate in kbps\&. Double-quotes and 
 
127
backslash-espacing can be used to include white-space to 
 
128
individual parameters\&. By default Ecasound will try to
 
129
launch \fIlame\fP\&. As a special exception (added to Ecasound
 
130
2\&.7\&.0), if the output program is "lame" and options 
 
131
include "--big-endian", Ecasound will detect this and output
 
132
big-endian samples\&.
 
133
.IP 
 
134
.IP "ext-cmd-ogg-input"
 
135
Command for starting Ogg Vorbis input\&. Ecasound expects that audio samples
 
136
are written to standard output\&. It should be noted that
 
137
Ecasound is not able to query the audio format parameters from
 
138
ogg files, so these need to be set manually by the user\&.
 
139
Before execution, %f is replaced with path to the input ogg\&. 
 
140
Double-quotes and backslash-espacing can be used to include white-space 
 
141
to individual parameters\&. By default Ecasound will try to
 
142
launch (ogg123)\&.
 
143
.IP 
 
144
.IP "ext-cmd-ogg-output"
 
145
Command for starting Ogg Vorbis output\&. Ecasound will write
 
146
samples in little-endian format to standard output\&. Other 
 
147
audio parameters are configurable\&. Before execution, %f is
 
148
replaced with path to the output ogg, %c, %s and %b with matching audio
 
149
format parameters, and %B with encoding bitrate in kbps\&.
 
150
Double-quotes and backslash-espacing can be used to include white-space to 
 
151
individual parameters\&. By default Ecasound will try to
 
152
launch (oggenc)\&.
 
153
.IP 
 
154
.IP "ext-cmd-mikmod"
 
155
Command for starting mikmod input\&. Ecasound expects that 
 
156
signed, 16bit, stereo audio samples are written to standard 
 
157
output\&. Before execution, %f is replaced with 
 
158
file path, and %s with selected sample rate\&. Double-quotes 
 
159
and backslash-espacing can be used to include white-space to 
 
160
individual parameters\&. By default Ecasound will try to launch
 
161
\fImikmod\fP\&.
 
162
.IP 
 
163
.IP "ext-cmd-timidity"
 
164
Command for starting timidity++ input\&. Ecasound expects that
 
165
signed, 16bit, stereo audio samples are written to standard
 
166
output\&. Before execution, %f is replaced with file path, and
 
167
%s with sample rate\&. Double-quotes and backslash-espacing can 
 
168
be used to include white-space to individual parameters\&.
 
169
By default Ecasound will try to launch \fItimidity\fP\&.
 
170
.IP 
 
171
.IP "ext-cmd-flac-input"
 
172
Command for starting FLAC input\&. Ecasound expects that audio samples
 
173
are written to standard output\&. It should be noted that
 
174
Ecasound is not able to query the audio format parameters from
 
175
FLAC files, so these need to be set manually by the user\&. 
 
176
Before execution, %f is replaced with path to the input FLAC
 
177
file\&. Double-quotes and backslash-espacing can be used to include 
 
178
white-space to individual parameters\&. By default Ecasound will
 
179
try to launch (flac)\&.
 
180
.IP 
 
181
.IP "ext-cmd-flac-output"
 
182
Command for starting FLAC output\&. Ecasound will write
 
183
samples to standard output\&. All audio parameters are
 
184
configurable\&. Before execution, %f is replaced with path to
 
185
the output flac, %c, %b and %s with matching audio
 
186
format parameters, %I with either \&'signed\&' or \&'unsigned\&', and
 
187
%E with either \&'little\&' or \&'big\&'\&. Double-quotes and backslash-espacing 
 
188
can be used to include white-space to individual parameters\&. By default 
 
189
Ecasound will try to launch (flac)\&.
 
190
.IP 
 
191
.IP "ext-cmd-aac-input"
 
192
Command for starting AAC input\&. Ecasound expects that signed,
 
193
16bit, stereo, big-endian audio samplesare written to standard 
 
194
output\&. It should be noted that       Ecasound is not able to query 
 
195
the input sample rate, so this needs to be set manually by the user\&. 
 
196
Before execution, %f is replaced with path to the input AAC
 
197
file\&. Note! FAAC must be compiled with MP4 support\&. Double-quotes 
 
198
and backslash-espacing can be used to include white-space to 
 
199
individual parameters\&. By default Ecasound will try to 
 
200
laucnh \fIfaad\fP\&.
 
201
.IP 
 
202
.IP "ext-cmd-aac-output"
 
203
Command for starting AAC output\&. Ecasound will write big-endian
 
204
audio samples to standard output\&. All other audio parameters are
 
205
configurable\&. Before execution, %f is replaced with path to
 
206
the output AAC file, %c, %b and %s with matching audio format 
 
207
parameters\&. Note! FAAC must be compiled with MP4 support\&. Double-quotes 
 
208
and backslash-espacing can be used to include white-space to 
 
209
individual parameters\&. By default Ecasound will try to launch
 
210
\fIfaac\fP\&.
 
211
.IP 
 
212
.SH "DEPRECATED"
 
213
 
 
214
.PP 
 
215
.IP "ext-cmd-wave-editor"
 
216
 
 
217
.IP 
 
218
.SH "SEE ALSO"
 
219
 
 
220
.PP 
 
221
ecasound (1), ecatools (1), ecasound-iam (1)
 
222
.PP 
 
223
.SH "AUTHOR"
 
224
 
 
225
.PP 
 
226
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>