xref: /netbsd/usr.bin/cdplay/cdplay.1 (revision bf9ec67e)
1.\"	$NetBSD: cdplay.1,v 1.14 2001/10/17 22:32:41 wiz 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 August 20, 2001
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 f Ar device
38.Op Ar command ...
39.Sh DESCRIPTION
40.Nm
41is a program to control the audio features of a CD-ROM drive.
42.Pp
43If no command is given, then
44.Nm
45enters interactive mode, reading commands from the standard input.
46.Pp
47The following options are available:
48.Bl -tag -width indent
49.It Fl f Ar device
50Specify the control device to use.  Both absolute paths and paths relative to
51.Pa /dev
52are accepted.  The suffix `c' (or 'd' on some architectures, see
53.Xr disklabel 8
54for details) is added to the
55device name if needed.  If the device not specified, the environment variables
56.Ev MUSIC_CD ,
57.Ev CD_DRIVE ,
58.Ev DISC
59and
60.Ev CDPLAY
61will be tried (in this order) to find the device.
62.El
63.Pp
64The available commands are listed below.  Only as many
65characters as are required to uniquely identify a command
66need be specified.  The word
67.Em play
68can be omitted in all cases.
69.Bl -tag -width Cm
70.It Cm play Op Ar first_track Op Ar last_track
71Play from track
72.Ar first_track
73to track
74.Ar last_track .
75The first track has number 1.
76.It Cm play Op Ar start_m:start_s.start_f Op Ar end_m:end_s.end_f
77Play from the absolute address
78(MSF) defined by
79.Ar start_m
80in minutes,
81.Ar start_s ,
82in seconds and
83.Ar start_f
84(frame number) to the absolute address defined by
85.Ar end_m
86in minutes,
87.Ar end_s ,
88in seconds and
89.Ar end_f
90(frame number).  Minutes are in the range 0-99. Seconds are in the range 0-59.
91Frame numbers are in the range 0-74.
92.It Cm play Op Ar #start_block Op length
93Play starting from the logical block
94.Ar start_block
95using
96.Ar length
97logical blocks.
98.It Cm next
99Skip to the next track.
100.It Cm prev
101Skip to the previous track.
102.It Cm pause
103Stop playing.  Do not stop the disc.
104.It Cm resume
105Resume playing.  Used after the
106.Em pause
107command.
108.It Cm shuffle
109Select shuffle play.  Only valid in interactive mode.
110.It Cm skip
111Skip to another track.  Only valid when shuffle play is selected.
112.It Cm stop
113Stop the disc.
114.It Cm eject
115Eject the disc.
116.It Cm close
117Inject the disc.
118.It Cm volume Ar left_channel Ar right_channel
119Set the volume of left channel to
120.Ar left_channel
121and the volume of right channel to
122.Ar right_channel .
123Allowed values are in the range 0-255.
124.It Cm volume Ar value
125Set the volume of both left channel right channel to
126.Ar value .
127Allowed values are in the range 0-255.
128.It Cm volume mute
129Turn the sound off.
130.It Cm volume mono
131Set the mono mode.
132.It Cm volume stereo
133Set the stereo mode.
134.It Cm volume left
135Play the left subtrack on both left and right channels.
136.It Cm volume right
137Play the right subtrack on both left and right channels.
138.It Cm info
139Print the table of contents.
140.It Cm status
141Display the current audio, media and volume status.
142.It Cm help
143Print the list of available commands.
144.It Cm reset
145Perform the hardware reset of the device.
146.It Cm set msf
147Set minute-second-frame ioctl mode (default).
148.It Cm set lba
149Set LBA ioctl mode.
150.It Cm quit
151Quit the program.
152.El
153.Sh FILES
154.Bl -tag -width /dev/rmcd0c -compact
155.It Pa /dev/cd??
156.It Pa /dev/mcd??
157.El
158.Sh SEE ALSO
159.Xr disklabel 8
160.Sh HISTORY
161The
162.Nm
163command first appeared in
164.Nx 1.5 .
165.Sh AUTHORS
166.An Jean-Marc Zucconi ,
167.An Andrey A.\ Chernov ,
168.An Serge V.\ Vakulenko ,
169.An Andrew Doran ,
170.An Sergey Svishchev .
171