abcde.1,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
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 *
19Grab a track from your CD
20.TP
21.B *
99d009fa 22Compress it to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or MPP/MP+(Musepack) format
c9c2ca27 23.TP
24.B *
25Comment or ID3 tag it
26.TP
27.B *
28Give it an intelligible filename
29.TP
30.B *
31Delete the intermediate WAV file (or save it for later use)
32.TP
33.B *
34Repeat until finished
35.SH OPTIONS
36.TP
37.B \-1
38Encode the whole CD in a single file. The resulting file uses the CD title
39for tagging.
40.TP
41.B \-a [actions]
42Comma-delimited list of actions to perform. Can be one or more of:
43cddb, read, normalize, encode, tag, move, playlist, clean. Normalize
44and encode imply read. Tag implies cddb, read, encode. Move implies
45cddb, read, encode, tag. Playlist implies cddb. The default is to
46do all actions except normalize and playlist.
47.TP
48.B \-b
49Enable batch mode normalization. See the BATCH configuration variable.
50.TP
51.B \-c [filename]
52Specifies an additional configuration file to parse. Configuration options
53in this file override those in /etc/abcde.conf or $HOME/.abcde.conf.
54.TP
55.B \-C [discid]
56Allows you to resume a session for
57.I discid
58when you no longer have the CD available (abcde will automatically resume if
59you still have the CD in the drive). You must have already finished at
60least the "read" action during the previous session.
61.TP
62.B \-d [devicename]
63CD\-ROM block device that contains audio tracks to be read.
64.TP
65.B \-D
66Capture debugging information (you'll want to redirect this \- try 'abcde \-D
672>logfile')
68.TP
81bc6204 69.B \-h
70Get help information.
04609998 71.TP
c9c2ca27 72.B \-j [number]
73Start [number] encoder processes at once. Useful for SMP systems. Overrides
74the MAXPROCS configuration variable. Set it to "0" when using distmp3 to avoid
75local encoding processes.
76.TP
77.B \-k
78Keep the wav files after encoding.
79.TP
80.B \-l
81Use the low-diskspace algorithm. See the LOWDISK configuration variable.
82.TP
83.B \-L
84Use a local CDDB repository. See CDDBLOCALDIR variable.
85.TP
81bc6204 86.B \-n
c9c2ca27 87Do not query CDDB database. Create and use a template. Edit the template to
88provide song names, artist(s), ...
89.TP
81bc6204 90.B \-N
c9c2ca27 91Non interactive mode. Do not ask anything from the user. Just go ahead.
92.TP
81bc6204 93.B \-m
c9c2ca27 94Create DOS-style playlists, modifying the resulting one by adding CRLF line
95endings. Some hardware players insist on having those to work.
96.TP
6119aaa1 97.B \-M
98Create a CUE file with information about the CD. Together with the possibility
99of creating a single file (see option "\-1"), one can recreate the original CD.
100.TP
24f444d7 101.B \-o [filetype][:filetypeoptions]
b82e2042 102Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx" or "mpc".
103Specify a comma-delimited list of output types to obtain all specified types.
104See the OUTPUTTYPE configuration variable. One can pass options to the encoder
105for a specific filetype on the command line separating them with a colon. The
24f444d7 106options must be escaped with double-quotes.
c9c2ca27 107.TP
108.B \-p
109Pads track numbers with 0\'s.
110.TP
111.B \-r [hosts...]
112Remote encode on this comma-delimited list of machines using distmp3. See
113the REMOTEHOSTS configuration variable.
114.TP
81bc6204 115.B \-R
116Add replaygain information to the id3 or tag information for play
117normalization. Only works with MP3 and Ogg/Vorbis.
118.TP
c9c2ca27 119.B \-S [speed]
120Set the speed of the CD drive. Needs CDSPEED and CDSPEEDOPTS set properly
121and both the program and device must support the capability.
122.TP
79e3928b 123.B \-t [number]
124Start the numbering of the tracks at a given number. It only affects the
125filenames and the playlist. Internal (tag) numbering remains the same.
126.TP
127.B \-T [number]
128Same as \-t but changes also the internal (tag) numbering. Keep in mind that
129the default TRACK tag for MP3 is $T/$TRACKS so it is changed to simply $T.
130.TP
c9c2ca27 131.B \-v
132Show the version and exit
133.TP
134.B \-V
135Be a bit more verbose. On slow networks the CDDB requests might give the
136sensation nothins is happening.
137.TP
138.B \-x
139Eject the CD when all tracks have been read. See the EJECTCD configuration
140variable.
141.TP
81bc6204 142.B \-w [comment]
143Add a comment to the tracks ripped from the CD.
144.TP
145.B \-W [number]
146Concatenate CD\'s. It uses the number provided to define a comment "CD #" and
147to modify the numbering of the tracks, starting with "#01".
c9c2ca27 148.TP
149.B [tracks]
150A list of tracks you want abcde to process. If this isn't specified, abcde
151will process the entire CD. Accepts ranges of track numbers -
152"abcde 1-5 7 9" will process tracks 1, 2, 3, 4, 5, 7, and 9.
153.SH OUTPUT
154Each track is, by default, placed in a separate file named after the track
9f659ada 155in a subdirectory named after the artist under the current directory.
c9c2ca27 156This can be modified using the OUTPUTFORMAT and VAOUTPUTFORMAT
9f659ada 157variables in your abcde.conf. Each file is given an extension identifying
b82e2042 158its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', or '.mpc'.
c9c2ca27 159.SH CONFIGURATION
160abcde sources two configuration files on startup - /etc/abcde.conf and
161$HOME/.abcde.conf, in that order.
162.TP
6119aaa1 163The configuration options stated on those files can ba overriden by providing
164the appropiate flags at runtime.
165.TP
c9c2ca27 166The configuration variables have to be set as follows:
167.TP
168.B VARIABLE=value
c9c2ca27 169Except when "value" needs to be quoted or otherwise interpreted. If other
170variables within "value" are to be expanded upon reading the configuration
171file, then double quotes should be used. If they are only supposed to be
172expanded upon use (for example OUTPUTFORMAT) then single quotes must be used.
173.TP
174All sh escaping/quoting rules apply.
175.TP
176Here is a list of options abcde recognizes:
177.TP
178.B CDDBURL
179Specifies a server to use for CDDB lookups.
180.TP
81bc6204 181.B HELLOINFO
182Specifies the Hello information to send to the CDDB server. The CDDB
183protocol requires you to send a valid username and hostname each time you
184connect. The format of this is username@hostname.
185.TP
186.B CDDBLOCALDIR
187Specifies a directory where we store a local CDDB repository. The entries must
188be standard CDDB entries, with the filename being the DISCID value. Other
189CD playing and ripping programs (like Grip) store the entries under ~/.cddb
190and we can make use of those entries.
191.TP
192.B CDDBCOPYLOCAL
193Store local copies of the CDDB entries under the $CDDBLOCALDIR directory.
194.TP
195.B CDDBUSELOCAL
196Actually use the stored copies of the CDDB entries. Can be overriden using the
197"-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give
198the choice of retrieving a CDDB entry from the internet.
199.TP
c9c2ca27 200.B OGGENCODERSYNTAX
201Specifies the style of encoder to use for the Ogg/Vorbis encoder. Valid options
202are \'oggenc\' (default for Ogg/Vorbis) and \'vorbize\'.
203This affects the default location of the binary,
204the variable to pick encoder command-line options from, and where the options
205are given.
206.TP
207.B MP3ENCODERSYNTAX
208Specifies the style of encoder to use for the MP3 encoder. Valid options are
209\'lame\' (default for MP3), \'gogo\', \'bladeenc\', \'l3enc\' and \'mp3enc\'.
210Affects the same way as explained above for Ogg/Vorbis.
211.TP
212.B FLACENCODERSYNTAX
213Specifies the style of encoder to use for the FLAC encoder. At this point only
214\'flac\' is available for FLAC encoding.
215.TP
216.B SPEEXENCODERSYNTAX
217Specifies the style of encoder to use for Speex encoder. At this point only
218\'speexenc\' is available for Ogg/Speex encoding.
219.TP
99d009fa 220.B MPPENCODERSYNTAX
221Specifies the style of encoder to use for MPP/MP+ (Musepack) encoder. At this
222point we only have \'mppenc\' available, from corecodecs.org.
223.TP
c9c2ca27 224.B NORMALIZERSYNTAX
225Specifies the style of normalizer to use. Valid options are \'default\'
81bc6204 226and \'normalize'\ (and both run \'normalize-audio\'), since we only support it,
227ATM.
c9c2ca27 228.TP
81bc6204 229.B CDROMREADERSYNTAX
230Specifies the style of cdrom reader to use. Valid options are \'cdparanoia\'
231and \'debug\'. It is used for querying the CDROM and obtain a list of valid
232tracks and DATA tracks. Right now, only cdparanoia is supported.
c9c2ca27 233.TP
81bc6204 234.B KEEPWAVS
235It defaults to no, so if you want to keep those wavs ripped from your CD,
236set it to "y". You can use the "-k" switch in the command line. The default
237behaviour with KEEPWAVS set is the keep the temporary directory and the wav
238files even you have requested the "clean" action.
c9c2ca27 239.TP
81bc6204 240.B PADTRACKS
241If set to "y", it adds 0's to the file numbers to complete a two-number
242holder. Usefull when encoding tracks 1-9.
c9c2ca27 243.TP
81bc6204 244.B INTERACTIVE
245Set to "n" if you want to perform automatic rips, without user intervention.
246.TP
247.B NICE VALUES
248Define the values for priorities (nice values) for the different CPU-hungry
249processes: encoding (ENCNICE), CDROM read (READNICE) and distributed encoder
250with distmp3 (DISTMP3NICE).
251.TP
252.B PATHNAMES
253The following configuration file options specify the pathnames of their
254respective utilities: LAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC, VORBIZE,
255OGGENC, FLAC, SPEEXENC, MPPENC, ID3, ID3V2, CDPARANOIA, CDDA2WAV, CDDAFS,
6119aaa1 256CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3, VORBISCOMMENT, NORMALIZE, CDSPEED,
257VORBISGAIN, MKCUE and HTTPGET.
81bc6204 258.TP
259.B COMMAND-LINE OPTIONS
260If you wish to specify command-line options to any of the programs abcde
261uses, set the following configuration file options: LAMEOPTS, GOGOOPTS,
262BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, OGGENCOPTS,
263FLACOPTS, SPEEXENCOPTS, MPPENCOPTS, ID3OPTS, ID3V2OPTS, CDPARANOIAOPTS,
264CDDA2WAVOPTS, CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS, NORMALIZEOPTS,
6119aaa1 265CDSPEEDOPTS, MKCUEOPTS,VORBISCOMMMENTOPTS, METAFLACOPTS and HTTPGETOPTS.
81bc6204 266.TP
267.B CDSPEEDVALUE
268Set the value of the CDROM speed. The default is to read the disc as fast as
269the reading program and the system permits. The steps are defined as 150kB/s
270(1x).
271.TP
272.B ACTIONS
273The default actions to be performed when reading a disc.
274.TP
275.B CDROM
276If set, it points to the CD-Rom device which has to be used for audio
277extraction. Abcde tries to guess the right device, but it may fail.
c9c2ca27 278.TP
279.B OUTPUTDIR
280Specifies the directory to place completed tracks/playlists in.
281.TP
282.B WAVOUTPUTDIR
283Specifies the temporary directory to store .wav files in. Abcde may use up
284to 700MB of temporary space for each session (although it is rare to use
285over 100MB for a machine that can encode music as fast as it can read it).
286.TP
c9c2ca27 287.B OUTPUTTYPE
288Specifies the encoding format to output, as well as the default extension and
b82e2042 289encoder. Defaults to "vorbis". Valid settings are "vorbis" (or "ogg")
290(Ogg/Vorbis), "mp3" (MPEG-1 Audio Layer III), "flac" (Free Lossless Audio
291Codec), "spx" (Ogg/Speex) and "mpc" (MPP/MP+ (Musepack)). Values like
292"vorbis,mp3" encode the tracks in both Ogg/Vorbis and MP3 formats.
81bc6204 293.br
c9c2ca27 294For each value in OUTPUTTYPE, abcde expands a different process for encoding,
295tagging and moving, so you can use the format placeholder, OUTPUT, to create
296different subdirectories to hold the different types. The variable OUTPUT will
b82e2042 297be 'vorbis', 'mp3', 'flac', 'spx' and/or 'mpc', depending on the OUTPUTTYPE you define.
c9c2ca27 298For example
81bc6204 299.br
c9c2ca27 300OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}'
301.TP
81bc6204 302.B OUTPUTFORMAT
303Specifies the format for completed Ogg/Vorbis, MP3, FLAC, Ogg/Speex or MPP/MP+
304(Musepack) filenames.
305Variables are included
306using standard shell syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE,
307TRACKFILE, TRACKNUM, and YEAR. Default is
308\'${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}-${TRACKFILE}\'.
309Make sure to use single quotes around this variable. TRACKNUM is
310automatically zero-padded, when the number of encoded tracks is higher than
3119. When lower, you can force with '-p' in the command line.
312.TP
c9c2ca27 313.B VAOUTPUTFORMAT
314Just like OUTPUTFORMAT but for Various Artists discs. Default is whatever
315OUTPUTFORMAT is set to.
316.TP
c9c2ca27 317.B MAXPROCS
318Defines how many encoders to run at once. This makes for huge speedups
319on SMP systems. You should run one encoder per CPU at once for maximum
320efficiency, although more doesn't hurt very much. Set it "0" when using
321mp3dist to avoid getting encoding processes in the local host.
322.TP
323.B LOWDISK
324If set to y, conserves disk space by encoding tracks immediately after
325reading them. This is substantially slower than normal operation but
326requires several hundred MB less space to complete the encoding of an
327entire CD. Use only if your system is low on space and cannot encode as
328quickly as it can read.
329.TP
330.B BATCH
331If set to y, enables batch mode normalization, which preserves relative
332volume differences between tracks of an album. Also enables nogap encoding
333when using the \'lame\' encoder.
334.TP
c9c2ca27 335.B PLAYLISTFORMAT
336Specifies the format for completed playlist filenames. Works like the
337OUTPUTFORMAT configuration variable. Default is
338\'${ARTISTFILE}_\-_${ALBUMFILE}.m3u\'.
339Make sure to use single quotes around this variable.
340.TP
341.B PLAYLISTDATAPREFIX
342Specifies a prefix for filenames within a playlist. Useful for http
343playlists, etc.
344.TP
99d009fa 345.B DOSPLAYLIST
346If set, the resulting playlist will have CR-LF line endings, needed by some
347hardware-based players.
348.TP
c9c2ca27 349.B COMMENT
350Specifies a comment to embed in the ID3 or Ogg comment field of each
351finished track. Can be up to 28 characters long. Supports the same
352syntax as OUTPUTFORMAT. Does not currently support ID3v2.
353.TP
354.B REMOTEHOSTS
355Specifies a comma-delimited list of systems to use for remote encoding using
356distmp3. Equivalent to -r.
357.TP
358.B mungefilename
359mungefilename() is an abcde shell function that can be overridden via
360abcde.conf. It takes CDDB data as $1 and outputs the resulting filename on
361stdout. It defaults to eating control characters, apostrophes and
362question marks, translating spaces and forward slashes to underscores, and
363translating colons to an underscore and a hyphen.
364.br
365If you modify this function, it is probably a good idea to keep the forward
366slash munging (UNIX cannot store a file with a '/' char in it) as well as
367the control character munging (NULs can't be in a filename either, and
368newlines and such in filenames are typically not desirable).
369.TP
7acef70b 370.B mungegenre
371mungegenre () is a shell function used to modify the $GENRE variable. As
372a default action, it takes $GENRE as $1 and outputs the resulting value
373to stdout converting all UPPERCASE characters to lowercase.
374.TP
375.B pre_read
376pre_read () is a shell function which is executed before the CDROM is read
377for the first time, during abcde execution. It can be used to close the CDROM
378tray, to set its speed (via "setcd" or via "eject", if available) and other
379preparation actions. The default function is empty.
380.TP
c9c2ca27 381.B EJECTCD
382If set to "y", abcde will call eject(1) to eject the cdrom from the drive
383after all tracks have been read.
79e3928b 384.TP
385.B EXTRAVERBOSE
386If set to "y", some operations which are usually now shown to the end user
387are visible, such as CDDB queries. Usefull for initial debug and if your
388network/CDDB server is slow.
24f444d7 389.SH EXAMPLES
390