add man page for audiocue2bincueHEADmaster

1 files changed, 78 insertions, 0 deletions

diff --git a/audiocue2bincue.rst b/audiocue2bincue.rst
new file mode 100644
index 0000000..755681e
--- /dev/null
+++ b/audiocue2bincue.rst
@@ -0,0 +1,78 @@
+.. 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.
+
+.. |version| replace:: 0.2.0
+.. |date| date::
+
+===============
+audiocue2bincue
+===============
+
+------------------------------------------------
+convert audio file based CD images to raw binary
+------------------------------------------------
+
+:Manual section: 1
+:Manual group: Urchlay
+:Date: |date|
+:Version: |version|
+
+SYNOPSIS
+========
+
+audiocue2bincue [**-s**] [**-n**] [**input.cue**] [**output.cue**]
+
+DESCRIPTION
+===========
+
+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't be able to use it with miragextract.
+
+Since libmirage currently (as of 3.2.4) doesn't seem to support these,
+the audiocue2bincue script is provided as a quick & dirty conversion tool.
+
+audiocue2bincue reads the .cue sheet from standard input and writes the modified .cue
+to standard output if no filenames are given.
+
+Default action (without -n) is to go ahead and convert the audio file(s) listed
+in the .cue file to raw CD audio.
+
+OPTIONS
+=======
+
+-s    Swap byte order during audio conversion.
+
+-n    Don't convert audio file(s) to .bin image, just write a .cue (which
+      won't be very useful, but it's good for testing).
+
+NOTES
+=====
+
+audiocue2bincue is written in Perl, so you'll need your OS's perl package
+installed. It doesn't use any CPAN modules, so there aren't a ton of
+perl-blah dependencies.
+
+Make sure you've got libsndfile installed, including the sndfile-convert command on
+your $PATH.
+
+If you have an mp3-based image, you'll need lame installed and on your $PATH, since
+libsndfile doesn't support mp3.
+
+audiocue2bincue hasn't been thoroughly tested. It seems to work fine, but
+you may run into nonstandard/weird/broken .cue files that it can't handle.
+
+AUTHOR
+======
+
+audiocue2bincue was written by B. Watson <yalhcru@gmail.com> and
+released under the WTFPL: Do WTF you want with this.
+
+SEE ALSO
+========
+
+miragextract(1), cuerecover(1), sndfile-convert(1), lame(1)