← Back to branch summary

~ubuntu-branches/ubuntu/trusty/alsa-utils/trusty

« back to all changes in this revision

Viewing changes to aplay/arecord.1

  • Committer: Package Import Robot
  • Author(s): Luke Yelavich
  • Date: 2013-07-26 10:56:44 UTC
  • mfrom: (1.2.17) (93.1.1 saucy-proposed)
  • Revision ID: package-import@ubuntu.com-20130726105644-kim9enke2jnozg73
Tags: 1.0.27.1-1ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Move init script volume settings to new alsactl database:
    + Set sane level for 'Speaker' and 'Headphone', needed for Dell Mini 9
      and Dell E series
    + ute PC Beep on hda cards that support it during initial volume setup
    + Mute *Analog/Digital Control for Creative cards by default
    + Default Digital Input Source to be Digital Mic 1 so that users
      with digital mic will be able to use it out of the box
    + Mute "IEC958 Optical Raw" by default
    + Set sane level for headphone 1 for Dell Studio XPS with 2.6.30
    + Prefer built-in digital mics on newer Dells
    + Unmute 'Line HP Swap' for Dove boards
    + Set reasonable volume levels for VMWare guests using snd.ens1371
  - debian/README.init.cs4236: Include in /usr/share/doc/alsa-utils so that
    users of snd-cs4236 (e.g., ThinkPad 600) can have audible sound
  - debian/patches/unset_pulse_internal.patch: We don't want alsamixer to
    show the pulse mixer by default, since it can be controlled from
    pulseaudio itself
  - Use upstart jobs for storing/restoring card settings
  - Add udev rule to apply UCM profiles for panda and equivalent hardware
  - Add Vcs-Bzr field
* Create a new upstart job for the alsa state daemon, and adjust the
  other upstart jobs accordingly
* Put the daemon file in /var/lib/alsa

Show diffs side-by-side

added added

removed removed

Lines of Context:
aplay/arecord.1
1
1
.TH APLAY 1 "1 January 2010"
2
2
.SH NAME
3
 
arecord, aplay \- command-line sound recorder and player for ALSA 
 
3
arecord, aplay \- command\-line sound recorder and player for ALSA 
4
4
soundcard driver
5
5
.SH SYNOPSIS
6
6
\fBarecord\fP [\fIflags\fP] [filename]
8
8
\fBaplay\fP [\fIflags\fP] [filename [filename]] ...
9
9
 
10
10
.SH DESCRIPTION
11
 
\fBarecord\fP is a command-line soundfile recorder for the ALSA soundcard
 
11
\fBarecord\fP is a command\-line soundfile recorder for the ALSA soundcard
12
12
driver. It supports several file formats and multiple soundcards with
13
13
multiple devices. If recording with interleaved mode samples the file is
14
14
automatically split before the 2GB filesize.
81
81
Min ticks to sleep. The default is not to sleep.
82
82
.TP
83
83
\fI\-M, \-\-mmap\fP            
84
 
Use memory-mapped (mmap) I/O mode for the audio stream.
 
84
Use memory\-mapped (mmap) I/O mode for the audio stream.
85
85
If this option is not set, the read/write I/O mode will be used.
86
86
.TP
87
87
\fI\-N, \-\-nonblock\fP          
88
 
Open the audio device in non-blocking mode. If the device is busy the program will exit immediately.
 
88
Open the audio device in non\-blocking mode. If the device is busy the program will exit immediately.
89
89
If this option is not set the program will block until the audio device is available again.
90
90
.TP
91
91
\fI\-F, \-\-period\-time=#\fP     
120
120
is given twice or three times.
121
121
.TP
122
122
\fI\-V, \-\-vumeter=TYPE\fP
123
 
Specifies the VU-meter type, either \fIstereo\fP or \fImono\fP.
124
 
The stereo VU-meter is available only for 2-channel stereo samples
 
123
Specifies the VU\-meter type, either \fIstereo\fP or \fImono\fP.
 
124
The stereo VU\-meter is available only for 2\-channel stereo samples
125
125
with interleaved format.
126
126
.TP
127
127
\fI\-I, \-\-separate\-channels\fP 
141
141
Allow interactive operation via stdin.
142
142
Currently only pause/resume via space or enter key is implemented.
143
143
.TP
 
144
\fI-m, \-\-chmap=ch1,ch2,...\fP
 
145
Give the channel map to override or follow.  Pass channel position
 
146
strings like \fIFL\fP, \fIFR\fP, etc.
 
147
 
 
148
If a device supports the override of the channel map, \fBaplay\fP
 
149
tries to pass the given channel map.
 
150
If it doesn't support the channel map override but still it provides
 
151
the channel map information, \fBaplay\fP tries to rearrange the
 
152
channel order in the buffer to match with the returned channel map
 
153
from the device.
 
154
.TP
144
155
\fI\-\-disable\-resample\fP
145
156
Disable automatic rate resample.
146
157
.TP
162
173
Minimum value is 1.
163
174
.TP
164
175
\fI\-\-test\-nowait\fP
165
 
Do not wait for the ring buffer--eats the whole CPU.
 
176
Do not wait for the ring buffer \(hy eats the whole CPU.
166
177
.TP
167
178
\fI\-\-max\-file\-time\fP
168
179
While recording, when the output file has been accumulating
177
188
send signals to it.
178
189
.TP
179
190
\fI\-\-use\-strftime\fP
180
 
When recording, interpret %-codes in the file name parameter using
 
191
When recording, interpret %\-codes in the file name parameter using
181
192
the strftime facility whenever the output file is opened.  The
182
193
important strftime codes are: %Y is the year, %m month, %d day of
183
194
the month, %H hour, %M minute and %S second.  In addition, %v is
184
195
the file number, starting at 1.  When this option is specified,
185
196
intermediate directories for the output file are created automatically.
186
197
This option has no effect if \-\-separate\-channels is specified.
 
198
.TP
 
199
\fI\-\-dump\-hw\-params\fP
 
200
Dump hw_params of the device preconfigured status to stderr. The dump
 
201
lists capabilities of the selected device such as supported formats,
 
202
sampling rates, numbers of channels, period and buffer bytes/sizes/times.
 
203
For raw device hw:X this option basically lists hardware capabilities of
 
204
the soundcard.
 
205
.TP
 
206
\fI\-\-fatal\-errors\fP
 
207
Disables recovery attempts when errors (e.g. xrun) are encountered; the
 
208
aplay process instead aborts immediately.
187
209
 
188
210
.SH SIGNALS
189
211
When recording, SIGINT, SIGTERM and SIGABRT will close the output 
196
218
.TP
197
219
\fBaplay \-c 1 \-t raw \-r 22050 \-f mu_law foobar\fR
198
220
will play the raw file "foobar" as a
199
 
22050-Hz, mono, 8-bit, Mu-Law .au file. 
 
221
22050\-Hz, mono, 8\-bit, Mu\-Law .au file. 
200
222
 
201
223
.TP
202
224
\fBarecord \-d 10 \-f cd \-t wav \-D copy foobar.wav\fP
203
 
will record foobar.wav as a 10-second, CD-quality wave file, using the
 
225
will record foobar.wav as a 10\-second, CD\-quality wave file, using the
204
226
PCM "copy" (which might be defined in the user's .asoundrc file as:
205
227
.nf
206
228
pcm.copy {
213
235
.fi
214
236
 
215
237
.TP
216
 
\fBarecord \-t wav \-max-file_time 30 mon.wav\fP
 
238
\fBarecord \-t wav \-\-max\-file\-time 30 mon.wav\fP
217
239
Record from the default audio source in monaural, 8,000 samples
218
240
per second, 8 bits per sample.  Start a new file every
219
 
30 seconds.  File names are mon-nn.wav, where nn increases
220
 
from 01.  The file after mon-99.wav is mon-100.wav.
 
241
30 seconds.  File names are mon\-nn.wav, where nn increases
 
242
from 01.  The file after mon\-99.wav is mon\-100.wav.
221
243
 
222
244
.TP
223
 
\fBarecord \-f cd \-t wav \-max-file-time 3600 --use-strftime %Y/%m/%d/listen-%H-%M-%v.wav\fP
 
245
\fBarecord \-f cd \-t wav \-\-max\-file\-time 3600 \-\-use-strftime %Y/%m/%d/listen-%H-%M-%v.wav\fP
224
246
Record in stereo from the default audio source.  Create a new file
225
247
every hour.  The files are placed in directories based on their start dates
226
248
and have names which include their start times and file numbers.