add man page for audiocue2bincueHEADmaster

1 files changed, 92 insertions, 0 deletions

diff --git a/audiocue2bincue.1 b/audiocue2bincue.1
new file mode 100644
index 0000000..7097cc6
--- /dev/null
+++ b/audiocue2bincue.1
@@ -0,0 +1,92 @@
+.\" Man page generated from reStructuredText.
+.
+.TH AUDIOCUE2BINCUE 1 "2020-05-13" "0.2.0" "Urchlay"
+.SH NAME
+audiocue2bincue \- convert audio file based CD images to raw binary
+.
+.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 audiocue2bincue(1) man page. Convert with:
+.
+.\" rst2man.py audiocue2bincue.rst > audiocue2bincue.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
+audiocue2bincue [\fB\-s\fP] [\fB\-n\fP] [\fBinput.cue\fP] [\fBoutput.cue\fP]
+.SH DESCRIPTION
+.sp
+If you have a CD image that consists of a .cue (or .ccd, .mds, etc) file
+and a .wav (or .ogg, .mp3, etc) audio file instead of a raw binary image,
+you won\(aqt be able to use it with miragextract.
+.sp
+Since libmirage currently (as of 3.2.4) doesn\(aqt seem to support these,
+the audiocue2bincue script is provided as a quick & dirty conversion tool.
+.sp
+audiocue2bincue reads the .cue sheet from standard input and writes the modified .cue
+to standard output if no filenames are given.
+.sp
+Default action (without \-n) is to go ahead and convert the audio file(s) listed
+in the .cue file to raw CD audio.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-s
+Swap byte order during audio conversion.
+.TP
+.B \-n
+Don\(aqt convert audio file(s) to .bin image, just write a .cue (which
+won\(aqt be very useful, but it\(aqs good for testing).
+.UNINDENT
+.SH NOTES
+.sp
+audiocue2bincue is written in Perl, so you\(aqll need your OS\(aqs perl package
+installed. It doesn\(aqt use any CPAN modules, so there aren\(aqt a ton of
+perl\-blah dependencies.
+.sp
+Make sure you\(aqve got libsndfile installed, including the sndfile\-convert command on
+your $PATH.
+.sp
+If you have an mp3\-based image, you\(aqll need lame installed and on your $PATH, since
+libsndfile doesn\(aqt support mp3.
+.sp
+audiocue2bincue hasn\(aqt been thoroughly tested. It seems to work fine, but
+you may run into nonstandard/weird/broken .cue files that it can\(aqt handle.
+.SH AUTHOR
+.sp
+audiocue2bincue 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
+miragextract(1), cuerecover(1), sndfile\-convert(1), lame(1)
+.\" Generated by docutils manpage writer.
+.