Blame src/usage-copy.h

Packit cb6d3d
/*
Packit cb6d3d
  Copyright (C) 1999, 2005, 2008, 2009 Rocky Bernstein
Packit cb6d3d
  Copyright (C) 2014 Robert Kausch <robert.kausch@freac.org>
Packit cb6d3d
*/
Packit cb6d3d
Packit cb6d3d
const char usage_help[] =
Packit cb6d3d
"USAGE:\n"
Packit cb6d3d
"  cd-paranoia [options]  [outfile]\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"OPTIONS:\n"
Packit cb6d3d
"  -A --analyze-drive              : run and log a complete analysis of drive\n"
Packit cb6d3d
"                                    caching, timing and reading behavior;\n"
Packit cb6d3d
"                                    verifies that cdparanoia is correctly\n"
Packit cb6d3d
"                                    modelling a specific drive's cache and\n"
Packit cb6d3d
"                                    read behavior. Implies -vQL\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"  -v --verbose                    : extra verbose operation\n"
Packit cb6d3d
"  -q --quiet                      : quiet operation\n"
Packit cb6d3d
"  -e --stderr-progress            : force output of progress information to\n"
Packit cb6d3d
"  -l --log-summary         <file> : save result summary to file\n"
Packit cb6d3d
"                                    stderr (for wrapper scripts)\n"
Packit cb6d3d
"  -L --log-debug           <file> : save detailed device autosense and\n"
Packit cb6d3d
"                                    debugging output to file\n"
Packit cb6d3d
"                                    stderr (for wrapper scripts)\n"
Packit cb6d3d
"  -V --version                    : print version info and quit\n"
Packit cb6d3d
"  -Q --query                      : autosense drive, query disc and quit\n"
Packit cb6d3d
"  -B --batch                      : 'batch' mode (saves each track to a\n"
Packit cb6d3d
"                                    seperate file.\n"
Packit cb6d3d
"  -s --search-for-drive           : do an exhaustive search for drive\n"
Packit cb6d3d
"  -h --help                       : print help\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"  -p --output-raw                 : output raw 16 bit PCM in host byte \n"
Packit cb6d3d
"                                    order\n"
Packit cb6d3d
"  -r --output-raw-little-endian   : output raw 16 bit little-endian PCM\n"
Packit cb6d3d
"  -R --output-raw-big-endian      : output raw 16 bit big-endian PCM\n"
Packit cb6d3d
"  -w --output-wav                 : output as WAV file (default)\n"
Packit cb6d3d
"  -f --output-aiff                : output as AIFF file\n"
Packit cb6d3d
"  -a --output-aifc                : output as AIFF-C file\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"  -c --force-cdrom-little-endian  : force treating drive as little endian\n"
Packit cb6d3d
"  -C --force-cdrom-big-endian     : force treating drive as big endian\n"
Packit cb6d3d
"  -n --force-default-sectors <n>  : force default number of sectors in read\n"
Packit cb6d3d
"                                    to n sectors\n"
Packit cb6d3d
"  -o --force-search-overlap  <n>  : force minimum overlap search during\n"
Packit cb6d3d
"                                    verification to n sectors\n"
Packit cb6d3d
"  -d --force-cdrom-device   <dev> : use specified device; disallow \n"
Packit cb6d3d
"                                    autosense\n"
Packit cb6d3d
"  -k --force-cooked-device  <dev> : really an alias for -d. Kept for \n"
Packit cb6d3d
"                                    compatibility.\n"
Packit cb6d3d
"  -g --force-generic-device <dev> : really an alias for -d. Kept for \n"
Packit cb6d3d
"                                    compatibility.\n"
Packit cb6d3d
"  -S --force-read-speed <n>       : read from device at specified speed; by\n"
Packit cb6d3d
"                                    default, cdparanoia sets drive to full\n"
Packit cb6d3d
"                                    speed.\n"
Packit cb6d3d
"  -t --toc-offset <n>             : Add <n> sectors to the values reported\n"
Packit cb6d3d
"                                    when addressing tracks. May be negative\n"
Packit cb6d3d
"  -T --toc-bias                   : Assume that the beginning offset of \n"
Packit cb6d3d
"                                    track 1 as reported in the TOC will be\n"
Packit cb6d3d
"                                    addressed as LBA 0.  Necessary for some\n"
Packit cb6d3d
"                                    Toshiba drives to get track boundaries\n"
Packit cb6d3d
"                                    correct\n"
Packit cb6d3d
"  -m --mmc-timeout <n>            : Set SCSI-MMC timeout to <n> seconds.\n"
Packit cb6d3d
"  -O --sample-offset <n>          : Add <n> samples to the offset when\n"
Packit cb6d3d
"                                    reading data.  May be negative.\n"
Packit cb6d3d
"  -z --never-skip[=n]             : never accept any less than perfect\n"
Packit cb6d3d
"                                    data reconstruction (don't allow 'V's)\n"
Packit cb6d3d
"                                    but if [n] is given, skip after [n]\n"
Packit cb6d3d
"                                    retries without progress.\n"
Packit cb6d3d
"  -Z --disable-paranoia           : disable all paranoia checking\n"
Packit cb6d3d
"  -Y --disable-extra-paranoia     : only do cdda2wav-style overlap checking\n"
Packit cb6d3d
"  -X --abort-on-skip              : abort on imperfect reads/skips\n"
Packit cb6d3d
"  -x --test-flags=mask            : simulate CD-reading errors of ilk-mask n\n"
Packit cb6d3d
"                                    mask & 0x10  - simulate underrun errors\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"OUTPUT SMILIES:\n"
Packit cb6d3d
"  :-)   Normal operation, low/no jitter\n"
Packit cb6d3d
"  :-|   Normal operation, considerable jitter\n"
Packit cb6d3d
"  :-/   Read drift\n"
Packit cb6d3d
"  :-P   Unreported loss of streaming in atomic read operation\n"
Packit cb6d3d
"  8-|   Finding read problems at same point during reread; hard to correct\n"
Packit cb6d3d
"  :-0   SCSI/ATAPI transport error\n"
Packit cb6d3d
"  :-(   Scratch detected\n"
Packit cb6d3d
"  ;-(   Gave up trying to perform a correction\n"
Packit cb6d3d
"  8-X   Aborted (as per -X) due to a scratch/skip\n"
Packit cb6d3d
"  :^D   Finished extracting\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"PROGRESS BAR SYMBOLS:\n"
Packit cb6d3d
"<space> No corrections needed\n"
Packit cb6d3d
"   -    Jitter correction required\n"
Packit cb6d3d
"   +    Unreported loss of streaming/other error in read\n"
Packit cb6d3d
"   !    Errors are getting through stage 1 but corrected in stage2\n"
Packit cb6d3d
"   e    SCSI/ATAPI transport error (corrected)\n"
Packit cb6d3d
"   V    Uncorrected error/skip\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"SPAN ARGUMENT:\n"
Packit cb6d3d
"The span argument may be a simple track number or a offset/span\n"
Packit cb6d3d
"specification.  The syntax of an offset/span takes the rough form:\n"
Packit cb6d3d
"  \n"
Packit cb6d3d
"                       1[ww:xx:yy.zz]-2[aa:bb:cc.dd] \n"
Packit cb6d3d
"\n"
Packit cb6d3d
"Here, 1 and 2 are track numbers; the numbers in brackets provide a\n"
Packit cb6d3d
"finer grained offset within a particular track. [aa:bb:cc.dd] is in\n"
Packit cb6d3d
"hours/minutes/seconds/sectors format. Zero fields need not be\n"
Packit cb6d3d
"specified: [::20], [:20], [20], [20.], etc, would be interpreted as\n"
Packit cb6d3d
"twenty seconds, [10:] would be ten minutes, [.30] would be thirty\n"
Packit cb6d3d
"sectors (75 sectors per second).\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"When only a single offset is supplied, it is interpreted as a starting\n"
Packit cb6d3d
"offset and ripping will continue to the end of he track.  If a single\n"
Packit cb6d3d
"offset is preceeded or followed by a hyphen, the implicit missing\n"
Packit cb6d3d
"offset is taken to be the start or end of the disc, respectively. Thus:\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"    1:[20.35]    Specifies ripping from track 1, second 20, sector 35 to \n"
Packit cb6d3d
"                 the end of track 1.\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"    1:[20.35]-   Specifies ripping from 1[20.35] to the end of the disc\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"    -2           Specifies ripping from the beginning of the disc up to\n"
Packit cb6d3d
"                 (and including) track 2\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"    -2:[30.35]   Specifies ripping from the beginning of the disc up to\n"
Packit cb6d3d
"                 2:[30.35]\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"    2-4          Specifies ripping from the beginning of track two to the\n"
Packit cb6d3d
"                 end of track 4.\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"Don't forget to protect square brackets and preceeding hyphens from\n"
Packit cb6d3d
"the shell...\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"A few examples, protected from the shell:\n"
Packit cb6d3d
"  A) query only with exhaustive search for a drive and full reporting\n"
Packit cb6d3d
"     of autosense:\n"
Packit cb6d3d
"       cd-paranoia -vsQ\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"  B) extract up to and including track 3, putting each track in a seperate\n"
Packit cb6d3d
"     file:\n"
Packit cb6d3d
"       cd-paranoia -B -- \"-3\"\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"  C) extract from track 1, time 0:30.12 to 1:10.00:\n"
Packit cb6d3d
"       cd-paranoia \"[:30.12]-1[1:10]\"\n"
Packit cb6d3d
"\n"
Packit cb6d3d
"Submit bug reports to bug-libcdio@gnu.org\n"
Packit cb6d3d
"\n"
Packit cb6d3d
;