Print this page
12287 errors in audio utility man pages
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1/audiorecord.1
+++ new/usr/src/man/man1/audiorecord.1
1 1 '\" te
2 2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
3 +.\" Copyright 2020 Peter Tribble.
3 4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 5 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
5 6 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 -.TH AUDIORECORD 1 "May 13, 2017"
7 +.TH AUDIORECORD 1 "Feb 8, 2020"
7 8 .SH NAME
8 9 audiorecord \- record an audio file
9 10 .SH SYNOPSIS
10 -.LP
11 11 .nf
12 -\fBaudiorecord\fR [\fB-af\fR] [\fB-v\fR \fIvol\fR] [\fB-c\fR \fIchannels\fR] [\fI-s\fR \fIrate\fR]
12 +\fBaudiorecord\fR [\fB-af\fR] [\fB-v\fR \fIvol\fR] [\fB-c\fR \fIchannels\fR] [\fB-s\fR \fIrate\fR]
13 13 [\fB-e\fR \fIencoding\fR] [\fB-t\fR \fItime\fR] [\fB-i\fR \fIinfo\fR] [\fB-d\fR \fIdev\fR]
14 - [\fB-T\fR \fBau\fR | \fBaif\fR[\fBf\fR] | \fBwav\fR] [\fIfile\fR[.\fBau\fR|.\fBaif\fR[\fBf\fR]]|.\fBwav\fR]
14 + [\fB-T\fR \fBau\fR|\fBaif\fR[\fBf\fR]|\fBwav\fR] [\fIfile\fR[.\fBau\fR|.\fBaif\fR[\fBf\fR]|.\fBwav\fR]]
15 15 .fi
16 16
17 17 .SH DESCRIPTION
18 -.LP
19 18 The \fBaudiorecord\fR utility copies audio data from the audio device to a
20 19 named audio file, or to the standard output if no filename is present. If no
21 20 output file is specified and standard output is a tty, the program exits with
22 21 an error message.
23 22 .sp
24 23 .LP
25 -By default, monaural audio data is recorded at 8 kHz and encoded in \fB-law\fR
24 +By default, monaural audio data is recorded at 8 kHz and encoded in \fBu-law\fR
26 25 format. If the audio device supports additional configurations, the \fB-c\fR,
27 26 \fB-s\fR, and \fB-e\fR options may be used to specify the data format. The
28 27 output file is prefixed by an audio file header that identifies the format of
29 28 the data encoded in the file.
30 29 .sp
31 30 .LP
32 31 Recording begins immediately and continues until a \fBSIGINT\fR signal (for
33 32 example, Control-c) is received. If the \fB-t\fR option is specified,
34 33 \fBaudiorecord\fR stops when the specified quantity of data has been recorded.
35 34 .sp
36 35 .LP
37 36 If the audio device is unavailable, that is, if another process currently has
38 37 read access, \fBaudiorecord\fR prints an error message and exits immediately.
39 38 .SH OPTIONS
40 -.LP
41 39 The following options are supported:
42 40 .sp
43 41 .ne 2
44 42 .na
45 -\fB\fB-\e?\fR\fR
43 +\fB\fB-?\fR\fR
46 44 .ad
47 45 .RS 24n
48 46 \fIHelp\fR: Prints a command line usage message.
49 47 .RE
50 48
51 49 .sp
52 50 .ne 2
53 51 .na
54 52 \fB\fB-a\fR\fR
55 53 .ad
56 54 .RS 24n
57 55 \fIAppend\fR: Appends the data on the end of the named audio file. The audio
58 56 device must support the audio data format of the existing file.
59 57 .RE
60 58
61 59 .sp
62 60 .ne 2
63 61 .na
64 62 \fB\fB-c\fR \fIchannels\fR\fR
65 63 .ad
66 64 .RS 24n
67 65 \fIChannels\fR: Specifies the number of audio channels (1 or 2). The value may
68 66 be specified as an integer or as the string \fBmono\fR or \fBstereo\fR. The
69 67 default value is \fBmono\fR.
70 68 .RE
71 69
72 70 .sp
73 71 .ne 2
74 72 .na
75 73 \fB\fB-d\fR \fIdev\fR\fR
76 74 .ad
77 75 .RS 24n
78 76 \fIDevice\fR: The \fIdev\fR argument specifies an alternate audio device from
79 77 which input should be taken. If the \fB-d\fR option is not specified, the
80 78 \fBAUDIODEV\fR environment variable is consulted (see below). Otherwise,
81 79 \fB/dev/audio\fR is used as the default audio device.
82 80 .RE
83 81
84 82 .sp
85 83 .ne 2
86 84 .na
87 85 \fB\fB-e\fR \fIencoding\fR\fR
88 86 .ad
89 87 .RS 24n
90 88 \fIEncoding\fR: Specifies the audio data encoding. This value may be one of
91 89 \fBulaw\fR, \fBalaw\fR, or \fBlinear\fR. The default encoding is \fBulaw\fR.
92 90 .RE
93 91
94 92 .sp
95 93 .ne 2
96 94 .na
97 95 \fB\fB-f\fR\fR
98 96 .ad
99 97 .RS 24n
100 98 \fIForce\fR: When the \fB-a\fR flag is specified, the sample rate of the audio
101 99 device must match the sample rate at which the original file was recorded. If
102 100 the \fB-f\fR flag is also specified, sample rate differences are ignored, with
103 101 a warning message printed on the standard error.
104 102 .RE
105 103
106 104 .sp
107 105 .ne 2
108 106 .na
109 107 \fB\fB-i\fR \fIinfo\fR\fR
110 108 .ad
111 109 .RS 24n
112 110 \fIInformation\fR: The `information' field of the output file header is set to
113 111 the string specified by the \fIinfo\fR argument. This option cannot be
114 112 specified in conjunction with the \fB-a\fR argument.
115 113 .RE
116 114
117 115 .sp
118 116 .ne 2
119 117 .na
120 118 \fB\fB-s\fR \fIrate\fR\fR
121 119 .ad
122 120 .RS 24n
123 121 \fISample Rate\fR: Specifies the sample rate, in samples per second. If a
124 122 number is followed by the letter \fBk\fR, it is multiplied by 1000 (for
125 123 example, 44.1k = 44100). The default sample rate is 8 kHz.
126 124 .RE
127 125
128 126 .sp
129 127 .ne 2
130 128 .na
131 129 \fB\fB-t\fR \fItime\fR\fR
132 130 .ad
133 131 .RS 24n
134 132 \fITime\fR: The \fItime\fR argument specifies the maximum length of time to
135 133 record. Time can be specified as a floating-point value, indicating the number
136 134 of seconds, or in the form: \fIhh:mm:ss.dd\fR, where the hour and minute
137 135 specifications are optional.
138 136 .RE
139 137
140 138 .sp
141 139 .ne 2
142 140 .na
143 141 \fB\fB-T\fR \fBau\fR | \fBaif\fR[\fBf\fR] | \fBwav\fR\fR
144 142 .ad
145 143 .RS 24n
146 144 Specifies the audio file type to create. If the \fB-a\fR option is used, the
147 145 file type must match the file to which it is being appended. Regardless of the
148 146 file suffix, the type is set as specified in this option. If this option is not
149 147 specified, the file suffix determines the type.
150 148 .RE
151 149
152 150 .sp
153 151 .ne 2
154 152 .na
155 153 \fB\fB-v\fR \fIvol\fR\fR
156 154 .ad
157 155 .RS 24n
|
↓ open down ↓ |
102 lines elided |
↑ open up ↑ |
158 156 \fIVolume\fR: The recording gain is set to the specified value before recording
159 157 begins, and is reset to its previous level when \fBaudiorecord\fR exits. The
160 158 \fIvol\fR argument is an integer value between 0 and 100, inclusive. If this
161 159 argument is not specified, the input volume remains at the level most recently
162 160 set by any process.
163 161 .RE
164 162
165 163 .SH OPERANDS
166 164 .ne 2
167 165 .na
168 -\fB\fIfile\fR[\fB\&.au\fR|\fB\&.aif\fR[\fBf\fR]]|\fB\&.wav\fR\fR
166 +\fIfile\fR[\fB\&.au\fR|\fB\&.aif\fR[\fBf\fR]|\fB\&.wav\fR]
169 167 .ad
170 168 .sp .6
171 169 .RS 4n
172 170 \fIFile Specification\fR: The named audio file is rewritten, or appended. If no
173 171 filename is present, and standard output is not a tty, or if the special
174 172 filename "\fB\(mi\fR" is specified, output is directed to the standard
175 173 output.
176 174 .sp
177 175 If the \fB-T\fR option is not specified, the file suffix determines the type of
178 176 file. If the suffix is not recognized, the default is \fB\&.au\fR. If the
179 177 \fB-T\fR option \fBis\fR specified, that file type is used regardless of the
180 178 file suffix.
181 179 .RE
182 180
183 181 .SH USAGE
184 -.LP
185 182 See \fBlargefile\fR(5) for the description of the behavior of \fBaudiorecord\fR
186 -when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
183 +when encountering files greater than or equal to 2 Gbyte (2^31 bytes).
187 184 .SH ENVIRONMENT VARIABLES
188 185 .ne 2
189 186 .na
190 187 \fB\fBAUDIODEV\fR\fR
191 188 .ad
192 189 .RS 12n
193 190 The full path name of the audio device to record from, if no \fB-d\fR argument
194 191 is supplied. If the \fBAUDIODEV\fR variable is not set, \fB/dev/audio\fR is
195 192 used.
196 193 .RE
197 194
198 -.SH ATTRIBUTES
199 -.LP
200 -See \fBattributes\fR(5) for descriptions of the following attributes:
201 -.sp
202 -
203 -.sp
204 -.TS
205 -box;
206 -c | c
207 -l | l .
208 -ATTRIBUTE TYPE ATTRIBUTE VALUE
209 -_
210 -Architecture SPARC, x86
211 -_
212 -Interface Stability Committed
213 -.TE
214 -
215 195 .SH SEE ALSO
216 -.LP
217 196 \fBaudioconvert\fR(1), \fBaudioplay\fR(1),
218 -\fBattributes\fR(5), \fBlargefile\fR(5), \fBaudio\fR(7I)
197 +\fBlargefile\fR(5), \fBaudio\fR(7I)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX