Added onetrack status.
[clinton/abcde.git] / README
c9c2ca27 1ABCDE
4abcde is a frontend command-line utility (actually, a shell script) that
9f659ada 5grabs tracks off a CD, encodes them to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or
6MPP/MP+(Musepack) format, and tags them, all in one go.
c9c2ca27 7
79e3928b 8Your finished Ogg/MP3/FLAC/Speex/MPP's are, by default, stored in a subdirectory
9f659ada 9of the current directory (named after the artist) with a filename based on the
79e3928b 10track title. Spaces are replaced by underscores, and apostrophes and control
11codes are filtered out. Colons are replaced with an underscore and a hyphen. The
12end result usually looks like: Our_Lady_Peace/01.Supermans_Dead.ogg This
13filename munging is customizable - edit the mungefilename function in your
14abcde.conf to change it.
c9c2ca27 15
b7f1cc84 16Many of the questions related of problems executing abcde have been moved to the
17FAQ, which should be distributed along with this package. Reffer to that file
18for help.
c9c2ca27 19
20To make abcde 2.x work more like 1.x, put these options in your abcde.conf:
c9c2ca27 26MAJOR CHANGES
b82e2042 28Changes in 2.3:
24f444d7 29* Support for mkcue, to create a CUE sheet of the CD structure.
30* New -o <output(1)>:<options(1)>,... way of passing specific options to an
31 output. Now we can pass specific options without having to modify a config
bef9c2d8 32 file. This feature was already present in the last versions of the 2.2 cycle.
24f444d7 33* Unix PIPEs, as a second way to encode files with a tight disc space.
bef9c2d8 34* Option to erase the "encoded" entries from the status file. Allows
b82e2042 35* The "ogg" output mode will be substituted for "vorbis" in the near future.
36 This release adds a compatibility layer so that both entries work.
24f444d7 37
81bc6204 38Changes in 2.2:
99d009fa 39
81bc6204 40* Support for MPP/MP+(Musepack) format. It can be downloaded from
79e3928b 41 It is supposed to be Free (not only free), and released under
42 the GPL...
81bc6204 43* New "-t <number>" option for starting the numbering of the output files at a
44 given starting number. Ideal for albums with more than one CD.
45* New "-T <number>" option, similar to "-t" but also modifies the tag entries
79e3928b 46 on the files themselves.
81bc6204 47* New "-w <COMMENT>" to add a comment to the tracks of a given CD rip. Use
49* New "-W <number>" option to combine both a comment with "CD #number" and a
50 starting number for both the tracks and the tags with "#01" (that is, 101 for
51 the 1st CD, 201 for the second...)
40c61684 52* Support for keeping an existing playlist (and not add new entries to it),
53 erase the existing one (overwrite) or append new entries to the existing
54 one.
7acef70b 55* Under ./examples you will find a very basic way to make abcde run in the
56 background and start a non-interactive rip of a CD, if it can find an
57 audio CD in the tray.
58 The abcded script depends on eject and cdparanoia being installed in your
59 system.
60* New mungegenre function to switch off (or modify) the default behaviour of
61 transforming uppercase characters to lowercase.
99d009fa 62* cdparanoia permits performing a query to the CD drive and obtain a list of
63 valid audio tracks. So, now we perform such query and process the results.
64* Support for "None of the above" has been added with the "0" selection. A
65 template is created, and the selection to edit it is defaulted to "y".
c9c2ca27 67New options in 2.1.19:
69* ONETRACK mode has been introduced. Setting the flag "-1" will create a
70 single file with all the tracks from the CD.
72Changes in 2.1.18:
74* CDSPEED option defaults to eject. However, since cdparanoia has a built-in
79e3928b 75 option to set the speed, we use it. There is not way (right now) to force the
76 use of eject, but it will be introduced in a future release. Also one can use
77 the pre_read function to set the speed with other program.
c9c2ca27 78
79New options in 2.1.16:
79e3928b 81* -S, CDSPEED and CDSPEEDOPTS for setting the speed of the CDROM. One can set
82 the options in abcde.conf and pass the value on the command line. This option
83 can be used with "eject -x <speed>", "setcd -x <speed>" or the built-in
84 cdparanoia option "-S <speed>", if the CD reader supports it.
c9c2ca27 85* Added a pre-read function. Modify it at your pleasure in abcde.conf
86 One can use it to close the CD drive.
79e3928b 87* -m option, to modify the playlist to include CRLF in every line. Some players
88 insist on having those to work properly with playlists.
c9c2ca27 89
90New options in 2.1.15:
92* -V can be used to obtain some more information about the CDDB queries.
93* -v shows the version, basic help, and exits.
95New options from 2.1.10 to 2.1.13:
97* CDROMID has been introduced for cdda2wav use with SCSI devices.
98* Use -L to retrieve the CDDB entries from a local repository (also one can
99 set CDDBUSELOCAL in the config file).
100* If CDDBCOPYLOCAL is set to "y" we store copies of the CDDB entries, under
101 CDDBLOCALDIR (defaults to "~/.cddb).
103Modifications from 2.1.9 to 2.1.10:
105* Initial (still incomplete) MacOSX support is on the works.
106* A new tool (curl) has been added for MacOSX compatibility, as HTTPGET
107 option.
109Options modified from 2.1.8 to 2.1.9:
111* KEEPWAVS option now sets the clean to "no".
113Options added/modified from 2.1.3 to 2.1.5:
115* Ogg/Speex added. Use "-o spx" to rip your audiobooks, for instance.
117Options added/modified from 2.1.1 to 2.1.3:
119* WGET has been substituted by HTTPGET. Now we support fetch as retrieval
120 program.
121* KEEPWAVS has been introduced. Set it to "y" and the wav tracks will be
122 kept.
123* CDDBPROTO is used to specify the protocol level in the CDDB retrieval.
124* DAGRAB has been introduced as a cd ripper.
126Options added/modified from 2.0.3 to 2.1.x:
72d7162b 128* -b use batch processing. It uses normalize-audio to adjust the volume of
129 the songs, and a -g gapless option from lame to remove gaps. Only available
c9c2ca27 130 for mp3+lame combination.
131* a new "normalize" option has been added to -a, to normalize the volume.
132* -o works now with a combination of the different outputs: ogg, mp3, flac.
133 Combine them separated by ",". Example: "-o ogg,flac".
79e3928b 134* OUTPUTTYPE is no longer used for the output file type. From version 2.1 abcde
135 implements multiple-output and the file type is always appended at the end of
136 the file. The OUTPUT variable can be used in the PLAYLISTFORMAT and
137 OUTPUTFORMAT to create different directory structures and playlist names for
138 each of the output formats selected.
140* DYEAR can be used as DiskYear value in CDDB data. If the data is not supplied
141 by the CDDB server, it can be added.
c9c2ca27 142
143Other options that changed from 1.x to 2.x:
145* -e doesn't exist anymore, abcde now presents you with all of the cddb data
146 and asks you if you want to edit it. If you don't want to be asked,
147 use -N or INTERACTIVE=n
148* The output type defaults to Ogg/Vorbis. Specify -o mp3 or OUTPUTTYPE=mp3
149 if you still want to output mp3's.
150* -l 2 is now just -l, LOWDISK=2 should now be LOWDISK=y
151* -V and -v are gone, abcde will now prompt you if you'd like to use Various
152 Artists handling, after showing you the cddb data.
153* -P is now '-a playlist,clean', PLAYLISTONLY=y is now
154 ACTIONS=playlist,clean
155* -p is now '-a playlist,move,clean', PLAYLIST=y is now
156 ACTIONS=playlist,move,clean
157* cddb-tool has been cleaned up a little bit. 'get' is now 'query' and
158 'read', and the tempfile handling has been removed.
160* FreeDB is now the default CDDB database.
166abcde requires the following backend tools to work:
168* An Ogg/Vorbis encoder (oggenc, the default, or vorbize) or:
169* An MP3 encoder (lame, gogo, bladeenc, l3enc, etc). Any MP3 encoder that
170 takes two filenames on the command line, one for input, one for output,
171 will work.
172 You can get lame at:
173 You can get gogo at:
174 You can get BladeEnc at:
175 You can get a trial version of mp3enc at:
176 or:
177* FLAC encoder (flac) or:
9f659ada 178* Ogg/Speex encoder (speexenc) or:
179* MPP/MP+(Musepack) encoder (mppenc)
72d7162b 180* normalize-audio for volume normalization.
c9c2ca27 181* CD Paranoia, an audio CD reading utility,
182* Or cdda2wav, the audio CD reading utility cdparanoia was born from,
183* Or dagrab, another audio CD reading utility.
184* cd-discid, a CDDB DiscID reading program. Formerly bundled with abcde.
185 It's available in Debian or
186* An HTTP retrieval program: wget, fetch (FreeBSD) or curl (MacOSX)
187* id3, an id3 tagging program. Available at:
188* id3v2, an id3 version 2.0 tagger.
189* (optional) distmp3, a client/server for distributed mp3 encoding.
190 You can get distmp3 at
c9c2ca27 192Abcde's new mailing list is So far has not
193been actively used.
194The posts from non-subscribers are moderated to prevent spam.
196Archives of the old list are publically available at:
199Abcde's current page is at
c9c2ca27 200Abcde's old homepage is at
c9c2ca27 202Jesus Climent <>
79e3928b 203
b7f1cc84 204abcde was originally created by Robert Woodcock <>
79e3928b 205