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