xref: /netbsd-src/usr.bin/audio/record/audiorecord.1 (revision 95d875fb90b1458e4f1de6950286ddcd6644bc61)
1.\"	$NetBSD: audiorecord.1,v 1.7 1999/09/23 15:42:06 dmcmahill Exp $
2.\"
3.\" Copyright (c) 1998-1999 Matthew R. Green
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. The name of the author may not be used to endorse or promote products
15.\"    derived from this software without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.Dd March 30, 1999
30.Dt AUDIORECORD 1
31.Os NetBSD
32.Sh NAME
33.Nm audiorecord
34.Nd record audio files
35.Sh SYNOPSIS
36.Nm
37.Op Fl afhV
38.Op Fl b Ar balance
39.Op Fl C Ar ctl
40.Op Fl d Ar device
41.Op Fl e Ar encoding
42.Op Fl i Ar info
43.Op Fl m Ar monvol
44.Op Fl P Ar precision
45.Op Fl p Ar input
46.Op Fl s Ar rate
47.Op Fl t Ar time
48.Op Fl v Ar volume
49.Op files
50.Sh DESCRIPTION
51The
52.Nm
53program copies the audio devices to the named audiofile, or the standard
54output if no file is named.
55The output file will contain a Sun/NeXT audio header.
56.Sh OPTIONS
57The following options are available:
58.Bl -tag -width 123456
59.It Fl a
60Append to the specified file, rather than overwriting.
61.It Fl b
62Set the balance to
63.Ar balance .
64This value must be between 0 and 63.
65.It Fl C
66Set the audio control device to be
67.Ar ctl .
68The default is
69.Pa /dev/audioctl0 .
70.It Fl d
71Set the audio device to be
72.Ar device .
73The default is
74.Pa /dev/audio0 .
75.It Fl e
76Set encoding to either
77.Dq alaw ,
78.Dq ulaw
79or
80.Dq linear .
81.It Fl f
82Force.  Normally when appending to audiofiles using the
83.Fl a
84option, the sample rates must match.  The
85.Fl f
86option will allow a discrepancy to be ignored.
87.It Fl h
88Print a help message.
89.It Fl i
90If the audio device cannot be opened, exit now rather than wait for it.
91.It Fl m
92Set the monitor volume.
93.It Fl P
94Set the precision.  This value is the number of bits per sample, and is
95normally either
96.Dq 8
97or
98.Dq 16 ,
99though the values
100.Dq 24
101and
102.Dq 32
103are also valid.
104.It Fl p
105Set the output port to
106.Ar port .
107The valid values of
108.Ar port
109are
110.Dq speaker ,
111.Dq headphone
112and
113.Dq line .
114.It Fl s
115Set the sampling rate.  This value is per-second.  Typical values are
1168000, 44100 and 48000, which are the telephone, CD Audio and DAT Audio
117default sampling rates.
118.It Fl t
119Sets the maximum amount of time to record.  Format is [hh:]mm:ss.
120.It Fl q
121Be quiet.
122.It Fl V
123Be verbose.
124.It Fl v
125Set the volume (gain) to
126.Ar volume .
127This value must be between 0 and 255.
128.El
129.Sh ENVIRONMENT
130.Bl -tag -width AUDIOCTLDEVICE
131.It AUDIOCTLDEVICE
132the audio control device to be used.
133.It AUDIODEVICE
134the audio device to be used.
135.El
136.Sh BUGS
137Many audio device hardware is limited in capabilities.  Any attempt
138to use an audio device beyond it's capabilities will result in an
139error.  This program is not finished and will become much more
140versatile in it's understanding of the audio device and the desired
141output.
142.Sh HISTORY
143The
144.Nm
145program was first seen in SunOS 5.  The
146.Nx
147.Nm
148was first made available in
149.Nx 1.4 .
150.Sh AUTHOR
151The
152.Nm
153program was written by Matthew R. Green <mrg@eterna.com.au>.
154.Sh SEE ALSO
155.Xr audioctl 1 ,
156.Xr audioplay 1 ,
157.Xr audioamd 4 ,
158.Xr aria 4 ,
159.Xr audio 4 ,
160.Xr eap 4 ,
161.Xr eso 4 ,
162.Xr ess 4 ,
163.Xr gus 4 ,
164.Xr guspnp 4 ,
165.Xr sb 4 ,
166.Xr sv 4 ,
167.Xr wss 4 ,
168.Xr ym .
169