auto-regenerate man/html pages

2 files changed, 620 insertions, 0 deletions

diff --git a/miragextract.1 b/miragextract.1
new file mode 100644
index 0000000..b19d03e
--- /dev/null
+++ b/miragextract.1
@@ -0,0 +1,144 @@
+.\" Man page generated from reStructuredText.
+.
+.TH MIRAGEXTRACT 1 "2020-05-07" "0.0.1" "Urchlay"
+.SH NAME
+miragextract \- extract audio and data tracks from CD images
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" RST source for miragextract(1) man page. Convert with:
+.
+.\" rst2man.py miragextract.rst > miragextract.1
+.
+.\" rst2man.py comes from the SBo development/docutils package.
+.
+.\" note to self: don't forget to check the generated man and html pages
+.
+.\" into git since we don't want to require our users to have rst2man.py.
+.
+.SH SYNOPSIS
+.sp
+miragextract [\fB\-l\fP] [\fB\-s\fP] [\fB\-t\fP track] [\fB\-b\fP base] [\fB\-f\fP fmt] [\fB\-q\fP quality ] \fBimage\-file\fP
+.SH DESCRIPTION
+.sp
+Extracts data and audio tracks from any CD image supported by libmirage.
+Data tracks are written as\-is, and audio tracks can be written as\-is or
+converted to wav, flag, or ogg/vorbis (via libsndfile).
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-\-help
+Print short usage string.
+.TP
+.B \-l
+Lists the tracks in the image without extracting them.
+.TP
+.B \-s
+Swaps bytes in audio tracks. Use this if your audio files sound
+like white noise or gibberish.
+.TP
+.B \-t
+Takes a track number (1\-99), and extracts only that one track.
+Default behaviour is to extract all tracks.
+.TP
+.B \-b
+Sets the base filename for the output files. Default is \(aqtrack\(aq.
+.TP
+.B \-f
+Sets the format and filename extension for the output files.
+Choices are \(aqwav\(aq, \(aqogg\(aq, \(aqflac\(aq, \(aqcdda\(aq (raw CD audio). Default is \(aqwav\(aq.
+.TP
+.B \-q
+Quality setting for .ogg and .flac output files. Integer from 0
+to 10. Default is 7.
+.UNINDENT
+.SH NOTES
+.sp
+Image\-file is e.g. a .cue, .ccd, .nrg, .mds, or anything else supported
+by libmirage. See the README for your version of libmirage for details.
+.sp
+Output audio files are named track01.wav, track02.wav, etc by default. The
+\(aqtrack\(aq part of the name can be set with \-b, and the extension will
+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, which is usually
+correct. Future versions of this program might be smart enough to
+detect e.g. Macintosh DMG files and name them appropriately (for now,
+just rename them if you need to).
+.sp
+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
+and the output filenames are concerned.
+.sp
+When extracting raw CD audio tracks, you can test them by listening to
+them with the \fIplay\fP command from \fIsox\fP\&. Try:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+play \-x \-t cdda track01.cdda
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\&...possibly without the \-x option if you\(aqre on a big\-endian platform.
+.\" other sections we might want, uncomment as needed.
+.
+.\" FILES
+.
+.\" =====
+.
+.\" ENVIRONMENT
+.
+.\" ===========
+.
+.\" EXIT STATUS
+.
+.\" ===========
+.
+.\" BUGS
+.
+.\" ====
+.
+.\" EXAMPLES
+.
+.\" ========
+.
+.SH AUTHORS
+.sp
+miragextract was written by B. Watson <\fI\%yalhcru@gmail.com\fP> and
+released under the WTFPL: Do WTF you want with this.
+.SH SEE ALSO
+.sp
+TODO: fill in
+.\" Generated by docutils manpage writer.
+.
diff --git a/miragextract.html b/miragextract.html
new file mode 100644
index 0000000..05b354f
--- /dev/null
+++ b/miragextract.html
@@ -0,0 +1,476 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<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" />
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="miragextract">
+<h1 class="title">miragextract</h1>
+<h2 class="subtitle" id="extract-audio-and-data-tracks-from-cd-images">extract audio and data tracks from CD images</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">1</td>
+</tr>
+<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>
+<tr><th class="docinfo-name">Version:</th>
+<td>0.0.1</td></tr>
+</tbody>
+</table>
+<!-- RST source for miragextract(1) man page. Convert with: -->
+<!-- rst2man.py miragextract.rst > miragextract.1 -->
+<!-- rst2man.py comes from the SBo development/docutils package. -->
+<!-- note to self: don't forget to check the generated man and html pages -->
+<!-- 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>
+</div>
+<div class="section" id="description">
+<h1>DESCRIPTION</h1>
+<p>Extracts data and audio tracks from any CD image supported by libmirage.
+Data tracks are written as-is, and audio tracks can be written as-is or
+converted to wav, flag, or ogg/vorbis (via libsndfile).</p>
+</div>
+<div class="section" id="options">
+<h1>OPTIONS</h1>
+<table class="docutils option-list" frame="void" rules="none">
+<col class="option" />
+<col class="description" />
+<tbody valign="top">
+<tr><td class="option-group">
+<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">-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>
+<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'.</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 'wav', 'ogg', 'flac', 'cdda' (raw CD audio). Default is 'wav'.</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.</td></tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="notes">
+<h1>NOTES</h1>
+<p>Image-file is e.g. a .cue, .ccd, .nrg, .mds, or anything else supported
+by libmirage. See the README for your version of libmirage for details.</p>
+<p>Output audio files are named track01.wav, track02.wav, etc by default. The
+'track' part of the name can be set with -b, and the extension will
+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', which is usually
+correct. Future versions of this program might be smart enough to
+detect e.g. Macintosh DMG files and name them appropriately (for now,
+just rename them if you need to).</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
+and the output filenames are concerned.</p>
+<p>When extracting raw CD audio tracks, you can test them by listening to
+them with the <em>play</em> command from <em>sox</em>. Try:</p>
+<pre class="literal-block">
+play -x -t cdda track01.cdda
+</pre>
+<p>...possibly without the -x option if you're on a big-endian platform.</p>
+<!-- other sections we might want, uncomment as needed. -->
+<!-- FILES -->
+<!-- ===== -->
+<!-- ENVIRONMENT -->
+<!-- =========== -->
+<!-- EXIT STATUS -->
+<!-- =========== -->
+<!-- BUGS -->
+<!-- ==== -->
+<!-- EXAMPLES -->
+<!-- ======== -->
+</div>
+<div class="section" id="authors">
+<h1>AUTHORS</h1>
+<p>miragextract was written by B. Watson &lt;<a class="reference external" href="mailto:yalhcru&#64;gmail.com">yalhcru&#64;gmail.com</a>&gt; and
+released under the WTFPL: Do WTF you want with this.</p>
+</div>
+<div class="section" id="see-also">
+<h1>SEE ALSO</h1>
+<p>TODO: fill in</p>
+</div>
+</div>
+</body>
+</html>