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