xref: /freebsd/usr.sbin/cdcontrol/cdcontrol.1 (revision 5069714534cba67f1985e6dfe23b145178372b5f)
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.
47Word
48.Em play
49can be omitted.
50.Bl -tag -width Cm
51.It Cm play Ar first_track Op Ar last_track
52Play from track
53.Ar first_track
54to track
55.Ar last_track .
56The first track has number 1.
57Can be omitted in all cases.
58.It Cm play Ar start_m:start_s.start_f Op Ar end_m:end_s.end_f
59Play from the absolute address
60(MSF) defined by
61.Ar start_m
62in minutes,
63.Ar start_s ,
64in seconds and
65.Ar start_f
66(frame number) to the absolute address defined by
67.Ar end_m
68in minutes,
69.Ar end_s ,
70in seconds and
71.Ar end_f
72(frame number). Minutes are in the range 0-99.
73Seconds are in the range 0-59.
74Frame numbers are in the range 0-74.
75.It Cm play Op Ar #start_block Op length
76Play starting from the logical block
77.Ar start_block
78using
79.Ar length
80logical blocks.
81.It Cm pause
82Stop playing.
83Do not stop the disc.
84.It Cm resume
85Resume playing.
86Used after the
87.Em pause
88command.
89.It Cm stop
90Stop the disc.
91.It Cm eject
92Eject the disc.
93.It Cm close
94Inject the disc.
95.It Cm volume Ar left_channel Ar right_channel
96Set the volume of left channel to
97.Ar left_channel
98and the volume of right channel to
99.Ar right_channel .
100Allowed values are in the range 0-255.
101.It Cm volume Ar mute
102Turn the sound off.
103.It Cm volume Ar mono
104Set the mono mode.
105.It Cm volume Ar stereo
106Set the stereo mode.
107.It Cm volume Ar left
108Play the left subtrack on both left and right channels.
109.It Cm volume Ar right
110Play the right subtrack on both left and right channels.
111.It Cm info
112Print the table of contents.
113.It Cm status Xo
114.Op Ar audio | media | volume
115.Xc
116Print the information about the disc:
117.Pp
118.Bl -tag -width "volume" -compact
119.It Ar audio
120the current playing status and position
121.It Ar media
122the current media catalog status
123.It Ar volume
124the current values of the volume for left and right channels.
125.El
126.It Cm cdid
127Display the serial number of the cd using the method used by the
128cddb (http://www.cddb.org/) project.
129.It Cm help
130Print the list of available commands.
131.It Cm debug Ar on
132Enable the debugging mode of the CD device driver.
133.It Cm debug Ar off
134Disable the driver debugging mode.
135.It Cm reset
136Perform the hardware reset of the device.
137.It Cm set Ar msf
138Set minute-second-frame ioctl mode (default).
139.It Cm set Ar lba
140Set LBA ioctl mode.
141.It Cm quit
142Quit the program.
143.El
144.Sh ENVIRONMENT
145The following environment variables affect the execution of
146.Nm :
147.Pp
148.Bl -tag -width CD_DRIVE -compact
149.It Ev CDROM
150The cd device to use if one isn't specified with the
151.Fl f
152flag.
153.Pp
154.It Ev CDPLAY
155.It Ev CD_DRIVE
156.It Ev DISC
157.It Ev MUSIC_CD
158These variables have been deprecated in favour of
159.Ev CDROM .
160.El
161.Sh FILES
162.Bl -tag -width /dev/mcd0c -compact
163.It Pa /dev/cd0c
164.It Pa /dev/mcd0c
165.It Pa /dev/acd0c
166.El
167.Sh AUTHORS
168.An Jean-Marc Zucconi ,
169.An Andrey A.\ Chernov ,
170.An Serge V.\ Vakulenko
171.Sh HISTORY
172The
173.Nm
174command appeared in
175.Fx 2.1 .
176