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