aboutsummaryrefslogtreecommitdiff
path: root/utils/tinyplay.1
diff options
context:
space:
mode:
authorTaylor Holberton <taylorcholberton@gmail.com>2016-11-19 10:12:44 -0800
committerTaylor Holberton <taylorcholberton@gmail.com>2016-11-19 10:12:44 -0800
commit84a74a7882e12e9dd8713f7d5dd084d4b41c5720 (patch)
tree895de75a4b86581fbfe77e73eee7aeba6a3d39b0 /utils/tinyplay.1
parent969ba7919d2fccd7b52688b446f73d8248b5e1f4 (diff)
updated man page
Diffstat (limited to 'utils/tinyplay.1')
-rw-r--r--utils/tinyplay.119
1 files changed, 10 insertions, 9 deletions
diff --git a/utils/tinyplay.1 b/utils/tinyplay.1
index bfd81be..56bac12 100644
--- a/utils/tinyplay.1
+++ b/utils/tinyplay.1
@@ -14,47 +14,48 @@ Options can be used to specify various hardware parameters to open the PCM with.
.SH OPTIONS
.TP
-\fB\-D\fR \fIcard\fR
+\fB\-D, --card\fR \fIcard\fR
Card number of the PCM.
The default is 0.
.TP
-\fB\-d\fR \fIdevice\fR
+\fB\-d, --device\fR \fIdevice\fR
Device number of the PCM.
The default is 0.
.TP
-\fB\-c\fR \fIchannels\fR
+\fB\-c, --channels\fR \fIchannels\fR
Number of channels the PCM will have.
This option is only valid for raw file types.
The default is 2 for raw file types.
.TP
-\fB\-r\fR \fIrate\fR
+\fB\-r, --rate\fR \fIrate\fR
Number of frames per second of the PCM.
This option is only valid for raw file types.
The default is 48000 for raw file types.
.TP
-\fB\-i\fR \fIfile-type\fR
+\fB\-i, --file-type\fR \fIfile-type\fR
The file type used for playback.
Available types are \fIraw\fR and \fIwav\fR.
Specifying \fIraw\fR means that \fIchannels\fR, \fIrate\fR and \fIbits\fR may have to be specified as well.
-The default is \fIwav\fR.
+By default, the file type is determined by the file name.
+Specifying the file type with this option will take precedent over the one determined by the file name.
.TP
-\fB\-b\fR \fIbits\fR
+\fB\-b, --bits\fR \fIbits\fR
Number of bits per sample the PCM will have.
This option is only valid for raw file types.
The default is 16 for raw file types.
.TP
-\fB\-p\fR \fIperiod_size\fR
+\fB\-p, --period-size\fR \fIperiod_size\fR
Number of frames in a period.
The default is 1024.
.TP
-\fB\-n\fR \fIperiods\fR
+\fB\-n, --period-count\fR \fIperiods\fR
Number of periods the PCM will have.
The default is 4.