diff options
Diffstat (limited to 'miragextract.rst')
| -rw-r--r-- | miragextract.rst | 45 |
1 files changed, 28 insertions, 17 deletions
diff --git a/miragextract.rst b/miragextract.rst index 2a477aa..b2cb9ff 100644 --- a/miragextract.rst +++ b/miragextract.rst @@ -5,7 +5,7 @@ .. 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.0.1 +.. |version| replace:: 0.1.0 .. |date| date:: ============ @@ -24,7 +24,7 @@ extract audio and data tracks from CD images SYNOPSIS ======== -miragextract [**-l**] [**-s**] [**-t** track] [**-b** base] [**-f** fmt] [**-q** quality ] **image-file** +miragextract [**-l**] [**-s**] [**-t** track] [**-b** base] [**-f** fmt] [**-p** passwd] [**-q** quality ] **image-file** DESCRIPTION =========== @@ -39,36 +39,41 @@ OPTIONS --help Print short usage string. --l Lists the tracks in the image without extracting them. - --a Extract only audio tracks. - --d Extract only data tracks. - --s Swaps bytes in audio tracks. Use this if your audio files sound - like white noise or gibberish. - --t Takes a track number (1-99), and extracts only that one track. - Default behaviour is to extract all tracks. +-a Extract only audio tracks. Default is to extract all tracks. -b Sets the base filename for the output files. Default is 'track'. Can be prefixed with a directory to write files in that dir, but the dir must already exist (example: -b extracted/track). See also the -n option. +-d Extract only data tracks. Default is to extract all tracks. + +-f Sets the format and filename extension for the output files. + Choices are **wav**, **ogg**, **flac**, **cdda** (raw CD audio). Default is **wav**. + +-l Lists the tracks in the image without extracting them. + -n Set the base filename to the input filename, minus its extension. E.g. for foo.cue, this is the same as saying "-b foo". Beware of using input filenames with directory separators in them: the output files will be written in the same dir as the input file. Hopefully you have permission to write there. --f Sets the format and filename extension for the output files. - Choices are **wav**, **ogg**, **flac**, **cdda** (raw CD audio). Default is **wav**. +-p Password for encrypted images. Note that anyone who can run **ps(1)** + on your system can view the password. Also note that password + support in miragextract is *completely* untested: I have no + encrypted images to test with. -q Quality setting for ogg and flac output files. Integer from 0 to 10. Default is 7. Has very little effect on flac, and no effect on wav or cdda output. +-s Swaps bytes in audio tracks. Use this if your audio files sound + like white noise or gibberish. + +-t Takes a track number (1-99), and extracts only that one track. + Default behaviour is to extract all tracks. + Always include a space between an option and its argument (e.g. **-b foo**, not **-bfoo**). NOTES @@ -118,8 +123,14 @@ As usual, 0 for success, non-zero for failure. BUGS ==== -There's not enough error checking. It's probably possible to make -miragextract segfault under some circumstances. +The -p option should prompt for a password. + +Not exactly a bug, per se, but miragextract can't deal with multi-file +images where one of the files is missing or truncated. This is because +libmirage validates the image when it's loaded, and is unlikely to change. + +Related to the above, there's no attempt to recover from +errors. miragextract exits as soon as it encounters an error of any kind. .. EXAMPLES .. ======== |