1abcde(1)                    General Commands Manual                   abcde(1)
2
3
4

NAME

6       abcde  -  Grab  an  entire CD and compress it to Ogg/Vorbis, MP3, FLAC,
7       Ogg/Speex, AAC, WavPack, Monkey's Audio (ape), MPP/MP+(Musepack),  True
8       Audio (tta), MP2 format and/or AIFF (Audio Interchange File Format).
9

SYNOPSIS

11       abcde [options] [tracks]
12

DESCRIPTION

14       Ordinarily,  the process of grabbing the data off a CD and encoding it,
15       then tagging or commenting it, is very involved.  abcde is designed  to
16       automate  this.  It  will  take an entire CD and convert it into a com‐
17       pressed audio format - Ogg/Vorbis, MPEG Audio  Layer  III  (MP3),  Free
18       Lossless Audio Codec (FLAC), Ogg/Speex, MPP/MP+(Musepack), M4A (AAC) wv
19       (WavPack), Monkey's Audio (ape), Opus, True  Audio  (tta),  MPEG  Audio
20       Layer II (MP2) or AIFF (Audio Interchange File Format) format(s).  With
21       one command, it will:
22
23       *      Do a CDDB or Musicbrainz query over the Internet to look up your
24              CD or use a locally stored CDDB entry, or read CD-TEXT from your
25              CD if it's available
26
27       *      Download the album art appropriate for your  music  tracks  with
28              many  user  configurable  options for download and post download
29              alterations including automated embedding of the album  art  for
30              some containers
31
32       *      Grab an audio track (or all the audio CD tracks) from your CD
33
34       *      Normalize  the  volume of the individual file (or the album as a
35              single unit)
36
37       *      Compress to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack),
38              M4A,  wv  (WavPack),  Monkey's Audio (ape), Opus format(s), True
39              Audio (tta), MP2 or AIFF (Audio Interchange File Format) all  in
40              one CD read
41
42       *      Comment or ID3/ID3v2 tag
43
44       *      Give an intelligible filename
45
46       *      Calculate  replaygain  values  for  the  individual file (or the
47              album as a single unit)
48
49       *      Delete the intermediate WAV file (or save it for later use)
50
51       *      Repeat until finished
52
53       Alternatively, abcde can also grab a CD and turn it into a single  FLAC
54       file  with  an embedded cuesheet which can be user later on as a source
55       for other formats, and will be treated as if it was the original CD. In
56       a way, abcde can take a compressed backup of your CD collection.
57

OPTIONS

59       -1     Encode  the  whole  CD in a single file. The resulting file uses
60              the CD title for tagging. If the resulting format is a flac file
61              with  an embedded cuesheet, the file can be used as a source for
62              creating other formats. Use "-1  -o  flac  -a  default,cue"  for
63              obtaining such a file.
64
65       -a [actions]
66              Comma-delimited  list  of actions to perform. Can be one or more
67              of: cddb,  cue,  read,  getalbumart,  embedalbumart,  normalize,
68              encode,  tag,  move,  replaygain, playlist, clean. Normalize and
69              encode imply read. Tag implies cddb, read, encode. Move  implies
70              cddb,  read, encode, tag. Replaygain implies cddb, read, encode,
71              tag and  move.  Playlist  implies  cddb.  embedalbumart  implies
72              getalbumart.   The default is to do all actions except cue, nor‐
73              malize, replaygain, getalbumart, embedalbumart and playlist.
74
75       -b     Enable batch mode normalization. See the BATCHNORM configuration
76              variable.
77
78       -B     Enable automatic embedding of album art with certain containers.
79              As of abcde 2.8.2 supported containers are  mp3  (using  eyeD3),
80              flac (using metaflac), m4a (using AtomicParsley), WavPack aka wv
81              (using wvtag) and experimental support for ogg (using vorbiscom‐
82              ment). This command line option also calls the getalbumart func‐
83              tion. Further details of album art embedding using the  embedal‐
84              bumart  function can be found in the abcde FAQ document packaged
85              with abcde.
86
87       -c [filename]
88              Specifies an additional configuration file to parse.  Configura‐
89              tion  options  in this file override those in /etc/abcde.conf or
90              $HOME/.abcde.conf.
91
92       -C [discid]
93              Allows you to resume a session for discid  when  you  no  longer
94              have  the  CD  available (abcde will automatically resume if you
95              still have the CD in the drive). You must have already  finished
96              at least the "read" action during the previous session.
97
98       -d [devicename | filename]
99              CD-ROM  block  device  that  contains  audio  tracks to be read.
100              Alternatively, a single-track flac file with embedded cuesheet.
101
102       -D     Capture debugging information (you'll want to  redirect  this  -
103              try 'abcde -D 2>logfile')
104
105       -e     Erase  information about encoded tracks from the internal status
106              file, to enable other encodings if the wav files have been kept.
107
108       -f     Force the removal of the temporary ABCDETEMPDIR directory,  even
109              when  we have not finished. For example, one can read and encode
110              several formats, including ´.ogg´, and later on execute a ´move´
111              action with only one of the given formats. On a normal situation
112              it would erase the rest of those encoded formats. In this  case,
113              abcde will refuse to execute such command, except if -f is used.
114
115       -g     Enable  lame's --nogap option.  See the NOGAP variable. WARNING:
116              lame's --nogap disables the Xing mp3 tag.  This tag is  required
117              for  mp3 players to correctly display track lengths when playing
118              variable-bit-rate mp3 files.
119
120       -G     Download album art using the getalbumart function. This is  best
121              done  with  CDDBMETHOD  including  musicbrainz  and requires the
122              installation of glyrc.  ImageMagick is an  optional  but  highly
123              recommended package. Further details of getalbumart can be found
124              in the abcde FAQ document packaged with abcde.
125
126       -h     Get help information.
127
128       -j [number]
129              Start [number] encoder processes at once. Useful  for  SMP  sys‐
130              tems.  Overrides  the MAXPROCS configuration variable. Set it to
131              "0" when using distmp3 to avoid local encoding processes.
132
133       -k     Keep the wav files after encoding.
134
135       -l     Use the low-diskspace algorithm. See the  LOWDISK  configuration
136              variable.
137
138       -L     Use a local CDDB repository. See CDDBLOCALDIR variable.
139
140       -m     Create  DOS-style  playlists,  modifying  the  resulting  one by
141              adding CRLF line endings. Some hardware players insist on having
142              those to work.
143
144       -n     Do  not query CDDB database. Create and use a template. Edit the
145              template to provide song names, artist(s), ...
146
147       -N     Non interactive mode. Do not ask anything from the user. Just go
148              ahead.
149
150       -o [filetype][:filetypeoptions]
151              Select  output  type. Can be "vorbis" (or "ogg"), "mp3", "flac",
152              "spx", "mpc",  "m4a",  "wav",  "wv",  "ape",  "opus",  "mka"  or
153              "aiff".   Specify  a  comma-delimited  list  of  output types to
154              obtain all specified types.  See  the  OUTPUTTYPE  configuration
155              variable.  One  can  pass  options to the encoder for a specific
156              filetype on the command line separating them with a  colon.  The
157              options must be escaped with double-quotes.
158
159       -p     Pads track numbers with 0´s.
160
161       -P     Use  Unix  PIPES to read and encode in one step (USEPIPES). This
162              disables multiple encodings, since the WAV audio file  is  never
163              stored  in  the disc. For more detail on this option see the FAQ
164              document in the source tarball.
165
166       -r [hosts...]
167              Remote encode on this comma-delimited  list  of  machines  using
168              distmp3. See the REMOTEHOSTS configuration variable.
169
170       -s [fields...]
171              List,  separated  by  commas, the fields to be shown in the CDDB
172              parsed entries.  Right now it only uses "year" and "genre".
173
174       -S [speed]
175              Set the speed of the CD drive. Needs CDSPEED and CDSPEEDOPTS set
176              properly  and both the program and device must support the capa‐
177              bility.
178
179       -t [number]
180              Start the numbering of the tracks at a  given  number.  It  only
181              affects the filenames and the playlist. Internal (tag) numbering
182              remains the same.
183
184       -T [number]
185              Same as -t but changes also the internal (tag)  numbering.  Keep
186              in  mind  that the default TRACK tag for MP3 is $T/$TRACKS so it
187              is changed to simply $T.
188
189       -U     Set CDDBPROTO to version 5,  so  that  we  retrieve  ISO-8859-15
190              encoded  CDDB  information,  and  we  tag  and add comments with
191              Latin1 encoding.
192
193       -v     Show the version and exit
194
195       -V     Be more verbose. On slow networks the CDDB requests  might  give
196              the  sensation  nothing is happening. Add this more than once to
197              make things even more verbose.
198
199       -x     Eject the CD when all tracks have been  read.  See  the  EJECTCD
200              configuration variable.
201
202       -X [cue2discid]
203              Use  an alternative "cue2discid" implementation. The name of the
204              binary must be exactly that. abcde comes with an  implementation
205              in  python  under  the  examples  directory. The special keyword
206              "builtin" forces the usage of the internal (default) implementa‐
207              tion in shell script.
208
209       -w [comment]
210              Add  a  comment to the tracks ripped from the CD. If you wish to
211              use parentheses, these will need to be escaped. i.e. you have to
212              write "\(" instead of "(".
213
214       -W [number]
215              Concatenate  CD´s.  It uses the number provided to define a com‐
216              ment "CD #" and to modify the numbering of the tracks,  starting
217              with  "#01".  For  Ogg/Vorbis  and FLAC files, it also defines a
218              DISCNUMBER tag.
219
220       -z     DEBUG mode: it will rip, using cdparanoia, the very first second
221              of  each  track  and  proceed  with  the  actions requested very
222              quickly, also providing some  "hidden"  information  about  what
223              happens  on  the background. CAUTION: IT WILL ERASE ANY EXISTING
224              RIPS WITHOUT WARNING!
225
226       [tracks]
227              A list of tracks you want abcde to process. If this isn't speci‐
228              fied,  abcde will process the entire CD. Accepts ranges of track
229              numbers - "abcde 1-5 7 9" will process tracks 1, 2, 3, 4, 5,  7,
230              and 9.
231

OUTPUT

233       Each  track  is,  by default, placed in a separate file named after the
234       track in a subdirectory named after the artist under the current direc‐
235       tory.  This  can  be modified using the OUTPUTFORMAT and VAOUTPUTFORMAT
236       variables in your abcde.conf. Each file is given an extension identify‐
237       ing   its  compression  format,  'vorbis'  for '.ogg', '.mp3', '.flac',
238       '.spx', '.mpc', '.wav', '.wv', '.ape', '.opus', '.mka' or 'aiff'.
239

CONFIGURATION

241       abcde sources two configuration files on startup - /etc/abcde.conf  and
242       $HOME/.abcde.conf, in that order.
243
244       The  configuration  options  stated in those files can be overridden by
245       providing the appropriate flags at runtime.
246
247       The configuration variables have to be set as follows:
248
249       VARIABLE=value
250              Except when "value" needs to be quoted or otherwise interpreted.
251              If  other variables within "value" are to be expanded upon read‐
252              ing the configuration file, then double quotes should  be  used.
253              If  they  are only supposed to be expanded upon use (for example
254              OUTPUTFORMAT) then single quotes must be used.
255
256       All shell escaping/quoting rules apply.
257
258       Here is a list of options abcde recognizes:
259
260       CDDBMETHOD
261              Specifies the methods we want  to  use  to  retrieve  the  track
262              information.  Three values are recognized: "cddb", "musicbrainz"
263              and "cdtext". List all the methods desired in a comma  delimited
264              list  and  abcde  will attempt them all, returning a list of all
265              search results. The "cddb" value needs the CDDBURL and HELLOINFO
266              variables described below. The "musicbrainz" value uses the Perl
267              helper script abcde-musicbrainz-tool to establish a conversation
268              with  the Musicbrainz server for information retrieval. "cdtext"
269              needs "icedax" or "cdda2wav" to be installed.
270
271       CDDBURL
272              Specifies a server to use for CDDB lookups.
273
274       CDDBPROTO
275              Specifies the protocol version used for the  CDDB  retrieval  of
276              results. Version 6 retrieves CDDB entries in UTF-8 format.
277
278       HELLOINFO
279              Specifies  the Hello information to send to the CDDB server. The
280              CDDB protocol requires you to send a valid username and hostname
281              each time you connect. The format of this is username@hostname.
282
283       CDDBLOCALDIR
284              Specifies  a  directory  where we store a local CDDB repository.
285              The entries must be standard CDDB  entries,  with  the  filename
286              being  the  DISCID  value. Other CD playing and ripping programs
287              (like Grip) store the entries under ~/.cddb and we can make  use
288              of those entries.
289
290       CDDBLOCALRECURSIVE
291              Specifies  if  the  CDDBLOCALDIR  has to be searched recursively
292              trying to find a match for the CDDB entry. If a match  is  found
293              and  selected,  and CDDBCOPYLOCAL is selected, it will be copied
294              to the root of the CDDBLOCALDIR if CDDBLOCALPOLICY is "modified"
295              or "new". The default "y" is needed for the local CDDB search to
296              work.
297
298       CDDBLOCALPOLICY
299              Defines when a CDDB  entry  should  be  stored  in  the  defined
300              CDDBLOCALDIR.  The possible policies are: "net" for a CDDB entry
301              which has been received from the net (overwriting  any  possible
302              local  CDDB  entry);  "new"  for a CDDB entry which was received
303              from the net, but will request confirmation to overwrite a local
304              CDDB  entry  found  in  the  root of the CDDBLOCALDIR directory;
305              "modified" for a CDDB entry found in the  local  repository  but
306              which  has  been modified by the user; and "always" which forces
307              the CDDB entry to be stored back in the root of the CDDBLOCALDIR
308              no  matter  where it was found, and no matter it was not edited.
309              This last option will always overwrite the one found in the root
310              of the local repository (if any). STILL NOT WORKING!!
311
312       CDDBCOPYLOCAL
313              Store  local  copies of the CDDB entries under the $CDDBLOCALDIR
314              directory.
315
316       CDDBUSELOCAL
317              Actually use the stored copies of the CDDB entries. Can be over‐
318              ridden  using  the  "-L" flag (if is CDDBUSELOCAL in "n"). If an
319              entry is found, we always give the choice of retrieving  a  CDDB
320              entry from the internet.
321
322       SHOWCDDBFIELDS
323              Coma-separated  list  of fields we want to parse during the CDDB
324              parsing.  Defaults to "year,genre".
325
326       OGGENCODERSYNTAX
327              Specifies the  style  of  encoder  to  use  for  the  Ogg/Vorbis
328              encoder. Valid options are ´oggenc´ (default for Ogg/Vorbis) and
329              ´vorbize´.  This affects the default location of the binary, the
330              variable  to  pick  encoder command-line options from, and where
331              the options are given.
332
333       MP3ENCODERSYNTAX
334              Specifies the style of encoder to use for the MP3 encoder. Valid
335              options  are  ´lame´  (default  for  MP3),  ´gogo´,  ´bladeenc´,
336              ´l3enc´ and ´mp3enc´.  Affects the same way as  explained  above
337              for Ogg/Vorbis.
338
339       FLACENCODERSYNTAX
340              Specifies  the  style of encoder to use for the FLAC encoder. At
341              this point only ´flac´ is available for FLAC encoding.
342
343       MP2ENCODERSYNTAX
344              Specifies the style of encoder to use for the MPEG-1 Audio Layer
345              II (MP2) encoder.  At this point both ´twolame´ and ´ffmpeg´ are
346              available for MP2 encoding.
347
348       SPEEXENCODERSYNTAX
349              Specifies the style of encoder to use for Speex encoder. At this
350              point only ´speexenc´ is available for Ogg/Speex encoding.
351
352       MPCENCODERSYNTAX
353              Specifies  the  style  of  encoder to use for MPP/MP+ (Musepack)
354              encoder. At this point we only  have  ´mpcenc´  available,  from
355              musepack.net.
356
357       AACENCODERSYNTAX
358              Specifies  the style of encoder to use for M4A (AAC) encoder. We
359              support ´fdkaac´ as ´default´  as  well  as  FFmpeg  or  avconv,
360              neroAacEnc,  qaac  and  fhgaacenc.  If qaac, refalac or FFmpeg /
361              avconv are used it is also possible to generate  Apple  Lossless
362              Audio  Codec (alac) files. Note that qaac, refalac and fhgaacenc
363              are Windows applications which require Wine to be installed.
364
365       TTAENCODERSYNTAX
366              Specifies the style of encoder  to  use  for  True  Audio  (tts)
367              encoding. We support ´tta´ as default but the older ´ttaenc´ can
368              be used as well.
369
370       WVENCODERSYNTAX
371              Specifies the style of encoder to use for  WavPack.  We  support
372              ´wavpack´  as  ´default´  but ´ffmpeg' is the other option (Note
373              that this is for FFmpeg only as avconv does not  have  a  native
374              WavPack encoder).
375
376       APENCODERSYNTAX
377              Specifies  the style of encoder to use for Monkey's Audio (ape).
378              We support ´mac´, Monkey's Audio Console, as ´default´.
379
380       OPUSENCODERSYNTAX
381              Specifies the style of encoder to use for the Opus  encoder.  At
382              this point only ´opusenc´ is available for Opus encoding.
383
384       MKAENCODERSYNTAX
385              Specifies  the  style  of encoder to use for the Matroska or mka
386              container. At this point only ´ffmpeg´ is available  to  utilise
387              the  mka  container.  Safe  audio codecs for mka include Vorbis,
388              MP2, MP3, LC-AAC, HE-AAC, WMAv1, WMAv2, AC3, eAC3 and Opus.  See
389              the FAQ document for more information.
390
391       AIFFENCODERSYNTAX
392              Specifies the style of encoder to use for Audio Interchange File
393              Format (AIFF).  At this point  only  ´ffmpeg´  is  available  to
394              utilise the AIFF container.
395
396       NORMALIZERSYNTAX
397              Specifies  the  style  of  normalizer to use.  Valid options are
398              ´default´ and ´normalize' (and both run ´normalize´),  since  we
399              only support it, ATM.
400
401       CDROMREADERSYNTAX
402              Specifies  the  style  of cdrom reader to use. Valid options are
403              ´cdparanoia´, ´libcdio' ´debug´  and  ´flac´.  It  is  used  for
404              querying  the  CDROM  and obtain a list of valid tracks and DATA
405              tracks. The special ´flac´ case is u sed to "rip" CD tracks from
406              a single-track flac file.
407
408       CUEREADERSYNTAX
409              Specifies  the  syntax  of the program we use to read the CD CUE
410              sheet. Right now we only support  ´mkcue´,  but  in  the  future
411              other readers might be used.
412
413       KEEPWAVS
414              It defaults to no, so if you want to keep those wavs ripped from
415              your CD, set it to "y". You can use the "-k" switch in the  com‐
416              mand  line.  The  default behaviour with KEEPWAVS set is to keep
417              the  temporary  directory  and  the  wav  files  even  you  have
418              requested the "clean" action.
419
420       PADTRACKS
421              If  set  to  "y",  it adds 0's to the file numbers to complete a
422              two-number holder. Useful when encoding tracks 1-9.
423
424       INTERACTIVE
425              Set to "n" if you want to perform automatic rips,  without  user
426              intervention.
427
428       NICE VALUES
429              Define the values for priorities (nice values) for the different
430              CPU-hungry processes: encoding (ENCNICE), CDROM read  (READNICE)
431              and distributed encoder with distmp3 (DISTMP3NICE).
432
433       PATHNAMES
434              The  following  configuration file options specify the pathnames
435              of their respective  utilities:  LAME,  GOGO,  BLADEENC,  L3ENC,
436              XINGMP3ENC,  MP3ENC,  VORBIZE,  OGGENC,  FLAC, SPEEXENC, MPCENC,
437              WAVEPACK, APENC,  OPUSENC,  ID3,  EYED3,  METAFLAC,  CDPARANOIA,
438              CD_PARANOIA,  CDDA2WAV, PIRD, CDDAFS, CDDISCID, CDDBTOOL, EJECT,
439              MD5SUM, DISTMP3,  VORBISCOMMENT,  NORMALIZE,  CDSPEED,  MP3GAIN,
440              VORBISGAIN, MPCGAIN, MKCUE, MKTOC, CUE2DISCID (see option "-X"),
441              DIFF, HTTPGET, GLYRC, IDENTIFY, DISPLAYCMD, CONVERT, QAAC, WINE,
442              FHGAACENC,  ATOMICPARSLEY,  FFMPEG,  TWOLAME,  MID3V2,  TTA  and
443              TTAENC.
444
445       COMMAND-LINE OPTIONS
446              If you wish to specify command-line options to any of  the  pro‐
447              grams  abcde uses, set the following configuration file options:
448              LAMEOPTS,  GOGOOPTS,   AIFFENCOPTS,   BLADEENCOPTS,   L3ENCOPTS,
449              XINGMP3ENCOPTS,  MP3ENCOPTS, VORBIZEOPTS, WAVEPACKENCOPTS, APEN‐
450              COPTS, OGGENCOPTS, FLACOPTS, SPEEXENCOPTS,  MPCENCOPTS,  FAACEN‐
451              COPTS,   NEROAACENCOPTS,  FDKAACENCOPTS,  OPUSENCOPTS,  ID3OPTS,
452              EYED3OPTS, MP3GAINOPTS, CDPARANOIAOPTS, CDDA2WAVOPTS,  PIRDOPTS,
453              CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS, NORMALIZEOPTS,
454              CDSPEEDOPTS, MKCUEOPTS, VORBISCOMMMENTOPTS,  METAFLACOPTS,  DIF‐
455              FOPTS,  FLACGAINOPTS,  VORBISGAINOPTS,  HTTPGETOPTS,  GLYRCOPTS,
456              IDENTIFYOPTS, CONVERTOPTS, DISPLAYCMDOPTS,  QAACENCOPTS,  FHGAA‐
457              CENCOPTS,  ATOMICPARSLEYOPTS,  FFMPEGENCOPTS, DAGRABOPTS, TWOLA‐
458              MENCOPTS and TTAENCOPTS.
459
460       CDSPEEDVALUE
461              Set the value of the CDROM speed. The default  is  to  read  the
462              disc  as fast as the reading program and the system permits. The
463              steps are defined as 150kB/s (1x).
464
465       ACTIONS
466              The default actions to be performed when reading a disc.
467
468       CDROM  If set, it points to the CD-Rom device which has to be used  for
469              audio  extraction. Abcde tries to guess the right device, but it
470              may fail. The special ´flac´ option is defined to extract tracks
471              from a single-track flac file.
472
473       CDPARANOIACDROMBUS
474              Defined  as "d" when using cdparanoia with an IDE bus and as "g"
475              when using cdparanoia with the ide-scsi emulation layer.
476
477       OUTPUTDIR
478              Specifies the directory to place completed tracks/playlists in.
479
480       WAVOUTPUTDIR
481              Specifies the temporary directory to store .wav files in.  Abcde
482              may  use  up  to  700MB  of  temporary  space  for  each session
483              (although it is rare to use over 100MB for a  machine  that  can
484              encode music as fast as it can read it).
485
486       OUTPUTTYPE
487              Specifies  the encoding format to output, as well as the default
488              extension and encoder. Defaults to "vorbis". Valid settings  are
489              "vorbis"  (or  "ogg")  (Ogg/Vorbis),  "mp3"  (MPEG-1 Audio Layer
490              III), "flac" (Free Lossless Audio Codec),  "mp2"  (MPEG-1  Audio
491              Layer  III), "spx" (Ogg/Speex), "mpc" (MPP/MP+ (Musepack), "m4a"
492              (AAC  or  ALAC),"wv"  (WavPack"),  "wav"  (Microsoft  Waveform),
493              "opus" (Opus Interactive Audio Codec), "tta" (True Audio), "mka"
494              (Matroska) or "aiff" (Audio  Interchange  File  Format).  Values
495              like  "vorbis,mp3"  encode the tracks in both Ogg/Vorbis and MP3
496              formats. For example:
497              OUTPUTTYPE=vorbis,flac
498              For each value in OUTPUTTYPE, abcde expands a different  process
499              for  encoding,  tagging  and  moving,  so you can use the format
500              placeholder, OUTPUT, to create different subdirectories to  hold
501              the  different  types.  The  variable  OUTPUT  will be 'vorbis',
502              'mp3', 'flac', 'spx', 'mpc', 'm4a',  mp2,  'wv',  'ape',  'tta',
503              'wav',
504              OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACK‐
505              NUM}._${TRACKFILE}'
506
507       OUTPUTFORMAT
508              Specifies  the  format  for  completed  Ogg/Vorbis,  MP3,  FLAC,
509              Ogg/Speex,  MPP/MP+  (Musepack)  or M4A filenames. Variables are
510              included using standard  shell  syntax.  Allowed  variables  are
511              GENRE,  ALBUMFILE,  ARTISTFILE,  TRACKFILE,  TRACKNUM, and YEAR.
512              Default   is    ´${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}-${TRACK‐
513              FILE}´.   Make  sure  to use single quotes around this variable.
514              TRACKNUM  is  automatically  zero-padded,  when  the  number  of
515              encoded  tracks is higher than 9. When lower, you can force with
516              '-p' in the command line.
517
518       VAOUTPUTFORMAT
519              Just like  OUTPUTFORMAT  but  for  Various  Artists  discs.  The
520              default      is      'Various-${ALBUMFILE}/${TRACKNUM}.${ARTIST‐
521              FILE}-${TRACKFILE}'
522
523       ONETRACKOUTPUTFORMAT
524              Just like OUTPUTFORMAT but for  single-track  rips  (see  option
525              "-1"). The default is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
526
527       VAONETRACKOUTPUTFORMAT
528              Just  like  ONETRACKOUTPUTFORMAT  but for Various Artists discs.
529              The default is 'Various-${ALBUMFILE}/${ALBUMFILE}'
530
531       MAXPROCS
532              Defines how many encoders to run at once. This  makes  for  huge
533              speedups  on  SMP systems. You should run one encoder per CPU at
534              once for maximum efficiency, although  more  doesn't  hurt  very
535              much.  Set  it  "0" when using mp3dist to avoid getting encoding
536              processes in the local host.
537
538       LOWDISK
539              If set to y, conserves disk space by encoding tracks immediately
540              after  reading  them.  This  is substantially slower than normal
541              operation but requires several hundred MB less space to complete
542              the  encoding of an entire CD. Use only if your system is low on
543              space and cannot encode as quickly as it can read.
544
545              Note that this option may also  help  when  reading  a  CD  with
546              errors. This is because on a scratchy disk reading is quite tim‐
547              ing sensitive and this option reduces the background load on the
548              system which allows the ripping program more precise control.
549
550       BATCHNORM
551              If  set  to y, enables batch mode normalization, which preserves
552              relative volume differences between tracks  of  an  album.  Also
553              enables nogap encoding when using the ´lame´ encoder.
554
555       NOGAP  Activate  the  lame's --nogap option, that allows files found in
556              CDs with no silence between songs (such as live concerts) to  be
557              encoded  without  noticeable  gaps. WARNING: lame's --nogap dis‐
558              ables the Xing mp3 tag.  This tag is required for mp3 players to
559              correctly  display  track lengths when playing variable-bit-rate
560              mp3 files.
561
562       PLAYLISTFORMAT
563              Specifies the format for  completed  playlist  filenames.  Works
564              like   the   OUTPUTFORMAT  configuration  variable.  Default  is
565              ´${ARTISTFILE}_-_${ALBUMFILE}.m3u´.  Make  sure  to  use  single
566              quotes around this variable.
567
568       PLAYLISTDATAPREFIX
569              Specifies  a  prefix for filenames within a playlist. Useful for
570              http playlists, etc.
571
572       DOSPLAYLIST
573              If set, the resulting playlist will  have  CR-LF  line  endings,
574              needed by some hardware-based players.
575
576       COMMENT
577              Specifies  a comment to embed in the ID3 or Ogg comment field of
578              each finished track. Can be up to 28 characters  long.  Supports
579              the  same  syntax  as  OUTPUTFORMAT.  Does not currently support
580              ID3v2.
581
582       REMOTEHOSTS
583              Specifies a comma-delimited list of systems to  use  for  remote
584              encoding using distmp3. Equivalent to -r.
585
586       mungefilename
587              mungefilename()  is an abcde shell function that can be overrid‐
588              den via abcde.conf. It takes CDDB data as  $1  and  outputs  the
589              resulting  filename  on stdout. It defaults to deleting any pre‐
590              ceding dots to filename, replacing spaces with an underscore and
591              eating  characters which variously Windows and Linux do not per‐
592              mit.
593              If you modify this function, it is probably a good idea to  keep
594              the  forward  slash munging (UNIX cannot store a file with a '/'
595              char in it) as well as the control character munging (NULs can't
596              be  in a filename either, and newlines and such in filenames are
597              typically not desirable).
598              New to abcde 2.7.3 are the user definable functions  mungetrack‐
599              name, mungeartistname and mungealbumname which default to munge‐
600              filename. These permit  finer-grained  control  of  track  name,
601              artist name and album name for the ultra-fastidious.
602
603       mungegenre
604              mungegenre  ()  is  a  shell  function used to modify the $GENRE
605              variable. As a default action, it takes $GENRE as $1 and outputs
606              the  resulting  value to stdout converting all UPPERCASE charac‐
607              ters to lowercase.
608
609       pre_read
610              pre_read () is a shell function which  is  executed  before  the
611              CDROM is read for the first time, during abcde execution. It can
612              be used to close the CDROM tray, to set its speed  (via  "setcd"
613              or via "eject", if available) and other preparation actions. The
614              default function is empty.
615
616       post_read
617              post_read () is a shell function which  is  executed  after  the
618              CDROM is read (and, if applies, before the CDROM is ejected). It
619              can be used to read a TOC from the CDROM, or to try to read  the
620              DATA  areas from the CD (if any exist).  The default function is
621              empty.
622
623       post_encode
624              post_encode () is a shell function which is executed  after  the
625              encoding  process.   It  can  be used to move completed files to
626              another location, run any sort of testing on the completed files
627              or embed album art if the built in embedding provided by abcde's
628              embedalbumart function is not to your taste.  The default  func‐
629              tion is empty.
630
631       EJECTCD
632              If  set to "y", abcde will call eject(1) to eject the cdrom from
633              the drive after all tracks have been read. It has no effect when
634              CDROM is set to a flac file.
635
636       EXTRAVERBOSE
637              If  set  to  "1", some operations which are usually now shown to
638              the end user are visible, such as CDDB queries. Useful for  ini‐
639              tial  debug  and if your network/CDDB server is slow. Set to "2"
640              or more for even more verbose output.
641

EXAMPLES

643       Possible ways one can call abcde:
644
645       abcde  Will work in most systems
646
647       abcde -d /dev/cdrom2
648              If the CDROM you are reading from is not the standard /dev/cdrom
649              (in GNU/Linux systems)
650
651       abcde -o vorbis,flac
652              Will create both Ogg/Vorbis and Ogg/FLAC files.
653
654       abcde -o vorbis:"-b 192"
655              Will  pass "-b 192" to the Ogg/Vorbis encoder, without having to
656              modify the config file
657
658       abcde -o mp3,flac,m4a,wv,ogg -B
659              abcde will create mp3, flac, m4a, wv  and  ogg  files  and  also
660              select suitable album art, download and embed the album art into
661              all 5 sets of tracks.
662
663       abcde -W 1
664              For double+ CD settings: will create the 1st  CD  starting  with
665              the  track  number  101,  and  will  add a comment "CD 1" to the
666              tracks, the second starting with 201 and so on.
667
668       abcde -d singletrack.flac -o vorbis:"-q 6"
669              Will extract the files contained in singletrack FLAC file  using
670              the  embedded  cuesheet  and  then  encode  the  output files to
671              Ogg/Vorbis with a quality setting of 6.
672

BACKEND TOOLS

674       abcde requires the following backend tools to work:
675
676       *      An Ogg/Vorbis,  MP3,  FLAC,  Ogg/Speex,  MPP/MP+(Musepack),  M4A
677              encoder  or Opus encoder (oggenc, vorbize, lame, gogo, bladeenc,
678              l3enc, mp3enc, flac, speexenc, mpcenc, fdkaac, neroAacEnc, faac,
679              wavpack, opusenc).
680
681       *      An audio CD reading utility (cdparanoia, icedax, cdda2wav, libc‐
682              dio (cd-paranoia), pird, dagrab). To read  CD-TEXT  information,
683              icedax or cdda2wav will be needed.
684
685       *      cd-discid, a CDDB DiscID reading program.
686
687       *      An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS
688              X, among others). Alternatively,  abcde-musicbrainz-tool  (which
689              depends  on  Perl and some Musicbrainz libraries) can be used to
690              retrieve CDDB information about the CD.
691
692       *      (for MP3s) id3 or eyeD3, id3 v1 and v2 tagging programs.
693
694       *      For Monkey's Audio  (ape)  tagging  Robert  Muth's  'apetag'  is
695              required.
696
697       *      To retrieve album art a glyrc package is required and optionally
698              the ImageMagick package should be installed.
699
700       *      (optional) distmp3, a client/server for distributed  mp3  encod‐
701              ing.
702
703       *      (optional) normalize, a WAV file volume normalizer.
704
705       *      (optional)   a  replaygain  file  volume  modifier  (vorbisgain,
706              metaflac, mp3gain, mpcgain, wvgain),
707
708       *      (optional) mkcue, a CD cuesheet extractor.
709

SEE ALSO

711       cdparanoia(1),  cd-paranoia(1)  icedax(1),   cdda2wav(1),   twolame(1),
712       mid3v2(1),  pird(1),  dagrab(1),  normalize(1),  oggenc(1), vorbize(1),
713       flac(1), speexenc(1), mpcenc(1), faac(1), fdkaac(1), identify(1),  dis‐
714       play(1), convert(1), wavpack(1), wvgain(1), wvtag(1), id3(1), eyeD3(1),
715       wget(1), fetch(1), cd-discid(1), distmp3(1),  distmp3host(1),  curl(1),
716       mkcue(1), vorbisgain(1), mp3gain(1)
717
718

DATA FORMATS

720       The  CDDB  metadata format is used a lot by abcde, both for lookups and
721       internally.         It's         documented          online          at
722       http://ftp.freedb.org/pub/freedb/latest/DBFORMAT
723
724

AUTHORS

726       Robert  Woodcock <rcw@debian.org>, Jesus Climent <jesus.climent@hispal‐
727       inux.es>,   Colin   Tuckley   <colint@debian.org>,    Steve    McIntyre
728       <93sam@debian.org>,  Andrew  Strong <andrew.david.strong@gmail.com> and
729       contributions from many others.
730
731
732
733                                                                      abcde(1)
Impressum