1 files changed, 158 insertions, 0 deletions
diff --git a/cuerecover.1 b/cuerecover.1
new file mode 100644
index 0000000..d57408e
--- /dev/null
+++ b/cuerecover.1
@@ -0,0 +1,158 @@
+.\" Man page generated from reStructuredText.
+.
+.TH CUERECOVER 1 "2020-05-11" "0.1.0" "Urchlay"
+.SH NAME
+cuerecover \- generate .cue file for CD image .bin
+.
+.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 cuerecover(1) man page. Convert with:
+.
+.\" rst2man.py cuerecover.rst > cuerecover.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
+cuerecover [\-s sec] \fBbin\-file\fP [\fBbin\-file\fP ...]
+.SH DESCRIPTION
+.sp
+cuerecover attempts to generate a usable cue sheet for CD images which
+are missing their .cue (or .ccd, .mds, etc) files. The generated cue
+sheet is written to standard output [*], so add e.g. "> filename.cue"
+to redirect it to a file.
+.sp
+If a single .bin file is given, it\(aqs assumed to hold all the tracks (which
+might only be one). If multiple .bin files are given, each one is assumed to
+represent one track of the same CD image.
+.sp
+For data tracks, the recovered track should be correct, provided the
+bin file wasn\(aqt truncated or otherwise corrupted.
+.sp
+For audio tracks, silence detection is used to find the start of the track
+(the INDEX 01 in the .cue file).
+.sp
+For audio tracks in a single .bin file, silence detection is used to
+find the split points between tracks. This means that in cases where
+one track segues into another, the two tracks will be combined in the
+resulting cue sheet. Also, if there are long periods of silence within
+a single track, this track will be split into two or more tracks.
+.sp
+[*] \fIOnly\fP the .cue file is written to stdout. Status and progress
+messages are printed to standard error.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-\-help
+Print short usage string.
+.TP
+.BI \-s \ <sec>
+Minimum amount of silence for detecting the split point between
+two audio tracks (default: 2). Argument is in seconds, and
+non\-integers are allowed. 0 means to disable splitting tracks:
+all the audio tracks will be combined into one in the .cue
+sheet. This option is ignored when multiple .bin file arguments
+are given, since they\(aqre already split into tracks.
+.TP
+.BI \-t \ <thresh>
+Silence threshold, 0 to 100. Default is 0. This is
+the percentage of non\-zero bytes allowed in a sector for it
+to be considered silent. Sometimes audio tracks have random
+data in the pregap (before the INDEX 01), which will fool
+cuerecover into thinking there\(aqs no pregap. This option can
+help with those, but don\(aqt set it too high.
+.TP
+.B \-v
+Verbose mode. Prints (on stderr) some extra messages about what
+cuerecover is doing. Probably only of interest to the author.
+.UNINDENT
+.sp
+Always include a space between an option and its argument (e.g. \fB\-s 1\fP, not \fB\-s1\fP).
+.SH NOTES
+.sp
+When reading multiple tracks from the same file, cuerecover makes some
+assumptions. These are usually valid, but should be mentioned here:
+.INDENT 0.0
+.IP \(bu 2
+The tracks are all MODE1 (data), MODE2 (also data, usually not found) or
+CD\-DA (regular CD audio). Extended format CDs like XA or CD+I are not
+supported, though you might still get listenable audio tracks from them.
+.IP \(bu 2
+If there\(aqs a data track, it will be the only data track, and it will be
+track 1. This is almost always the case, since most operating systems
+from the CD\-ROM era (and even modern ones) don\(aqt provide access to
+data tracks that aren\(aqt the first track on the disc.
+.IP \(bu 2
+If there\(aqs a data track, it\(aqs a raw image (2352 bytes per sector, includes
+the sync pulse, address, CRC, ECC, etc). If the data track was stored as
+\(aqcooked\(aq data (2048 bytes/sector, MODE1/2048 in the original .cue file),
+it\(aqll be treated as an audio track. You can check for this by trying to
+mount the .bin file as an ISO or HFS image: if it mounts, the first
+track is \(aqcooked\(aq. It\(aqll also be obvious if you use the .cue sheet to
+extract the image into files: ISO images don\(aqt sound musical at all!
+.IP \(bu 2
+cuerecover will generate \fIa\fP cue file, which will be valid... but it may
+not match the original (missing) one exactly. This is because cuerecover
+has to look for silent sections of the image and use those as split points
+for the tracks. If there\(aqs a 3\-second silent section between tracks 2 and
+3, is that 1 second of silence at the end of track 2 + 2 seconds of silence
+at the start of track 3, or vice versa, or 1.5 seconds each, or...?
+.UNINDENT
+.\" other sections we might want, uncomment as needed.
+.
+.\" FILES
+.
+.\" =====
+.
+.\" ENVIRONMENT
+.
+.\" ===========
+.
+.SH EXIT STATUS
+.sp
+As usual, 0 for success, non\-zero for failure.
+.\" BUGS
+.
+.\" ====
+.
+.\" EXAMPLES
+.
+.\" ========
+.
+.SH AUTHORS
+.sp
+cuerecover 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)
+.\" Generated by docutils manpage writer.
+.