Annotation of src/usr.bin/cdio/cdio.1, Revision 1.31
1.31 ! krw 1: .\" $OpenBSD: cdio.1,v 1.30 2005/01/22 10:21:26 robert Exp $
1.26 jmc 2: .\"
3: .\" Copyright (c) 1995 Serge V. Vakulenko
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: .\"
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by Serge V. Vakulenko.
18: .\" 4. The name of the author may not be used to endorse or promote products
19: .\" derived from this software without specific prior written permission.
20: .\"
21: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.21 aaron 31: .\"
1.1 downsj 32: .Dd July 3, 1995
33: .Dt CDIO 1
1.14 aaron 34: .Os
1.1 downsj 35: .Sh NAME
36: .Nm cdio
1.20 espie 37: .Nd compact disc audio player and control utility
1.1 downsj 38: .Sh SYNOPSIS
39: .Nm cdio
1.21 aaron 40: .Op Fl sv
1.28 jmc 41: .Xo
42: .Oo Fl d
43: .Ar host : Ns Ar port Oc
44: .Xc
1.13 aaron 45: .Op Fl f Ar device
46: .Op Ar command args ...
1.1 downsj 47: .Sh DESCRIPTION
1.13 aaron 48: The
1.14 aaron 49: .Nm
1.17 aaron 50: program controls audio features of a CD drive.
51: The
1.13 aaron 52: .Ar device
53: is a name such
1.14 aaron 54: as
1.17 aaron 55: .Dq cd0
1.14 aaron 56: or
57: .Dq mcd0 .
1.1 downsj 58: .Pp
1.13 aaron 59: If a
60: .Ar device
1.14 aaron 61: is not specified, the environment variable
1.1 downsj 62: .Ev DISC
1.13 aaron 63: will be used to find the CD device.
1.1 downsj 64: .Pp
1.13 aaron 65: If no command is given,
1.14 aaron 66: .Nm
1.1 downsj 67: enters an interactive mode, reading commands from the standard input.
68: .Pp
1.16 aaron 69: The options are as follows:
1.19 aaron 70: .Bl -tag -width Ds
1.28 jmc 71: .It Xo
72: .Fl d
73: .Ar host : Ns Ar port
74: .Xc
1.24 espie 75: Specifies cddb host (default: freedb.freedb.org:cddb).
1.13 aaron 76: .It Fl f Ar device
77: Specifies a device name such as
78: .Pa /dev/rcd0d
79: or
80: .Pa mcd0 .
81: Both absolute and relative paths to
82: .Pa /dev
83: filenames are possible.
1.11 deraadt 84: The raw partition name is added if needed.
1.28 jmc 85: .It Fl s
86: Silent mode.
87: Do not print table headers or human-readable comments.
88: .It Fl v
89: Verbose mode.
90: Print as much information as possible.
1.1 downsj 91: .El
92: .Pp
1.17 aaron 93: The available commands are listed below.
94: Only as many characters as are required to uniquely identify a command
95: need be specified.
96: The word
97: .Ic play
1.13 aaron 98: may be omitted.
1.29 jmc 99: .Bl -tag -width Ds
100: .It Ic cddb Op Ar n
101: Print the table of contents after matching the disc with the cddb.
102: In case of multiple matches, reissue the command with
103: .Ar n .
104: .It Ic cdid
105: Print the disc ID that will be used for matching with the cddb.
106: .It Ic close
107: Inject the disc.
108: .It Ic debug Ar on | off
109: Enable/disable the debugging mode of the CD device driver.
110: .It Ic device Ar devname
111: Make
112: .Ar devname
113: the current CD device.
114: This is the equivalent of quitting
115: .Nm
116: and restarting with a different device.
117: .It Ic eject
118: Eject the disc.
1.30 robert 119: .It Ic exit
120: A synonym for
121: .Ic quit .
1.29 jmc 122: .It Ic help
123: Print the list of available commands.
124: .It Ic info
125: Print the table of contents.
126: .It Ic next
127: Play the next track.
128: If we're at the last track, stop.
129: .It Ic pause
130: Stop playing.
131: Do not stop the disc.
1.17 aaron 132: .It Ic play Ar first_track Op Ar last_track
1.14 aaron 133: Play from track
134: .Ar first_track
1.1 downsj 135: to track
1.14 aaron 136: .Ar last_track .
1.13 aaron 137: The first track has number 1 and may be omitted in all cases.
1.31 ! krw 138: .It Xo Ic play
! 139: .Op Ar tr1
! 140: .Ar m1 : Ns Ar s1 Ns Op .f1
! 141: .Op Ar tr2
! 142: .Oo Ar m2 : Ns Ar s2 Ns
! 143: .Op .f2 Oc
! 144: .Xc
1.1 downsj 145: Play from the absolute address
1.14 aaron 146: (MSF) defined by
1.31 ! krw 147: .Ar m1
1.14 aaron 148: in minutes,
1.31 ! krw 149: .Ar s1
! 150: in seconds,
! 151: frame number
! 152: .Ar f1 ,
! 153: to the absolute address defined by
! 154: .Ar m2
1.14 aaron 155: in minutes,
1.31 ! krw 156: .Ar s2
! 157: in seconds,
! 158: frame number
! 159: .Ar f2 .
! 160: If a track number is specified
! 161: .Pq tr Ns Ar X ,
! 162: then the minutes, seconds, and frame numbers
! 163: are relative to the start of that track.
! 164: Minutes are in the range 0\(en99.
! 165: Seconds are in the range 0\(en59.
! 166: Frame numbers are in the range 0\(en74.
1.29 jmc 167: .It Ic play Op Ar #start_block Op Ar length
1.1 downsj 168: Play starting from the logical block
1.13 aaron 169: .Ar start_block
1.1 downsj 170: using
1.13 aaron 171: .Ar length
1.1 downsj 172: logical blocks.
1.17 aaron 173: .It Ic previous
174: Play the previous track.
175: If we're at the first track, restart.
1.29 jmc 176: .It Ic quit
177: Quit the program.
1.17 aaron 178: .It Ic replay
1.8 angelos 179: Replay the current track again.
1.29 jmc 180: .It Ic reset
181: Perform a hardware reset of the device.
1.17 aaron 182: .It Ic resume
183: Resume playing.
184: Used after the
185: .Ic pause
1.4 deraadt 186: command.
1.29 jmc 187: .It Ic set Ar lba | msf
188: Set LBA
189: .Pq Ar lba
190: or minute-second-frame
191: .Pq Ar msf
192: ioctl mode.
193: The default is minute-second-frame ioctl mode.
194: .It Ic status
195: Print information about the disc:
196: the current playing status and position,
197: the current media catalog status,
198: and the current values of the volume for left and right channels.
1.17 aaron 199: .It Ic stop
1.1 downsj 200: Stop the disc.
1.17 aaron 201: .It Ic volume Ar left_channel Ar right_channel
1.14 aaron 202: Set the volume of the left channel to
1.13 aaron 203: .Ar left_channel
1.14 aaron 204: and the volume of the right channel to
205: .Ar right_channel .
1.29 jmc 206: Allowed values are in the range 0\-255.
207: .It Ic volume Ar left
208: Play the left subtrack on both left and right channels.
209: .It Ic volume Ar mono
210: Set the mono mode.
1.17 aaron 211: .It Ic volume Ar mute
1.1 downsj 212: Turn the sound off.
1.29 jmc 213: .It Ic volume Ar right
214: Play the right subtrack on both left and right channels.
1.17 aaron 215: .It Ic volume Ar stereo
1.1 downsj 216: Set the stereo mode.
1.18 aaron 217: .El
1.1 downsj 218: .Sh FILES
219: .Bl -tag -width /dev/rmcd0c -compact
1.10 mickey 220: .It Pa /dev/rcd0c
221: .It Pa /dev/rmcd0c
1.1 downsj 222: .El
1.28 jmc 223: .Sh SEE ALSO
224: .Xr aucat 1 ,
225: .Xr audioctl 1 ,
226: .Xr mixerctl 1 ,
227: .Xr audio 4
1.1 downsj 228: .Sh HISTORY
229: The
1.14 aaron 230: .Nm
1.1 downsj 231: command is based on
232: .Nm cdcontrol ,
1.22 mpech 233: which first appeared in
234: .Fx 2.1 .
1.27 jmc 235: .Sh AUTHORS
236: Jean-Marc Zucconi,
237: Andrey A. Chernov,
238: Serge V. Vakulenko,
239: Marc Espie