From a4fd28dad7d0e1f360f48cff1bde3ec2cbfbc6a3 Mon Sep 17 00:00:00 2001 From: JoeLametta Date: Mon, 6 Jan 2020 11:18:14 +0000 Subject: [PATCH 1/4] WIP: Add manpage This manpage is based on morituri's one (Debian version). See: https://manpages.debian.org/jessie/morituri/rip.1 Fixes #73. Signed-off-by: JoeLametta --- doc/whipper.1 | 295 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 295 insertions(+) create mode 100644 doc/whipper.1 diff --git a/doc/whipper.1 b/doc/whipper.1 new file mode 100644 index 00000000..c346ed67 --- /dev/null +++ b/doc/whipper.1 @@ -0,0 +1,295 @@ +.TH "whipper" "1" "Januray 2020" +.SH whipper +Usage: whipper [command] + +whipper is a CD ripping utility focusing on accuracy over speed. + +Whipper gives you a tree of subcommands to work with. +You can get help on subcommands by using the -h option to the subcommand. + +Commands: + accurip handle AccurateRip information + cd handle CDs + drive handle drives + image handle images + offset handle drive offsets + mblookup lookup MusicBrainz entry + +Implemented by: whipper.command.main.Whipper + +Options: + -h, --help show this help message and exit + -e --eject when to eject disc (default: success) + -R, --record record API requests for playback + -v, --version show version information + + +.SH whipper accurip +Usage: whipper accurip [command] + +Handle AccurateRip information. + +Handle AccurateRip information. Retrieves AccurateRip disc entries and +displays diagnostic information. + +Commands: + show show accuraterip data + +Implemented by: whipper.command.accurip.AccuRip + +Options: + -h, --help show this help message and exit + + +.SH whipper accurip show +Usage: whipper accurip show + +Show accuraterip data + +Retrieves and display accuraterip data from the given URL + +Implemented by: whipper.command.accurip.Show + +Options: + -h, --help show this help message and exit + --url accuraterip URL to load data from + + +.SH whipper cd +handle CDs + +Usage: whipper cd [command] + +Display and rip CD-DA and metadata. + +Commands: + info retrieve information about the currently inserted CD + rip rip CD + +Implemented by: whipper.command.cd.CD + +Options: + -h, --help show this help message and exit + -d DEVICE, --device=DEVICE + CD-DA device + + +.SH whipper cd info +Usage: whipper cd info + +retrieve information about the currently inserted CD + +Implemented by: whipper.command.cd.Info + +Options: + -h, --help show this help message and exit + -T TOC_PICKLE, --toc-pickle=TOC_PICKLE + pickle to use for reading and writing the TOC + -R RELEASE_ID, --release-id=RELEASE_ID + MusicBrainz release id to match to (if there + are multiple) + + +.SH whipper cd rip +rip CD + +Usage: whipper cd rip + +Rips a CD. + + Tracks are named according to the track template, filling in the +variables and adding the file extension. Variables exclusive to the +track template are: + - %t: track number + - %a: track artist + - %n: track title + - %s: track sort name + +Disc files (.cue, .log, .m3u) are named according to the disc +template, filling in the variables and adding the file extension. +Variables for both disc and track template are: + - %A: album artist + - %S: album sort name + - %d: disc title + - %y: release year + - %r: release type, lowercase + - %R: Release type, normal case + - %x: audio extension, lowercase + - %X: audio extension, uppercase + + +Paths to track files referenced in .cue and .m3u files will be made +relative to the directory of the disc files. + +All files will be created relative to the given output directory. Log +files will log the path to tracks relative to this directory. + +Implemented by: whipper.command.cd.Rip + +Options: + -h, --help show this help message and exit + -T TOC_PICKLE, --toc-pickle=TOC_PICKLE + pickle to use for reading and writing the TOC + -R RELEASE_ID, --release-id=RELEASE_ID + MusicBrainz release id to match to (if there + are multiple) + -L LOGGER, --logger=LOGGER + logger to use (default 'whipper', choose from + 'whipper') + -o OFFSET, --offset=OFFSET + sample read offset (defaults to configured + value, or 0) + -O OUTPUT_DIRECTORY, --output-directory=OUTPUT_DIRECTORY + output directory; will be included in file + paths in result files (defaults to absolute + path to current directory; set to empty if you + want paths to be relative instead) + -W WORKING_DIRECTORY, --working-directory=WORKING_DIRECTORY + working directory; whipper will change to + this directory and files will be created + relative to it when not absolute + --track-template=TRACK_TEMPLATE + template for track file naming (default %r/%A + - %d/%t. %a - %n) + --disc-template=DISC_TEMPLATE + template for disc file naming (default %r/%A - + %d/%A - %d) + --profile=PROFILE profile for encoding (default 'flac', choices + 'wav', 'wavpack', 'alac', 'flac') + -U, --unknown whether to continue ripping if the CD is + unknown (False) + + +.SH whipper drive +handle drives + +Usage: whipper drive [command] + +handle drives + +Commands: + analyze analyze caching behaviour of drive + list list drives + +Implemented by: whipper.command.drive.Drive + +Options: + -h, --help show this help message and exit + + +.SH whipper drive analyze +Usage: whipper drive analyze + +analyze caching behaviour of drive + +Implemented by: whipper.command.drive.Analyze + +Options: + -h, --help show this help message and exit + -d DEVICE, --device=DEVICE + CD-DA device + + +.SH whipper drive list +Usage: whipper drive list + +list drives + +Implemented by: whipper.command.drive.List + +Options: + -h, --help show this help message and exit + + +.SH whipper image +handle images + +Usage: whipper image [command] + +Handle disc images. Disc images are described by a .cue file. Disc +images can be encoded to another format (for example, to make a +compressed encoding), retagged and verified. + +Commands: + verify verify image + +Implemented by: whipper.command.image.Image + +Options: + -h, --help show this help message and exit + + +.SH whipper image verify +verify image + +Usage: whipper image verify [CUEFILE]... + +Verifies the image from the given .cue files against the AccurateRip +database. + +Implemented by: whipper.command.image.Verify + +Options: + -h, --help show this help message and exit + + +.SH whipper offset +handle drive offsets + +Usage: whipper offset [command] + +handle drive offsets + +Commands: + find find drive read offset + +Implemented by: whipper.command.offset.Offset + +Options: + -h, --help show this help message and exit + + +.SH whipper offset find +find drive read offset + +Usage: whipper offset find + +Find drive's read offset by ripping tracks from a CD in the +AccurateRip database. + +Implemented by: whipper.command.offset.Find + +Options: + -h, --help show this help message and exit + -o OFFSETS, --offsets=OFFSETS + list of offsets, comma-separated, colon- + separated for ranges (defaults to +6, +48, + +102, +667, +12, +30, +618, +594, +738, -472, + +98, +116, +96, +733, +120, +691, +685, +97, + +600, +690, +1292, +99, +676, +686, +1182, + -24, +704, +572, +688, +91, +696, +103, -491, + +689, +145, +708, +697, +564, +86, +679, +355, + -496, -1164, +1160, +694, 0, -436, +79, +94, + +684, +681, +106, +692, +943, +1194, +92, + +117, +680, +682, +1268, +678, -582, +1473, + +1279, -54, +1508, +740, +1272, +534, +976, + +687, +675, +1303, +674, +1263, +108, +974, + +122, +111, -489, +772, +732, -495, -494, + +975, +935, +87, +668, +1776, +1364, +1336, + +1127) + -d DEVICE, --device=DEVICE + CD-DA device + + +.SH whipper mblookup +lookup MusicBrainz entry + +Usage: whipper mblookup [command] + +Look up a MusicBrainz disc id and output information. + +Implemented by: whipper.command.mblookup.MBLookup + +Options: + -h, --help show this help message and exit + --mbid MB disc id or release id to look up From 3f89c76be930b439518c2d3878569a24bdcdcb16 Mon Sep 17 00:00:00 2001 From: JoeLametta Date: Mon, 6 Jan 2020 14:59:31 +0000 Subject: [PATCH 2/4] Improve manpage Signed-off-by: JoeLametta --- doc/whipper.1 | 136 +++++++++++++++++++++++--------------------------- 1 file changed, 62 insertions(+), 74 deletions(-) diff --git a/doc/whipper.1 b/doc/whipper.1 index c346ed67..6abeb9c7 100644 --- a/doc/whipper.1 +++ b/doc/whipper.1 @@ -2,18 +2,18 @@ .SH whipper Usage: whipper [command] -whipper is a CD ripping utility focusing on accuracy over speed. +Whipper is a CD ripping utility focusing on accuracy over speed. Whipper gives you a tree of subcommands to work with. You can get help on subcommands by using the -h option to the subcommand. Commands: - accurip handle AccurateRip information - cd handle CDs - drive handle drives - image handle images - offset handle drive offsets - mblookup lookup MusicBrainz entry + accurip handle AccurateRip information + cd handle CDs + drive handle drives + image handle images + offset handle drive offsets + mblookup lookup MusicBrainz entry Implemented by: whipper.command.main.Whipper @@ -29,11 +29,10 @@ Usage: whipper accurip [command] Handle AccurateRip information. -Handle AccurateRip information. Retrieves AccurateRip disc entries and -displays diagnostic information. +Retrieves AccurateRip disc entries and displays diagnostic information. Commands: - show show accuraterip data + show show AccurateRip data Implemented by: whipper.command.accurip.AccuRip @@ -42,24 +41,23 @@ Options: .SH whipper accurip show -Usage: whipper accurip show +Usage: whipper accurip show [URL] -Show accuraterip data +Show AccurateRip data -Retrieves and display accuraterip data from the given URL +Retrieves and display AccurateRip data from the given URL Implemented by: whipper.command.accurip.Show Options: -h, --help show this help message and exit - --url accuraterip URL to load data from .SH whipper cd -handle CDs - Usage: whipper cd [command] +Handle CDs + Display and rip CD-DA and metadata. Commands: @@ -69,15 +67,15 @@ Commands: Implemented by: whipper.command.cd.CD Options: - -h, --help show this help message and exit + -h, --help show this help message and exit -d DEVICE, --device=DEVICE - CD-DA device + CD-DA device .SH whipper cd info Usage: whipper cd info -retrieve information about the currently inserted CD +Retrieve information about the currently inserted CD Implemented by: whipper.command.cd.Info @@ -91,33 +89,29 @@ Options: .SH whipper cd rip -rip CD - Usage: whipper cd rip Rips a CD. - Tracks are named according to the track template, filling in the -variables and adding the file extension. Variables exclusive to the -track template are: +Tracks are named according to the track template, filling in the variables +and adding the file extension. Variables exclusive to the track template are: - %t: track number - %a: track artist - %n: track title - %s: track sort name -Disc files (.cue, .log, .m3u) are named according to the disc -template, filling in the variables and adding the file extension. -Variables for both disc and track template are: - - %A: album artist - - %S: album sort name +Disc files (.cue, .log, .m3u) are named according to the disc template, +filling in the variables and adding the file extension. Variables for both +disc and track template are: + - %A: release artist + - %S: release sort name - %d: disc title - %y: release year - %r: release type, lowercase - - %R: Release type, normal case + - %R: release type, normal case - %x: audio extension, lowercase - %X: audio extension, uppercase - Paths to track files referenced in .cue and .m3u files will be made relative to the directory of the disc files. @@ -134,11 +128,12 @@ Options: MusicBrainz release id to match to (if there are multiple) -L LOGGER, --logger=LOGGER - logger to use (default 'whipper', choose from - 'whipper') + logger to use (default 'whipper') -o OFFSET, --offset=OFFSET sample read offset (defaults to configured value, or 0) + -p, --prompt prompt if there are multiple matching releases + -c, --country filter releases by country -O OUTPUT_DIRECTORY, --output-directory=OUTPUT_DIRECTORY output directory; will be included in file paths in result files (defaults to absolute @@ -156,16 +151,16 @@ Options: %d/%A - %d) --profile=PROFILE profile for encoding (default 'flac', choices 'wav', 'wavpack', 'alac', 'flac') - -U, --unknown whether to continue ripping if the CD is - unknown (False) + -U, --unknown whether to continue ripping if the CD is unknown + -x, --force-overread force overreading into the lead-out portion of + the disc. Requires software/drive support to work + --cdr whether to continue ripping if the disc is a CD-R .SH whipper drive -handle drives - Usage: whipper drive [command] -handle drives +Drive utilities. Commands: analyze analyze caching behaviour of drive @@ -180,7 +175,7 @@ Options: .SH whipper drive analyze Usage: whipper drive analyze -analyze caching behaviour of drive +Determine whether cdparanoia can defeat the audio cache of the drive. Implemented by: whipper.command.drive.Analyze @@ -193,7 +188,7 @@ Options: .SH whipper drive list Usage: whipper drive list -list drives +List available CD-DA drives. Implemented by: whipper.command.drive.List @@ -202,13 +197,10 @@ Options: .SH whipper image -handle images - Usage: whipper image [command] -Handle disc images. Disc images are described by a .cue file. Disc -images can be encoded to another format (for example, to make a -compressed encoding), retagged and verified. +Handle disc images. Disc images are described by a .cue file. +Disc images can be verified. Commands: verify verify image @@ -220,8 +212,6 @@ Options: .SH whipper image verify -verify image - Usage: whipper image verify [CUEFILE]... Verifies the image from the given .cue files against the AccurateRip @@ -234,11 +224,10 @@ Options: .SH whipper offset -handle drive offsets - Usage: whipper offset [command] -handle drive offsets +Handle drive offsets. +Drive offset detection utility. Commands: find find drive read offset @@ -250,46 +239,45 @@ Options: .SH whipper offset find -find drive read offset - Usage: whipper offset find -Find drive's read offset by ripping tracks from a CD in the -AccurateRip database. +Find drive's read offset by ripping tracks from a +CD in the AccurateRip database. Implemented by: whipper.command.offset.Find Options: -h, --help show this help message and exit - -o OFFSETS, --offsets=OFFSETS - list of offsets, comma-separated, colon- - separated for ranges (defaults to +6, +48, - +102, +667, +12, +30, +618, +594, +738, -472, - +98, +116, +96, +733, +120, +691, +685, +97, - +600, +690, +1292, +99, +676, +686, +1182, - -24, +704, +572, +688, +91, +696, +103, -491, - +689, +145, +708, +697, +564, +86, +679, +355, - -496, -1164, +1160, +694, 0, -436, +79, +94, - +684, +681, +106, +692, +943, +1194, +92, - +117, +680, +682, +1268, +678, -582, +1473, - +1279, -54, +1508, +740, +1272, +534, +976, - +687, +675, +1303, +674, +1263, +108, +974, - +122, +111, -489, +772, +732, -495, -494, - +975, +935, +87, +668, +1776, +1364, +1336, - +1127) -d DEVICE, --device=DEVICE CD-DA device + -o OFFSETS, --offsets=OFFSETS + list of offsets, comma-separated, colon-separated + for ranges (defaults to: +6, +667, +48, +102, +12, + +30, +103, +618, +96, +594, +738, +98, -472, +116, + +733, +696, +120, +691, +685, +99, +97, +600, +676, + +690, +1292, +702, +686, -24, +704, +697, +572, + +1182, +688, +91, -491, +145, +689, +564, +708, + +86, +355, +79, -496, +679, -1164, 0, +1160, -436, + +694, +684, +94, +1194, +106, +681, +117, +692, + +943, +92, +680, +678, +682, +1268, +1279, +1473, + -582, -54, +674, +687, +1272, +1263, +1508, +675, + +534, +740, +122, -489, +974, +976, +1303, +108, + +1130, +111, +739, +732, -589, -495, -494, +975, + +961, +935, +87, +668, +234, +1776, +138, +1364, + +1336, +1262, +1127) .SH whipper mblookup -lookup MusicBrainz entry +Usage: whipper mblookup [MUSICBRAINZ_ID] + +Look up a MusicBrainz disc ID/release ID and output information. -Usage: whipper mblookup [command] +You can get the MusicBrainz disc id with whipper cd info. -Look up a MusicBrainz disc id and output information. +Example disc ID: KnpGsLhvH.lPrNc1PBL21lb9Bg4- +Example release ID: c56ff16e-1d81-47de-926f-ba22891bd2bd Implemented by: whipper.command.mblookup.MBLookup Options: -h, --help show this help message and exit - --mbid MB disc id or release id to look up From c531fd09025c538ca94578fb52d4d2d7e8c2a0c6 Mon Sep 17 00:00:00 2001 From: JoeLametta Date: Mon, 6 Jan 2020 15:01:41 +0000 Subject: [PATCH 3/4] Remove "profile" option Signed-off-by: JoeLametta --- doc/whipper.1 | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/whipper.1 b/doc/whipper.1 index 6abeb9c7..ba94141a 100644 --- a/doc/whipper.1 +++ b/doc/whipper.1 @@ -149,8 +149,6 @@ Options: --disc-template=DISC_TEMPLATE template for disc file naming (default %r/%A - %d/%A - %d) - --profile=PROFILE profile for encoding (default 'flac', choices - 'wav', 'wavpack', 'alac', 'flac') -U, --unknown whether to continue ripping if the CD is unknown -x, --force-overread force overreading into the lead-out portion of the disc. Requires software/drive support to work From f5e301e207a316d5ed1e26be49fc7159443f1f9e Mon Sep 17 00:00:00 2001 From: JoeLametta Date: Sat, 22 Feb 2020 19:02:35 +0000 Subject: [PATCH 4/4] Misc changes - Improved formatting - Added new whipper cd rip options Signed-off-by: JoeLametta --- doc/whipper.1 | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/whipper.1 b/doc/whipper.1 index ba94141a..16ecad32 100644 --- a/doc/whipper.1 +++ b/doc/whipper.1 @@ -1,10 +1,11 @@ -.TH "whipper" "1" "Januray 2020" +.TH "whipper" "1" "February 2020" .SH whipper Usage: whipper [command] Whipper is a CD ripping utility focusing on accuracy over speed. Whipper gives you a tree of subcommands to work with. + You can get help on subcommands by using the -h option to the subcommand. Commands: @@ -153,6 +154,11 @@ Options: -x, --force-overread force overreading into the lead-out portion of the disc. Requires software/drive support to work --cdr whether to continue ripping if the disc is a CD-R + -C, --cover-art fetch cover art and save it as standalone file, + embed into FLAC files or perform both actions: + file, embed, complete option values respectively + -r, --max-retries number of rip attempts before giving up if can't + rip a track. This defaults to 5; 0 means infinity. .SH whipper drive @@ -198,6 +204,7 @@ Options: Usage: whipper image [command] Handle disc images. Disc images are described by a .cue file. + Disc images can be verified. Commands: @@ -225,6 +232,7 @@ Options: Usage: whipper offset [command] Handle drive offsets. + Drive offset detection utility. Commands: