auto-regenerate man/html pages

1 files changed, 56 insertions, 23 deletions

diff --git a/cuerecover.html b/cuerecover.html
index 3bb5510..a82e423 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-09" />
+<meta name="date" content="2020-05-11" />
 <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-11</td></tr>
 <tr><th class="docinfo-name">Version:</th>
 <td>0.1.0</td></tr>
 </tbody>
@@ -391,18 +391,22 @@ ul.auto-toc {
 <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.</p>
+sheet is written to standard output [*], so add e.g. &quot;&gt; filename.cue&quot;
+to redirect it to a file.</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>
-<p>For data tracks that hold ISO9660, UFS, or Macintosh HFS filesystems,
-the recovered track should be correct, provided the .bin file wasn't
-truncated or otherwise corrupted.</p>
-<p>For audio tracks, silence detection is used to find the split points
-between tracks. This means that in cases where one track segues into
-another, the two tracks will be combined in the resulting cue sheet. Also,
-if there are long periods of silence within a single track, this track
-will be split into two or more tracks.</p>
+<p>For data tracks, the recovered track should be correct, provided the
+bin file wasn't truncated or otherwise corrupted.</p>
+<p>For audio tracks, silence detection is used to find the start of the track
+(the INDEX 01 in the .cue file).</p>
+<p>For audio tracks in a single .bin file, silence detection is used to
+find the split points between tracks. This means that in cases where
+one track segues into another, the two tracks will be combined in the
+resulting cue sheet. Also, if there are long periods of silence within
+a single track, this track will be split into two or more tracks.</p>
+<p>[*] <em>Only</em> the .cue file is written to stdout. Status and progress
+messages are printed to standard error.</p>
 </div>
 <div class="section" id="options">
 <h1>OPTIONS</h1>
@@ -414,26 +418,55 @@ will be split into two or more tracks.</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">-a</span></kbd></td>
-<td>Assume all tracks are audio. Disable data track detection. Trying
-to listen to a data track as audio will usually give you a
-headache.</td></tr>
-<tr><td class="option-group">
-<kbd><span class="option">-d</span></kbd></td>
-<td>Only include data track(s) in the .cue file.</td></tr>
-<tr><td class="option-group">
-<kbd><span class="option">-s</span></kbd></td>
+<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. 2. This option is ignored when multiple .bin file arguments
+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
+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>
+<tr><td class="option-group">
+<kbd><span class="option">-v</span></kbd></td>
+<td>Verbose mode. Prints (on stderr) some extra messages about what
+cuerecover is doing. Probably only of interest to the author.</td></tr>
 </tbody>
 </table>
 <p>Always include a space between an option and its argument (e.g. <strong>-s 1</strong>, not <strong>-s1</strong>).</p>
-<!-- NOTES -->
-<!-- ===== -->
+</div>
+<div class="section" id="notes">
+<h1>NOTES</h1>
+<p>When reading multiple tracks from the same file, cuerecover makes some
+assumptions. These are usually valid, but should be mentioned here:</p>
+<ul class="simple">
+<li>The tracks are all MODE1 (data), MODE2 (also data, usually video CDs) or
+CD-DA (regular CD audio). Extended format CDs like XA or CD+I are not
+supported, though you might still get listenable audio tracks from them.</li>
+<li>If there's a data track, it will be the only data track, and it will be
+track 1. This is almost always the case, since most operating systems
+from the CD-ROM era (and even modern ones) don't provide access to
+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
+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>
+<li>cuerecover will generate <em>a</em> cue file, which will be valid... but it may
+not match the original (missing) one exactly. This is because cuerecover
+has to look for silent sections of the image and use those as split points
+for the tracks. If there's a 3-second silent section between tracks 2 and
+3, is that 1 second of silence at the end of track 2 + 2 seconds of silence
+at the start of track 3, or vice versa, or 1.5 seconds each, or...?</li>
+</ul>
 <!-- other sections we might want, uncomment as needed. -->
 <!-- FILES -->
 <!-- ===== -->