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