abcde.1, abcde.conf
[abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index 1e720ff..657eea0 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -39,6 +39,14 @@ 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
@@ -48,12 +56,12 @@ the file can be used as a source for creating other formats. Use "-1 -M -o
 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
-and encode imply read. Tag implies cddb, read, encode. Move implies
-cddb, read, encode, tag. Replaygain implies cddb, read, encode, tag and move.
-Playlist implies cddb. The default is to do all actions except normalize,
-replaygain and playlist.
+Comma-delimited list of actions to perform. Can be one or more of: cddb, cue,
+read, normalize, encode, tag, move, replaygain, playlist, clean. Normalize and
+encode imply read. Tag implies cddb, read, encode. Move implies cddb, read,
+encode, tag. Replaygain implies cddb, read, encode, tag and move.  Playlist
+implies cddb. The default is to do all actions except normalize, replaygain and
+playlist.
 .TP
 .B \-b
 Enable batch mode normalization. See the BATCHNORM configuration variable.
@@ -130,7 +138,7 @@ endings. Some hardware players insist on having those to work.
 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 embedded in a flac single file it can be used as source for
-encoding other formats.
+encoding other formats (see option "\-d").
 .TP
 .B \-o [filetype][:filetypeoptions]
 Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc",
@@ -170,11 +178,9 @@ filenames and the playlist. Internal (tag) numbering remains the same.
 Same as \-t but changes also the internal (tag) numbering. Keep in mind that
 the default TRACK tag for MP3 is $T/$TRACKS so it is changed to simply $T.
 .TP
-.B \-u
-Set CDDBPROTO to version 6, so that we retrieve UTF-8 encoded CDDB
-information, and we tag and add comments with a proper encoding. This flag will
-be removed and -U will be added to set it to version 5 once version 6 becomes
-the default.
+.B \-U
+Set CDDBPROTO to version 5, so that we retrieve ISO-8859-15 encoded CDDB
+information, and we tag and add comments with Latin1 encoding.
 .TP
 .B \-v
 Show the version and exit
@@ -187,6 +193,12 @@ sensation nothing is happening.
 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
@@ -350,7 +362,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,
@@ -413,8 +425,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