freebsd-dev/usr.sbin/cdcontrol/cdcontrol.1

202 lines
4.1 KiB
Groff
Raw Normal View History

1999-08-28 01:35:59 +00:00
.\" $FreeBSD$
.\"
2002-05-30 07:34:10 +00:00
.Dd May 8, 2002
.Dt CDCONTROL 1
.Os
.Sh NAME
.Nm cdcontrol
.Nd compact disc control utility
.Sh SYNOPSIS
.Nm
.Op Fl sv
.Op Fl f Ar device
.Op Ar command ...
.Sh DESCRIPTION
2002-04-20 12:27:18 +00:00
The
.Nm
utility is a program to control audio features of a CD drive.
The device is a name such
1997-12-08 07:43:13 +00:00
as
.Pa cd0
or
2001-07-15 08:06:20 +00:00
.Pa mcd0 .
.Pp
2002-05-30 07:34:10 +00:00
If no
.Ar command
is given, then
1997-09-04 11:52:28 +00:00
.Nm
enters an interactive mode, reading commands from the standard input.
.Pp
The following options are available:
1997-12-08 07:43:13 +00:00
.Bl -tag -width indent
.It Fl s
2002-05-30 07:34:10 +00:00
Silent mode.
Do not print table headers and human readable comments.
.It Fl v
2002-05-30 07:34:10 +00:00
Verbose mode.
Print as much information as possible.
.It Fl f Ar device
Specify a device, such as
1997-12-08 07:43:13 +00:00
.Pa /dev/cd0c
or
.Pa mcd0 .
Both absolute path and relative to
.Pa /dev
filename are possible.
2002-05-30 07:34:10 +00:00
Suffix
.Pa c
is added to the device name if needed.
.El
.Pp
2002-05-30 07:34:10 +00:00
The available commands are listed below.
Only as many
characters as are required to uniquely identify a command
need be specified.
The word
2002-05-30 07:34:10 +00:00
.Ic play
2001-07-15 08:06:20 +00:00
can be omitted or the characters
2002-05-30 07:34:10 +00:00
.Ic +
and
2002-05-30 07:34:10 +00:00
.Ic -
can be used in the
place of
2002-05-30 07:34:10 +00:00
.Ic next
and
2002-05-30 07:34:10 +00:00
.Ic prev .
.Bl -tag -width indent
.It Ic play Ar first_track Op Ar last_track
2001-07-15 08:06:20 +00:00
Play from track
1997-12-08 07:43:13 +00:00
.Ar first_track
to track
1998-01-07 07:43:04 +00:00
.Ar last_track .
The first track has number 1.
1997-12-08 07:43:13 +00:00
Can be omitted in all cases.
2002-05-30 07:34:10 +00:00
.It Xo
.Ic play
.Ar start_m : Ns Ar start_s . Ns Ar start_f
2002-05-30 07:34:10 +00:00
.Op Ar end_m : Ns Ar end_s . Ns Ar end_f
.Xc
Play from the absolute address
2001-07-15 08:06:20 +00:00
(MSF) defined by
1997-12-08 07:43:13 +00:00
.Ar start_m
2001-07-15 08:06:20 +00:00
in minutes,
1997-12-08 07:43:13 +00:00
.Ar start_s ,
2001-07-15 08:06:20 +00:00
in seconds and
1997-12-08 07:43:13 +00:00
.Ar start_f
(frame number) to the absolute address defined by
1997-12-08 07:43:13 +00:00
.Ar end_m
2001-07-15 08:06:20 +00:00
in minutes,
1997-12-08 07:43:13 +00:00
.Ar end_s ,
2001-07-15 08:06:20 +00:00
in seconds and
1997-12-08 07:43:13 +00:00
.Ar end_f
2002-05-30 07:34:10 +00:00
(frame number).
Minutes are in the range 0-99.
Seconds are in the range 0-59.
Frame numbers are in the range 0-74.
2002-05-30 07:34:10 +00:00
.It Ic play Op # Ns Ar start_block Op Ar length
Play starting from the logical block
1997-12-08 07:43:13 +00:00
.Ar start_block
using
1997-12-08 07:43:13 +00:00
.Ar length
logical blocks.
2002-05-30 07:34:10 +00:00
.It Ic next Op Ar tracks
Skip forward a number of tracks (default 1).
2002-05-30 07:34:10 +00:00
.It Ic prev Op Ar tracks
Skip backward a number of tracks (default 1).
2002-05-30 07:34:10 +00:00
.It Ic pause
Stop playing.
Do not stop the disc.
2002-05-30 07:34:10 +00:00
.It Ic resume
Resume playing.
2001-07-15 08:06:20 +00:00
Used after the
2002-05-30 07:34:10 +00:00
.Ic pause
1997-12-08 07:43:13 +00:00
command.
2002-05-30 07:34:10 +00:00
.It Ic stop
Stop the disc.
2002-05-30 07:34:10 +00:00
.It Ic eject
Eject the disc.
2002-05-30 07:34:10 +00:00
.It Ic close
1996-02-02 22:03:37 +00:00
Inject the disc.
2002-05-30 07:34:10 +00:00
.It Ic volume Ar left_channel right_channel
2001-07-15 08:06:20 +00:00
Set the volume of left channel to
1997-12-08 07:43:13 +00:00
.Ar left_channel
2001-07-15 08:06:20 +00:00
and the volume of right channel to
.Ar right_channel .
Allowed values are in the range 0-255.
2002-05-30 07:34:10 +00:00
.It Ic volume Cm mute
Turn the sound off.
2002-05-30 07:34:10 +00:00
.It Ic volume Cm mono
Set the mono mode.
2002-05-30 07:34:10 +00:00
.It Ic volume Cm stereo
Set the stereo mode.
2002-05-30 07:34:10 +00:00
.It Ic volume Cm left
Play the left subtrack on both left and right channels.
2002-05-30 07:34:10 +00:00
.It Ic volume Cm right
Play the right subtrack on both left and right channels.
2002-05-30 07:34:10 +00:00
.It Ic info
Print the table of contents.
2002-05-30 07:34:10 +00:00
.It Ic status Op Cm audio | media | volume
Print the information about the disc:
2000-12-27 15:30:30 +00:00
.Pp
2002-05-30 07:34:10 +00:00
.Bl -tag -width ".Cm volume" -compact
.It Cm audio
2000-12-27 15:30:30 +00:00
the current playing status and position
2002-05-30 07:34:10 +00:00
.It Cm media
2000-12-27 15:30:30 +00:00
the current media catalog status
2002-05-30 07:34:10 +00:00
.It Cm volume
1996-02-03 14:13:36 +00:00
the current values of the volume for left and right channels.
2000-12-27 15:30:30 +00:00
.El
2002-05-30 07:34:10 +00:00
.It Ic cdid
Display the serial number of the CD using the method used by the
.Tn CDDB
project
.Pq Pa http://www.cddb.org/ .
.It Ic help
Print the list of available commands.
2002-05-30 07:34:10 +00:00
.It Ic debug Cm on
Enable the debugging mode of the CD device driver.
2002-05-30 07:34:10 +00:00
.It Ic debug Cm off
Disable the driver debugging mode.
2002-05-30 07:34:10 +00:00
.It Ic reset
Perform the hardware reset of the device.
2002-05-30 07:34:10 +00:00
.It Ic set Cm msf
1996-02-03 14:13:36 +00:00
Set minute-second-frame ioctl mode (default).
2002-05-30 07:34:10 +00:00
.It Ic set Cm lba
1996-02-03 14:13:36 +00:00
Set LBA ioctl mode.
2002-05-30 07:34:10 +00:00
.It Ic speed Ar s
Set the highest speed that the drive should use for reading data.
The units are multiples of a single speed CDROM (150 KB/s).
Specify
.Dq Li max
to use the drive's fastest speed.
2002-05-30 07:34:10 +00:00
.It Ic quit
Quit the program.
2000-12-27 15:30:30 +00:00
.El
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm :
2002-05-30 07:34:10 +00:00
.Bl -tag -width ".Ev CD_DRIVE"
.It Ev CDROM
2002-05-30 07:34:10 +00:00
The CD device to use, if one is not specified with the
.Fl f
2002-05-30 07:34:10 +00:00
option.
.It Ev CDPLAY , CD_DRIVE , DISC , MUSIC_CD
These variables have been deprecated in favour of
.Ev CDROM .
.El
.Sh FILES
2002-05-30 07:34:10 +00:00
.Bl -tag -width ".Pa /dev/mcd0c" -compact
2000-05-07 09:50:44 +00:00
.It Pa /dev/cd0c
.It Pa /dev/mcd0c
.It Pa /dev/acd0c
.El
.Sh AUTHORS
2002-05-30 07:34:10 +00:00
.An Jean-Marc Zucconi
.An Andrey A. Chernov
.An Serge V. Vakulenko
.Sh HISTORY
The
1997-09-04 11:52:28 +00:00
.Nm
1996-08-23 00:57:08 +00:00
command appeared in
.Fx 2.1 .