aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorB. Watson <yalhcru@gmail.com>2020-05-07 04:42:34 -0400
committerB. Watson <yalhcru@gmail.com>2020-05-07 04:42:34 -0400
commitf8a072dfc63065a134268fbc0a75a1eff02294fe (patch)
tree3f8b613fc3f44620a4f9352c7d6c909aedca3e34 /README
parent1aba77a39dea8fe7372ca6406eb870e61e27941a (diff)
downloadmiragextract-f8a072dfc63065a134268fbc0a75a1eff02294fe.tar.gz
add a bunch of options, make sndfile work
Diffstat (limited to 'README')
-rw-r--r--README70
1 files changed, 59 insertions, 11 deletions
diff --git a/README b/README
index 97fa814..eb3bf81 100644
--- a/README
+++ b/README
@@ -1,20 +1,68 @@
-miragextract
+README for miragextract v0.0.1
+==============================
+Description
+-----------
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).
-One day, it will work like this:
+Installing
+----------
+Requires GNU make, libmirage >= 3.0.0 and libsndfile (tested with 1.0.26,
+other recent-ish versions should work).
-Usage: miragextract [-t track] [-b basename] [-f cdda|wav|ogg|flac] image-file
+To build, run "make" or "gmake". There is no "make install", just copy the
+miragextract binary to /usr/local/bin and the man page (miragextract.1)
+to /usr/local/share/man/man1, or whatever paths make sense on your OS.
+There's also a miragextract.html, if you prefer your documentation
+that way.
--t takes a track number, and extracts only that one track. Default
-behaviour is to extract all tracks.
+Supported formats
+-----------------
+According to the README from libmirage-3.2.4:
--b sets the basename for the output files. Default is 'track'.
+> Currently supported image formats:
+> - BlindWrite 5/6 (B5T, B6T) file format (readonly)
+> - Roxio / WinOnCD (C2D) file format (readonly)
+> - CloneCD (CCD, SUB, IMG) image format (readonly)
+> - DiscJuggler (CDI) file format (readonly)
+> - Easy CD Creator (CIF) file format (readonly)
+> - CDRwin (CUE, BIN) image format (readonly)
+> - Raw track loader (ISO, UDF etc.) image format (read-write)
+> - Alcohol 120% (MDS) image format (readonly)
+> - Daemon Tools (MDX) image format (readonly)
+> - Nero Burning ROM (NRG) image format (readonly)
+> - ReadCD (TOC, BIN) image format (readonly)
+> - Cdrdao's (TOC, BIN) image format (read-write)
+> - XCDRoast (TOC, BIN) image format (readonly)
--f sets the format and filename extension for the output files. Default is
-'wav'. "cdda" files are raw CD audio samples.
+> Currently supported filter streams:
+> - Apple Disk Image (DMG) container format (readonly)
+> - Apple Disk Image (IMG, SMI) via MacBinary container format (readonly)
+> - GZip (GZ) container format (readonly)
+> - XZ (XZ) container format (readonly)
+> - Compressed ISO (CSO) container format (readonly)
+> - Compressed ISO (ISZ) container format (readonly)
+> - Error Code Modeller (ECM) container format (readonly)
+> - PowerISO (DAA) image format (readonly)
+> - SNDFILE audio files (read-write)
-Output files will be named e.g. track01.wav, track02.wav.
+Not all these formats have been tested with miragextract. I have tested
+bin/cue (both single-bin and multi-bin), mds, ecm, nrg, and ccd as of
+this writing, and all work fine.
-Requires libmirage >= 3.0.0 and libsndfile (tested with 1.0.26, other
-versions should work).
+Author and Copyright
+--------------------
+miragextract was written by B. Watson <yalchru@gmail.com>, and is released
+under the WTFPL: Do WTF you want with this.
+
+Support
+-------
+None guaranteed. If you run into problems, first try the latest code
+from git, which you can find at:
+
+http://urchlay.naptime.net/repos/miragextract/
+
+If this doesn't help, contact me by email (see above) and I'll see what
+I can do.