xref: /dragonfly/usr.sbin/cdcontrol/cdcontrol.1 (revision ec21d9fb)
1.\" $FreeBSD: src/usr.sbin/cdcontrol/cdcontrol.1,v 1.21.2.14 2003/03/12 22:08:13 trhodes Exp $
2.\" $DragonFly: src/usr.sbin/cdcontrol/cdcontrol.1,v 1.5 2007/05/17 19:26:06 swildner Exp $
3.\"
4.Dd July 3, 1995
5.Dt CDCONTROL 1
6.Os
7.Sh NAME
8.Nm cdcontrol
9.Nd compact disc control utility
10.Sh SYNOPSIS
11.Nm
12.Op Fl sv
13.Op Fl f Ar device
14.Op Ar command ...
15.Sh DESCRIPTION
16The
17.Nm
18utility is a program to control audio features of a CD drive.
19The device is a name such
20as
21.Pa cd0 .
22.Pp
23If no
24.Ar command
25is given, then
26.Nm
27enters an interactive mode, reading commands from the standard input.
28.Pp
29The following options are available:
30.Bl -tag -width indent
31.It Fl s
32Silent mode.
33Do not print table headers and human readable comments.
34.It Fl v
35Verbose mode.
36Print as much information as possible.
37.It Fl f Ar device
38Specify a device, such as
39.Pa /dev/cd0c .
40Both absolute path and relative to
41.Pa /dev
42filename are possible.
43Suffix
44.Pa c
45is added to the device name if needed.
46.El
47.Pp
48The available commands are listed below.
49Only as many
50characters as are required to uniquely identify a command
51need be specified.
52The word
53.Ic play
54can be omitted or the characters
55.Ic +
56and
57.Ic -
58can be used in the
59place of
60.Ic next
61and
62.Ic prev .
63.Bl -tag -width indent
64.It Ic play Ar first_track Op Ar last_track
65Play from track
66.Ar first_track
67to track
68.Ar last_track .
69The first track has number 1.
70Can be omitted in all cases.
71.It Xo
72.Ic play
73.Ar start_m : Ns Ar start_s . Ns Ar start_f
74.Op Ar end_m : Ns Ar end_s . Ns Ar end_f
75.Xc
76Play from the absolute address
77(MSF) defined by
78.Ar start_m
79in minutes,
80.Ar start_s ,
81in seconds and
82.Ar start_f
83(frame number) to the absolute address defined by
84.Ar end_m
85in minutes,
86.Ar end_s ,
87in seconds and
88.Ar end_f
89(frame number).
90Minutes are in the range 0-99.
91Seconds are in the range 0-59.
92Frame numbers are in the range 0-74.
93.It Ic play Op # Ns Ar start_block Op Ar length
94Play starting from the logical block
95.Ar start_block
96using
97.Ar length
98logical blocks.
99.It Ic next Op Ar tracks
100Skip forward a number of tracks (default 1).
101.It Ic prev Op Ar tracks
102Skip backward a number of tracks (default 1).
103.It Ic pause
104Stop playing.
105Do not stop the disc.
106.It Ic resume
107Resume playing.
108Used after the
109.Ic pause
110command.
111.It Ic stop
112Stop the disc.
113.It Ic eject
114Eject the disc.
115.It Ic close
116Inject the disc.
117.It Ic volume Ar left_channel right_channel
118Set the volume of left channel to
119.Ar left_channel
120and the volume of right channel to
121.Ar right_channel .
122Allowed values are in the range 0-255.
123.It Ic volume Cm mute
124Turn the sound off.
125.It Ic volume Cm mono
126Set the mono mode.
127.It Ic volume Cm stereo
128Set the stereo mode.
129.It Ic volume Cm left
130Play the left subtrack on both left and right channels.
131.It Ic volume Cm right
132Play the right subtrack on both left and right channels.
133.It Ic info
134Print the table of contents.
135.It Ic status Op Cm audio | media | volume
136Print the information about the disc:
137.Pp
138.Bl -tag -width ".Cm volume" -compact
139.It Cm audio
140the current playing status and position
141.It Cm media
142the current media catalog status
143.It Cm volume
144the current values of the volume for left and right channels.
145.El
146.It Ic cdid
147Display the serial number of the CD using the method used by the
148.Tn CDDB
149project
150.Pq Pa http://www.cddb.org/ .
151.It Ic help
152Print the list of available commands.
153.It Ic debug Cm on
154Enable the debugging mode of the CD device driver.
155.It Ic debug Cm off
156Disable the driver debugging mode.
157.It Ic reset
158Perform the hardware reset of the device.
159.It Ic set Cm msf
160Set minute-second-frame ioctl mode (default).
161.It Ic set Cm lba
162Set LBA ioctl mode.
163.It Ic speed Ar s
164Set the highest speed that the drive should use for reading data.
165The units are multiples of a single speed CDROM (150 KB/s).
166Specify
167.Dq Li max
168to use the drive's fastest speed.
169.It Ic quit
170Quit the program.
171.It Ic exit
172A synonym for
173.Ic quit .
174.El
175.Sh ENVIRONMENT
176The following environment variables affect the execution of
177.Nm :
178.Bl -tag -width ".Ev CD_DRIVE"
179.It Ev CDROM
180The CD device to use, if one is not specified with the
181.Fl f
182option.
183.It Ev CDPLAY , CD_DRIVE , DISC , MUSIC_CD
184These variables have been deprecated in favour of
185.Ev CDROM .
186.El
187.Sh FILES
188.Bl -tag -width ".Pa /dev/acd0c" -compact
189.It Pa /dev/cd0c
190.It Pa /dev/acd0c
191.El
192.Sh HISTORY
193The
194.Nm
195command appeared in
196.Fx 2.1 .
197.Sh AUTHORS
198.An Jean-Marc Zucconi
199.An Andrey A. Chernov
200.An Serge V. Vakulenko
201