usr.sbin/cdcontrol/cdcontrol.1

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