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