Recursive CDDB local dir work
[clinton/abcde.git] / abcde.1
1 .TH abcde 1
3 abcde \- Grab an entire CD and compress it to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or MPP/MP+(Musepack) format.
5 .B abcde
6 .I [options] [tracks]
8 Ordinarily, the process of grabbing the data off a CD and encoding it, then
9 tagging or commenting it, is very involved.
10 .BR abcde
11 is designed to automate this. It will take an entire CD and convert it into
12 a compressed audio format - Ogg/Vorbis, MPEG Audio Layer III, Free Lossless
13 Audio Codec (FLAC), Ogg/Speex or MPP/MP+(Musepack). With one command, it will:
14 .TP
15 .B *
16 Do a CDDB query over the Internet to look up your CD or use a locally stored CDDB entry
17 .TP
18 .B *
19 Grab an audio track (or all the audio CD tracks) from your CD
20 .TP
21 .B *
22 Normalize the volume of the individual file (or the album as a single unit)
23 .TP
24 .B *
25 Compress to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or MPP/MP+(Musepack) format(s), all in one CD read
26 .TP
27 .B *
28 Comment or ID3/ID3v2 tag
29 .TP
30 .B *
31 Give an intelligible filename
32 .TP
33 .B *
34 Calculate replaygain values for the individual file (or the album as a single unit)
35 .TP
36 .B *
37 Delete the intermediate WAV file (or save it for later use)
38 .TP
39 .B *
40 Repeat until finished
42 .TP
43 .B \-1
44 Encode the whole CD in a single file. The resulting file uses the CD title
45 for tagging. If the resulting format is a flac file with an embeded cuesheet,
46 the file can be used as a source for creating other formats.
47 .TP
48 .B \-a [actions]
49 Comma-delimited list of actions to perform. Can be one or more of:
50 cddb, read, normalize, encode, tag, move, replaygain, playlist, clean. Normalize
51 and encode imply read. Tag implies cddb, read, encode. Move implies
52 cddb, read, encode, tag. Replaygain implies cddb, read, encode, tag and move.
53 Playlist implies cddb. The default is to do all actions except normalize,
54 replaygain and playlist.
55 .TP
56 .B \-b
57 Enable batch mode normalization. See the BATCHNORM configuration variable.
58 .TP
59 .B \-B
60 Disable batch mode replaygain. It processes file by file to add the replaygain
61 information. See the NOBATCHREPLAYGAIN configuration variable.
62 .TP
63 .B \-c [filename]
64 Specifies an additional configuration file to parse. Configuration options
65 in this file override those in /etc/abcde.conf or $HOME/.abcde.conf.
66 .TP
67 .B \-C [discid]
68 Allows you to resume a session for
69 .I discid
70 when you no longer have the CD available (abcde will automatically resume if
71 you still have the CD in the drive). You must have already finished at
72 least the "read" action during the previous session.
73 .TP
74 .B \-d [devicename | filename]
75 CD\-ROM block device that contains audio tracks to be read. Alternatively, a
76 single-track flac file with embeded cuesheet.
77 .TP
78 .B \-D
79 Capture debugging information (you'll want to redirect this \- try 'abcde \-D
80 2>logfile')
81 .TP
82 .B \-e
83 Erase information about encoded tracks from the internal status file, to enable
84 other encodings if the wav files have been kept.
85 .TP
86 .B \-g
87 Enable lame's \-\-nogap option. See the NOGAP variable. WARNING: lame's
88 \-\-nogap disables the Xing mp3 tag. This tag is required for mp3 players to
89 correctly display track lengths when playing variable-bit-rate mp3 files.
90 .TP
91 .B \-h
92 Get help information.
93 .TP
94 .B \-j [number]
95 Start [number] encoder processes at once. Useful for SMP systems. Overrides
96 the MAXPROCS configuration variable. Set it to "0" when using distmp3 to avoid
97 local encoding processes.
98 .TP
99 .B \-k
100 Keep the wav files after encoding.
101 .TP
102 .B \-l
103 Use the low-diskspace algorithm. See the LOWDISK configuration variable.
104 .TP
105 .B \-L
106 Use a local CDDB repository. See CDDBLOCALDIR variable.
107 .TP
108 .B \-n
109 Do not query CDDB database. Create and use a template. Edit the template to
110 provide song names, artist(s), ...
111 .TP
112 .B \-N
113 Non interactive mode. Do not ask anything from the user. Just go ahead.
114 .TP
115 .B \-m
116 Create DOS-style playlists, modifying the resulting one by adding CRLF line
117 endings. Some hardware players insist on having those to work.
118 .TP
119 .B \-M
120 Create a CUE file with information about the CD. Together with the possibility
121 of creating a single file (see option "\-1"), one can recreate the original CD.
122 If the cuesheet is embeded in a flac single file it can be used as source for
123 encoding other formats.
124 .TP
125 .B \-o [filetype][:filetypeoptions]
126 Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc" or
127 "wav". Specify a comma-delimited list of output types to obtain all specified
128 types. See the OUTPUTTYPE configuration variable. One can pass options to the
129 encoder for a specific filetype on the command line separating them with a
130 colon. The options must be escaped with double-quotes.
131 .TP
132 .B \-p
133 Pads track numbers with 0\'s.
134 .TP
135 .B \-r [hosts...]
136 Remote encode on this comma-delimited list of machines using distmp3. See
137 the REMOTEHOSTS configuration variable.
138 .TP
139 .B \-R
140 When CDDBLOCALDIR and CDDBUSELOCAL are defined, search recursively under the
141 defined directory for matches of the CDDB entry.
142 .TP
143 .B \-s [fields...]
144 List, separated by comas, the fields to be shown in the CDDB parsed entries.
145 Right now it only uses "year" and "genre".
146 .TP
147 .B \-S [speed]
148 Set the speed of the CD drive. Needs CDSPEED and CDSPEEDOPTS set properly
149 and both the program and device must support the capability.
150 .TP
151 .B \-t [number]
152 Start the numbering of the tracks at a given number. It only affects the
153 filenames and the playlist. Internal (tag) numbering remains the same.
154 .TP
155 .B \-T [number]
156 Same as \-t but changes also the internal (tag) numbering. Keep in mind that
157 the default TRACK tag for MP3 is $T/$TRACKS so it is changed to simply $T.
158 .TP
159 .B \-u
160 Set CDDBPROTOCOL to version 6, so that we retrieve UTF-8 encoded CDDB
161 information, and we tag and add comments with a proper encoding. This flag will
162 be removed and -U will be added to set it to version 5 once version 6 becomes
163 the default.
164 .TP
165 .B \-v
166 Show the version and exit
167 .TP
168 .B \-V
169 Be a bit more verbose. On slow networks the CDDB requests might give the
170 sensation nothins is happening.
171 .TP
172 .B \-x
173 Eject the CD when all tracks have been read. See the EJECTCD configuration
174 variable.
175 .TP
176 .B \-w [comment]
177 Add a comment to the tracks ripped from the CD.
178 .TP
179 .B \-W [number]
180 Concatenate CD\'s. It uses the number provided to define a comment "CD #" and
181 to modify the numbering of the tracks, starting with "#01".
182 .TP
183 .B \-z
184 DEBUG mode: it will rip, using cdparanoia, the very first second of each track
185 and proceed with the actions requested very quickly, also providing some
186 "hidden" information about what happens on the background. CAUTION: IT WILL
188 .TP
189 .B [tracks]
190 A list of tracks you want abcde to process. If this isn't specified, abcde
191 will process the entire CD. Accepts ranges of track numbers -
192 "abcde 1-5 7 9" will process tracks 1, 2, 3, 4, 5, 7, and 9.
194 Each track is, by default, placed in a separate file named after the track
195 in a subdirectory named after the artist under the current directory.
196 This can be modified using the OUTPUTFORMAT and VAOUTPUTFORMAT
197 variables in your abcde.conf. Each file is given an extension identifying
198 its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', or '.wav'.
200 abcde sources two configuration files on startup - /etc/abcde.conf and
201 $HOME/.abcde.conf, in that order.
202 .TP
203 The configuration options stated on those files can ba overriden by providing
204 the appropiate flags at runtime.
205 .TP
206 The configuration variables have to be set as follows:
207 .TP
208 .B VARIABLE=value
209 Except when "value" needs to be quoted or otherwise interpreted. If other
210 variables within "value" are to be expanded upon reading the configuration
211 file, then double quotes should be used. If they are only supposed to be
212 expanded upon use (for example OUTPUTFORMAT) then single quotes must be used.
213 .TP
214 All sh escaping/quoting rules apply.
215 .TP
216 Here is a list of options abcde recognizes:
217 .TP
219 Specifies a server to use for CDDB lookups.
220 .TP
222 Specifies the Hello information to send to the CDDB server. The CDDB
223 protocol requires you to send a valid username and hostname each time you
224 connect. The format of this is username@hostname.
225 .TP
227 Specifies a directory where we store a local CDDB repository. The entries must
228 be standard CDDB entries, with the filename being the DISCID value. Other
229 CD playing and ripping programs (like Grip) store the entries under ~/.cddb
230 and we can make use of those entries.
231 .TP
233 Specifies if the CDDBLOCALDIR has to be searched recursively trying to find a
234 match for the CDDB entry. If a match is found and selected, and CDDBCOPYLOCAL
235 is selected, it will be copied to the root of the CDDBLOCALDIR if
236 CDDBLOCALPOLICY is "modified" or "new".
237 .TP
239 Defines when a CDDB entry should be stored in the defined CDDBLOCALDIR. The
240 possible policies are: "net" for a CDDB entry which has been received from the
241 net (overwriting any possible local CDDB entry); "new" for a CDDB entry which
242 was received from the net, but will request confirmation to overwrite a local
243 CDDB entry found in the root of the CDDBLOCALDIR directory; "modified" for a
244 CDDB entry found in the local repository but which has been modified by the
245 user; and "always" which forces the CDDB entry to be stored back in the root of
246 the CDDBLOCALDIR no matter where it was found, and no matter it was not edited.
247 This last option will always overwrite the one found in the root of the local
248 repository (if any).
249 .TP
251 Store local copies of the CDDB entries under the $CDDBLOCALDIR directory.
252 .TP
254 Actually use the stored copies of the CDDB entries. Can be overriden using the
255 "-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give
256 the choice of retrieving a CDDB entry from the internet.
257 .TP
259 Coma-separated list of fields we want to parse during the CDDB parsing.
260 Defaults to "year,genre".
261 .TP
263 Specifies the style of encoder to use for the Ogg/Vorbis encoder. Valid options
264 are \'oggenc\' (default for Ogg/Vorbis) and \'vorbize\'.
265 This affects the default location of the binary,
266 the variable to pick encoder command-line options from, and where the options
267 are given.
268 .TP
270 Specifies the style of encoder to use for the MP3 encoder. Valid options are
271 \'lame\' (default for MP3), \'gogo\', \'bladeenc\', \'l3enc\' and \'mp3enc\'.
272 Affects the same way as explained above for Ogg/Vorbis.
273 .TP
275 Specifies the style of encoder to use for the FLAC encoder. At this point only
276 \'flac\' is available for FLAC encoding.
277 .TP
279 Specifies the style of encoder to use for Speex encoder. At this point only
280 \'speexenc\' is available for Ogg/Speex encoding.
281 .TP
283 Specifies the style of encoder to use for MPP/MP+ (Musepack) encoder. At this
284 point we only have \'mppenc\' available, from
285 .TP
287 Specifies the style of normalizer to use. Valid options are \'default\'
288 and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
289 ATM.
290 .TP
292 Specifies the style of cdrom reader to use. Valid options are \'cdparanoia\',
293 \'debug\' and \'flac\'. It is used for querying the CDROM and obtain a list of
294 valid tracks and DATA tracks. The special \'flac\' case is used to "rip" CD
295 tracks from a single-track flac file.
296 .TP
298 Specifies the syntax of the program we use to read the CD CUE sheet. Right now
299 we only support \'mkcue\', but in the future other readers might be used.
300 .TP
302 It defaults to no, so if you want to keep those wavs ripped from your CD,
303 set it to "y". You can use the "-k" switch in the command line. The default
304 behaviour with KEEPWAVS set is to keep the temporary directory and the wav
305 files even you have requested the "clean" action.
306 .TP
308 If set to "y", it adds 0's to the file numbers to complete a two-number
309 holder. Useful when encoding tracks 1-9.
310 .TP
312 Set to "n" if you want to perform automatic rips, without user intervention.
313 .TP
315 Define the values for priorities (nice values) for the different CPU-hungry
316 processes: encoding (ENCNICE), CDROM read (READNICE) and distributed encoder
317 with distmp3 (DISTMP3NICE).
318 .TP
320 The following configuration file options specify the pathnames of their
321 respective utilities: LAME, TOOLAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC,
326 .TP
328 If you wish to specify command-line options to any of the programs abcde uses,
329 set the following configuration file options: LAMEOPTS, TOOLAMEOPTS, GOGOOPTS,
335 .TP
337 Set the value of the CDROM speed. The default is to read the disc as fast as
338 the reading program and the system permits. The steps are defined as 150kB/s
339 (1x).
340 .TP
342 The default actions to be performed when reading a disc.
343 .TP
344 .B CDROM
345 If set, it points to the CD-Rom device which has to be used for audio
346 extraction. Abcde tries to guess the right device, but it may fail. The special
347 \'flac\' option is defined to extract tracks from a single-track flac file.
348 .TP
350 Defined as "d" when using cdparanoia with an IDE bus and as "g" when using
351 cdparanoia with the ide-scsi emulation layer.
352 .TP
354 Specifies the directory to place completed tracks/playlists in.
355 .TP
357 Specifies the temporary directory to store .wav files in. Abcde may use up
358 to 700MB of temporary space for each session (although it is rare to use
359 over 100MB for a machine that can encode music as fast as it can read it).
360 .TP
362 Specifies the encoding format to output, as well as the default extension and
363 encoder. Defaults to "vorbis". Valid settings are "vorbis" (or "ogg")
364 (Ogg/Vorbis), "mp3" (MPEG-1 Audio Layer III), "flac" (Free Lossless Audio
365 Codec), "spx" (Ogg/Speex), "mpc" (MPP/MP+ (Musepack)) or "wav" (Microsoft
366 Waveform). Values like "vorbis,mp3" encode the tracks in both Ogg/Vorbis and
367 MP3 formats.
368 .br
369 For each value in OUTPUTTYPE, abcde expands a different process for encoding,
370 tagging and moving, so you can use the format placeholder, OUTPUT, to create
371 different subdirectories to hold the different types. The variable OUTPUT will
372 be 'vorbis', 'mp3', 'flac', 'spx' and/or 'mpc', depending on the OUTPUTTYPE you define.
373 For example
374 .br
376 .TP
378 Specifies the format for completed Ogg/Vorbis, MP3, FLAC, Ogg/Speex or MPP/MP+
379 (Musepack) filenames.
380 Variables are included
381 using standard shell syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE,
382 TRACKFILE, TRACKNUM, and YEAR. Default is
384 Make sure to use single quotes around this variable. TRACKNUM is
385 automatically zero-padded, when the number of encoded tracks is higher than
386 9. When lower, you can force with '-p' in the command line.
387 .TP
389 Just like OUTPUTFORMAT but for Various Artists discs. Default is whatever
390 OUTPUTFORMAT is set to.
391 .TP
393 Defines how many encoders to run at once. This makes for huge speedups
394 on SMP systems. You should run one encoder per CPU at once for maximum
395 efficiency, although more doesn't hurt very much. Set it "0" when using
396 mp3dist to avoid getting encoding processes in the local host.
397 .TP
399 If set to y, conserves disk space by encoding tracks immediately after
400 reading them. This is substantially slower than normal operation but
401 requires several hundred MB less space to complete the encoding of an
402 entire CD. Use only if your system is low on space and cannot encode as
403 quickly as it can read.
404 .TP
406 If set to y, enables batch mode normalization, which preserves relative
407 volume differences between tracks of an album. Also enables nogap encoding
408 when using the \'lame\' encoder.
409 .TP
410 .B NOGAP
411 Activate the lame's \-\-nogap option, that allows files found in CDs with no
412 silence between songs (such as live concerts) to be encoded without noticeable
413 gaps. WARNING: lame's \-\-nogap disables the Xing mp3 tag. This tag is
414 required for mp3 players to correctly display track lengths when playing
415 variable-bit-rate mp3 files.
416 .TP
418 Specifies the format for completed playlist filenames. Works like the
419 OUTPUTFORMAT configuration variable. Default is
420 \'${ARTISTFILE}_\-_${ALBUMFILE}.m3u\'.
421 Make sure to use single quotes around this variable.
422 .TP
424 Specifies a prefix for filenames within a playlist. Useful for http
425 playlists, etc.
426 .TP
428 If set, the resulting playlist will have CR-LF line endings, needed by some
429 hardware-based players.
430 .TP
432 Specifies a comment to embed in the ID3 or Ogg comment field of each
433 finished track. Can be up to 28 characters long. Supports the same
434 syntax as OUTPUTFORMAT. Does not currently support ID3v2.
435 .TP
437 Specifies a comma-delimited list of systems to use for remote encoding using
438 distmp3. Equivalent to -r.
439 .TP
440 .B mungefilename
441 mungefilename() is an abcde shell function that can be overridden via
442 abcde.conf. It takes CDDB data as $1 and outputs the resulting filename on
443 stdout. It defaults to eating control characters, apostrophes and
444 question marks, translating spaces and forward slashes to underscores, and
445 translating colons to an underscore and a hyphen.
446 .br
447 If you modify this function, it is probably a good idea to keep the forward
448 slash munging (UNIX cannot store a file with a '/' char in it) as well as
449 the control character munging (NULs can't be in a filename either, and
450 newlines and such in filenames are typically not desirable).
451 .TP
452 .B mungegenre
453 mungegenre () is a shell function used to modify the $GENRE variable. As
454 a default action, it takes $GENRE as $1 and outputs the resulting value
455 to stdout converting all UPPERCASE characters to lowercase.
456 .TP
457 .B pre_read
458 pre_read () is a shell function which is executed before the CDROM is read
459 for the first time, during abcde execution. It can be used to close the CDROM
460 tray, to set its speed (via "setcd" or via "eject", if available) and other
461 preparation actions. The default function is empty.
462 .TP
463 .B post_read
464 post_read () is a shell function which is executed after the CDROM is read
465 (and, if applies, before the CDROM is ejected). It can be used to read a TOC
466 from the CDROM, or to try to read the DATA areas from the CD (if any exist).
467 The default function is empty.
468 .TP
470 If set to "y", abcde will call eject(1) to eject the cdrom from the drive
471 after all tracks have been read. It has no effect when CDROM is set to a flac
472 file.
473 .TP
475 If set to "y", some operations which are usually now shown to the end user
476 are visible, such as CDDB queries. Useful for initial debug and if your
477 network/CDDB server is slow.
479 Possible ways one can call abcde
480 .TP
481 .B abcde
482 Will work in most systems
483 .TP
484 .B abcde \-d /dev/cdrom2
485 If the CDROM you are reding from is not the standard /dev/cdrom (in GNU/Linux systems)
486 .TP
487 .B abcde \-o vorbis,flac
488 Will create both Ogg/Vorbis and Ogg/FLAC files.
489 .TP
490 .B abcde \-o vorbis:"-b 192"
491 Will pass "-b 192" to the Ogg/Vorbis encoder, without having to modify the
492 config file
493 .TP
494 .B abcde \-W 1
495 For double+ CD settings: will create the 1st CD starting with the track number
496 101, and will add a comment "CD 1" to the tracks, the second starting with 201
497 and so on.
498 .TP
499 .B abcde \-d singletrack.flac
500 Will extract the files contained in singletrack using the embeded cuesheet.
502 abcde requires the following backend tools to work:
503 .TP
504 .B *
505 An Ogg/Vorbis, MP3, FLAC, Ogg/Speex or MPP/MP+(Musepack) encoder (oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mppenc)
506 .TP
507 .B *
508 An audio CD reading utility (cdparanoia, cdda2wav, dagrab)
509 .TP
510 .B *
511 cd-discid, a CDDB DiscID reading program.
512 .TP
513 .B *
514 An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others).
515 .TP
516 .B *
517 (for MP3s) id3 or id3v2, id3 v1 and v2 tagging programs.
518 .TP
519 .B *
520 (optional) distmp3, a client/server for distributed mp3 encoding.
521 .TP
522 .B *
523 (optional) normalize-audio, a WAV file volume normalizer.
524 .TP
525 .B *
526 (optional) a replaygain file volume modifier (vorbisgain, metaflac, mp3gain),
527 .TP
528 .B *
529 (optional) mkcue, a CD cuesheet extractor.
530 .SH "SEE ALSO"
531 .BR cdparanoia (1),
532 .BR cdda2wav (1),
533 .BR dagrab (1),
534 .BR normalize-audio (1),
535 .BR oggenc (1),
536 .BR vorbize (1),
537 .BR flac (1),
538 .BR toolame (1),
539 .BR speexenc (1),
540 .BR mppenc (1),
541 .BR id3 (1),
542 .BR id3v2 (1),
543 .BR wget (1),
544 .BR fetch (1),
545 .BR cd-discid (1),
546 .BR distmp3 (1),
547 .BR distmp3host (1),
548 .BR curl (1),
549 .BR mkcue (1),
550 .BR vorbisgain (1),
551 .BR mp3gain (1)
553 Robert Woodcock <>,
554 Jesus Climent <> and contributions from many others.