auto-regenerate man/html pages

4 files changed, 64 insertions, 44 deletions

diff --git a/cuerecover.1 b/cuerecover.1
index 0f72d89..7395e91 100644
--- a/cuerecover.1
+++ b/cuerecover.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH CUERECOVER 1 "2020-05-11" "0.1.0" "Urchlay"
+.TH CUERECOVER 1 "2020-05-12" "0.1.0" "Urchlay"
 .SH NAME
 cuerecover \- generate .cue file for CD image .bin
 .
@@ -42,13 +42,11 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .
 .SH SYNOPSIS
 .sp
-cuerecover [\-s sec] \fBbin\-file\fP [\fBbin\-file\fP ...]
+cuerecover [\-o output] [\-s sec] [\-t thresh] \fBbin\-file\fP [\fBbin\-file\fP ...]
 .SH DESCRIPTION
 .sp
 cuerecover attempts to generate a usable cue sheet for CD images which
-are missing their .cue (or .ccd, .mds, etc) files. The generated cue
-sheet is written to standard output [*], so add e.g. "> filename.cue"
-to redirect it to a file.
+are missing their .cue (or .ccd, .mds, etc) files.
 .sp
 If a single .bin file is given, it\(aqs assumed to hold all the tracks (which
 might only be one). If multiple .bin files are given, each one is assumed to
@@ -74,13 +72,20 @@ messages are printed to standard error.
 .B \-\-help
 Print short usage string.
 .TP
+.BI \-o \ <file>
+Write cue file to \fIfile\fP rather than standard output. If
+\fIfile\fP already exists, cuerecover will refuse to overwrite it,
+which makes this safer than redirecting stdout.
+.TP
 .BI \-s \ <sec>
 Minimum amount of silence for detecting the split point between
-two audio tracks (default: 2). Argument is in seconds, and
-non\-integers are allowed. 0 means to disable splitting tracks:
-all the audio tracks will be combined into one in the .cue
-sheet. This option is ignored when multiple .bin file arguments
-are given, since they\(aqre already split into tracks.
+two audio tracks. Argument is in seconds, and decimals
+are allowed. The default is 2, which is the standard sized
+gap between tracks in the Redbook standard and in most CD
+authoring software. 0 means to disable splitting tracks:
+all the audio tracks will be combined into one in the
+.cue sheet. This option is ignored when multiple .bin file
+arguments are given, since they\(aqre already split into tracks.
 .TP
 .BI \-t \ <thresh>
 Silence threshold, 0 to 100. Default is 0. This is
@@ -88,7 +93,9 @@ the percentage of non\-zero bytes allowed in a sector for it
 to be considered silent. Sometimes audio tracks have random
 data in the pregap (before the INDEX 01), which will fool
 cuerecover into thinking there\(aqs no pregap. This option can
-help with those, but don\(aqt set it too high.
+help with those, but don\(aqt set it too high. This option is ignored
+when multiple .bin file arguments are given, since they\(aqre already
+split into tracks.
 .TP
 .B \-v
 Verbose mode. Prints (on stderr) some extra messages about what
@@ -114,7 +121,8 @@ data tracks that aren\(aqt the first track on the disc.
 If there\(aqs a data track, it\(aqs a raw image (2352 bytes per sector, includes
 the sync pulse, address, CRC, ECC, etc). If the data track was stored as
 \(aqcooked\(aq data (2048 bytes/sector, MODE1/2048 in the original .cue file),
-it\(aqll be treated as an audio track. You can check for this by trying to
+it\(aqll be treated as an audio track, and you\(aqll get a warning that it
+looks like \(aqcooked\(aq data. You can check for this by trying to
 mount the .bin file as an ISO or HFS image: if it mounts, the first
 track is \(aqcooked\(aq. It\(aqll also be obvious if you use the .cue sheet to
 extract the image into files: ISO images don\(aqt sound musical at all!
diff --git a/cuerecover.html b/cuerecover.html
index a82e423..7de40e0 100644
--- a/cuerecover.html
+++ b/cuerecover.html
@@ -5,7 +5,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
 <title>cuerecover</title>
-<meta name="date" content="2020-05-11" />
+<meta name="date" content="2020-05-12" />
 <style type="text/css">
 
 /*
@@ -373,7 +373,7 @@ ul.auto-toc {
 <tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Urchlay</td>
 </tr>
 <tr><th class="docinfo-name">Date:</th>
-<td>2020-05-11</td></tr>
+<td>2020-05-12</td></tr>
 <tr><th class="docinfo-name">Version:</th>
 <td>0.1.0</td></tr>
 </tbody>
@@ -385,14 +385,12 @@ ul.auto-toc {
 <!-- into git since we don't want to require our users to have rst2man.py. -->
 <div class="section" id="synopsis">
 <h1>SYNOPSIS</h1>
-<p>cuerecover [-s sec] <strong>bin-file</strong> [<strong>bin-file</strong> ...]</p>
+<p>cuerecover [-o output] [-s sec] [-t thresh] <strong>bin-file</strong> [<strong>bin-file</strong> ...]</p>
 </div>
 <div class="section" id="description">
 <h1>DESCRIPTION</h1>
 <p>cuerecover attempts to generate a usable cue sheet for CD images which
-are missing their .cue (or .ccd, .mds, etc) files. The generated cue
-sheet is written to standard output [*], so add e.g. &quot;&gt; filename.cue&quot;
-to redirect it to a file.</p>
+are missing their .cue (or .ccd, .mds, etc) files.</p>
 <p>If a single .bin file is given, it's assumed to hold all the tracks (which
 might only be one). If multiple .bin files are given, each one is assumed to
 represent one track of the same CD image.</p>
@@ -418,13 +416,20 @@ messages are printed to standard error.</p>
 <kbd><span class="option">--help</span></kbd></td>
 <td>Print short usage string.</td></tr>
 <tr><td class="option-group">
+<kbd><span class="option">-o <var>&lt;file&gt;</var></span></kbd></td>
+<td>Write cue file to <em>file</em> rather than standard output. If
+<em>file</em> already exists, cuerecover will refuse to overwrite it,
+which makes this safer than redirecting stdout.</td></tr>
+<tr><td class="option-group">
 <kbd><span class="option">-s <var>&lt;sec&gt;</var></span></kbd></td>
 <td>Minimum amount of silence for detecting the split point between
-two audio tracks (default: 2). Argument is in seconds, and
-non-integers are allowed. 0 means to disable splitting tracks:
-all the audio tracks will be combined into one in the .cue
-sheet. This option is ignored when multiple .bin file arguments
-are given, since they're already split into tracks.</td></tr>
+two audio tracks. Argument is in seconds, and decimals
+are allowed. The default is 2, which is the standard sized
+gap between tracks in the Redbook standard and in most CD
+authoring software. 0 means to disable splitting tracks:
+all the audio tracks will be combined into one in the
+.cue sheet. This option is ignored when multiple .bin file
+arguments are given, since they're already split into tracks.</td></tr>
 <tr><td class="option-group">
 <kbd><span class="option">-t <var>&lt;thresh&gt;</var></span></kbd></td>
 <td>Silence threshold, 0 to 100. Default is 0. This is
@@ -432,7 +437,9 @@ the percentage of non-zero bytes allowed in a sector for it
 to be considered silent. Sometimes audio tracks have random
 data in the pregap (before the INDEX 01), which will fool
 cuerecover into thinking there's no pregap. This option can
-help with those, but don't set it too high.</td></tr>
+help with those, but don't set it too high. This option is ignored
+when multiple .bin file arguments are given, since they're already
+split into tracks.</td></tr>
 <tr><td class="option-group">
 <kbd><span class="option">-v</span></kbd></td>
 <td>Verbose mode. Prints (on stderr) some extra messages about what
@@ -456,7 +463,8 @@ data tracks that aren't the first track on the disc.</li>
 <li>If there's a data track, it's a raw image (2352 bytes per sector, includes
 the sync pulse, address, CRC, ECC, etc). If the data track was stored as
 'cooked' data (2048 bytes/sector, MODE1/2048 in the original .cue file),
-it'll be treated as an audio track. You can check for this by trying to
+it'll be treated as an audio track, and you'll get a warning that it
+looks like 'cooked' data. You can check for this by trying to
 mount the .bin file as an ISO or HFS image: if it mounts, the first
 track is 'cooked'. It'll also be obvious if you use the .cue sheet to
 extract the image into files: ISO images don't sound musical at all!</li>
diff --git a/miragextract.1 b/miragextract.1
index 15571cd..5054312 100644
--- a/miragextract.1
+++ b/miragextract.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH MIRAGEXTRACT 1 "2020-05-09" "0.1.0" "Urchlay"
+.TH MIRAGEXTRACT 1 "2020-05-12" "0.1.0" "Urchlay"
 .SH NAME
 miragextract \- extract audio and data tracks from CD images
 .
@@ -57,8 +57,8 @@ Print short usage string.
 .B \-a
 Extract only audio tracks. Default is to extract all tracks.
 .TP
-.B \-b
-Sets the base filename for the output files. Default is \(aqtrack\(aq.
+.BI \-b \ <name>
+Sets the base filename for the output files. Default is \fBtrack\fP\&.
 Can be prefixed with a directory to write files in that dir,
 but the dir must already exist (example: \-b extracted/track). See
 also the \-n option.
@@ -68,7 +68,8 @@ Extract only data tracks. Default is to extract all tracks.
 .TP
 .B \-f
 Sets the format and filename extension for the output audio files.
-Choices are \fBwav\fP, \fBogg\fP, \fBflac\fP, \fBcdda\fP (raw CD audio). Default is \fBwav\fP\&.
+Choices are \fBwav\fP, \fBogg\fP, \fBflac\fP, \fBcdda\fP (raw CD audio).
+Default is \fBwav\fP\&.
 .TP
 .B \-l
 Lists the tracks in the image without extracting them.
@@ -80,13 +81,13 @@ using input filenames with directory separators in them: the output files
 will be written in the same dir as the input file. Hopefully you
 have permission to write there.
 .TP
-.B \-p
+.BI \-p \ <passwd>
 Password for encrypted images. Note that anyone who can run \fBps(1)\fP
 on your system may be able to view the password. Also note that password
 support in miragextract is \fIcompletely\fP untested: I have no
 encrypted images to test with.
 .TP
-.B \-q
+.BI \-q \ <qual>
 Quality setting for ogg and flac output files. Integer from 0
 to 10. Default is 7. Has very little effect on flac, and no effect on
 wav or cdda output.
@@ -95,7 +96,7 @@ wav or cdda output.
 Swaps bytes in audio tracks. Use this if your audio files sound
 like white noise or gibberish.
 .TP
-.B \-t
+.BI \-t \ <track>
 Takes a track number (1\-99), and extracts only that one track.
 Default behaviour is to extract all tracks.
 .UNINDENT
@@ -114,8 +115,9 @@ match the encoding set with \-f. Note that mp3 is NOT a valid \-f option.
 If you need mp3, extract to .wav and then use a tool like lame or ffmpeg
 to convert to mp3.
 .sp
-Output data tracks will be named to end in \(aq.iso\(aq, or \(aq.dmg\(aq if they look
-like Apple disk images.
+Output data tracks will be named to end in \(aq.iso\(aq by default, or \(aq.hfs\(aq
+if they look like Apple disk images, or \(aq.hfs.iso\(aq for "hybrid" images
+that can be mounted as either (such as Blizzard\(aqs Mac/PC releases).
 .sp
 Images with multiple sessions should be supported, but have not been
 tested. Track numbering just continues, so a disc with 2 sessions of
diff --git a/miragextract.html b/miragextract.html
index d42031d..bf833e9 100644
--- a/miragextract.html
+++ b/miragextract.html
@@ -5,7 +5,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
 <title>miragextract</title>
-<meta name="date" content="2020-05-09" />
+<meta name="date" content="2020-05-12" />
 <style type="text/css">
 
 /*
@@ -373,7 +373,7 @@ ul.auto-toc {
 <tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Urchlay</td>
 </tr>
 <tr><th class="docinfo-name">Date:</th>
-<td>2020-05-09</td></tr>
+<td>2020-05-12</td></tr>
 <tr><th class="docinfo-name">Version:</th>
 <td>0.1.0</td></tr>
 </tbody>
@@ -406,8 +406,8 @@ converted to wav, flac, or ogg/vorbis (via libsndfile).</p>
 <kbd><span class="option">-a</span></kbd></td>
 <td>Extract only audio tracks. Default is to extract all tracks.</td></tr>
 <tr><td class="option-group">
-<kbd><span class="option">-b</span></kbd></td>
-<td>Sets the base filename for the output files. Default is 'track'.
+<kbd><span class="option">-b <var>&lt;name&gt;</var></span></kbd></td>
+<td>Sets the base filename for the output files. Default is <strong>track</strong>.
 Can be prefixed with a directory to write files in that dir,
 but the dir must already exist (example: -b extracted/track). See
 also the -n option.</td></tr>
@@ -417,7 +417,8 @@ also the -n option.</td></tr>
 <tr><td class="option-group">
 <kbd><span class="option">-f</span></kbd></td>
 <td>Sets the format and filename extension for the output audio files.
-Choices are <strong>wav</strong>, <strong>ogg</strong>, <strong>flac</strong>, <strong>cdda</strong> (raw CD audio). Default is <strong>wav</strong>.</td></tr>
+Choices are <strong>wav</strong>, <strong>ogg</strong>, <strong>flac</strong>, <strong>cdda</strong> (raw CD audio).
+Default is <strong>wav</strong>.</td></tr>
 <tr><td class="option-group">
 <kbd><span class="option">-l</span></kbd></td>
 <td>Lists the tracks in the image without extracting them.</td></tr>
@@ -429,13 +430,13 @@ using input filenames with directory separators in them: the output files
 will be written in the same dir as the input file. Hopefully you
 have permission to write there.</td></tr>
 <tr><td class="option-group">
-<kbd><span class="option">-p</span></kbd></td>
+<kbd><span class="option">-p <var>&lt;passwd&gt;</var></span></kbd></td>
 <td>Password for encrypted images. Note that anyone who can run <strong>ps(1)</strong>
 on your system may be able to view the password. Also note that password
 support in miragextract is <em>completely</em> untested: I have no
 encrypted images to test with.</td></tr>
 <tr><td class="option-group">
-<kbd><span class="option">-q</span></kbd></td>
+<kbd><span class="option">-q <var>&lt;qual&gt;</var></span></kbd></td>
 <td>Quality setting for ogg and flac output files. Integer from 0
 to 10. Default is 7. Has very little effect on flac, and no effect on
 wav or cdda output.</td></tr>
@@ -444,7 +445,7 @@ wav or cdda output.</td></tr>
 <td>Swaps bytes in audio tracks. Use this if your audio files sound
 like white noise or gibberish.</td></tr>
 <tr><td class="option-group">
-<kbd><span class="option">-t</span></kbd></td>
+<kbd><span class="option">-t <var>&lt;track&gt;</var></span></kbd></td>
 <td>Takes a track number (1-99), and extracts only that one track.
 Default behaviour is to extract all tracks.</td></tr>
 </tbody>
@@ -461,8 +462,9 @@ by libmirage. See the README for your version of libmirage for details.</p>
 match the encoding set with -f. Note that mp3 is NOT a valid -f option.
 If you need mp3, extract to .wav and then use a tool like lame or ffmpeg
 to convert to mp3.</p>
-<p>Output data tracks will be named to end in '.iso', or '.dmg' if they look
-like Apple disk images.</p>
+<p>Output data tracks will be named to end in '.iso' by default, or '.hfs'
+if they look like Apple disk images, or '.hfs.iso' for &quot;hybrid&quot; images
+that can be mounted as either (such as Blizzard's Mac/PC releases).</p>
 <p>Images with multiple sessions should be supported, but have not been
 tested. Track numbering just continues, so a disc with 2 sessions of
 8 files each will have tracks numbered 1 to 16 as far as the -t option