~ubuntu-branches/ubuntu/edgy/libcdio/edgy-updates

« back to all changes in this revision

Viewing changes to src/cd-paranoia/doc/en/cd-paranoia.1

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2005-11-15 16:53:23 UTC
  • mfrom: (3.1.1 etch)
  • Revision ID: james.westby@ubuntu.com-20051115165323-peroku75syl2j36u
Tags: 0.76-1ubuntu1
* Sync to new Debian version, manually apply Ubuntu patches:
  - debian/control: Remove dpkg-awk build dependency.
  - debian/rules: hardcode $LIBCDEV. This keeps the diff small (compared to
    the original patch of changing every ${libcdev} occurence).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH cd-paranoia 1 "version III release alpha 9.8 libcdio"
 
2
.SH NAME
 
3
cdparanoia 9.8 (Paranoia release III libcdio) \- an audio CD reading utility which includes extra data verification features
 
4
.SH SYNOPSIS
 
5
.B cdparanoia
 
6
.RB [ options ]
 
7
.B span 
 
8
.RB [ outfile ]
 
9
.SH DESCRIPTION
 
10
.B cd-paranoia
 
11
retrieves audio tracks from CDDA capable CD-ROM drives.  The data can
 
12
be saved to a file or directed to standard output in WAV, AIFF, AIFF-C
 
13
or raw format.  Most ATAPI, SCSI and several proprietary CD-ROM drive
 
14
makes are supported;
 
15
.B cd-paranoia
 
16
can determine if the target drive is CDDA capable.
 
17
.P
 
18
In addition to simple reading, 
 
19
.B cd-paranoia
 
20
adds extra-robust data verification, synchronization, error handling
 
21
and scratch reconstruction capability.
 
22
.SH OPTIONS
 
23
 
 
24
.TP
 
25
.B \-v --verbose
 
26
Be absurdly verbose about the autosensing and reading process. Good
 
27
for setup and debugging.
 
28
 
 
29
.TP
 
30
.B \-q --quiet
 
31
Do not print any progress or error information during the reading process.
 
32
 
 
33
.TP
 
34
.B \-e --stderr-progress
 
35
Force output of progress information to stderr (for wrapper scripts).
 
36
 
 
37
.TP
 
38
.B \-V --version
 
39
Print the program version and quit.
 
40
 
 
41
.TP
 
42
.B \-Q --query
 
43
Perform CD-ROM drive autosense, query and print the CD-ROM table of
 
44
contents, then quit.
 
45
 
 
46
.TP
 
47
.B \-s --search-for-drive
 
48
Forces a complete search for a cdrom drive, even if the /dev/cdrom link exists.
 
49
 
 
50
.TP
 
51
.B \-h --help
 
52
Print a brief synopsis of 
 
53
.B cd-paranoia 
 
54
usage and options.
 
55
 
 
56
.TP
 
57
.B \-p --output-raw
 
58
Output headerless data as raw 16 bit PCM data with interleaved samples in host byte order.  To force little or big endian byte order, use 
 
59
.B \-r 
 
60
or 
 
61
.B \-R
 
62
as described below.
 
63
 
 
64
.TP
 
65
.B \-r --output-raw-little-endian
 
66
Output headerless data as raw 16 bit PCM data with interleaved samples in LSB first byte order.
 
67
 
 
68
.TP
 
69
.B \-R --output-raw-big-endian
 
70
Output headerless data as raw 16 bit PCM data with interleaved samples in MSB first byte order.
 
71
 
 
72
.TP
 
73
.B \-w --output-wav
 
74
Output data in Micro$oft RIFF WAV format (note that WAV data is always
 
75
LSB first byte order).
 
76
 
 
77
.TP
 
78
.B \-f --output-aiff
 
79
Output data in Apple AIFF format (note that AIFC data is
 
80
always in MSB first byte order).
 
81
 
 
82
.TP
 
83
.B \-a --output-aifc
 
84
Output data in uncompressed Apple AIFF-C format (note that AIFF-C data is
 
85
always in MSB first byte order).
 
86
 
 
87
.TP
 
88
.BI "\-B --batch "
 
89
 
 
90
Cdda2wav-style batch output flag; cd-paranoia will split the output
 
91
into multiple files at track boundaries.  Output file names are
 
92
prepended with 'track#.'
 
93
 
 
94
.TP
 
95
.B \-c --force-cdrom-little-endian
 
96
Some CD-ROM drives misreport their endianness (or do not report it at
 
97
all); it's possible that cd-paranoia will guess wrong.  Use
 
98
.B \-c
 
99
to force cd-paranoia to treat the drive as a little endian device.
 
100
 
 
101
.TP
 
102
.B \-C --force-cdrom-big-endian
 
103
As above but force cd-paranoia to treat the drive as a big endian device.
 
104
 
 
105
.TP
 
106
.BI "\-n --force-default-sectors " n
 
107
Force the interface backend to do atomic reads of 
 
108
.B n
 
109
sectors per read.  This number can be misleading; the kernel will often
 
110
split read requests into multiple atomic reads (the automated Paranoia
 
111
code is aware of this) or allow reads only wihin a restricted size
 
112
range. 
 
113
.B This option should generally not be used.
 
114
 
 
115
.TP
 
116
.BI "\-d --force-cdrom-device " device
 
117
Force the interface backend to read from
 
118
.B device
 
119
rather than the first readable CD-ROM drive it finds containing a
 
120
CD-DA disc.  This can be used to specify devices of any valid
 
121
interface type (ATAPI, SCSI or proprietary).
 
122
 
 
123
.TP
 
124
.BI "\-g --force-generic-device " device
 
125
This option is an alias for
 
126
.B \-d
 
127
and is retained for compatibility.
 
128
 
 
129
.TP
 
130
.BI "\-S --force-read-speed " number
 
131
Use this option explicitly to set the read rate of the CD drive (where
 
132
supported).  This can reduce underruns on machines with slow disks, or
 
133
which are low on memory.
 
134
 
 
135
.TP
 
136
.BI "\-t --toc-offset " number
 
137
Use this option to force the entire disc LBA addressing to shift by
 
138
the given amount; the value is added to the beginning offsets in the
 
139
TOC.  This can be used to shift track boundaries for the whole disc
 
140
manually on sector granularity.  The next option does something
 
141
similar...
 
142
 
 
143
.TP
 
144
.BI "\-T --toc-bias "
 
145
Some drives (usually random Toshibas) report the actual track
 
146
beginning offset values in the TOC, but then treat the beginning of
 
147
track 1 index 1 as sector 0 for all read operations.  This results in
 
148
every track seeming to start too late (losing a bit of the beginning
 
149
and catching a bit of the next track).
 
150
\-T accounts for this behavior.  Note that this option will cause
 
151
cd-paranoia to attempt to read sectors before or past the known user
 
152
data area of the disc, resulting in read errors at disc edges on most
 
153
drives and possibly even hard lockups on some buggy hardware.
 
154
 
 
155
.TP
 
156
.BI "\-O --sample-offset " number
 
157
Some CD-ROM/CD-R drives will add an offset to the position on reading
 
158
audio data. This is usually around 500-700 audio samples (ca. 1/75
 
159
second) on reading. So when cd-paranoia queries a specific
 
160
sector, it might not receive exactly that sector, but shifted by some
 
161
amount.
 
162
.P
 
163
Use this option to force the entire disc to shift sample position
 
164
output by the given amount; This can be used to shift track boundaries
 
165
for the whole disc manually on sample granularity. Note that if you
 
166
are ripping something including the ending of the CD (e.g. the entire
 
167
disk), this option will cause cd-paranoia to attempt to read
 
168
partial sectors before or past the known user data area, probably
 
169
causing read errors on most drives and possibly even hard lockups on
 
170
some buggy hardware.
 
171
 
 
172
.TP
 
173
.B \-Z --disable-paranoia
 
174
Disable 
 
175
.B all
 
176
data verification and correction features.  When using -Z, cd-paranoia
 
177
reads data exactly as would cdda2wav with an overlap setting of zero.
 
178
This option implies that 
 
179
.B \-Y
 
180
is active.
 
181
 
 
182
.TP
 
183
.B \-z --never-skip[=max_retries]
 
184
Do not accept any skips; retry forever if needed.  An optional maximum
 
185
number of retries can be specified; for comparison, default without -z is
 
186
currently 20.
 
187
 
 
188
.TP
 
189
.B \-Y --disable-extra-paranoia
 
190
Disables intra-read data verification; only overlap checking at read
 
191
boundaries is performed. It can wedge if errors occur in the attempted overlap area. Not recommended.
 
192
 
 
193
.TP
 
194
.B \-X --abort-on-skip
 
195
If the read skips due to imperfect data, a scratch, whatever, abort reading this track.  If output is to a file, delete the partially completed file.
 
196
 
 
197
.TP
 
198
.B \-x --test-flags mask
 
199
Simulate CD-reading errors. This is used in regression testing, but
 
200
other uses might be to see how well a CD-ROM performs under
 
201
(simulated) CD degradation. mask specifies the artificial kinds of
 
202
errors to introduced; "or"-ing values from the selection below will
 
203
simulate the kind of specified failure.
 
204
.P
 
205
     0x10  - Simulate under-run reading
 
206
.TP
 
207
 
 
208
 
 
209
.SH OUTPUT SMILIES
 
210
.TP
 
211
.B
 
212
  :-)   
 
213
Normal operation, low/no jitter
 
214
.TP
 
215
.B
 
216
  :-|   
 
217
Normal operation, considerable jitter
 
218
.TP
 
219
.B
 
220
  :-/   
 
221
Read drift
 
222
.TP
 
223
.B
 
224
  :-P   
 
225
Unreported loss of streaming in atomic read operation
 
226
.TP
 
227
.B
 
228
  8-|   
 
229
Finding read problems at same point during reread; hard to correct
 
230
.TP
 
231
.B
 
232
  :-0   
 
233
SCSI/ATAPI transport error
 
234
.TP
 
235
.B
 
236
  :-(   
 
237
Scratch detected
 
238
.TP
 
239
.B
 
240
  ;-(   
 
241
Gave up trying to perform a correction
 
242
.TP
 
243
.B
 
244
  8-X
 
245
Aborted read due to known, uncorrectable error
 
246
.TP
 
247
.B
 
248
  :^D   
 
249
Finished extracting
 
250
 
 
251
.SH PROGRESS BAR SYMBOLS
 
252
.TP
 
253
.B
 
254
<space> 
 
255
No corrections needed
 
256
.TP
 
257
.B
 
258
   -    
 
259
Jitter correction required
 
260
.TP
 
261
.B
 
262
   +    
 
263
Unreported loss of streaming/other error in read
 
264
.TP
 
265
.B
 
266
   !  
 
267
Errors found after stage 1 correction; the drive is making the
 
268
same error through multiple re-reads, and cd-paranoia is having trouble
 
269
detecting them.
 
270
.TP
 
271
.B
 
272
   e    
 
273
SCSI/ATAPI transport error (corrected)
 
274
.TP
 
275
.B
 
276
   V    
 
277
Uncorrected error/skip
 
278
 
 
279
.SH SPAN ARGUMENT
 
280
 
 
281
The span argument specifies which track, tracks or subsections of
 
282
tracks to read.  This argument is required. 
 
283
.B NOTE:
 
284
Unless the span is a simple number, it's generally a good idea to
 
285
quote the span argument to protect it from the shell.
 
286
.P
 
287
The span argument may be a simple track number or an offset/span
 
288
specification.  The syntax of an offset/span takes the rough form:
 
289
.P
 
290
1[ww:xx:yy.zz]-2[aa:bb:cc.dd] 
 
291
.P
 
292
Here, 1 and 2 are track numbers; the numbers in brackets provide a
 
293
finer grained offset within a particular track. [aa:bb:cc.dd] is in
 
294
hours/minutes/seconds/sectors format. Zero fields need not be
 
295
specified: [::20], [:20], [20], [20.], etc, would be interpreted as
 
296
twenty seconds, [10:] would be ten minutes, [.30] would be thirty
 
297
sectors (75 sectors per second).
 
298
.P
 
299
When only a single offset is supplied, it is interpreted as a starting
 
300
offset and ripping will continue to the end of the track.  If a single
 
301
offset is preceeded or followed by a hyphen, the implicit missing
 
302
offset is taken to be the start or end of the disc, respectively. Thus:
 
303
 
 
304
.TP
 
305
.B  1:[20.35]    
 
306
Specifies ripping from track 1, second 20, sector 35 to the end of
 
307
track 1.
 
308
.TP
 
309
.B 1:[20.35]-   
 
310
Specifies ripping from 1[20.35] to the end of the disc
 
311
.TP
 
312
.B \-2           
 
313
Specifies ripping from the beginning of the disc up to (and including) track 2
 
314
.TP
 
315
.B \-2:[30.35]   
 
316
Specifies ripping from the beginning of the disc up to 2:[30.35]
 
317
.TP
 
318
.B 2-4          
 
319
Specifies ripping from the beginning of track 2 to the end of track 4.
 
320
.P
 
321
Again, don't forget to protect square brackets and preceeding hyphens from
 
322
the shell.
 
323
 
 
324
.SH EXAMPLES
 
325
 
 
326
A few examples, protected from the shell:
 
327
.TP
 
328
Query only with exhaustive search for a drive and full reporting of autosense:
 
329
.P
 
330
       cd-paranoia -vsQ
 
331
.TP
 
332
Extract an entire disc, putting each track in a seperate file:
 
333
.P
 
334
       cd-paranoia -B 
 
335
.TP
 
336
Extract from track 1, time 0:30.12 to 1:10.00:
 
337
.P
 
338
       cd-paranoia "1[:30.12]-1[1:10]"
 
339
.TP
 
340
Extract from the beginning of the disc up to track 3:
 
341
.P
 
342
       cd-paranoia -- "-3"
 
343
.TP
 
344
The "--" above is to distinguish "-3" from an option flag.
 
345
.SH OUTPUT
 
346
 
 
347
The output file argument is optional; if it is not specified,
 
348
cd-paranoia will output samples to one of
 
349
.BR cdda.wav ", " cdda.aifc ", or " cdda.raw
 
350
depending on whether 
 
351
.BR \-w ", " \-a ", " \-r " or " \-R " is used (" \-w 
 
352
is the implicit default).  The output file argument of 
 
353
.B \-
 
354
specifies standard output; all data formats may be piped. 
 
355
 
 
356
.SH ACKNOWLEDGEMENTS
 
357
cd-paranoia sprang from and once drew heavily from the interface of
 
358
Heiko Eissfeldt's (heiko@colossus.escape.de) 'cdda2wav'
 
359
package. cd-paranoia would not have happened without it.
 
360
.P
 
361
Joerg Schilling has also contributed SCSI expertise through his
 
362
generic SCSI transport library.
 
363
.P
 
364
.SH AUTHOR
 
365
Monty <monty@xiph.org>
 
366
.P
 
367
Cdparanoia's homepage may be found at:
 
368
http://www.xiph.org/paranoia/
 
369
.P
 
370
Revised for use with libcdio by Rocky <rocky@panix.com>
 
371
.P
 
372
The libcdio homepage may be found at:
 
373
http://www.gnu.org/software/libcdio