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