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