Small typo.

[clinton/abcde.git] / README

diff --git a/README b/README
index 813a79d..f2baf6a 100644 (file)
--- a/README
+++ b/README
@@ -2,8 +2,9 @@ ABCDE
 =====
 
 abcde is a frontend command-line utility (actually, a shell script) that
 =====
 
 abcde is a frontend command-line utility (actually, a shell script) that

-grabs tracks off a CD, encodes them to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or
-MPP/MP+(Musepack) format, and tags them, all in one go.
+grabs tracks off a CD or a singletrack flac file with an embeded cuesheet,
+encodes them to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or MPP/MP+(Musepack)
+format, and tags them, all in one go.

 
 Your finished Ogg/MP3/FLAC/Speex/MPP's are, by default, stored in a subdirectory
 of the current directory (named after the artist) with a filename based on the
 
 Your finished Ogg/MP3/FLAC/Speex/MPP's are, by default, stored in a subdirectory
 of the current directory (named after the artist) with a filename based on the


@@ -15,27 +16,61 @@ abcde.conf to change it.
 
 Many of the questions related of problems executing abcde have been moved to the
 FAQ, which should be distributed along with this package. Reffer to that file 
 
 Many of the questions related of problems executing abcde have been moved to the
 FAQ, which should be distributed along with this package. Reffer to that file 

-for help.
-
-To make abcde 2.x work more like 1.x, put these options in your abcde.conf:
-
-INTERACTIVE=n
-OUTPUTTYPE=mp3
-ID3TAGV=1
+for more help.

 
 MAJOR CHANGES
 =============
 
 MAJOR CHANGES
 =============

-Changes in 2.2-pre2:
-
-* Support for MPP/MP+(Musepack) format. It can be downloaded from 
+Changes in 2.4:
+* Read TOC entries from the CD. The default uses cdrdao. The program mkcue is
+  also optional.
+* Possibility to use CDDBCHOICE1,CDDBCHOICE2 (i.e., 1,3) to get a diff of two
+  parsed CDDB entries.
+* Added SHOWCDDBFIELDS to define wether to show the YEAR and GENRE fields from
+  the CDDB output.
+* Added the possibility of using a singletrack flac file with an embeded
+  cuesheet as a source to extract tracks from.
+* Added replaygain for Ogg/Vorbis and Ogg/FLAC.
+* Added M4A encoding.
+* Uses the default found $CDROMREADER instead of forcing cdparanoia when
+  cdda2wav is installed.
+* BATCH mode has been splitted into two options: BATCHNORM and NOGAP.
+* Added -u option for UNICODE (UTF-8) tag encoding.
+* Added -z for debug.
+* Added -f to force the removal of left files.
+ 
+Changes in 2.3:
+* Support for mkcue, to create a CUE sheet of the CD structure. It can be used
+  with "-1" to create a backup, so that later on the original CD can be
+  recreated.
+* New -o <output(1)>:<options(1)>,... way of passing specific options to an
+  output. Now we can pass specific options without having to modify a config
+  file. This feature was already present in the last versions of the 2.2 cycle.
+* Unix PIPEs, as a second way to encode files with a low disc space.
+* Option to erase the "encoded" entries from the status file. Allows one to
+  encode the wav files (in case they were not erased) into another format. This
+  is needed until status information is stored for each format.
+* The "ogg" output mode will be substituted for "vorbis" in the near future.
+  This release adds a compatibility layer so that both entries work.
+* The FLAC encoder forces the files to be overwritten, in case they previously
+  exists. This avoids a half-through abcde run to continue without errors in
+  case it was cancelled during the FLAC encoding.
+* Added a post_read() function so that we can do things with the CD before we
+  eject it.
+
+Changes in 2.2:
+
+* Support for MPP/MP+(Musepack) format. It can be downloaded from

   corecodecs.org. It is supposed to be Free (not only free), and released under
   the GPL...
   corecodecs.org. It is supposed to be Free (not only free), and released under
   the GPL...

-* New "-w <comment>" option to add a comment for a given CD on the command
-  line.
-* New "-t <number>" option for starting the numbering of the output files at 
-  a given starting number. Ideal for albums with more than one CD.
-  New "-T <number>" option, similar to "-s" but also modifies the tag entries
+* New "-t <number>" option for starting the numbering of the output files at a
+  given starting number. Ideal for albums with more than one CD.  
+* New "-T <number>" option, similar to "-t" but also modifies the tag entries

   on the files themselves.
   on the files themselves.

+* New "-w <COMMENT>" to add a comment to the tracks of a given CD rip. Use
+  quotes.
+* New "-W <number>" option to combine both a comment with "CD #number" and a
+  starting number for both the tracks and the tags with "#01" (that is, 101 for
+  the 1st CD, 201 for the second...)

 * Support for keeping an existing playlist (and not add new entries to it),
   erase the existing one (overwrite) or append new entries to the existing
   one.
 * Support for keeping an existing playlist (and not add new entries to it),
   erase the existing one (overwrite) or append new entries to the existing
   one.


@@ -46,9 +81,6 @@ Changes in 2.2-pre2:
   system.
 * New mungegenre function to switch off (or modify) the default behaviour of
   transforming uppercase characters to lowercase.
   system.
 * New mungegenre function to switch off (or modify) the default behaviour of
   transforming uppercase characters to lowercase.

-
-Changes in 2.2-pre1:
-

 * cdparanoia permits performing a query to the CD drive and obtain a list of 
   valid audio tracks. So, now we perform such query and process the results.
 * Support for "None of the above" has been added with the "0" selection. A 
 * cdparanoia permits performing a query to the CD drive and obtain a list of 
   valid audio tracks. So, now we perform such query and process the results.
 * Support for "None of the above" has been added with the "0" selection. A