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