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