Remove debian/conffiles - it is not needed
[abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index ece9eb7..eea08ad 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -10,45 +10,66 @@ tagging or commenting it, is very involved.
 .BR abcde
 is designed to automate this. It will take an entire CD and convert it into
 a compressed audio format - Ogg/Vorbis, MPEG Audio Layer III, Free Lossless
-Audio Codec (FLAC), Ogg/Speex or MPP/MP+(Musepack). With one command, it will:
+Audio Codec (FLAC), Ogg/Speex, MPP/MP+(Musepack) and/or M4A (AAC) format(s).
+With one command, it will:
 .TP
 .B *
 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)
 .TP
 .B *
 Repeat until finished
+.P
+Alternatively, 
+.B abcde
+can also grab a CD and turn it into a single FLAC file with an embedded
+cuesheet which can be user later on as a source for other formats, and will be
+treated as if it was the original CD. In a way,
+.B abcde
+can take a compressed backup of your CD collection.
 .SH OPTIONS
 .TP
 .B \-1
 Encode the whole CD in a single file. The resulting file uses the CD title
-for tagging. If the resulting format is a flac file with an embeded cuesheet,
-the file can be used as a source for creating other formats.
+for tagging. If the resulting format is a flac file with an embedded cuesheet,
+the file can be used as a source for creating other formats. Use "-1 -o
+flac -a default,cue" for obtaining such a file.
 .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
-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.
+Comma-delimited list of actions to perform. Can be one or more of: cddb, cue,
+read, normalize, encode, tag, move, replaygain, playlist, clean. Normalize and
+encode imply read. Tag implies cddb, read, encode. Move implies cddb, read,
+encode, tag. Replaygain implies cddb, read, encode, tag and move.  Playlist
+implies cddb. The default is to do all actions except cue, normalize,
+replaygain and playlist.
 .TP
 .B \-b
 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
 in this file override those in /etc/abcde.conf or $HOME/.abcde.conf.
@@ -62,7 +83,7 @@ least the "read" action during the previous session.
 .TP
 .B \-d [devicename | filename]
 CD\-ROM block device that contains audio tracks to be read. Alternatively, a
-single-track flac file with embeded cuesheet.
+single-track flac file with embedded cuesheet.
 .TP
 .B \-D
 Capture debugging information (you'll want to redirect this \- try 'abcde \-D
@@ -72,6 +93,14 @@ Capture debugging information (you'll want to redirect this \- try 'abcde \-D
 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
@@ -105,29 +134,32 @@ Non interactive mode. Do not ask anything from the user. Just go ahead.
 Create DOS-style playlists, modifying the resulting one by adding CRLF line
 endings. Some hardware players insist on having those to work.
 .TP
-.B \-M
-Create a CUE file with information about the CD. Together with the possibility
-of creating a single file (see option "\-1"), one can recreate the original CD.
-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 \-q [quality]
+Use a pre-defined quality level for the encoding process. Defined as low,
+medium or high. The "medium" value is used to reset the default values if other
+are used in the config file(s).
+.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.
@@ -145,23 +177,40 @@ 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 CDDBPROTO to version 5, so that we retrieve ISO-8859-15 encoded CDDB
+information, and we tag and add comments with Latin1 encoding.
+.TP
 .B \-v
 Show the version and exit
 .TP
 .B \-V
 Be a bit more verbose. On slow networks the CDDB requests might give the
-sensation nothins is happening.
+sensation nothing is happening.
 .TP
 .B \-x
 Eject the CD when all tracks have been read. See the EJECTCD configuration
 variable.
 .TP
+.B \-X [cue2discid]
+Use an alternative "cue2discid" implementation. The name of the binary must be
+exactly that. abcde comes with an implementation in python under the examples
+directory. The special keyword "builtin" forces the usage of the internal
+(default) implementation in shell script.
+.TP
 .B \-w [comment]
 Add a comment to the tracks ripped from the CD.
 .TP
 .B \-W [number]
 Concatenate CD\'s. It uses the number provided to define a comment "CD #" and
-to modify the numbering of the tracks, starting with "#01".
+to modify the numbering of the tracks, starting with "#01". For Ogg/Vorbis and 
+FLAC files, it also defines a DISCNUMBER tag.
+.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
@@ -172,13 +221,13 @@ 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 appropiate flags at runtime.
+The configuration options stated on those files can be overridden by providing
+the appropriate flags at runtime.
 .TP
 The configuration variables have to be set as follows:
 .TP
@@ -192,9 +241,19 @@ 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 establish a conversation with the server for information retrieval.
+.TP
 .B CDDBURL
 Specifies a server to use for CDDB lookups.
 .TP
+.B CDDBPROTO
+Specifies the protocol version used for the CDDB retrieval of results. Version
+6 retrieves CDDB entries in UTF-8 format.
+.TP
 .B HELLOINFO
 Specifies the Hello information to send to the CDDB server. The CDDB
 protocol requires you to send a valid username and hostname each time you
@@ -206,11 +265,29 @@ 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). STILL NOT WORKING!!
+.TP
 .B CDDBCOPYLOCAL
 Store local copies of the CDDB entries under the $CDDBLOCALDIR directory.
 .TP
 .B CDDBUSELOCAL
-Actually use the stored copies of the CDDB entries. Can be overriden using the 
+Actually use the stored copies of the CDDB entries. Can be overridden using the 
 "-L" flag (if is CDDBUSELOCAL in "n"). If an entry is found, we always give 
 the choice of retrieving a CDDB entry from the internet.
 .TP
@@ -242,6 +319,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,
@@ -260,7 +341,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
@@ -277,18 +358,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,
+CUE2DISCID (see option "\-X"), 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
@@ -319,31 +402,35 @@ 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
-OUTPUTFORMAT is set to.
+Just like OUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${TRACKNUM}.${ARTISTFILE}-${TRACKFILE}'
+.TP
+.B ONETRACKOUTPUTFORMAT
+Just like OUTPUTFORMAT but for single-track rips (see option "\-1"). The default is '${ARTISTFILE}-${ALBUMFILE}/${ALBUMFILE}'
+.TP
+.B VAONETRACKOUTPUTFORMAT
+Just like ONETRACKOUTPUTFORMAT but for Various Artists discs. The default is 'Various-${ALBUMFILE}/${ALBUMFILE}'
 .TP
 .B MAXPROCS
 Defines how many encoders to run at once. This makes for huge speedups
@@ -438,7 +525,7 @@ Possible ways one can call abcde
 Will work in most systems
 .TP
 .B abcde \-d /dev/cdrom2
-If the CDROM you are reding from is not the standard /dev/cdrom (in GNU/Linux systems)
+If the CDROM you are reading from is not the standard /dev/cdrom (in GNU/Linux systems)
 .TP
 .B abcde \-o vorbis,flac
 Will create both Ogg/Vorbis and Ogg/FLAC files.
@@ -453,12 +540,12 @@ For double+ CD settings: will create the 1st CD starting with the track number
 and so on.
 .TP
 .B abcde \-d singletrack.flac
-Will extract the files contained in singletrack using the embeded cuesheet.
+Will extract the files contained in singletrack using the embedded cuesheet.
 .SH BACKEND TOOLS
 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)
@@ -467,7 +554,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.
@@ -476,7 +563,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.
@@ -488,16 +578,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 <rcw@debian.org>,
 Jesus Climent <jesus.climent@hispalinux.es> and contributions from many others.