Annotation of src/usr.bin/cdio/cdio.1, Revision 1.52
1.52 ! ratchov 1: .\" $OpenBSD: cdio.1,v 1.51 2008/06/30 23:35:39 av 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.52 ! ratchov 32: .Dd $Mdocdate: June 30 2008 $
1.1 downsj 33: .Dt CDIO 1
1.14 aaron 34: .Os
1.1 downsj 35: .Sh NAME
36: .Nm cdio
1.37 jmc 37: .Nd compact disc control utility
1.1 downsj 38: .Sh SYNOPSIS
39: .Nm cdio
1.21 aaron 40: .Op Fl sv
1.37 jmc 41: .Oo Fl d Ar host :
42: .Ar port Oc
1.13 aaron 43: .Op Fl f Ar device
44: .Op Ar command args ...
1.1 downsj 45: .Sh DESCRIPTION
1.13 aaron 46: The
1.14 aaron 47: .Nm
1.37 jmc 48: program is a compact disc control utility,
49: with support for playing audio CDs and TAO CD writing.
1.1 downsj 50: .Pp
1.13 aaron 51: If no command is given,
1.14 aaron 52: .Nm
1.37 jmc 53: enters interactive mode, reading commands from the standard input.
1.1 downsj 54: .Pp
1.16 aaron 55: The options are as follows:
1.19 aaron 56: .Bl -tag -width Ds
1.28 jmc 57: .It Xo
58: .Fl d
59: .Ar host : Ns Ar port
60: .Xc
1.38 jmc 61: Specifies a CDDB host
62: .Bq default: freedb.freedb.org:cddb .
1.13 aaron 63: .It Fl f Ar device
1.38 jmc 64: Specifies the name of the CD device, such as
1.40 jmc 65: .Pa /dev/rcd0c
1.13 aaron 66: or
67: .Pa mcd0 .
68: Both absolute and relative paths to
69: .Pa /dev
1.38 jmc 70: filenames are possible;
71: the raw partition name is added if needed.
1.28 jmc 72: .It Fl s
73: Silent mode.
74: Do not print table headers or human-readable comments.
75: .It Fl v
76: Verbose mode.
77: Print as much information as possible.
1.1 downsj 78: .El
79: .Pp
1.17 aaron 80: The available commands are listed below.
81: Only as many characters as are required to uniquely identify a command
82: need be specified.
1.45 jmc 83: If no command is given,
84: only a track number or range,
85: then
1.17 aaron 86: .Ic play
1.45 jmc 87: is assumed.
1.29 jmc 88: .Bl -tag -width Ds
1.32 mjc 89: .It Ic blank
90: Minimally blank the disc.
1.29 jmc 91: .It Ic cddb Op Ar n
1.47 jmc 92: Print the Table Of Contents (TOC) after matching the disc with the CDDB.
1.29 jmc 93: In case of multiple matches, reissue the command with
94: .Ar n .
95: .It Ic cdid
1.38 jmc 96: Print the disc ID that will be used for matching with the CDDB.
1.43 jmc 97: .It Ic cdplay Op Ar track1-trackN ...
1.42 mjc 98: Play specified tracks from disk.
99: Unlike
1.45 jmc 100: .Ic play ,
101: the CD player need not be connected to an audio device;
102: instead it rips tracks from disk and outputs audio data to
1.52 ! ratchov 103: the default
! 104: .Xr audio 4
! 105: device or
! 106: .Xr aucat 1
! 107: socket.
1.42 mjc 108: Both individual tracks and track ranges may be specified.
109: If range is specified in descending order tracks will be played in descending order.
110: If the first value in the range is omitted, tracks from first track on disk to the specified one will be played.
111: If the last value in the range is omitted, tracks from the specified track to the last track on disk will be played.
1.46 sobrado 112: .It Ic cdrip Op Ar track1-trackN ...
113: Rip specified tracks from disk.
114: Audio tracks are saved as WAVE sound files.
115: All tracks will be saved in the current working directory.
116: If parameters are omitted, all tracks are ripped.
117: Both individual tracks and track ranges may be specified, in the same format as the
118: .Ic cdplay
119: command.
1.29 jmc 120: .It Ic close
121: Inject the disc.
122: .It Ic debug Ar on | off
123: Enable/disable the debugging mode of the CD device driver.
124: .It Ic device Ar devname
125: Make
126: .Ar devname
127: the current CD device.
128: This is the equivalent of quitting
129: .Nm
130: and restarting with a different device.
131: .It Ic eject
132: Eject the disc.
1.30 robert 133: .It Ic exit
134: A synonym for
135: .Ic quit .
1.29 jmc 136: .It Ic help
137: Print the list of available commands.
138: .It Ic info
1.47 jmc 139: Print the Table Of Contents (TOC).
1.29 jmc 140: .It Ic next
141: Play the next track.
142: If we're at the last track, stop.
143: .It Ic pause
144: Stop playing.
145: Do not stop the disc.
1.17 aaron 146: .It Ic play Ar first_track Op Ar last_track
1.14 aaron 147: Play from track
148: .Ar first_track
1.1 downsj 149: to track
1.14 aaron 150: .Ar last_track .
1.13 aaron 151: The first track has number 1 and may be omitted in all cases.
1.31 krw 152: .It Xo Ic play
153: .Op Ar tr1
154: .Ar m1 : Ns Ar s1 Ns Op .f1
155: .Op Ar tr2
156: .Oo Ar m2 : Ns Ar s2 Ns
157: .Op .f2 Oc
158: .Xc
1.1 downsj 159: Play from the absolute address
1.14 aaron 160: (MSF) defined by
1.31 krw 161: .Ar m1
1.14 aaron 162: in minutes,
1.31 krw 163: .Ar s1
164: in seconds,
165: frame number
166: .Ar f1 ,
167: to the absolute address defined by
168: .Ar m2
1.14 aaron 169: in minutes,
1.31 krw 170: .Ar s2
171: in seconds,
172: frame number
173: .Ar f2 .
174: If a track number is specified
175: .Pq tr Ns Ar X ,
176: then the minutes, seconds, and frame numbers
177: are relative to the start of that track.
178: Minutes are in the range 0\(en99.
179: Seconds are in the range 0\(en59.
180: Frame numbers are in the range 0\(en74.
1.29 jmc 181: .It Ic play Op Ar #start_block Op Ar length
1.1 downsj 182: Play starting from the logical block
1.13 aaron 183: .Ar start_block
1.1 downsj 184: using
1.13 aaron 185: .Ar length
1.1 downsj 186: logical blocks.
1.17 aaron 187: .It Ic previous
188: Play the previous track.
189: If we're at the first track, restart.
1.29 jmc 190: .It Ic quit
191: Quit the program.
1.17 aaron 192: .It Ic replay
1.41 jmc 193: Replay the current track.
1.29 jmc 194: .It Ic reset
195: Perform a hardware reset of the device.
1.17 aaron 196: .It Ic resume
197: Resume playing.
198: Used after the
199: .Ic pause
1.4 deraadt 200: command.
1.29 jmc 201: .It Ic set Ar lba | msf
202: Set LBA
203: .Pq Ar lba
204: or minute-second-frame
205: .Pq Ar msf
206: ioctl mode.
207: The default is minute-second-frame ioctl mode.
208: .It Ic status
209: Print information about the disc:
210: the current playing status and position,
211: the current media catalog status,
212: and the current values of the volume for left and right channels.
1.17 aaron 213: .It Ic stop
1.1 downsj 214: Stop the disc.
1.32 mjc 215: .It Xo Ic tao
1.36 jmc 216: .Op Fl ad
1.51 av 217: .Op Fl s Ar speed
1.32 mjc 218: .Ar trackfile ...
219: .Xc
1.36 jmc 220: .Bq command line only
221: \ \&Write a track-at-once CD containing the specified
222: .Ar trackfile .
223: .Pp
224: The options are as follows:
1.38 jmc 225: .Pp
226: .Bl -tag -width Ds -compact
1.36 jmc 227: .It Fl a
1.49 jmc 228: Write files as audio tracks.
1.50 jmc 229: File formats of audio tracks may be CDDA or WAVE
230: with 2 channels of PCM audio,
231: signed 16-bit (little endian) values sampled at 44100 Hz.
1.36 jmc 232: .It Fl d
233: Write files as data tracks (the default).
1.51 av 234: .It Fl s Ar speed
235: Specify a write speed for tracks.
236: .Ar speed
237: may be a numerical value between 1 and
238: the maximum speed supported by the media and drive,
239: or one of the literal strings
240: .Dq auto
241: or
242: .Dq max ,
243: meaning the optimal or maximum speed detected.
1.36 jmc 244: .El
1.17 aaron 245: .It Ic volume Ar left_channel Ar right_channel
1.14 aaron 246: Set the volume of the left channel to
1.13 aaron 247: .Ar left_channel
1.14 aaron 248: and the volume of the right channel to
249: .Ar right_channel .
1.29 jmc 250: Allowed values are in the range 0\-255.
1.34 jmc 251: .It Xo Ic volume
252: .Ic left \*(Ba
253: .Ic right \*(Ba
254: .Ic mono \*(Ba
255: .Ic stereo \*(Ba
256: .Ic mute
257: .Xc
258: Respectively:
259: play the left subtrack on both left and right channels;
260: play the right subtrack on both left and right channels;
261: set mono mode;
262: set stereo mode;
263: turn the sound off.
1.38 jmc 264: .El
265: .Sh ENVIRONMENT
1.52 ! ratchov 266: .Bl -tag -width "AUDIODEVICEXXX"
1.39 jmc 267: .It Ev DISC , CDROM
268: Specifies the name of the CD device to use.
269: If both
270: .Ev DISC
271: and
272: .Ev CDROM
273: are set,
274: .Ev DISC
275: takes precedence.
276: If neither
277: .Ev DISC
278: nor
279: .Ev CDROM
280: are set,
281: the default is
282: .Pa cd0 .
283: See also the
1.38 jmc 284: .Fl f
1.39 jmc 285: option, above.
1.52 ! ratchov 286: .It Ev AUDIODEVICE
! 287: Name of the
! 288: .Xr aucat 1
! 289: socket to connect to, or path to the
! 290: .Xr audio 4
! 291: device to use.
1.18 aaron 292: .El
1.1 downsj 293: .Sh FILES
294: .Bl -tag -width /dev/rmcd0c -compact
1.10 mickey 295: .It Pa /dev/rcd0c
296: .It Pa /dev/rmcd0c
1.1 downsj 297: .El
1.28 jmc 298: .Sh SEE ALSO
299: .Xr aucat 1 ,
300: .Xr audioctl 1 ,
301: .Xr mixerctl 1 ,
302: .Xr audio 4
1.1 downsj 303: .Sh HISTORY
304: The
1.14 aaron 305: .Nm
1.1 downsj 306: command is based on
307: .Nm cdcontrol ,
1.22 mpech 308: which first appeared in
309: .Fx 2.1 .
1.27 jmc 310: .Sh AUTHORS
311: Jean-Marc Zucconi,
312: Andrey A. Chernov,
313: Serge V. Vakulenko,
314: Marc Espie