auto-regenerate man/html pages

1 files changed, 144 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.
+.