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