From 686e7d6aa545f04d35d9fe2f7bc01ce8b49ace19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Thu, 28 May 2020 20:30:40 -0400 Subject: [PATCH] Add man pages. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes #73. Signed-off-by: Louis-Philippe Véronneau --- man/Makefile | 7 +++ man/README.md | 21 +++++++ man/whipper-accurip.rst | 33 +++++++++++ man/whipper-cd-info.rst | 38 +++++++++++++ man/whipper-cd-rip.rst | 101 ++++++++++++++++++++++++++++++++++ man/whipper-cd.rst | 39 +++++++++++++ man/whipper-drive-analyze.rst | 31 +++++++++++ man/whipper-drive-list.rst | 27 +++++++++ man/whipper-drive.rst | 36 ++++++++++++ man/whipper-image-verify.rst | 33 +++++++++++ man/whipper-image.rst | 35 ++++++++++++ man/whipper-mblookup.rst | 40 ++++++++++++++ man/whipper-offset-find.rst | 34 ++++++++++++ man/whipper-offset.rst | 35 ++++++++++++ man/whipper.rst | 82 +++++++++++++++++++++++++++ 15 files changed, 592 insertions(+) create mode 100755 man/Makefile create mode 100644 man/README.md create mode 100644 man/whipper-accurip.rst create mode 100644 man/whipper-cd-info.rst create mode 100644 man/whipper-cd-rip.rst create mode 100644 man/whipper-cd.rst create mode 100644 man/whipper-drive-analyze.rst create mode 100644 man/whipper-drive-list.rst create mode 100644 man/whipper-drive.rst create mode 100644 man/whipper-image-verify.rst create mode 100644 man/whipper-image.rst create mode 100644 man/whipper-mblookup.rst create mode 100644 man/whipper-offset-find.rst create mode 100644 man/whipper-offset.rst create mode 100644 man/whipper.rst diff --git a/man/Makefile b/man/Makefile new file mode 100755 index 00000000..d8bea5f6 --- /dev/null +++ b/man/Makefile @@ -0,0 +1,7 @@ +MAKEFLAGS += --silent + +build: + for manpage in *.rst; do rst2man --exit-status=2 --report=1 $${manpage} "$${manpage%%.*}".1 ; done + +clean: + rm *.1 diff --git a/man/README.md b/man/README.md new file mode 100644 index 00000000..637ec032 --- /dev/null +++ b/man/README.md @@ -0,0 +1,21 @@ +The man pages in this directory can be generated using the `rst2man` command +line tool provided by the Python `docutils` project: + + rst2man whipper.rst whipper.1 + +Alternatively, you can also build all of the man pages in this directory at the +same time by running (requires `make`): + + make + +or this way (without make): + + for manpage in *.rst; do rst2man --exit-status=2 --report=1 --debug ${manpage} "${manpage%%.*}".1 ; done + +The directory can be cleaned of generated man pages by running: + + make clean + +or this way (without make): + + rm *.1 diff --git a/man/whipper-accurip.rst b/man/whipper-accurip.rst new file mode 100644 index 00000000..9682123f --- /dev/null +++ b/man/whipper-accurip.rst @@ -0,0 +1,33 @@ +=============== +whipper-accurip +=============== + +------------------------------ +Handle AccurateRip information +------------------------------ + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper accurip **show** ** +| whipper accurip **-h** + +Arguments +========= + +| **show** ** Show AccurateRip data for the given URL + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +See Also +======== + +whipper(1) diff --git a/man/whipper-cd-info.rst b/man/whipper-cd-info.rst new file mode 100644 index 00000000..2649c066 --- /dev/null +++ b/man/whipper-cd-info.rst @@ -0,0 +1,38 @@ +=============== +whipper-cd-info +=============== + +---------------------------------------------------- +Retrieve information about the currently inserted CD +---------------------------------------------------- + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper cd info [**-R** **] [**-p**] [**-c** **] +| whipper cd info **-h** + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +| **-R** ** | **--release-id** ** +| MusicBrainz release id to match to (if there are multiple) + +| **-p** | **--prompt** +| Prompt if there are multiple matching releases + +| **-c** ** | **--country** ** +| Filter releases by country + + +See Also +======== + +whipper(1), whipper-cd(1), whipper-cd-rip(1) diff --git a/man/whipper-cd-rip.rst b/man/whipper-cd-rip.rst new file mode 100644 index 00000000..4173a348 --- /dev/null +++ b/man/whipper-cd-rip.rst @@ -0,0 +1,101 @@ +============== +whipper-cd-rip +============== + +--------- +Rips a CD +--------- + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper cd info [**options**] +| whipper cd info **-h** + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +| **-R** ** | **--release-id** ** +| MusicBrainz release id to match to (if there are multiple) + +| **-p** | **--prompt** +| Prompt if there are multiple matching releases + +| **-c** ** | **--country** ** +| Filter releases by country + +| **-L** ** +| Logger to use + +| **-o** ** | **--offset** ** +| Sample read offset + +| **-x** | **--force-overread** +| Force overreading into the lead-out portion of the disc. Works only if +| the patched cdparanoia package is installed and the drive supports this +| feature + +| **-O** ** | **--output-directory** ** +| Output directory; will be included in file paths in log + +| **-W** ** | **--working-directory** ** +| Working directory; whipper will change to this directory and files will +| be created relative to it when not absolute + +| **--track-template** ** +| Template for track file naming + +| **--disc-template** ** +| Template for disc file naming + +| **-U** | **--unknown** +| whether to continue ripping if the CD is unknown + +| **--cdr** +| whether to continue ripping if the disc is a CD-R + +Template schemes +================ + +| 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: release artist +| - %S: release 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 + +See Also +======== + +whipper(1), whipper-cd(1), whipper-cd-info(1) diff --git a/man/whipper-cd.rst b/man/whipper-cd.rst new file mode 100644 index 00000000..d859c598 --- /dev/null +++ b/man/whipper-cd.rst @@ -0,0 +1,39 @@ +========== +whipper-cd +========== + +---------------------------------- +Display and rip CD-DA and metadata +---------------------------------- + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper cd **-d** ** [**subcommand**] +| whipper cd **-h** + +Subcommands +=========== + +| **info** Retrieve information about the currently inserted CD +| **rip** Rip the CD + +| For more details on these subcommands, see their respective man pages. + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +| **-d** ** | **--device** ** +| Path to the CD-DA device + +See Also +======== + +whipper(1), whipper-cd-info(1), whipper-cd-rip(1) diff --git a/man/whipper-drive-analyze.rst b/man/whipper-drive-analyze.rst new file mode 100644 index 00000000..c158342c --- /dev/null +++ b/man/whipper-drive-analyze.rst @@ -0,0 +1,31 @@ +===================== +whipper-drive-analyze +===================== + +-------------------------------------------------------------------- +Determine whether cdparanoia can defeat the audio cache of the drive +-------------------------------------------------------------------- + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper drive analyze [**-d** **] +| whipper drive analyze **-h** + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +| **-d** ** | **--device** ** +| Path to the CD-DA device + +See Also +======== + +whipper(1), whipper-drive(1), whipper-drive-list(1) diff --git a/man/whipper-drive-list.rst b/man/whipper-drive-list.rst new file mode 100644 index 00000000..e2ffdd23 --- /dev/null +++ b/man/whipper-drive-list.rst @@ -0,0 +1,27 @@ +===================== +whipper-drive-analyze +===================== + +--------------------------- +List available CD-DA drives +--------------------------- + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper drive list [**-h**] + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +See Also +======== + +whipper(1), whipper-drive(1), whipper-drive-analyze(1) diff --git a/man/whipper-drive.rst b/man/whipper-drive.rst new file mode 100644 index 00000000..c4bff523 --- /dev/null +++ b/man/whipper-drive.rst @@ -0,0 +1,36 @@ +============= +whipper-drive +============= + +--------------- +Drive utilities +--------------- + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper drive [**subcommand**] +| whipper drive **-h** + +Subcommands +=========== + +| **analyze** Analyze caching behaviour of drive +| **list** List drives + +| For more details on these subcommands, see their respective man pages. + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +See Also +======== + +whipper(1), whipper-drive-analyze(1), whipper-drive-list(1) diff --git a/man/whipper-image-verify.rst b/man/whipper-image-verify.rst new file mode 100644 index 00000000..15323904 --- /dev/null +++ b/man/whipper-image-verify.rst @@ -0,0 +1,33 @@ +==================== +whipper-image-verify +==================== + +----------------------------------------------------------------------------- +Verifies the image from the given .cue files against the AccurateRip database +----------------------------------------------------------------------------- + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper image verify ** +| whipper image verify **-h** + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +Arguments +========= + +| ** CUE file to load rip image from + +See Also +======== + +whipper(1), whipper-image(1) diff --git a/man/whipper-image.rst b/man/whipper-image.rst new file mode 100644 index 00000000..d41308f6 --- /dev/null +++ b/man/whipper-image.rst @@ -0,0 +1,35 @@ +============= +whipper-image +============= + +------------------ +Handle disc images +------------------ + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper image [**subcommand**] +| whipper image **-h** + +Subcommands +=========== + +| **verify** Verify image + +| For more details on these subcommands, see their respective man pages. + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +See Also +======== + +whipper(1), whipper-image-verify(1) diff --git a/man/whipper-mblookup.rst b/man/whipper-mblookup.rst new file mode 100644 index 00000000..75edc652 --- /dev/null +++ b/man/whipper-mblookup.rst @@ -0,0 +1,40 @@ +================ +whipper-mblookup +================ + +---------------------------------------------------- +Look up a MusicBrainz disc id and output information +---------------------------------------------------- + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper mblookup ** +| whipper mblookup **-h** + +Arguments +========= + +| ** MusicBrainz disc id to look up + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +Examples +======== + +You can lookup a MusicBrainz disc id and output its information this way:: + + whipper mblookup KnpGsLhvH.lPrNc1PBL21lb9Bg4- + +See Also +======== + +whipper(1) diff --git a/man/whipper-offset-find.rst b/man/whipper-offset-find.rst new file mode 100644 index 00000000..a5008098 --- /dev/null +++ b/man/whipper-offset-find.rst @@ -0,0 +1,34 @@ +=================== +whipper-offset-find +=================== + +-------------------------------------------------------------------------------- +Find drive's read offset by ripping tracks from a CD in the AccurateRip database +-------------------------------------------------------------------------------- + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper offset find [**-o** **] [**-d** **] +| whipper offset find **-h** + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +| **-o** ** | **--offsets** ** +| List of offsets, comma-separated, colon-separated for range + +| **-d** ** | **--device** ** +| Path to the CD-DA device + +See Also +======== + +whipper(1), whipper-offset(1) diff --git a/man/whipper-offset.rst b/man/whipper-offset.rst new file mode 100644 index 00000000..63bd8bcc --- /dev/null +++ b/man/whipper-offset.rst @@ -0,0 +1,35 @@ +============== +whipper-offset +============== + +------------------------------ +Drive offset detection utility +------------------------------ + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper offset [**subcommand**] +| whipper offset **-h** + +Subcommands +=========== + +| **find** Find drive read offset + +| For more details on these subcommands, see their respective man pages. + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +See Also +======== + +whipper(1), whipper-offset-find(1) diff --git a/man/whipper.rst b/man/whipper.rst new file mode 100644 index 00000000..edf695ec --- /dev/null +++ b/man/whipper.rst @@ -0,0 +1,82 @@ +======= +whipper +======= + +---------------------------------------------------- +A CD ripping utility focusing on accuracy over speed +---------------------------------------------------- + +:Author: Louis-Philippe Véronneau +:Date: 2020 +:Manual section: 1 + +Synopsis +======== + +| whipper [**subcommand**] +| whipper [**-R**] [**-v**] [**-h**] [**-e** *{never failure success always}*] + +Description +=========== + +| **whipper** is a CD ripping utility focusing on accuracy over speed that +| supports multiple features. As such, **whipper**: + +| + +| * Detects correct read offset (in samples) +| * Detects whether ripped media is a CD-R +| * Has ability to defeat cache of drives +| * Performs Test & Copy rips +| * Verifies rip accuracy using the AccurateRip database +| * Uses MusicBrainz for metadata lookup +| * Supports reading the pre-emphasis flag embedded into some CDs (and +| correctly tags the resulting rip) +| * Detects and rips non digitally silent Hidden Track One Audio (HTOA) +| * Provides batch ripping capabilities +| * Provides templates for file and directory naming +| * Supports lossless encoding of ripped audio tracks (FLAC) +| * Allows extensibility through external logger plugins + +Options +======= + +| **-h** | **--help** +| Show this help message and exit + +| **-e** | **--eject** *never failure success always* +| When to eject disc (default: success) + +| **-R** | **--record** +| Record API requests for playback + +| **-v** | **--version** +| Show version information + +Subcommands +=========== + +**whipper** gives you a tree of subcommands to work with, namely: + +| + +| * accurip +| * cd +| * drive +| * image +| * mblookup +| * offset + +| For more details on these subcommands, see their respective man pages. + +Bugs +==== + +| Bugs can be reported to your distribution's bug tracker or upstream +| at https://github.com/whipper-team/whipper/issues. + +See Also +======== + +whipper-accurip(1), whipper-cd(1), whipper-drive(1), whipper-image(1), +whipper-mblookup(1), whipper-offset(1)