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

« back to all changes in this revision

Viewing changes to Documentation/ecasoundrc_manpage.yo

  • 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:
2
2
 
3
3
manpage(ecasoundrc)
4
4
       (5)
5
 
       (27.09.2008)
 
5
       (22.03.2009)
6
6
       ()
7
7
       (Multimedia software)
8
8
 
107
107
 
108
108
        dit(ext-cmd-text-editor)
109
109
        If em(ext-cmd-text-editor-use-getenv) is em(false) or "EDITOR" 
110
 
        is null, value of this field is used. Defaults to em(pico).
 
110
        is null, value of this field is used.
111
111
 
112
112
        dit(ext-cmd-text-editor-use-getenv)
113
113
        Should ecasound try to query environment variable "EDITOR".
114
114
        Defaults to em(true).
115
115
 
116
116
        dit(ext-cmd-mp3-input)
117
 
        Command for starting mp3 input. Ecasound expects that signed,
118
 
        16bit, stereo audio samples are written to standard output.
119
 
        Ecasound will query other audio format parameters by parsing 
 
117
        Command for starting mp3 input. Ecasound expects to read signed,
 
118
        16bit, little-endian stereo audio samples from its standard
 
119
        input. Ecsound will query other audio format parameters by parsing 
120
120
        the mp3 file header. Before execution, %f is replaced with
121
121
        path to the input mp3. If exists, "%o" is replaced with he
122
122
        start offset in mp3 frames. Double-quotes and backslash-espacing 
123
123
        can be used to include white-space to individual parameters.
124
 
        Defaults to em(mpg123 --stereo -r -b 0 -q -s -k %o %f).
 
124
        By default, em(mpg123) is launched.
125
125
 
126
126
        dit(ext-cmd-mp3-output)
127
127
        Command for starting mp3 output. Ecasound will write stereo, 
130
130
        path to the output mp3, %S with sample rate in kHz, and 
131
131
        %B with encoding bitrate in kbps. Double-quotes and 
132
132
        backslash-espacing can be used to include white-space to 
133
 
        individual parameters.Defaults to em(lame -b %B -s %S -x -S - %f).
 
133
        individual parameters. By default Ecasound will try to
 
134
        launch em(lame). As a special exception (added to Ecasound
 
135
        2.7.0), if the output program is "lame" and options 
 
136
        include "--big-endian", Ecasound will detect this and output
 
137
        big-endian samples.
134
138
 
135
139
        dit(ext-cmd-ogg-input)
136
140
        Command for starting Ogg Vorbis input. Ecasound expects that audio samples
139
143
        ogg files, so these need to be set manually by the user.
140
144
        Before execution, %f is replaced with path to the input ogg. 
141
145
        Double-quotes and backslash-espacing can be used to include white-space 
142
 
        to individual parameters. Defaults to 
143
 
        em(ogg123 -d raw -o byteorder:%E --file=- %f).
 
146
        to individual parameters. By default Ecasound will try to
 
147
        launch (ogg123).
144
148
 
145
149
        dit(ext-cmd-ogg-output)
146
150
        Command for starting Ogg Vorbis output. Ecasound will write
149
153
        replaced with path to the output ogg, %c, %s and %b with matching audio
150
154
        format parameters, and %B with encoding bitrate in kbps.
151
155
        Double-quotes and backslash-espacing can be used to include white-space to 
152
 
        individual parameters. Defaults to 
153
 
        em(oggenc -b %B --raw --raw-bits=%b --raw-chan=%c --raw-rate=%s --raw-endianness 0 --output=%f -).
 
156
        individual parameters. By default Ecasound will try to
 
157
        launch (oggenc).
154
158
 
155
159
        dit(ext-cmd-mikmod)
156
160
        Command for starting mikmod input. Ecasound expects that 
158
162
        output. Before execution, %f is replaced with 
159
163
        file path, and %s with selected sample rate. Double-quotes 
160
164
        and backslash-espacing can be used to include white-space to 
161
 
        individual parameters. Defaults to em(mikmod -d stdout -o 16s -q -f %s -p 0 --noloops %f).
 
165
        individual parameters. By default Ecasound will try to launch
 
166
        em(mikmod).
162
167
 
163
168
        dit(ext-cmd-timidity)
164
169
        Command for starting timidity++ input. Ecasound expects that
166
171
        output. Before execution, %f is replaced with file path, and
167
172
        %s with sample rate. Double-quotes and backslash-espacing can 
168
173
        be used to include white-space to individual parameters.
169
 
        Defaults to em(timidity -Or1S -id -s %s -o - %f).
 
174
        By default Ecasound will try to launch em(timidity).
170
175
 
171
176
        dit(ext-cmd-flac-input)
172
177
        Command for starting FLAC input. Ecasound expects that audio samples
175
180
        FLAC files, so these need to be set manually by the user. 
176
181
        Before execution, %f is replaced with path to the input FLAC
177
182
        file. Double-quotes and backslash-espacing can be used to include 
178
 
        white-space to individual parameters.Defaults to em(flac -d -c %f).
 
183
        white-space to individual parameters. By default Ecasound will
 
184
        try to launch (flac).
179
185
 
180
186
        dit(ext-cmd-flac-output)
181
187
        Command for starting FLAC output. Ecasound will write
184
190
        the output flac, %c, %b and %s with matching audio
185
191
        format parameters, %I with either 'signed' or 'unsigned', and
186
192
        %E with either 'little' or 'big'. Double-quotes and backslash-espacing 
187
 
        can be used to include white-space to individual parameters. Defaults 
188
 
        to em(flac -o %f --force-raw-format --channels=%c --bps=%b --sample-rate=%s --sign=%I --endian=%E -).
 
193
        can be used to include white-space to individual parameters. By default 
 
194
        Ecasound will try to launch (flac).
189
195
 
190
196
        dit(ext-cmd-aac-input)
191
197
        Command for starting AAC input. Ecasound expects that signed,
195
201
        Before execution, %f is replaced with path to the input AAC
196
202
        file. Note! FAAC must be compiled with MP4 support. Double-quotes 
197
203
        and backslash-espacing can be used to include white-space to 
198
 
        individual parameters. Defaults to em(faad -w -b 1 -f 2 -d %f).
 
204
        individual parameters. By default Ecasound will try to 
 
205
        laucnh em(faad).
199
206
 
200
207
        dit(ext-cmd-aac-output)
201
208
        Command for starting AAC output. Ecasound will write big-endian
204
211
        the output AAC file, %c, %b and %s with matching audio format 
205
212
        parameters. Note! FAAC must be compiled with MP4 support. Double-quotes 
206
213
        and backslash-espacing can be used to include white-space to 
207
 
        individual parameters. Defaults to em(faac -P -o %f -R %s -B %b -C %c -).
 
214
        individual parameters. By default Ecasound will try to launch
 
215
        em(faac).
208
216
 
209
217
enddit()
210
218