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