Annotation of src/usr.bin/cdio/cdio.1, Revision 1.42
1.42 ! mjc 1: .\" $OpenBSD: cdio.1,v 1.41 2007/03/26 11:46:07 jmc 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.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.
83: The word
84: .Ic play
1.13 aaron 85: may be omitted.
1.29 jmc 86: .Bl -tag -width Ds
1.32 mjc 87: .It Ic blank
88: Minimally blank the disc.
1.29 jmc 89: .It Ic cddb Op Ar n
1.38 jmc 90: Print the table of contents after matching the disc with the CDDB.
1.29 jmc 91: In case of multiple matches, reissue the command with
92: .Ar n .
93: .It Ic cdid
1.38 jmc 94: Print the disc ID that will be used for matching with the CDDB.
1.42 ! mjc 95: .It Ic cdrip
! 96: .Op Ar track1-trackN ...
! 97: Rip specified tracks from disk.
! 98: Audio tracks are saved as WAVE sound files.
! 99: All tracks will be saved in the current working directory.
! 100: If parameters are omitted, all tracks are ripped.
! 101: Both individual tracks and track ranges may be specified, in the same format as the
! 102: .Ic cdplay
! 103: command.
! 104: .It Ic cdplay
! 105: .Op Ar track1-trackN ...
! 106: Play specified tracks from disk.
! 107: Unlike
! 108: .Ic cdrip
! 109: it rips tracks from disk and outputs audio data to
! 110: .Pa /dev/audio .
! 111: Both individual tracks and track ranges may be specified.
! 112: If range is specified in descending order tracks will be played in descending order.
! 113: If the first value in the range is omitted, tracks from first track on disk to the specified one will be played.
! 114: If the last value in the range is omitted, tracks from the specified track to the last track on disk will be played.
1.29 jmc 115: .It Ic close
116: Inject the disc.
117: .It Ic debug Ar on | off
118: Enable/disable the debugging mode of the CD device driver.
119: .It Ic device Ar devname
120: Make
121: .Ar devname
122: the current CD device.
123: This is the equivalent of quitting
124: .Nm
125: and restarting with a different device.
126: .It Ic eject
127: Eject the disc.
1.30 robert 128: .It Ic exit
129: A synonym for
130: .Ic quit .
1.29 jmc 131: .It Ic help
132: Print the list of available commands.
133: .It Ic info
134: Print the table of contents.
135: .It Ic next
136: Play the next track.
137: If we're at the last track, stop.
138: .It Ic pause
139: Stop playing.
140: Do not stop the disc.
1.17 aaron 141: .It Ic play Ar first_track Op Ar last_track
1.14 aaron 142: Play from track
143: .Ar first_track
1.1 downsj 144: to track
1.14 aaron 145: .Ar last_track .
1.13 aaron 146: The first track has number 1 and may be omitted in all cases.
1.31 krw 147: .It Xo Ic play
148: .Op Ar tr1
149: .Ar m1 : Ns Ar s1 Ns Op .f1
150: .Op Ar tr2
151: .Oo Ar m2 : Ns Ar s2 Ns
152: .Op .f2 Oc
153: .Xc
1.1 downsj 154: Play from the absolute address
1.14 aaron 155: (MSF) defined by
1.31 krw 156: .Ar m1
1.14 aaron 157: in minutes,
1.31 krw 158: .Ar s1
159: in seconds,
160: frame number
161: .Ar f1 ,
162: to the absolute address defined by
163: .Ar m2
1.14 aaron 164: in minutes,
1.31 krw 165: .Ar s2
166: in seconds,
167: frame number
168: .Ar f2 .
169: If a track number is specified
170: .Pq tr Ns Ar X ,
171: then the minutes, seconds, and frame numbers
172: are relative to the start of that track.
173: Minutes are in the range 0\(en99.
174: Seconds are in the range 0\(en59.
175: Frame numbers are in the range 0\(en74.
1.29 jmc 176: .It Ic play Op Ar #start_block Op Ar length
1.1 downsj 177: Play starting from the logical block
1.13 aaron 178: .Ar start_block
1.1 downsj 179: using
1.13 aaron 180: .Ar length
1.1 downsj 181: logical blocks.
1.17 aaron 182: .It Ic previous
183: Play the previous track.
184: If we're at the first track, restart.
1.29 jmc 185: .It Ic quit
186: Quit the program.
1.17 aaron 187: .It Ic replay
1.41 jmc 188: Replay the current track.
1.29 jmc 189: .It Ic reset
190: Perform a hardware reset of the device.
1.17 aaron 191: .It Ic resume
192: Resume playing.
193: Used after the
194: .Ic pause
1.4 deraadt 195: command.
1.29 jmc 196: .It Ic set Ar lba | msf
197: Set LBA
198: .Pq Ar lba
199: or minute-second-frame
200: .Pq Ar msf
201: ioctl mode.
202: The default is minute-second-frame ioctl mode.
203: .It Ic status
204: Print information about the disc:
205: the current playing status and position,
206: the current media catalog status,
207: and the current values of the volume for left and right channels.
1.17 aaron 208: .It Ic stop
1.1 downsj 209: Stop the disc.
1.32 mjc 210: .It Xo Ic tao
1.36 jmc 211: .Op Fl ad
1.32 mjc 212: .Ar trackfile ...
213: .Xc
1.36 jmc 214: .Bq command line only
215: \ \&Write a track-at-once CD containing the specified
216: .Ar trackfile .
217: .Pp
218: The options are as follows:
1.38 jmc 219: .Pp
220: .Bl -tag -width Ds -compact
1.36 jmc 221: .It Fl a
222: Write files as audio tracks.
223: .It Fl d
224: Write files as data tracks (the default).
225: .El
1.17 aaron 226: .It Ic volume Ar left_channel Ar right_channel
1.14 aaron 227: Set the volume of the left channel to
1.13 aaron 228: .Ar left_channel
1.14 aaron 229: and the volume of the right channel to
230: .Ar right_channel .
1.29 jmc 231: Allowed values are in the range 0\-255.
1.34 jmc 232: .It Xo Ic volume
233: .Ic left \*(Ba
234: .Ic right \*(Ba
235: .Ic mono \*(Ba
236: .Ic stereo \*(Ba
237: .Ic mute
238: .Xc
239: Respectively:
240: play the left subtrack on both left and right channels;
241: play the right subtrack on both left and right channels;
242: set mono mode;
243: set stereo mode;
244: turn the sound off.
1.38 jmc 245: .El
246: .Sh ENVIRONMENT
247: .Bl -tag -width "DICSXXX"
1.39 jmc 248: .It Ev DISC , CDROM
249: Specifies the name of the CD device to use.
250: If both
251: .Ev DISC
252: and
253: .Ev CDROM
254: are set,
255: .Ev DISC
256: takes precedence.
257: If neither
258: .Ev DISC
259: nor
260: .Ev CDROM
261: are set,
262: the default is
263: .Pa cd0 .
264: See also the
1.38 jmc 265: .Fl f
1.39 jmc 266: option, above.
1.18 aaron 267: .El
1.1 downsj 268: .Sh FILES
269: .Bl -tag -width /dev/rmcd0c -compact
1.10 mickey 270: .It Pa /dev/rcd0c
271: .It Pa /dev/rmcd0c
1.1 downsj 272: .El
1.28 jmc 273: .Sh SEE ALSO
274: .Xr aucat 1 ,
275: .Xr audioctl 1 ,
276: .Xr mixerctl 1 ,
277: .Xr audio 4
1.1 downsj 278: .Sh HISTORY
279: The
1.14 aaron 280: .Nm
1.1 downsj 281: command is based on
282: .Nm cdcontrol ,
1.22 mpech 283: which first appeared in
284: .Fx 2.1 .
1.27 jmc 285: .Sh AUTHORS
286: Jean-Marc Zucconi,
287: Andrey A. Chernov,
288: Serge V. Vakulenko,
289: Marc Espie