musicfix

music file renamer and tagger
git clone git://git.2f30.org/musicfix.git
Log | Files | Refs | README | LICENSE

commit a65c221b07db359900561190dbbd7060e462b128
parent fa42e8465c60b5654969fca86ad857e78ef57559
Author: lostd <lostd@2f30.org>
Date:   Tue Jan  1 15:53:56 +0000

Better document usage and configuration

Diffstat:
README | 65+++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 57 insertions(+), 8 deletions(-)
diff --git a/README b/README @@ -2,14 +2,23 @@ Musicfix is a music file renamer and tagger with consistency concerns. It has a release-centered logic and gets data from the Discogs.com site. -First configure the target music directory (mdir variable). +First configure the target music directory (`mdir` config attribute). Next browse the site and locate your album. Change to the album's directory. Ensure the files are ordered and provide the release id to the program. Enjoy! -The simplest `~/.musicfix` configuration file would contain: - mdir: ~/music +# Dependencies + + * System packages: taglib + * Ruby gems: discogs-wrapper stringex taglib-ruby + + +# Usage + + $ musicfix relid [tracks] + $ musicfix dump relid [relfile] + $ musicfix load [relfile] More sophisticated track selection can be performed by providing a second command line argument of the form: @@ -20,15 +29,55 @@ a second command line argument of the form: Alternatively, YAML metadata files can be used (`release.yaml` by default) in order to dump information from Discogs.com and/or load the information -from file. To generate a base metadata file for your release simply do: +from file. This way you can generate a base release file, edit to +your needs, and then use it for tagging and renaming. - $ musicfix dump relid -# Dependencies - * System packages: taglib - * Ruby gems: discogs-wrapper stringex taglib-ruby +# Configuration + +The simplest `~/.musicfix` configuration file only contains: + + mdir: ~/music + +Furthermore, templates are used for the naming of music files +and the cover artwork image. The defaults are: + + track: '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{d}#{fn}-#{fa}-#{ft}.#{x}"' + image: '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{zz}-#{fba}-#{fb}_cover.jpg"' + +To run a shell command upon completion use the `after` attribute. +For example, to update the MPD database: + + after: '"mpc update #{fba}-#{my}-#{fb}-#{fv}"' + +The variables used in the templates are explained below. +The 'f' prefix means "normalized for filename". + +Use everywhere: + + [f]b: album name + [f]ba: album artist + y: release year + my: master release year + g: genre style + [f]v: release format + +Only for track naming: + + [f]a: track artist + [f]t: track title + [f]n: track number, may have letters (vinyls) + d: disc number + tn: track number counter + x: file extension in lowercase + +Only for image naming: + + zz: zeros that match d + n width + # Some test releases + * Sound, The (2) – From The Lions Mouth: 377432 * Various – Return Of The Banshee: 127565 * Harold Budd & Brian Eno – The Pearl: 699395