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