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