usr.bin/cdplay/cdplay.1

   1 .\"     $NetBSD: cdplay.1,v 1.21 2006/11/13 16:33:56 ad Exp $
   2 .\"
   3 .\" Copyright (c) 1999, 2000 Andrew Doran.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" from FreeBSD: cdcontrol.1,v 1.16.2.2 1999/01/31 15:36:01 billf Exp
  28 .\"
  29 .Dd April 23, 2007
  30 .Dt CDPLAY 1
  31 .Os
  32 .Sh NAME
  33 .Nm cdplay
  34 .Nd compact disc player
  35 .Sh SYNOPSIS
  36 .Nm cdplay
  37 .Op Fl a Ar audio device
  38 .Op Fl f Ar device
  39 .Op Ar command ...
  40 .Sh DESCRIPTION
  41 .Nm
  42 is a program to control the audio features of a CD-ROM drive.
  43 .Pp
  44 If no command is given, then
  45 .Nm
  46 enters interactive mode, reading commands from the standard input.
  47 .Pp
  48 The following options are available:
  49 .Bl -tag -width indent
  50 .It Fl a Ar audio device
  51 Specify the audio device to use.
  52 Used only in digital transfer mode.
  53 If not specified, the environment variables
  54 .Ev AUDIODEV
  55 and
  56 .Ev SPEAKER
  57 will be tried (in this order) to find the device; as a last resort,
  58 .Pa /dev/sound
  59 will be used.
  60 .It Fl f Ar device
  61 Specify the control device to use.
  62 Both absolute paths and paths relative to
  63 .Pa /dev
  64 are accepted.
  65 The suffix
  66 .Ql c
  67 (or
  68 .Ql d
  69 on some architectures, see
  70 .Xr disklabel 8
  71 for details) is added to the
  72 device name if needed.
  73 If the device not specified, the environment variables
  74 .Ev MUSIC_CD ,
  75 .Ev CD_DRIVE ,
  76 .Ev DISC
  77 and
  78 .Ev CDPLAY
  79 will be tried (in this order) to find the device.
  80 .El
  81 .Pp
  82 The available commands are listed below.
  83 Only as many characters as are required to uniquely identify a command
  84 need be specified.
  85 The word
  86 .Em play
  87 can be omitted in all cases.
  88 .Bl -tag -width Cm
  89 .It Cm play Op Ar first_track Op Ar last_track
  90 Play from track
  91 .Ar first_track
  92 to track
  93 .Ar last_track .
  94 The first track has number 1.
  95 .It Cm play Op Ar start_m:start_s.start_f Op Ar end_m:end_s.end_f
  96 Play from the absolute address
  97 (MSF) defined by
  98 .Ar start_m
  99 in minutes,
 100 .Ar start_s ,
 101 in seconds and
 102 .Ar start_f
 103 (frame number) to the absolute address defined by
 104 .Ar end_m
 105 in minutes,
 106 .Ar end_s ,
 107 in seconds and
 108 .Ar end_f
 109 (frame number).
 110 Minutes are in the range 0-99.
 111 Seconds are in the range 0-59.
 112 Frame numbers are in the range 0-74.
 113 .It Cm play Op Ar #start_block Op length
 114 Play starting from the logical block
 115 .Ar start_block
 116 using
 117 .Ar length
 118 logical blocks.
 119 .It Cm next
 120 Skip to the next track.
 121 .It Cm prev
 122 Skip to the previous track.
 123 .It Cm pause
 124 Stop playing.
 125 Do not stop the disc.
 126 .It Cm resume
 127 Resume playing.
 128 Used after the
 129 .Em pause
 130 command.
 131 .It Cm shuffle
 132 Select shuffle play.
 133 Only valid in interactive mode.
 134 .It Cm single Op Ar track
 135 Pick a single track and play it repeatedly.
 136 If a
 137 .Ar track
 138 argument is not given the
 139 .Cm single
 140 command will shut shuffle mode off and play the disc normally.
 141 Only valid in interactive mode.
 142 .It Cm skip
 143 Skip to another track.
 144 Only valid when shuffle play is selected.
 145 .It Cm stop
 146 Stop the disc.
 147 .It Cm eject
 148 Eject the disc.
 149 .It Cm close
 150 Inject the disc.
 151 .It Cm volume Ar left_channel Ar right_channel
 152 Set the volume of left channel to
 153 .Ar left_channel
 154 and the volume of right channel to
 155 .Ar right_channel .
 156 Allowed values are in the range 0-255.
 157 .It Cm volume Ar value
 158 Set the volume of both left channel right channel to
 159 .Ar value .
 160 Allowed values are in the range 0-255.
 161 .It Cm volume mute
 162 Turn the sound off.
 163 .It Cm volume mono
 164 Set the mono mode.
 165 .It Cm volume stereo
 166 Set the stereo mode.
 167 .It Cm volume left
 168 Play the left subtrack on both left and right channels.
 169 .It Cm volume right
 170 Play the right subtrack on both left and right channels.
 171 .It Cm info
 172 Print the table of contents.
 173 .It Cm status
 174 Display the current audio, media and volume status.
 175 .It Cm digital Ar n
 176 Turn on digital transfer mode.
 177 In this mode,
 178 .Nm
 179 reads digital data from disc and sends it to an audio device.
 180 A SCSI or ATAPI CD-ROM is required; and the audio device must
 181 support CD audio format (44100 Hz sampling rate, 16-bit
 182 stereo samples).
 183 Audio data are read and written in groups of
 184 .Ar n
 185 frames (5 by default, or 1/15 seconds).
 186 .It Cm help
 187 Print the list of available commands.
 188 .It Cm reset
 189 Perform the hardware reset of the device.
 190 .It Cm set msf
 191 Set minute-second-frame ioctl mode (default).
 192 .It Cm set lba
 193 Set LBA ioctl mode.
 194 .It Cm quit
 195 Quit the program.
 196 .El
 197 .Sh FILES
 198 .Bl -tag -width /dev/rmcd0c -compact
 199 .It Pa /dev/cd??
 200 .It Pa /dev/mcd??
 201 .El
 202 .Sh SEE ALSO
 203 .Xr disklabel 8 ,
 204 .Xr mscdlabel 8
 205 .Sh HISTORY
 206 The
 207 .Nm
 208 command first appeared in
 209 .Nx 1.5 .
 210 Support for digital transfer mode was added in
 211 .Nx 4.0 .