← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/ecasound2.2/jaunty

« back to all changes in this revision

Viewing changes to Documentation/ecasoundrc_manpage.man

  • Committer: Bazaar Package Importer
  • Author(s): Junichi Uekawa
  • Date: 2008-03-23 21:42:49 UTC
  • mfrom: (3.1.6 hardy)
  • Revision ID: james.westby@ubuntu.com-20080323214249-evlfv3y1o8q747la
Tags: 2.4.6.1-2
http://bugs.debian.org/454890
* Bug fix: "FTBFS with GCC 4.3: missing #includes", thanks to Martin
  Michlmayr (Closes: #454890).
- 13_gcc4: updated

Show diffs side-by-side

added added

removed removed

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