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