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

« back to all changes in this revision

Viewing changes to Documentation/ecasoundrc.5

  • Committer: Bazaar Package Importer
  • Author(s): Junichi Uekawa
  • Date: 2009-11-02 18:22:35 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20091102182235-4ngh7699dmkgonyu
Tags: 2.7.0-1
* New upstream release.
* Depend on libreadline-dev instead of libreadline5-dev by request of
  Mattias Klose. It's now libreadline6-dev. (closes: #553748)
* Update menu file to use section Applications/ instead of Apps/.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "ecasoundrc" "5" "27\&.09\&.2008" "" "Multimedia software"
 
1
.TH "ecasoundrc" "5" "22\&.03\&.2009" "" "Multimedia software"
2
2
 
3
3
.PP 
4
4
.SH "NAME"
102
102
.IP 
103
103
.IP "ext-cmd-text-editor"
104
104
If \fIext-cmd-text-editor-use-getenv\fP is \fIfalse\fP or "EDITOR" 
105
 
is null, value of this field is used\&. Defaults to \fIpico\fP\&.
 
105
is null, value of this field is used\&.
106
106
.IP 
107
107
.IP "ext-cmd-text-editor-use-getenv"
108
108
Should ecasound try to query environment variable "EDITOR"\&.
109
109
Defaults to \fItrue\fP\&.
110
110
.IP 
111
111
.IP "ext-cmd-mp3-input"
112
 
Command for starting mp3 input\&. Ecasound expects that signed,
113
 
16bit, stereo audio samples are written to standard output\&.
114
 
Ecasound will query other audio format parameters by parsing 
 
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
115
the mp3 file header\&. Before execution, %f is replaced with
116
116
path to the input mp3\&. If exists, "%o" is replaced with he
117
117
start offset in mp3 frames\&. Double-quotes and backslash-espacing 
118
118
can be used to include white-space to individual parameters\&.
119
 
Defaults to \fImpg123 --stereo -r -b 0 -q -s -k %o %f\fP\&.
 
119
By default, \fImpg123\fP is launched\&.
120
120
.IP 
121
121
.IP "ext-cmd-mp3-output"
122
122
Command for starting mp3 output\&. Ecasound will write stereo, 
125
125
path to the output mp3, %S with sample rate in kHz, and 
126
126
%B with encoding bitrate in kbps\&. Double-quotes and 
127
127
backslash-espacing can be used to include white-space to 
128
 
individual parameters\&.Defaults to \fIlame -b %B -s %S -x -S - %f\fP\&.
 
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\&.
129
133
.IP 
130
134
.IP "ext-cmd-ogg-input"
131
135
Command for starting Ogg Vorbis input\&. Ecasound expects that audio samples
134
138
ogg files, so these need to be set manually by the user\&.
135
139
Before execution, %f is replaced with path to the input ogg\&. 
136
140
Double-quotes and backslash-espacing can be used to include white-space 
137
 
to individual parameters\&. Defaults to 
138
 
\fIogg123 -d raw -o byteorder:%E --file=- %f\fP\&.
 
141
to individual parameters\&. By default Ecasound will try to
 
142
launch (ogg123)\&.
139
143
.IP 
140
144
.IP "ext-cmd-ogg-output"
141
145
Command for starting Ogg Vorbis output\&. Ecasound will write
144
148
replaced with path to the output ogg, %c, %s and %b with matching audio
145
149
format parameters, and %B with encoding bitrate in kbps\&.
146
150
Double-quotes and backslash-espacing can be used to include white-space to 
147
 
individual parameters\&. Defaults to 
148
 
\fIoggenc -b %B --raw --raw-bits=%b --raw-chan=%c --raw-rate=%s --raw-endianness 0 --output=%f -\fP\&.
 
151
individual parameters\&. By default Ecasound will try to
 
152
launch (oggenc)\&.
149
153
.IP 
150
154
.IP "ext-cmd-mikmod"
151
155
Command for starting mikmod input\&. Ecasound expects that 
153
157
output\&. Before execution, %f is replaced with 
154
158
file path, and %s with selected sample rate\&. Double-quotes 
155
159
and backslash-espacing can be used to include white-space to 
156
 
individual parameters\&. Defaults to \fImikmod -d stdout -o 16s -q -f %s -p 0 --noloops %f\fP\&.
 
160
individual parameters\&. By default Ecasound will try to launch
 
161
\fImikmod\fP\&.
157
162
.IP 
158
163
.IP "ext-cmd-timidity"
159
164
Command for starting timidity++ input\&. Ecasound expects that
161
166
output\&. Before execution, %f is replaced with file path, and
162
167
%s with sample rate\&. Double-quotes and backslash-espacing can 
163
168
be used to include white-space to individual parameters\&.
164
 
Defaults to \fItimidity -Or1S -id -s %s -o - %f\fP\&.
 
169
By default Ecasound will try to launch \fItimidity\fP\&.
165
170
.IP 
166
171
.IP "ext-cmd-flac-input"
167
172
Command for starting FLAC input\&. Ecasound expects that audio samples
170
175
FLAC files, so these need to be set manually by the user\&. 
171
176
Before execution, %f is replaced with path to the input FLAC
172
177
file\&. Double-quotes and backslash-espacing can be used to include 
173
 
white-space to individual parameters\&.Defaults to \fIflac -d -c %f\fP\&.
 
178
white-space to individual parameters\&. By default Ecasound will
 
179
try to launch (flac)\&.
174
180
.IP 
175
181
.IP "ext-cmd-flac-output"
176
182
Command for starting FLAC output\&. Ecasound will write
179
185
the output flac, %c, %b and %s with matching audio
180
186
format parameters, %I with either \&'signed\&' or \&'unsigned\&', and
181
187
%E with either \&'little\&' or \&'big\&'\&. Double-quotes and backslash-espacing 
182
 
can be used to include white-space to individual parameters\&. Defaults 
183
 
to \fIflac -o %f --force-raw-format --channels=%c --bps=%b --sample-rate=%s --sign=%I --endian=%E -\fP\&.
 
188
can be used to include white-space to individual parameters\&. By default 
 
189
Ecasound will try to launch (flac)\&.
184
190
.IP 
185
191
.IP "ext-cmd-aac-input"
186
192
Command for starting AAC input\&. Ecasound expects that signed,
190
196
Before execution, %f is replaced with path to the input AAC
191
197
file\&. Note! FAAC must be compiled with MP4 support\&. Double-quotes 
192
198
and backslash-espacing can be used to include white-space to 
193
 
individual parameters\&. Defaults to \fIfaad -w -b 1 -f 2 -d %f\fP\&.
 
199
individual parameters\&. By default Ecasound will try to 
 
200
laucnh \fIfaad\fP\&.
194
201
.IP 
195
202
.IP "ext-cmd-aac-output"
196
203
Command for starting AAC output\&. Ecasound will write big-endian
199
206
the output AAC file, %c, %b and %s with matching audio format 
200
207
parameters\&. Note! FAAC must be compiled with MP4 support\&. Double-quotes 
201
208
and backslash-espacing can be used to include white-space to 
202
 
individual parameters\&. Defaults to \fIfaac -P -o %f -R %s -B %b -C %c -\fP\&.
 
209
individual parameters\&. By default Ecasound will try to launch
 
210
\fIfaac\fP\&.
203
211
.IP 
204
212
.SH "DEPRECATED"
205
213