audio/mktoc: New maintainer, add man page.

Signed-off-by: B. Watson <yalhcru@gmail.com>

1 files changed, 186 insertions, 0 deletions

diff --git a/audio/mktoc/mktoc.rst b/audio/mktoc/mktoc.rst
new file mode 100644
index 0000000000..3a5414aa28
--- /dev/null
+++ b/audio/mktoc/mktoc.rst
@@ -0,0 +1,186 @@
+.. RST source for mktoc(1) man page. Convert with:
+..   rst2man.py mktoc.rst > mktoc.1
+.. rst2man.py comes from the SBo development/docutils package.
+
+.. Upstream's README is already RST, I just added some stuff to make
+.. it format in man page style.
+
+.. |version| replace:: 1.3
+.. |date| date::
+
+=====
+mktoc
+=====
+
+------------------------------
+create TOC files for audio CDs
+------------------------------
+
+:Manual section: 1
+:Manual group: SlackBuilds.org
+:Date: |date|
+:Version: |version|
+
+SYNOPSIS
+========
+::
+
+   mktoc [OPTIONS] < CUE_FILE
+   mktoc [OPTIONS] [[-f] CUE_FILE] [[-o] TOC_FILE]
+   mktoc [OPTIONS] -w WAV_FILES [[-o] TOC_FILE]
+
+
+DESCRIPTION
+===========
+
+.. Mktoc // (c) 2011, Patrick C. McGinty
+.. mktoc[@]tuxcoder[dot]com
+
+Mktoc simplifies the steps needed to create audio CD TOC files for the
+cdrdao CD burning program. For users familiar with ExactAudioCopy or CdrWin,
+TOC files are synonymous with CUE sheets. The primary goal of mktoc is to
+create TOC files using a previously generated CUE sheet.
+
+Features
+========
+
+* Create a TOC file from a list of WAV files.
+* Convert an ExactAudioCopy (EAC) CUE file to the TOC format that
+  is usable by cdrdao.
+* Multi-session aware CUE parsing, necessary for making CDDB and
+  AccurateRip matchable discs.
+* Non-compliant CUE sheet support.
+* Support for various pregap methods.
+* Can create offset corrected WAV files for true 'bit-for-bit'
+  accurate copies.
+* Fuzzy file name logic can correct common file name spelling
+  variations.
+* Workaround known TOC file parsing bugs in cdrdao.
+
+Usage
+=====
+
+``CUE_FILE`` must contain a valid CUE format. When ``*_FILE`` is not
+provided, the program will read from ``STDIN``. All output will be sent to
+``STDOUT``.
+
+All attempts will be made to preserve any and all information from the input
+file. For any case where the CUE file contains unknown or bad values, the
+user will be notified on ``STDERR``.
+
+Options
+=======
+
+--version
+
+   show program's version number and exit
+
+-h
+
+   show help message and exit
+
+--help
+
+   show detailed usage instructions and exit
+
+-a, --allow-missing-wav
+
+   do not abort when WAV file(s) are missing, (experts only). It is possible
+   when using this option that a bug in cdrdao will create a CD that ignores
+   the pregap definitions in the TOC file.  Only use this option if the CUE
+   file does not contain pregaps, or if you do not wish to retain the pregap
+   information.
+
+-c <WAV_OFFSET>, --offset-correction=<WAV_OFFSET>
+
+   correct reader/writer offset by creating WAV file(s) shifted by
+   WAV_OFFSET samples (original data is not modified)
+
+-d, --debug
+
+   enable debugging statements
+
+-f <CUE_FILE>, --file=<CUE_FILE>
+
+   specify the input CUE file to read
+
+-m, --multi
+
+   for safety, this option must be set when creating a mulit-session TOC
+   file
+
+-o <TOC_FILE>, --output=<TOC_FILE>
+
+   specify the output TOC file to write
+
+-t, --use-temp
+
+   write offset corrected WAV files to /tmp directory
+
+-w, --wave
+
+   write a TOC file using list of WAV files
+
+-z, --no-multi
+
+   disable multi-session support; program assumes TOC will be written in
+   single-session mode
+
+Examples
+========
+
+1. Create a TOC file from a set of WAV files::
+
+      mktoc -w *.wav
+
+2. Write a TOC file to ``toc_file.toc``, from a set of WAV files::
+
+      mktoc -w *.wav toc_file.toc
+      mktoc -w *.wav > toc_file.toc
+      mktoc -w *.wav -o toc_file.toc
+
+3. Create a TOC file from a valid CUE file::
+
+      mktoc cue_file.cue
+      mktoc < cue_file.cue
+      mktoc -f cue_file.cue
+
+4. Write a TOC file to ``toc_file.toc``, given an input CUE file::
+
+      mktoc cue_file.cue toc_file.toc
+      mktoc < cue_file.cue > toc_file.toc
+      mktoc -f cue_file.cue -o toc_file.toc
+
+5. Tell mktoc to ignore missing WAV file errors. There is a potential that
+   the result TOC file will cause cdrdao to lose pregap information during
+   the burn process (see above)::
+
+      mktoc -a cue_file.cue
+
+6. Adjust WAV files for a CD writer offset value. For example, if your CD
+   writer has a -30 sample write offset, it can be corrected by offsetting
+   the input WAV files by +30 samples. New WAV files will be placed in the
+   working directory in a new dir called ``wav+30``::
+
+      mktoc -c 30 < cue_file.cue
+
+7. Adjust WAV files for a CD writer offset value, but create new files in
+   the ``/tmp`` directory::
+
+      mktoc -c 30 -t < cue_file.cue
+
+Contact
+=======
+
+E-mail
+------
+
+|  mktoc[@]tuxcoder[dot]com
+
+Info
+----
+
+|  http://packages.python.org/mktoc/
+|  https://github.com/cmcginty/mktoc
+|  http://blog.tuxcoder.com
+