X-Git-Url: https://git.hcoop.net/clinton/abcde.git/blobdiff_plain/d100b6be9769de4fde85281fd6c8bc96cc7080e8..ffd57cfc08e45a1d6a708399bfd23a3aa0ddd734:/abcde.1

diff --git a/abcde.1 b/abcde.1
index 9719f2a..a43810c 100644
--- a/abcde.1
+++ b/abcde.1
@@ -39,13 +39,22 @@ Delete the intermediate WAV file (or save it for later use)
 .TP
 .B *
 Repeat until finished
+.P
+Alternatively, 
+.B abcde
+can also grab a CD and turn it into a single FLAC file with an embedded
+cuesheet which can be user later on as a source for other formats, and will be
+treated as if it was the original CD. In a way,
+.B abcde
+can take a compressed backup of your CD collection.
 .SH OPTIONS
 .TP
 .B \-1
 Encode the whole CD in a single file. The resulting file uses the CD title
-for tagging. If the resulting format is a flac file with an embeded cuesheet,
+for tagging. If the resulting format is a flac file with an embedded cuesheet,
 the file can be used as a source for creating other formats. Use "-1 -M -o
-flac" for obtaining such a file .TP
+flac" for obtaining such a file.
+.TP
 .B \-a [actions]
 Comma-delimited list of actions to perform. Can be one or more of:
 cddb, read, normalize, encode, tag, move, replaygain, playlist, clean. Normalize
@@ -74,7 +83,7 @@ least the "read" action during the previous session.
 .TP
 .B \-d [devicename | filename]
 CD\-ROM block device that contains audio tracks to be read. Alternatively, a
-single-track flac file with embeded cuesheet.
+single-track flac file with embedded cuesheet.
 .TP
 .B \-D
 Capture debugging information (you'll want to redirect this \- try 'abcde \-D
@@ -128,8 +137,8 @@ endings. Some hardware players insist on having those to work.
 .B \-M
 Create a CUE file with information about the CD. Together with the possibility
 of creating a single file (see option "\-1"), one can recreate the original CD.
-If the cuesheet is embeded in a flac single file it can be used as source for
-encoding other formats.
+If the cuesheet is embedded in a flac single file it can be used as source for
+encoding other formats (see option "\-d").
 .TP
 .B \-o [filetype][:filetypeoptions]
 Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc",
@@ -180,12 +189,18 @@ Show the version and exit
 .TP
 .B \-V
 Be a bit more verbose. On slow networks the CDDB requests might give the
-sensation nothins is happening.
+sensation nothing is happening.
 .TP
 .B \-x
 Eject the CD when all tracks have been read. See the EJECTCD configuration
 variable.
 .TP
+.B \-X [cue2discid]
+Use an alternative "cue2discid" implementation. The name of the binary must be
+exactly that. abcde comes with an implementation in python under the examples
+directory. The special keyword "builtin" forces the usage of the internal
+(default) implementation in shell script.
+.TP
 .B \-w [comment]
 Add a comment to the tracks ripped from the CD.
 .TP
@@ -213,8 +228,8 @@ its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.
 abcde sources two configuration files on startup - /etc/abcde.conf and
 $HOME/.abcde.conf, in that order. 
 .TP
-The configuration options stated on those files can be overriden by providing
-the appropiate flags at runtime.
+The configuration options stated on those files can be overridden by providing
+the appropriate flags at runtime.
 .TP
 The configuration variables have to be set as follows:
 .TP
@@ -232,7 +247,7 @@ Here is a list of options abcde recognizes:
 Specifies the method we want to use to retrieve the track information. Two
 values are recognized: "cddb" and "musicbrainz". The "cddb" value needs the
 CDDBURL and HELLOINFO variables described below. The "musicbrainz" value uses
-Python to stablish a conversation with the server for information retrieval.
+Python to establish a conversation with the server for information retrieval.
 .TP
 .B CDDBURL
 Specifies a server to use for CDDB lookups.
@@ -274,7 +289,7 @@ repository (if any). STILL NOT WORKING!!
 Store local copies of the CDDB entries under the $CDDBLOCALDIR directory.
 .TP
 .B CDDBUSELOCAL
-Actually use the stored copies of the CDDB entries. Can be overriden using the 
+Actually use the stored copies of the CDDB entries. Can be overridden using the 
 "-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give 
 the choice of retrieving a CDDB entry from the internet.
 .TP
@@ -349,7 +364,7 @@ respective utilities: LAME, TOOLAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC,
 VORBIZE, OGGENC, FLAC, SPEEXENC, MPPENC, AACEND, ID3, ID3V2, EYED3, METAFLAC,
 CDPARANOIA, CDDA2WAV, CDDAFS, CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3,
 VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, MPPGAIN, MKCUE, MKTOC,
-DIFF and HTTPGET.
+CUE2DISCID (see option "\-X"), DIFF and HTTPGET.
 .TP
 .B COMMAND-LINE OPTIONS
 If you wish to specify command-line options to any of the programs abcde uses,
@@ -412,8 +427,13 @@ you can force with
 '-p' in the command line.
 .TP
 .B VAOUTPUTFORMAT
-Just like OUTPUTFORMAT but for Various Artists discs. Default is whatever
-OUTPUTFORMAT is set to.
+Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
+.TP
+.B ONETRACKOUTPUTFORMAT
+Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
+.TP
+.B VAONETRACKOUTPUTFORMAT
+Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${ALBUMFILE}'
 .TP
 .B MAXPROCS
 Defines how many encoders to run at once. This makes for huge speedups
@@ -508,7 +528,7 @@ Possible ways one can call abcde
 Will work in most systems
 .TP
 .B abcde \-d /dev/cdrom2
-If the CDROM you are reding from is not the standard /dev/cdrom (in GNU/Linux systems)
+If the CDROM you are reading from is not the standard /dev/cdrom (in GNU/Linux systems)
 .TP
 .B abcde \-o vorbis,flac
 Will create both Ogg/Vorbis and Ogg/FLAC files.
@@ -523,7 +543,7 @@ For double+ CD settings: will create the 1st CD starting with the track number
 and so on.
 .TP
 .B abcde \-d singletrack.flac
-Will extract the files contained in singletrack using the embeded cuesheet.
+Will extract the files contained in singletrack using the embedded cuesheet.
 .SH BACKEND TOOLS
 abcde requires the following backend tools to work:
 .TP