aplay: add a paragraph for '--samples' ('-s') option to aplay manual

A '--samples' ('-s') option was added so that record/playback process is
terminated after handling the same number of PCM frames as a value of the
option. However this option is not described in aplay manual.

This commit adds a paragraph for the option.

Fixes: 3d44e2bc15 ('aplay: Add samples argument for playing/recording a given number of samples')
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Reviewed-by: Daniel Baluta daniel.baluta@nxp.com
Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
Takashi Sakamoto 2018-11-06 08:51:16 +09:00 committed by Takashi Iwai
parent f79082df38
commit 8b0cdffe09

View file

@ -77,6 +77,11 @@ Interrupt after # seconds.
A value of zero means infinity. A value of zero means infinity.
The default is zero, so if this option is omitted then the arecord process will run until it is killed. The default is zero, so if this option is omitted then the arecord process will run until it is killed.
.TP .TP
\fI\-s, \-\-samples=#\fP
Interrupt after tranmission of # PCM frames.
A value of zero means infinity.
The default is zero, so if this options is omitted then the record/playback process will run until it is killed.
.TP
\fI\-M, \-\-mmap\fP \fI\-M, \-\-mmap\fP
Use memory\-mapped (mmap) I/O mode for the audio stream. Use memory\-mapped (mmap) I/O mode for the audio stream.
If this option is not set, the read/write I/O mode will be used. If this option is not set, the read/write I/O mode will be used.