[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: cddb, cue,
60 read, normalize, encode, tag, move, replaygain, playlist, clean. Normalize and
61 encode imply read. Tag implies cddb, read, encode. Move implies cddb, read,
62 encode, tag. Replaygain implies cddb, read, encode, tag and move. Playlist
63 implies cddb. The default is to do all actions except normalize, replaygain and
64 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 \-o [filetype][:filetypeoptions]
138 Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc",
139 "m4a" or "wav". Specify a comma-delimited list of output types to obtain all
140 specified types. See the OUTPUTTYPE configuration variable. One can pass
141 options to the encoder for a specific filetype on the command line separating
142 them with a colon. The options must be escaped with double-quotes.
143 .TP
144 .B \-p
145 Pads track numbers with 0\'s.
146 .TP
147 .B \-P
148 Use Unix PIPES to read and encode in one step. It disables multiple encodings,
149 since the WAV audio file is never stored in the disc.
150 .TP
151 .B \-r [hosts...]
152 Remote encode on this comma-delimited list of machines using distmp3. See
153 the REMOTEHOSTS configuration variable.
154 .TP
155 .B \-R
156 When CDDBLOCALDIR and CDDBUSELOCAL are defined, search recursively under the
157 defined directory for matches of the CDDB entry.
158 .TP
159 .B \-s [fields...]
160 List, separated by comas, the fields to be shown in the CDDB parsed entries.
161 Right now it only uses "year" and "genre".
162 .TP
163 .B \-S [speed]
164 Set the speed of the CD drive. Needs CDSPEED and CDSPEEDOPTS set properly
165 and both the program and device must support the capability.
166 .TP
167 .B \-t [number]
168 Start the numbering of the tracks at a given number. It only affects the
169 filenames and the playlist. Internal (tag) numbering remains the same.
170 .TP
171 .B \-T [number]
172 Same as \-t but changes also the internal (tag) numbering. Keep in mind that
173 the default TRACK tag for MP3 is $T/$TRACKS so it is changed to simply $T.
174 .TP
175 .B \-U
176 Set CDDBPROTO to version 5, so that we retrieve ISO-8859-15 encoded CDDB
177 information, and we tag and add comments with Latin1 encoding.
178 .TP
179 .B \-v
180 Show the version and exit
181 .TP
182 .B \-V
183 Be a bit more verbose. On slow networks the CDDB requests might give the
184 sensation nothing is happening.
185 .TP
186 .B \-x
187 Eject the CD when all tracks have been read. See the EJECTCD configuration
188 variable.
189 .TP
190 .B \-X [cue2discid]
191 Use an alternative "cue2discid" implementation. The name of the binary must be
192 exactly that. abcde comes with an implementation in python under the examples
193 directory. The special keyword "builtin" forces the usage of the internal
194 (default) implementation in shell script.
195 .TP
196 .B \-w [comment]
197 Add a comment to the tracks ripped from the CD.
198 .TP
199 .B \-W [number]
200 Concatenate CD\'s. It uses the number provided to define a comment "CD #" and
201 to modify the numbering of the tracks, starting with "#01".
202 .TP
203 .B \-z
204 DEBUG mode: it will rip, using cdparanoia, the very first second of each track
205 and proceed with the actions requested very quickly, also providing some
206 "hidden" information about what happens on the background. CAUTION: IT WILL
208 .TP
209 .B [tracks]
210 A list of tracks you want abcde to process. If this isn't specified, abcde
211 will process the entire CD. Accepts ranges of track numbers -
212 "abcde 1-5 7 9" will process tracks 1, 2, 3, 4, 5, 7, and 9.
214 Each track is, by default, placed in a separate file named after the track
215 in a subdirectory named after the artist under the current directory.
216 This can be modified using the OUTPUTFORMAT and VAOUTPUTFORMAT
217 variables in your abcde.conf. Each file is given an extension identifying
218 its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.aac' or '.wav'.
220 abcde sources two configuration files on startup - /etc/abcde.conf and
221 $HOME/.abcde.conf, in that order.
222 .TP
223 The configuration options stated on those files can be overridden by providing
224 the appropriate flags at runtime.
225 .TP
226 The configuration variables have to be set as follows:
227 .TP
228 .B VARIABLE=value
229 Except when "value" needs to be quoted or otherwise interpreted. If other
230 variables within "value" are to be expanded upon reading the configuration
231 file, then double quotes should be used. If they are only supposed to be
232 expanded upon use (for example OUTPUTFORMAT) then single quotes must be used.
233 .TP
234 All sh escaping/quoting rules apply.
235 .TP
236 Here is a list of options abcde recognizes:
237 .TP
239 Specifies the method we want to use to retrieve the track information. Two
240 values are recognized: "cddb" and "musicbrainz". The "cddb" value needs the
241 CDDBURL and HELLOINFO variables described below. The "musicbrainz" value uses
242 Python to establish a conversation with the server for information retrieval.
243 .TP
245 Specifies a server to use for CDDB lookups.
246 .TP
248 Specifies the protocol version used for the CDDB retrieval of results. Version
249 6 retrieves CDDB entries in UTF-8 format.
250 .TP
252 Specifies the Hello information to send to the CDDB server. The CDDB
253 protocol requires you to send a valid username and hostname each time you
254 connect. The format of this is username@hostname.
255 .TP
257 Specifies a directory where we store a local CDDB repository. The entries must
258 be standard CDDB entries, with the filename being the DISCID value. Other
259 CD playing and ripping programs (like Grip) store the entries under ~/.cddb
260 and we can make use of those entries.
261 .TP
263 Specifies if the CDDBLOCALDIR has to be searched recursively trying to find a
264 match for the CDDB entry. If a match is found and selected, and CDDBCOPYLOCAL
265 is selected, it will be copied to the root of the CDDBLOCALDIR if
266 CDDBLOCALPOLICY is "modified" or "new".
267 .TP
269 Defines when a CDDB entry should be stored in the defined CDDBLOCALDIR. The
270 possible policies are: "net" for a CDDB entry which has been received from the
271 net (overwriting any possible local CDDB entry); "new" for a CDDB entry which
272 was received from the net, but will request confirmation to overwrite a local
273 CDDB entry found in the root of the CDDBLOCALDIR directory; "modified" for a
274 CDDB entry found in the local repository but which has been modified by the
275 user; and "always" which forces the CDDB entry to be stored back in the root of
276 the CDDBLOCALDIR no matter where it was found, and no matter it was not edited.
277 This last option will always overwrite the one found in the root of the local
278 repository (if any). STILL NOT WORKING!!
279 .TP
281 Store local copies of the CDDB entries under the $CDDBLOCALDIR directory.
282 .TP
284 Actually use the stored copies of the CDDB entries. Can be overridden using the
285 "-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give
286 the choice of retrieving a CDDB entry from the internet.
287 .TP
289 Coma-separated list of fields we want to parse during the CDDB parsing.
290 Defaults to "year,genre".
291 .TP
293 Specifies the style of encoder to use for the Ogg/Vorbis encoder. Valid options
294 are \'oggenc\' (default for Ogg/Vorbis) and \'vorbize\'.
295 This affects the default location of the binary,
296 the variable to pick encoder command-line options from, and where the options
297 are given.
298 .TP
300 Specifies the style of encoder to use for the MP3 encoder. Valid options are
301 \'lame\' (default for MP3), \'gogo\', \'bladeenc\', \'l3enc\' and \'mp3enc\'.
302 Affects the same way as explained above for Ogg/Vorbis.
303 .TP
305 Specifies the style of encoder to use for the FLAC encoder. At this point only
306 \'flac\' is available for FLAC encoding.
307 .TP
309 Specifies the style of encoder to use for Speex encoder. At this point only
310 \'speexenc\' is available for Ogg/Speex encoding.
311 .TP
313 Specifies the style of encoder to use for MPP/MP+ (Musepack) encoder. At this
314 point we only have \'mppenc\' available, from corecodecs.org.
315 .TP
317 Specifies the style of encoder to use for M4A (AAC) encoder. At this point we
318 only support \'faac\', so \'default\' points to it.
319 .TP
321 Specifies the style of normalizer to use. Valid options are \'default\'
322 and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
323 ATM.
324 .TP
326 Specifies the style of cdrom reader to use. Valid options are \'cdparanoia\',
327 \'debug\' and \'flac\'. It is used for querying the CDROM and obtain a list of
328 valid tracks and DATA tracks. The special \'flac\' case is used to "rip" CD
329 tracks from a single-track flac file.
330 .TP
332 Specifies the syntax of the program we use to read the CD CUE sheet. Right now
333 we only support \'mkcue\', but in the future other readers might be used.
334 .TP
336 It defaults to no, so if you want to keep those wavs ripped from your CD,
337 set it to "y". You can use the "-k" switch in the command line. The default
338 behaviour with KEEPWAVS set is to keep the temporary directory and the wav
339 files even you have requested the "clean" action.
340 .TP
342 If set to "y", it adds 0's to the file numbers to complete a two-number
343 holder. Useful when encoding tracks 1-9.
344 .TP
346 Set to "n" if you want to perform automatic rips, without user intervention.
347 .TP
349 Define the values for priorities (nice values) for the different CPU-hungry
350 processes: encoding (ENCNICE), CDROM read (READNICE) and distributed encoder
351 with distmp3 (DISTMP3NICE).
352 .TP
354 The following configuration file options specify the pathnames of their
355 respective utilities: LAME, TOOLAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC,
359 CUE2DISCID (see option "\-X"), DIFF and HTTPGET.
360 .TP
362 If you wish to specify command-line options to any of the programs abcde uses,
363 set the following configuration file options: LAMEOPTS, TOOLAMEOPTS, GOGOOPTS,
369 .TP
371 Set the value of the CDROM speed. The default is to read the disc as fast as
372 the reading program and the system permits. The steps are defined as 150kB/s
373 (1x).
374 .TP
376 The default actions to be performed when reading a disc.
377 .TP
378 .B CDROM
379 If set, it points to the CD-Rom device which has to be used for audio
380 extraction. Abcde tries to guess the right device, but it may fail. The special
381 \'flac\' option is defined to extract tracks from a single-track flac file.
382 .TP
384 Defined as "d" when using cdparanoia with an IDE bus and as "g" when using
385 cdparanoia with the ide-scsi emulation layer.
386 .TP
388 Specifies the directory to place completed tracks/playlists in.
389 .TP
391 Specifies the temporary directory to store .wav files in. Abcde may use up
392 to 700MB of temporary space for each session (although it is rare to use
393 over 100MB for a machine that can encode music as fast as it can read it).
394 .TP
396 Specifies the encoding format to output, as well as the default extension and
397 encoder. Defaults to "vorbis". Valid settings are "vorbis" (or "ogg")
398 (Ogg/Vorbis), "mp3" (MPEG-1 Audio Layer III), "flac" (Free Lossless Audio
399 Codec), "spx" (Ogg/Speex), "mpc" (MPP/MP+ (Musepack)), "m4a" (for M4A (AAC)) or
400 "wav" (Microsoft Waveform). Values like "vorbis,mp3" encode the tracks in both
401 Ogg/Vorbis and MP3 formats.
402 .br
403 For each value in OUTPUTTYPE, abcde expands a different process for encoding,
404 tagging and moving, so you can use the format placeholder, OUTPUT, to create
405 different subdirectories to hold the different types. The variable OUTPUT will
406 be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a' and/or 'wav', depending on the
407 OUTPUTTYPE you define. For example
408 .br
410 .TP
412 Specifies the format for completed Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+
413 (Musepack) or M4A filenames. Variables are included using standard shell
414 syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE,
416 Make sure to use single quotes around this variable. TRACKNUM is automatically
417 zero-padded, when the number of encoded tracks is higher than 9. When lower,
418 you can force with
419 '-p' in the command line.
420 .TP
422 Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
423 .TP
425 Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
426 .TP
428 Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${ALBUMFILE}'
429 .TP
431 Defines how many encoders to run at once. This makes for huge speedups
432 on SMP systems. You should run one encoder per CPU at once for maximum
433 efficiency, although more doesn't hurt very much. Set it "0" when using
434 mp3dist to avoid getting encoding processes in the local host.
435 .TP
437 If set to y, conserves disk space by encoding tracks immediately after
438 reading them. This is substantially slower than normal operation but
439 requires several hundred MB less space to complete the encoding of an
440 entire CD. Use only if your system is low on space and cannot encode as
441 quickly as it can read.
442 .TP
444 If set to y, enables batch mode normalization, which preserves relative
445 volume differences between tracks of an album. Also enables nogap encoding
446 when using the \'lame\' encoder.
447 .TP
448 .B NOGAP
449 Activate the lame's \-\-nogap option, that allows files found in CDs with no
450 silence between songs (such as live concerts) to be encoded without noticeable
451 gaps. WARNING: lame's \-\-nogap disables the Xing mp3 tag. This tag is
452 required for mp3 players to correctly display track lengths when playing
453 variable-bit-rate mp3 files.
454 .TP
456 Specifies the format for completed playlist filenames. Works like the
457 OUTPUTFORMAT configuration variable. Default is
458 \'${ARTISTFILE}_\-_${ALBUMFILE}.m3u\'.
459 Make sure to use single quotes around this variable.
460 .TP
462 Specifies a prefix for filenames within a playlist. Useful for http
463 playlists, etc.
464 .TP
466 If set, the resulting playlist will have CR-LF line endings, needed by some
467 hardware-based players.
468 .TP
470 Specifies a comment to embed in the ID3 or Ogg comment field of each
471 finished track. Can be up to 28 characters long. Supports the same
472 syntax as OUTPUTFORMAT. Does not currently support ID3v2.
473 .TP
475 Specifies a comma-delimited list of systems to use for remote encoding using
476 distmp3. Equivalent to -r.
477 .TP
478 .B mungefilename
479 mungefilename() is an abcde shell function that can be overridden via
480 abcde.conf. It takes CDDB data as $1 and outputs the resulting filename on
481 stdout. It defaults to eating control characters, apostrophes and
482 question marks, translating spaces and forward slashes to underscores, and
483 translating colons to an underscore and a hyphen.
484 .br
485 If you modify this function, it is probably a good idea to keep the forward
486 slash munging (UNIX cannot store a file with a '/' char in it) as well as
487 the control character munging (NULs can't be in a filename either, and
488 newlines and such in filenames are typically not desirable).
489 .TP
490 .B mungegenre
491 mungegenre () is a shell function used to modify the $GENRE variable. As
492 a default action, it takes $GENRE as $1 and outputs the resulting value
493 to stdout converting all UPPERCASE characters to lowercase.
494 .TP
495 .B pre_read
496 pre_read () is a shell function which is executed before the CDROM is read
497 for the first time, during abcde execution. It can be used to close the CDROM
498 tray, to set its speed (via "setcd" or via "eject", if available) and other
499 preparation actions. The default function is empty.
500 .TP
501 .B post_read
502 post_read () is a shell function which is executed after the CDROM is read
503 (and, if applies, before the CDROM is ejected). It can be used to read a TOC
504 from the CDROM, or to try to read the DATA areas from the CD (if any exist).
505 The default function is empty.
506 .TP
508 If set to "y", abcde will call eject(1) to eject the cdrom from the drive
509 after all tracks have been read. It has no effect when CDROM is set to a flac
510 file.
511 .TP
513 If set to "y", some operations which are usually now shown to the end user
514 are visible, such as CDDB queries. Useful for initial debug and if your
515 network/CDDB server is slow.
517 Possible ways one can call abcde
518 .TP
519 .B abcde
520 Will work in most systems
521 .TP
522 .B abcde \-d /dev/cdrom2
523 If the CDROM you are reading from is not the standard /dev/cdrom (in GNU/Linux systems)
524 .TP
525 .B abcde \-o vorbis,flac
526 Will create both Ogg/Vorbis and Ogg/FLAC files.
527 .TP
528 .B abcde \-o vorbis:"-b 192"
529 Will pass "-b 192" to the Ogg/Vorbis encoder, without having to modify the
530 config file
531 .TP
532 .B abcde \-W 1
533 For double+ CD settings: will create the 1st CD starting with the track number
534 101, and will add a comment "CD 1" to the tracks, the second starting with 201
535 and so on.
536 .TP
537 .B abcde \-d singletrack.flac
538 Will extract the files contained in singletrack using the embedded cuesheet.
540 abcde requires the following backend tools to work:
541 .TP
542 .B *
543 An Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack) or M4A encoder (oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mppenc, faac)
544 .TP
545 .B *
546 An audio CD reading utility (cdparanoia, cdda2wav, dagrab)
547 .TP
548 .B *
549 cd-discid, a CDDB DiscID reading program.
550 .TP
551 .B *
552 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.
553 .TP
554 .B *
555 (for MP3s) id3 or id3v2, id3 v1 and v2 tagging programs.
556 .TP
557 .B *
558 (optional) distmp3, a client/server for distributed mp3 encoding.
559 .TP
560 .B *
561 (optional) normalize-audio, a WAV file volume normalizer.
562 .TP
563 .B *
564 (optional) a replaygain file volume modifier (vorbisgain, metaflac, mp3gain, replaygain),
565 .TP
566 .B *
567 (optional) mkcue, a CD cuesheet extractor.
568 .SH "SEE ALSO"
569 .BR cdparanoia (1),
570 .BR cdda2wav (1),
571 .BR dagrab (1),
572 .BR normalize-audio (1),
573 .BR oggenc (1),
574 .BR vorbize (1),
575 .BR flac (1),
576 .BR toolame (1),
577 .BR speexenc (1),
578 .BR mppenc (1),
579 .BR faac (1),
580 .BR id3 (1),
581 .BR id3v2 (1),
582 .BR wget (1),
583 .BR fetch (1),
584 .BR cd-discid (1),
585 .BR distmp3 (1),
586 .BR distmp3host (1),
587 .BR curl (1),
588 .BR mkcue (1),
589 .BR vorbisgain (1),
590 .BR mp3gain (1)
592 Robert Woodcock <rcw@debian.org>,
593 Jesus Climent <jesus.climent@hispalinux.es> and contributions from many others.