X-Git-Url: https://git.hcoop.net/clinton/abcde.git/blobdiff_plain/1b94d6b746bbb08effaf20627ee1b98520c55dc6..f37b07d0726802b2c026c2bd40bf54b60c26a693:/abcde.1 diff --git a/abcde.1 b/abcde.1 index 73a26ed..2ca1409 100644 --- a/abcde.1 +++ b/abcde.1 @@ -16,16 +16,22 @@ Audio Codec (FLAC), Ogg/Speex or MPP/MP+(Musepack). With one command, it will: Do a CDDB query over the Internet to look up your CD or use a locally stored CDDB entry .TP .B * -Grab a track from your CD +Grab an audio track (or all the audio CD tracks) from your CD .TP .B * -Compress it to Ogg/Vorbis, MP3, FLAC, Ogg/Speex and/or MPP/MP+(Musepack) format +Normalize the volume of the individual file (or the album as a single unit) .TP .B * -Comment or ID3 tag it +Compress to Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack) and/or M4A format(s), all in one CD read .TP .B * -Give it an intelligible filename +Comment or ID3/ID3v2 tag +.TP +.B * +Give an intelligible filename +.TP +.B * +Calculate replaygain values for the individual file (or the album as a single unit) .TP .B * Delete the intermediate WAV file (or save it for later use) @@ -41,13 +47,18 @@ the file can be used as a source for creating other formats. .TP .B \-a [actions] Comma-delimited list of actions to perform. Can be one or more of: -cddb, read, normalize, encode, tag, move, playlist, clean. Normalize +cddb, read, normalize, encode, tag, move, replaygain, playlist, clean. Normalize and encode imply read. Tag implies cddb, read, encode. Move implies -cddb, read, encode, tag. Playlist implies cddb. The default is to -do all actions except normalize and playlist. +cddb, read, encode, tag. Replaygain implies cddb, read, encode, tag and move. +Playlist implies cddb. The default is to do all actions except normalize, +replaygain and playlist. .TP .B \-b -Enable batch mode normalization. See the BATCH configuration variable. +Enable batch mode normalization. See the BATCHNORM configuration variable. +.TP +.B \-B +Disable batch mode replaygain. It processes file by file to add the replaygain +information. See the NOBATCHREPLAYGAIN configuration variable. .TP .B \-c [filename] Specifies an additional configuration file to parse. Configuration options @@ -68,6 +79,23 @@ single-track flac file with embeded cuesheet. Capture debugging information (you'll want to redirect this \- try 'abcde \-D 2>logfile') .TP +.B \-e +Erase information about encoded tracks from the internal status file, to enable +other encodings if the wav files have been kept. +.TP +.B \-f +Force the removal of the temporary ABCDETEMPDIR directory, even when we have +not finished. For example, one can read and encode several formats, including +\'.ogg\', and later on execute a \'move\' action with only one of the given +formats. On a normal situation it would erase the rest of those encoded +formats. In this case, abcde will refuse to execute such command, except if \-f +is used. +.TP +.B \-g +Enable lame's \-\-nogap option. See the NOGAP variable. WARNING: lame's +\-\-nogap disables the Xing mp3 tag. This tag is required for mp3 players to +correctly display track lengths when playing variable-bit-rate mp3 files. +.TP .B \-h Get help information. .TP @@ -103,22 +131,26 @@ If the cuesheet is embeded in a flac single file it can be used as source for encoding other formats. .TP .B \-o [filetype][:filetypeoptions] -Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx" or "mpc". -Specify a comma-delimited list of output types to obtain all specified types. -See the OUTPUTTYPE configuration variable. One can pass options to the encoder -for a specific filetype on the command line separating them with a colon. The -options must be escaped with double-quotes. +Select output type. Can be "vorbis" (or "ogg"), "mp3", "flac", "spx", "mpc", +"m4a" or "wav". Specify a comma-delimited list of output types to obtain all +specified types. See the OUTPUTTYPE configuration variable. One can pass +options to the encoder for a specific filetype on the command line separating +them with a colon. The options must be escaped with double-quotes. .TP .B \-p Pads track numbers with 0\'s. .TP +.B \-P +Use Unix PIPES to read and encode in one step. It disables multiple encodings, +since the WAV audio file is never stored in the disc. +.TP .B \-r [hosts...] Remote encode on this comma-delimited list of machines using distmp3. See the REMOTEHOSTS configuration variable. .TP .B \-R -Add replaygain information to the id3 or tag information for play -normalization. Only works with Ogg/FLAC and Ogg/Vorbis. +When CDDBLOCALDIR and CDDBUSELOCAL are defined, search recursively under the +defined directory for matches of the CDDB entry. .TP .B \-s [fields...] List, separated by comas, the fields to be shown in the CDDB parsed entries. @@ -136,6 +168,12 @@ filenames and the playlist. Internal (tag) numbering remains the same. Same as \-t but changes also the internal (tag) numbering. Keep in mind that the default TRACK tag for MP3 is $T/$TRACKS so it is changed to simply $T. .TP +.B \-u +Set CDDBPROTOCOL to version 6, so that we retrieve UTF-8 encoded CDDB +information, and we tag and add comments with a proper encoding. This flag will +be removed and -U will be added to set it to version 5 once version 6 becomes +the default. +.TP .B \-v Show the version and exit .TP @@ -154,6 +192,12 @@ Add a comment to the tracks ripped from the CD. Concatenate CD\'s. It uses the number provided to define a comment "CD #" and to modify the numbering of the tracks, starting with "#01". .TP +.B \-z +DEBUG mode: it will rip, using cdparanoia, the very first second of each track +and proceed with the actions requested very quickly, also providing some +"hidden" information about what happens on the background. CAUTION: IT WILL +ERASE ANY EXISTING RIPS WITHOUT WARNING! +.TP .B [tracks] A list of tracks you want abcde to process. If this isn't specified, abcde will process the entire CD. Accepts ranges of track numbers - @@ -163,12 +207,12 @@ Each track is, by default, placed in a separate file named after the track in a subdirectory named after the artist under the current directory. This can be modified using the OUTPUTFORMAT and VAOUTPUTFORMAT variables in your abcde.conf. Each file is given an extension identifying -its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', or '.mpc'. +its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.aac' or '.wav'. .SH CONFIGURATION abcde sources two configuration files on startup - /etc/abcde.conf and $HOME/.abcde.conf, in that order. .TP -The configuration options stated on those files can ba overriden by providing +The configuration options stated on those files can be overriden by providing the appropiate flags at runtime. .TP The configuration variables have to be set as follows: @@ -183,6 +227,12 @@ All sh escaping/quoting rules apply. .TP Here is a list of options abcde recognizes: .TP +.B CDDBMETHOD +Specifies the method we want to use to retrieve the track information. Two +values are recognized: "cddb" and "musicbrainz". The "cddb" value needs the +CDDBURL and HELLOINFO variables described below. The "musicbrainz" value uses +Python to stablish a conversation with the server for information retrieval. +.TP .B CDDBURL Specifies a server to use for CDDB lookups. .TP @@ -197,6 +247,24 @@ be standard CDDB entries, with the filename being the DISCID value. Other CD playing and ripping programs (like Grip) store the entries under ~/.cddb and we can make use of those entries. .TP +.B CDDBLOCALRECURSIVE +Specifies if the CDDBLOCALDIR has to be searched recursively trying to find a +match for the CDDB entry. If a match is found and selected, and CDDBCOPYLOCAL +is selected, it will be copied to the root of the CDDBLOCALDIR if +CDDBLOCALPOLICY is "modified" or "new". +.TP +.B CDDBLOCALPOLICY +Defines when a CDDB entry should be stored in the defined CDDBLOCALDIR. The +possible policies are: "net" for a CDDB entry which has been received from the +net (overwriting any possible local CDDB entry); "new" for a CDDB entry which +was received from the net, but will request confirmation to overwrite a local +CDDB entry found in the root of the CDDBLOCALDIR directory; "modified" for a +CDDB entry found in the local repository but which has been modified by the +user; and "always" which forces the CDDB entry to be stored back in the root of +the CDDBLOCALDIR no matter where it was found, and no matter it was not edited. +This last option will always overwrite the one found in the root of the local +repository (if any). +.TP .B CDDBCOPYLOCAL Store local copies of the CDDB entries under the $CDDBLOCALDIR directory. .TP @@ -233,6 +301,10 @@ Specifies the style of encoder to use for Speex encoder. At this point only Specifies the style of encoder to use for MPP/MP+ (Musepack) encoder. At this point we only have \'mppenc\' available, from corecodecs.org. .TP +.B AACENCODERSYNTAX +Specifies the style of encoder to use for M4A (AAC) encoder. At this point we +only support \'faac\', so \'default\' points to it. +.TP .B NORMALIZERSYNTAX Specifies the style of normalizer to use. Valid options are \'default\' and \'normalize'\ (and both run \'normalize-audio\'), since we only support it, @@ -251,7 +323,7 @@ we only support \'mkcue\', but in the future other readers might be used. .B KEEPWAVS It defaults to no, so if you want to keep those wavs ripped from your CD, set it to "y". You can use the "-k" switch in the command line. The default -behaviour with KEEPWAVS set is the keep the temporary directory and the wav +behaviour with KEEPWAVS set is to keep the temporary directory and the wav files even you have requested the "clean" action. .TP .B PADTRACKS @@ -268,18 +340,20 @@ with distmp3 (DISTMP3NICE). .TP .B PATHNAMES The following configuration file options specify the pathnames of their -respective utilities: LAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC, VORBIZE, -OGGENC, FLAC, SPEEXENC, MPPENC, ID3, ID3V2, CDPARANOIA, CDDA2WAV, CDDAFS, -CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3, VORBISCOMMENT, NORMALIZE, CDSPEED, -VORBISGAIN, MKCUE and HTTPGET. +respective utilities: LAME, TOOLAME, GOGO, BLADEENC, L3ENC, XINGMP3ENC, MP3ENC, +VORBIZE, OGGENC, FLAC, SPEEXENC, MPPENC, AACEND, ID3, ID3V2, EYED3, METAFLAC, +CDPARANOIA, CDDA2WAV, CDDAFS, CDDISCID, CDDBTOOL, EJECT, MD5SUM, DISTMP3, +VORBISCOMMENT, NORMALIZE, CDSPEED, MP3GAIN, VORBISGAIN, MPPGAIN, MKCUE, MKTOC, +DIFF and HTTPGET. .TP .B COMMAND-LINE OPTIONS -If you wish to specify command-line options to any of the programs abcde -uses, set the following configuration file options: LAMEOPTS, GOGOOPTS, +If you wish to specify command-line options to any of the programs abcde uses, +set the following configuration file options: LAMEOPTS, TOOLAMEOPTS, GOGOOPTS, BLADEENCOPTS, L3ENCOPTS, XINGMP3ENCOPTS, MP3ENCOPTS, VORBIZEOPTS, OGGENCOPTS, -FLACOPTS, SPEEXENCOPTS, MPPENCOPTS, ID3OPTS, ID3V2OPTS, CDPARANOIAOPTS, -CDDA2WAVOPTS, CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS, NORMALIZEOPTS, -CDSPEEDOPTS, MKCUEOPTS,VORBISCOMMMENTOPTS, METAFLACOPTS and HTTPGETOPTS. +FLACOPTS, SPEEXENCOPTS, MPPENCOPTS, AACENCOPTS, ID3OPTS, ID3V2OPTS, +CDPARANOIAOPTS, CDDA2WAVOPTS, CDDAFSOPTS, CDDBTOOLOPTS, EJECTOPTS, DISTMP3OPTS, +NORMALIZEOPTS, CDSPEEDOPTS, MKCUEOPTS, VORBISCOMMMENTOPTS, METAFLACOPTS, +DIFFOPTS and HTTPGETOPTS. .TP .B CDSPEEDVALUE Set the value of the CDROM speed. The default is to read the disc as fast as @@ -310,27 +384,27 @@ over 100MB for a machine that can encode music as fast as it can read it). Specifies the encoding format to output, as well as the default extension and encoder. Defaults to "vorbis". Valid settings are "vorbis" (or "ogg") (Ogg/Vorbis), "mp3" (MPEG-1 Audio Layer III), "flac" (Free Lossless Audio -Codec), "spx" (Ogg/Speex) and "mpc" (MPP/MP+ (Musepack)). Values like -"vorbis,mp3" encode the tracks in both Ogg/Vorbis and MP3 formats. +Codec), "spx" (Ogg/Speex), "mpc" (MPP/MP+ (Musepack)), "m4a" (for M4A (AAC)) or +"wav" (Microsoft Waveform). Values like "vorbis,mp3" encode the tracks in both +Ogg/Vorbis and MP3 formats. .br For each value in OUTPUTTYPE, abcde expands a different process for encoding, tagging and moving, so you can use the format placeholder, OUTPUT, to create different subdirectories to hold the different types. The variable OUTPUT will -be 'vorbis', 'mp3', 'flac', 'spx' and/or 'mpc', depending on the OUTPUTTYPE you define. -For example +be 'vorbis', 'mp3', 'flac', 'spx', 'mpc', 'm4a' and/or 'wav', depending on the +OUTPUTTYPE you define. For example .br OUTPUTFORMAT='${OUTPUT}/${ARTISTFILE}/${ALBUMFILE}/${TRACKNUM}._${TRACKFILE}' .TP .B OUTPUTFORMAT -Specifies the format for completed Ogg/Vorbis, MP3, FLAC, Ogg/Speex or MPP/MP+ -(Musepack) filenames. -Variables are included -using standard shell syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE, -TRACKFILE, TRACKNUM, and YEAR. Default is -\'${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}-${TRACKFILE}\'. -Make sure to use single quotes around this variable. TRACKNUM is -automatically zero-padded, when the number of encoded tracks is higher than -9. When lower, you can force with '-p' in the command line. +Specifies the format for completed Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+ +(Musepack) or M4A filenames. Variables are included using standard shell +syntax. Allowed variables are GENRE, ALBUMFILE, ARTISTFILE, TRACKFILE, +TRACKNUM, and YEAR. Default is \'${ARTISTFILE}-${ALBUMFILE}/${TRACKNUM}-${TRACKFILE}\'. +Make sure to use single quotes around this variable. TRACKNUM is automatically +zero-padded, when the number of encoded tracks is higher than 9. When lower, +you can force with +'-p' in the command line. .TP .B VAOUTPUTFORMAT Just like OUTPUTFORMAT but for Various Artists discs. Default is whatever @@ -349,11 +423,18 @@ requires several hundred MB less space to complete the encoding of an entire CD. Use only if your system is low on space and cannot encode as quickly as it can read. .TP -.B BATCH +.B BATCHNORM If set to y, enables batch mode normalization, which preserves relative volume differences between tracks of an album. Also enables nogap encoding when using the \'lame\' encoder. .TP +.B NOGAP +Activate the lame's \-\-nogap option, that allows files found in CDs with no +silence between songs (such as live concerts) to be encoded without noticeable +gaps. WARNING: lame's \-\-nogap disables the Xing mp3 tag. This tag is +required for mp3 players to correctly display track lengths when playing +variable-bit-rate mp3 files. +.TP .B PLAYLISTFORMAT Specifies the format for completed playlist filenames. Works like the OUTPUTFORMAT configuration variable. Default is @@ -421,17 +502,17 @@ Possible ways one can call abcde .B abcde Will work in most systems .TP -.B abcde -d /dev/cdrom2 +.B abcde \-d /dev/cdrom2 If the CDROM you are reding from is not the standard /dev/cdrom (in GNU/Linux systems) .TP -.B abcde -o vorbis,flac +.B abcde \-o vorbis,flac Will create both Ogg/Vorbis and Ogg/FLAC files. .TP -.B abcde -o vorbis:"-b 192" +.B abcde \-o vorbis:"-b 192" Will pass "-b 192" to the Ogg/Vorbis encoder, without having to modify the config file .TP -.B abcde -W 1 +.B abcde \-W 1 For double+ CD settings: will create the 1st CD starting with the track number 101, and will add a comment "CD 1" to the tracks, the second starting with 201 and so on. @@ -442,7 +523,7 @@ Will extract the files contained in singletrack using the embeded cuesheet. abcde requires the following backend tools to work: .TP .B * -An Ogg/Vorbis, MP3, FLAC, Ogg/Speex or MPP/MP+(Musepack) encoder (oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mppenc) +An Ogg/Vorbis, MP3, FLAC, Ogg/Speex, MPP/MP+(Musepack) or M4A encoder (oggenc, vorbize, lame, gogo, bladeenc, l3enc, mp3enc, flac, speexenc, mppenc, faac) .TP .B * An audio CD reading utility (cdparanoia, cdda2wav, dagrab) @@ -451,7 +532,7 @@ An audio CD reading utility (cdparanoia, cdda2wav, dagrab) cd-discid, a CDDB DiscID reading program. .TP .B * -An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others). +An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others). Alternatively, musicbrainz-get-tracks (which depends on Python) can be used to retrieve CDDB information about the CD. .TP .B * (for MP3s) id3 or id3v2, id3 v1 and v2 tagging programs. @@ -460,7 +541,10 @@ An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others (optional) distmp3, a client/server for distributed mp3 encoding. .TP .B * -(optional) normalize, a WAV file volume normalizer. +(optional) normalize-audio, a WAV file volume normalizer. +.TP +.B * +(optional) a replaygain file volume modifier (vorbisgain, metaflac, mp3gain, replaygain), .TP .B * (optional) mkcue, a CD cuesheet extractor. @@ -472,16 +556,21 @@ An HTTP retrieval program: wget, fetch (FreeBSD) or curl (Mac OS X, among others .BR oggenc (1), .BR vorbize (1), .BR flac (1), +.BR toolame (1), .BR speexenc (1), .BR mppenc (1), +.BR faac (1), .BR id3 (1), +.BR id3v2 (1), .BR wget (1), .BR fetch (1), .BR cd-discid (1), .BR distmp3 (1), .BR distmp3host (1), -.BR curl (1) +.BR curl (1), .BR mkcue (1), +.BR vorbisgain (1), +.BR mp3gain (1) .SH AUTHORS Robert Woodcock , Jesus Climent and contributions from many others.