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