source: mp3-find/trunk/README

Last change on this file was 42, checked in by peter, 13 years ago

incremented version to 0.07

File size: 2.2 KB
Line 
1MP3::Find version 0.07
2======================
3
4DESCRIPTION
5    This module allows you to search for MP3 files by their ID3 tags. You
6    can ask for the results to be sorted by one or more of those tags, and
7    return either the list of filenames (the deault), a "printf"-style
8    formatted string for each file using its ID3 tags, or the actual Perl
9    data structure representing the results.
10
11    There are currently two backends to this module: MP3::Find::Filesystem
12    and MP3::Find::DB. You choose which one you want by passing its name as
13    the argument to you "use" statement; MP3::Find will look for a
14    MP3::Find::$BACKEND module. If no backend name is given, it will default
15    to using MP3::Find::Filesystem.
16
17    Note: I'm still working out some kinks in the DB backend, so it is
18    currently not as stable as the Filesystem backend.
19
20    Note the second: This whole project is still in the alpha stage, so I
21    can make no guarentees that there won't be significant interface changes
22    in the next few versions or so. Also, comments about what about the API
23    rocks (or sucks!) are appreciated.
24
25INSTALL
26    To install this module type the following:
27
28        perl Makefile.PL
29        make
30        make test
31        make install
32
33SYNOPSIS
34        # select with backend you want
35        use MP3::Find qw(Filesystem);
36   
37        print "$_\n" foreach find_mp3s(
38            dir => '/home/peter/cds',
39            query => {
40                artist => 'ilyaimy',
41                title => 'deep in the am',
42            },
43            ignore_case => 1,
44            exact_match => 1,
45            sort => [qw(year album tracknum)],
46            printf => '%2n. %a - %t (%b: %y)',
47        );
48
49REQUIRES
50    File::Find, MP3::Info, and Scalar::Util are needed for the filesystem
51    backend (MP3::Find::Filesystem). In addition, if MP3::Tag is available,
52    you can search by explicit ID3v2 tag frames.
53
54    DBI, DBD::SQLite, and SQL::Abstract are needed for the database backend
55    (MP3::Find::DB).
56
57COPYRIGHT AND LICENSE
58    Copyright (c) 2006 by Peter Eichman. All rights reserved.
59
60    This program is free software; you can redistribute it and/or modify it
61    under the same terms as Perl itself.
62
Note: See TracBrowser for help on using the repository browser.