add -p password option

1 files changed, 34 insertions, 24 deletions

diff --git a/miragextract.html b/miragextract.html
index c657461..3fe03ad 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-07" />
+<meta name="date" content="2020-05-09" />
 <style type="text/css">
 
 /*
@@ -373,9 +373,9 @@ 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-07</td></tr>
+<td>2020-05-09</td></tr>
 <tr><th class="docinfo-name">Version:</th>
-<td>0.0.1</td></tr>
+<td>0.1.0</td></tr>
 </tbody>
 </table>
 <!-- RST source for miragextract(1) man page. Convert with: -->
@@ -385,7 +385,7 @@ 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>miragextract [<strong>-l</strong>] [<strong>-s</strong>] [<strong>-t</strong> track] [<strong>-b</strong> base] [<strong>-f</strong> fmt] [<strong>-q</strong> quality ] <strong>image-file</strong></p>
+<p>miragextract [<strong>-l</strong>] [<strong>-s</strong>] [<strong>-t</strong> track] [<strong>-b</strong> base] [<strong>-f</strong> fmt] [<strong>-p</strong> passwd] [<strong>-q</strong> quality ] <strong>image-file</strong></p>
 </div>
 <div class="section" id="description">
 <h1>DESCRIPTION</h1>
@@ -403,22 +403,8 @@ converted to wav, flac, or ogg/vorbis (via libsndfile).</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">-l</span></kbd></td>
-<td>Lists the tracks in the image without extracting them.</td></tr>
-<tr><td class="option-group">
 <kbd><span class="option">-a</span></kbd></td>
-<td>Extract only audio tracks.</td></tr>
-<tr><td class="option-group">
-<kbd><span class="option">-d</span></kbd></td>
-<td>Extract only data tracks.</td></tr>
-<tr><td class="option-group">
-<kbd><span class="option">-s</span></kbd></td>
-<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>
-<td>Takes a track number (1-99), and extracts only that one track.
-Default behaviour is to extract all tracks.</td></tr>
+<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'.
@@ -426,6 +412,16 @@ 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>
 <tr><td class="option-group">
+<kbd><span class="option">-d</span></kbd></td>
+<td>Extract only data tracks. Default is to extract all tracks.</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 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>
+<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>
+<tr><td class="option-group">
 <kbd><span class="option">-n</span></kbd></td>
 <td>Set the base filename to the input filename, minus its extension.
 E.g. for foo.cue, this is the same as saying &quot;-b foo&quot;. Beware of
@@ -433,14 +429,24 @@ 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">-f</span></kbd></td>
-<td>Sets the format and filename extension for the output 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>
+<kbd><span class="option">-p</span></kbd></td>
+<td>Password for encrypted images. Note that anyone who can run <strong>ps(1)</strong>
+on your system can 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>
 <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>
+<tr><td class="option-group">
+<kbd><span class="option">-s</span></kbd></td>
+<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>
+<td>Takes a track number (1-99), and extracts only that one track.
+Default behaviour is to extract all tracks.</td></tr>
 </tbody>
 </table>
 <p>Always include a space between an option and its argument (e.g. <strong>-b foo</strong>, not <strong>-bfoo</strong>).</p>
@@ -481,8 +487,12 @@ play -x -t cdda track01.cdda
 </div>
 <div class="section" id="bugs">
 <h1>BUGS</h1>
-<p>There's not enough error checking. It's probably possible to make
-miragextract segfault under some circumstances.</p>
+<p>The -p option should prompt for a password.</p>
+<p>Not exactly a bug, per se, but miragextract can't deal with multi-file
+images where one of the files is missing or truncated. This is because
+libmirage validates the image when it's loaded, and is unlikely to change.</p>
+<p>Related to the above, there's no attempt to recover from
+errors. miragextract exits as soon as it encounters an error of any kind.</p>
 <!-- EXAMPLES -->
 <!-- ======== -->
 </div>