Changeset 6 in mp3-find


Ignore:
Timestamp:
01/31/06 14:43:55 (19 years ago)
Author:
peter
Message:
  • doc clarification for find_mp3s (suggestion fr. Michael Slass)
Location:
trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/Changes

    r3 r6  
    330.01  29 Jan 2006 
    44    - first CPAN release 
     5 
     60.02 
     7    - doc updates (thanks to Michael Slass for the suggestion) 
     8 
  • trunk/lib/MP3/Find.pm

    r3 r6  
    8989=item C<dir> 
    9090 
    91 Where to start the search. This can either be a single string or 
    92 an arrayref. Defaults to your home directory. 
     91Arrayref or scalar; tell C<find_mp3s> where to start the search. 
     92Directories in the arrayref are searched sequentially. 
    9393 
    9494=item C<query> 
     
    9898or lower case; C<find_mp3s> will convert them into upper case for  
    9999you. Value may either be strings, which are converted into regular 
    100 exporessions, or may be C<qr[...]> regular expressions already. 
     100exporessions, or may be C<qr/.../> regular expressions already. 
    101101 
    102102=item C<ignore_case> 
    103103 
    104 Ignore case when matching search strings to the ID3 tag values. 
     104Boolean, default false; set to a true value to ignore case when 
     105matching search strings to the ID3 tag values. 
    105106 
    106107=item C<exact_match> 
    107108 
    108 Adds an implicit C<^> and C<$> around each query string. Does nothing 
    109 if the query is already a regular expression. 
     109Boolean, default false; set to a true value to add an implicit 
     110C<^> and C<$> around each query string. Does nothing if the query 
     111term is already a regular expression. 
    110112 
    111113=item C<sort> 
     
    138140=item C<no_format> 
    139141 
    140 Causes C<find_mp3s> to return an array of hashrefs instead of an array 
    141 of (formatted) strings. Each hashref consists of the key-value pairs 
    142 from C<MP3::Info::get_mp3_tag> and C<MP3::Info::get_mp3_info>, plus 
    143 the key C<FILENAME> (with the obvious value ;-) 
     142Boolean, default false; set to a true value to have C<find_mp3s> to 
     143return an array of hashrefs instead of an array of (formatted) strings. 
     144Each hashref consists of the key-value pairs from C<MP3::Info::get_mp3_tag> 
     145and C<MP3::Info::get_mp3_info>, plus the key C<FILENAME> (with the obvious  
     146value ;-) 
    144147 
    145148    @results = ( 
Note: See TracChangeset for help on using the changeset viewer.