Remove USEPIPES from debian/docs
[abcde.git] / README
1 ABCDE
2 =====
3
4 abcde is a frontend command-line utility (actually, a shell script) that
5 grabs tracks off a CD or a singletrack flac file with an embeded cuesheet,
6 encodes them to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, M4A, Opus, WavPack,
7 Monkey's Audio (ape) and/or MPP/MP+(Musepack) format, and tags them, all
8 in one go.
9
10 Your finished Ogg/MP3/FLAC/Speex/M4A/Opus,WavPack/Ape/MPP's are, by default,
11 stored in a subdirectory of the current directory (named after the artist)
12 with a filename based on the track title. Spaces are replaced by underscores,
13 and apostrophes and control codes are filtered out. Colons are replaced with
14 an underscore and a hyphen. The end result usually looks like:
15 Our_Lady_Peace/01.Supermans_Dead.ogg. This filename munging is customizable,
16 edit the mungefilename function in your abcde.conf to change it.
17
18 Many of the questions related of problems executing abcde have been moved to the
19 FAQ, which should be distributed along with this package. Refer to that file
20 for more help.
21
22 MAJOR CHANGES
23 =============
24
25 Changes in 2.7
26 * Rewrite of the mungefilename function.
27 * Support added for downloading album art.
28 * Support added for ripping with libcdio (cd-paranoia).
29 * Some error checking and a small help file added to abcde-musicbrainz-tool. 
30 * Substantial renovations of m4a encoding with a choice now between encoding
31   with faac, NeroAacEnc and fdkaac.
32 * Fixes to USEPIPES with the addition of several new encoders and rippers.
33   Details on USEPIPES now available in the abcde FAQ doc.
34 * Support added for encoding with Monkey's Audio (ape), tagging is with
35   Robert Muth's apetag.
36 * Support added for encoding with WavPack.
37 * mp3 tagging renovated with version sniffing differentiating between eyeD3
38   versions. Tagging formalised with options now for id3, id3v2 and eyeD3.
39 * Many, many bug fixes. See the changelog for more details.
40
41 Changes in 2.6:
42 * Lots of bugfixes
43
44 Changes in 2.5:
45 * Added working support for Musicbrainz using a perl helper script.
46
47 Changes in 2.4:
48 * Read TOC entries from the CD. The default uses cdrdao. The program mkcue is
49   also optional.
50 * Possibility to use CDDBCHOICE1,CDDBCHOICE2 (i.e., 1,3) to get a diff of two
51   parsed CDDB entries.
52 * Added SHOWCDDBFIELDS to define whether to show the YEAR and GENRE fields from
53   the CDDB output.
54 * Added the possibility of embeding a cuesheet on a singletrack flac file. A
55   single BACKUP flag is most likely needed to use all the needed flags:
56   "abcde -1 -o flac -a default,cue"
57 * Added the possibility of using a singletrack flac file with an embeded
58   cuesheet as a source to extract tracks from (use -X to specify an external
59   CUE2DISCID implementation; check under examples in the distributed source
60   code or package).
61 * Added replaygain for Ogg/Vorbis and Ogg/FLAC.
62 * Added M4A encoding.
63 * Uses the default found $CDROMREADER instead of forcing cdparanoia when
64   cdda2wav is installed.
65 * BATCH mode has been split into two options: BATCHNORM and NOGAP.
66 * Added -U option for non-UNICODE (non UTF-8) tag encoding.
67 * Added -z for debug.
68 * Added -f to force the removal of left files.
69 * CUE support has changed from a flag (-M) to an action (cue).
70
71 Changes in 2.3:
72 * Support for mkcue, to create a CUE sheet of the CD structure. It can be used
73   with "-1" to create a backup, so that later the original CD can be recreated.
74 * New -o <output(1)>:<options(1)>,... way of passing specific options to an
75   output. Now we can pass specific options without having to modify a config
76   file. This feature was already present in the last versions of the 2.2 cycle.
77 * Unix PIPEs, as a second way to encode files with a low disc space.
78 * Option to erase the "encoded" entries from the status file. Allows one to
79   encode the wav files (in case they were not erased) into another format. This
80   is needed until status information is stored for each format.
81 * The "ogg" output mode will be substituted for "vorbis" in the near future.
82   This release adds a compatibility layer so that both entries work.
83 * The FLAC encoder forces the files to be overwritten, in case they previously
84   exists. This avoids a half-through abcde run to continue without errors in
85   case it was cancelled during the FLAC encoding.
86 * Added a post_read() function so that we can do things with the CD before we
87   eject it.
88
89 Changes in 2.2:
90
91 * Support for MPP/MP+(Musepack) format. It can be downloaded from
92   corecodecs.org. It is supposed to be Free (not only free), and released under
93   the GPL...
94 * New "-t <number>" option for starting the numbering of the output files at a
95   given starting number. Ideal for albums with more than one CD.
96 * New "-T <number>" option, similar to "-t" but also modifies the tag entries
97   on the files themselves.
98 * New "-w <COMMENT>" to add a comment to the tracks of a given CD rip. Use
99   quotes.
100 * New "-W <number>" option to combine both a comment with "CD #number" and a
101   starting number for both the tracks and the tags with "#01" (that is, 101 for
102   the 1st CD, 201 for the second...)
103 * Support for keeping an existing playlist (and not add new entries to it),
104   erase the existing one (overwrite) or append new entries to the existing
105   one.
106 * Under ./examples you will find a very basic way to make abcde run in the
107   background and start a non-interactive rip of a CD, if it can find an
108   audio CD in the tray.
109   The abcded script depends on eject and cdparanoia being installed in your
110   system.
111 * New mungegenre function to switch off (or modify) the default behaviour of
112   transforming uppercase characters to lowercase.
113 * cdparanoia permits performing a query to the CD drive and obtain a list of
114   valid audio tracks. So, now we perform such query and process the results.
115 * Support for "None of the above" has been added with the "0" selection. A
116   template is created, and the selection to edit it is defaulted to "y".
117
118 New options in 2.1.19:
119
120 * ONETRACK mode has been introduced. Setting the flag "-1" will create a
121   single file with all the tracks from the CD.
122
123 Changes in 2.1.18:
124
125 * CDSPEED option defaults to eject. However, since cdparanoia has a built-in
126   option to set the speed, we use it. There is not way (right now) to force the
127   use of eject, but it will be introduced in a future release. Also one can use
128   the pre_read function to set the speed with other program.
129
130 New options in 2.1.16:
131
132 * -S, CDSPEED and CDSPEEDOPTS for setting the speed of the CDROM. One can set
133   the options in abcde.conf and pass the value on the command line.  This option
134   can be used with "eject -x <speed>", "setcd -x <speed>" or the built-in
135   cdparanoia option "-S <speed>", if the CD reader supports it.
136 * Added a pre-read function. Modify it at your pleasure in abcde.conf
137   One can use it to close the CD drive.
138 * -m option, to modify the playlist to include CRLF in every line. Some players
139   insist on having those to work properly with playlists.
140
141 New options in 2.1.15:
142
143 * -V can be used to obtain some more information about the CDDB queries.
144 * -v shows the version, basic help, and exits.
145
146 New options from 2.1.10 to 2.1.13:
147
148 * CDROMID has been introduced for cdda2wav use with SCSI devices.
149 * Use -L to retrieve the CDDB entries from a local repository (also one can
150   set CDDBUSELOCAL in the config file).
151 * If CDDBCOPYLOCAL is set to "y" we store copies of the CDDB entries, under
152   CDDBLOCALDIR (defaults to "~/.cddb).
153
154 Modifications from 2.1.9 to 2.1.10:
155
156 * Initial (still incomplete) MacOSX support is on the works.
157 * A new tool (curl) has been added for MacOSX compatibility, as HTTPGET
158   option.
159
160 Options modified from 2.1.8 to 2.1.9:
161
162 * KEEPWAVS option now sets the clean to "no".
163
164 Options added/modified from 2.1.3 to 2.1.5:
165
166 * Ogg/Speex added. Use "-o spx" to rip your audiobooks, for instance.
167
168 Options added/modified from 2.1.1 to 2.1.3:
169
170 * WGET has been substituted by HTTPGET. Now we support fetch as retrieval
171   program.
172 * KEEPWAVS has been introduced. Set it to "y" and the wav tracks will be
173   kept.
174 * CDDBPROTO is used to specify the protocol level in the CDDB retrieval.
175 * DAGRAB has been introduced as a cd ripper.
176
177 Options added/modified from 2.0.3 to 2.1.x:
178
179 * -b use batch processing. It uses normalize-audio to adjust the volume of
180   the songs, and a -g gapless option from lame to remove gaps. Only available
181   for mp3+lame combination.
182 * a new "normalize" option has been added to -a, to normalize the volume.
183 * -o works now with a combination of the different outputs: ogg, mp3, flac.
184   Combine them separated by ",". Example: "-o ogg,flac".
185 * OUTPUTTYPE is no longer used for the output file type. From version 2.1 abcde
186   implements multiple-output and the file type is always appended at the end of
187   the file. The OUTPUT variable can be used in the PLAYLISTFORMAT and
188   OUTPUTFORMAT to create different directory structures and playlist names for
189   each of the output formats selected.
190
191 * DYEAR can be used as DiskYear value in CDDB data. If the data is not supplied
192   by the CDDB server, it can be added.
193
194 Other options that changed from 1.x to 2.x:
195
196 * -e doesn't exist anymore, abcde now presents you with all of the cddb data
197   and asks you if you want to edit it. If you don't want to be asked,
198   use -N or INTERACTIVE=n
199 * The output type defaults to Ogg/Vorbis. Specify -o mp3 or OUTPUTTYPE=mp3
200   if you still want to output mp3's.
201 * -l 2 is now just -l, LOWDISK=2 should now be LOWDISK=y
202 * -V and -v are gone, abcde will now prompt you if you'd like to use Various
203   Artists handling, after showing you the cddb data.
204 * -P is now '-a playlist,clean', PLAYLISTONLY=y is now
205   ACTIONS=playlist,clean
206 * -p is now '-a playlist,move,clean', PLAYLIST=y is now
207   ACTIONS=playlist,move,clean
208 * cddb-tool has been cleaned up a little bit. 'get' is now 'query' and
209   'read', and the tempfile handling has been removed.
210 * ID3COMMENT is now COMMENT.
211 * FreeDB is now the default CDDB database.
212
213
214 REQUIREMENTS
215 ============
216
217 abcde requires the following backend tools to work:
218
219 * An Ogg/Vorbis encoder (oggenc, the default, or vorbize) or:
220 * An MP3 encoder (lame, gogo, bladeenc, l3enc, etc) or:
221 * A FLAC encoder (flac) or:
222 * An Ogg/Speex encoder (speexenc) or:
223 * An MPP/MP+(Musepack) encoder (mpcenc) or:
224 * An AAC encoder (faac, NeroAacEnc, fdkaac) or:
225 * An Opus encoder )opusenc) or:
226 * A Monkey's Ausio encoder (mac) or:
227 * A WavPack encoder (wavpack)
228 * normalize-audio for volume normalization.
229 * CD Paranoia, an audio CD reading utility or:
230 * icedax/cdda2wav, the audio CD reading utility cdparanoia was born from or:
231 * cd-paranoia, an audio cd reading utility, courtesy of GNU libcdio or:
232 * dagrab, another audio CD reading utility.
233 * cd-discid, a CDDB DiscID reading program. Formerly bundled with abcde.
234   It's available in Debian or http://linukz.org/cd-discid.shtml
235 * An HTTP retrieval program: wget, fetch (FreeBSD) or curl (MacOSX)
236 * id3, an id3 tagging program. Available at: http://lly.org/~rcw/id3/
237 * eyeD3, an id3 version 2.0 tagger. http://eyed3.nicfit.net/
238 * (optional) distmp3, a client/server for distributed mp3 encoding.
239   You can get distmp3 at http://wlug.westbo.se/medlprog/medlprog.html
240
241 Abcde's new mailing list is abcde-users@lists.einval.com. Visit
242
243   http://lists.einval.com/cgi-bin/mailman/listinfo/abcde-users
244
245 to subscribe. Posts from non-subscribers are moderated to prevent
246 spam.
247
248 Abcde's current page is at http://abcde.einval.com/ and the latest
249 upstream code is in git at http://git.einval.com/cgi-bin/gitweb.cgi?p=abcde.git
250
251 --
252 Jesus Climent <jesus.climent@hispalinux.es>
253 Colin Tuckley <colint@debian.org>
254 Steve McIntyre <93sam@debian.org>
255
256 abcde was originally created by Robert Woodcock <rcw@debian.org>