Merged changes for 2.3.99.5
[abcde.git] / abcde.1
diff --git a/abcde.1 b/abcde.1
index 2ca1409..43c2cfd 100644 (file)
--- a/abcde.1
+++ b/abcde.1
@@ -10,7 +10,8 @@ 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
@@ -42,9 +43,9 @@ Repeat until finished
 .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.
-.TP
+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 -M -o
+flac" 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, replaygain, playlist, clean. Normalize
@@ -73,7 +74,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
@@ -127,7 +128,7 @@ endings. Some hardware players insist on having those to work.
 .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
+If the cuesheet is embedded in a flac single file it can be used as source for
 encoding other formats.
 .TP
 .B \-o [filetype][:filetypeoptions]
@@ -169,7 +170,7 @@ 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
+Set CDDBPROTO 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.
@@ -179,7 +180,7 @@ 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
@@ -212,8 +213,8 @@ its compression format, 'vorbis' for '.ogg', '.mp3', '.flac', '.spx', '.mpc', '.
 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 be 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
@@ -231,11 +232,15 @@ Here is a list of options abcde recognizes:
 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.
+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
@@ -263,13 +268,13 @@ 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).
+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
@@ -503,7 +508,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.
@@ -518,7 +523,7 @@ 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