← Back to branch summary

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

« back to all changes in this revision

Viewing changes to Documentation/ecasignalview.1

  • Committer: Bazaar Package Importer
  • Author(s): Junichi Uekawa
  • Date: 2008-09-26 09:58:52 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20080926095852-k3v9ewhmxpaltusw
Tags: 2.5.2-3
yodl 2.13.1 removed --unique-output option. Remove --unique-output
accordingly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Documentation/ecasignalview.1
1
 
.TH "ecatools" "1" "12\&.11\&.2005" "" "Multimedia software" 
 
1
.TH "ecatools" "1" "12\&.11\&.2005" "" "Multimedia software"
 
2
 
2
3
.PP 
3
 
.SH "NAME" 
 
4
.SH "NAME"
4
5
ecatools \- audio processing utils based on ecasound
5
6
.PP 
6
 
.SH "SYNOPSIS" 
 
7
.SH "SYNOPSIS"
7
8
\fBecaconvert\fP \&.extension file1 [ file2 \&.\&.\&. fileN ]
8
9
.PP 
9
10
\fBecafixdc\fP file1 [ file2 \&.\&.\&. fileN ]
18
19
.PP 
19
20
\fBecasignalview\fP [ options ] [ input ] [ output ]
20
21
.PP 
21
 
.SH "DESCRIPTION" 
 
22
.SH "DESCRIPTION"
 
23
 
22
24
.PP 
23
25
Ecatools are simple command line utils for audio file processing\&.
24
26
Each tool is designed to perform one specific operation\&. Most of 
92
94
on to play the next one\&. Issuing Ctrl-C twice (within one second), 
93
95
will cause ecaplay to exit\&.
94
96
.PP 
95
 
.IP "-d:debuglevel" 
 
97
.IP "-d:debuglevel"
96
98
Set libecasound debug level\&. See ecasound(1)\&.
97
99
.IP 
98
 
.IP "-f" 
 
100
.IP "-f"
99
101
Flush the playlist contents\&. See also 
100
102
options \fI-l, -p and -q\fP\&.
101
103
.IP 
102
 
.IP "-h" 
 
104
.IP "-h"
103
105
Print usage information and exit\&.
104
106
.IP 
105
 
.IP "-k:number" 
 
107
.IP "-k:number"
106
108
Skip \&'number\&' of files\&.
107
109
.IP 
108
 
.IP "-l" 
 
110
.IP "-l"
109
111
List the current playlist contents to stdout\&. See also 
110
112
options \fI-f, -p and -q\fP\&.
111
113
.IP 
112
 
.IP "-o:output_device" 
 
114
.IP "-o:output_device"
113
115
Use \&'output_device\&' instead of the default output device 
114
116
(as specified in \fI~/\&.ecasound/ecasoundrc\fP)\&. Syntax is same
115
117
as used by "-o" ecasound option (see ecasound(1) man page)\&.
116
118
This option overrides the \fIECAPLAY_OUTPUT_DEVICE\fP environment
117
119
variable (more info below)\&.
118
120
.IP 
119
 
.IP "-p" 
 
121
.IP "-p"
120
122
Play tracks in the playlist (in looped mode)\&. See also 
121
123
options \fI-f, -l and -q\fP\&.
122
124
.IP 
123
 
.IP "-q" 
 
125
.IP "-q"
124
126
Queue new tracks to the playlist\&. All filenames given on
125
127
the command-line will be added to the the playlist\&. It is 
126
128
possible to queue new tracks while another instance of 
127
129
ecaplay is using the playlist\&. See also options \fI-f, -l 
128
130
and -p\fP\&.
129
131
.IP 
130
 
.PP 
131
132
\fBECASIGNALVIEW\fP
132
133
.PP 
133
134
Ecasignalview is meant for monitoring signal amplitude and peak 
134
135
statistics\&. It accepts the following options:
135
136
.PP 
136
 
.IP "input" 
 
137
.IP "input"
137
138
The first option not starting with a \&'-\&' is interpreted 
138
139
as an input string\&. This can be a device or a filename\&. All formats
139
140
supported by libecasound are accepted\&. Defaults to \&'/dev/dsp\&'\&.
140
141
.IP 
141
 
.IP "output" 
 
142
.IP "output"
142
143
Similarly to input, second option not starting with a \&'-\&'
143
144
is interpreted as output\&. Defaults to \&'null\&'\&.
144
145
.IP 
145
 
.IP "-b:buffersize" 
 
146
.IP "-b:buffersize"
146
147
Buffersize in sample frames\&. Defaults to 128\&.
147
148
.IP 
148
 
.IP "-c" 
 
149
.IP "-c"
149
150
Enable cumulative mode\&. Counters are not reseted after refresh\&.
150
151
\fI*deprecated*\fP
151
152
.IP 
152
 
.IP "-d" 
 
153
.IP "-d"
153
154
Enable debug mode\&.
154
155
.IP 
155
 
.IP "-f:format_string" 
 
156
.IP "-f:format_string"
156
157
Specify default audio format\&. See ecasound(1) for details\&.
157
158
.IP 
158
 
.IP "-r:rate_msec" 
 
159
.IP "-r:rate_msec"
159
160
Specify screen refresh rate in milliseconds\&.
160
161
.IP 
161
 
.IP "-I" 
 
162
.IP "-I"
162
163
Use linear scale for showing audio sample amplitude\&.
163
164
.IP 
164
 
.IP "-L" 
 
165
.IP "-L"
165
166
Use logarithmic scale for showing audio sample amplitude\&.
166
167
.IP 
167
 
.IP "-G, -B, -M*, -r, -z" 
 
168
.IP "-G, -B, -M*, -r, -z"
168
169
Ecasound options use to modify the engine behaviour, see 
169
170
ecasound(1) manpage for details\&.
170
171
.IP 
171
 
.PP 
172
172
When ecasignalview is running, the following keyboard 
173
173
commands can be used to control the operation (requires 
174
174
system support for UNIX terminal interface control):
175
175
.PP 
176
 
.IP "spacebar" 
 
176
.IP "spacebar"
177
177
Reset statistics (max-peak, avg-amplitude and clipped
178
178
samples count)\&.
179
179
.IP 
180
 
.IP "q or Q or Esc" 
 
180
.IP "q or Q or Esc"
181
181
Quit ecasignalview\&.
182
182
.IP 
183
 
.PP 
184
183
It is also possible to reset the max-peak and clipped-samples 
185
184
counters by sending a SIGHUP signal to the process (i\&.e\&.
186
185
from another console: "killall -v -HUP ecasignalview")\&.
189
188
from "Ecasound User\&'s Guide" (see \&'\&'http://www\&.eca\&.cx/ecasound 
190
189
-> Documentation\&'\&')\&.
191
190
.PP 
192
 
.SH "ENVIRONMENT" 
 
191
.SH "ENVIRONMENT"
 
192
 
193
193
.PP 
194
194
\fIECASOUND\fP
195
195
Path to the ecasound executable\&. Used by many ecatools\&.
198
198
Device ecaplay should use for audio output\&. Same syntax
199
199
as for ecaplay/ecasound "-o" option\&.
200
200
.PP 
201
 
.SH "FILES" 
 
201
.SH "FILES"
 
202
 
202
203
.PP 
203
204
\fI~/\&.ecasound/ecasoundrc\fP
204
205
The default ecasound resource file\&. See ecasoundrc(5)
208
209
File used to store the ecaplay playlist (one track per
209
210
line with full path)\&.
210
211
.PP 
211
 
.SH "SEE ALSO" 
 
212
.SH "SEE ALSO"
 
213
 
212
214
.PP 
213
215
ecasound (1), ecalength(1), "HTML docs in the Documentation subdirectory"
214
216
.PP 
215
 
.SH "AUTHOR" 
 
217
.SH "AUTHOR"
 
218
 
216
219
.PP 
217
 
Kai Vehmanen, <kvehmanen -at- eca -dot- cx>
 
220
Kai Vehmanen, <kvehmanen -at- eca -dot- cx <kvehmanen -at- eca -dot- cx>>