Drop taint mode
[app-musicexpo.git] / musicexpo
index c408bb4ff3013e8bde3453551ad51501c922a7ef..a687c4d6af8b2b4eac853bee9e3afd5c78088c0d 100755 (executable)
--- a/musicexpo
+++ b/musicexpo
@@ -1,4 +1,4 @@
-#!/usr/bin/perl -wT -CSDA
+#!/usr/bin/perl -w -CSDA
 use v5.14;
 
 use App::MusicExpo;
@@ -7,17 +7,19 @@ App::MusicExpo->run;
 
 __END__
 
+=encoding utf-8
+
 =head1 NAME
 
 musicexpo - script which generates a HTML table of music tags
 
 =head1 SYNOPSIS
 
-    # Creates a table with the songs a.mp3 and b.flac using the template 'index.tmpl' and caching the tags in the file 'cache.db'. The download links point to /music/a.mp3 and /music/b.mp3
+    # Creates a table with the songs a.mp3 and b.flac using the default template and without caching. The download links point to /music/a.mp3 and /music/b.mp3
     musicexpo a.mp3 b.flac
 
-    # Disables caching, and the download links point to /download/a.flac, /download/b.flac, /download/c.flac
-    musicexpo --no-caching --prefix /download/ my/music/a.flac my/music/b.flac othermusic/c.flac
+    # Caches to 'cache.db', and the download links point to /download/a.flac, /download/b.flac, /download/c.flac
+    musicexpo --cache 'cache.db' --prefix /download/ my/music/a.flac my/music/b.flac othermusic/c.flac
 
     # Caches into /tmp/musicexpocache and uses directory/file.tmpl as template
     musicexpo --cache /tmp/musicexpocache --template directory/file.tmpl my-music/*.mp3
@@ -32,7 +34,10 @@ The default template looks like:
     |---------+---------+-----------------+---------+-------+------+------|
     | Cellule | Silence | L'autre endroit | Electro | 01/09 | 2005 | FLAC |
 
-where the title is a download link.
+where the title is a download link. If you have multiple files with the same
+basename (such as C<cellule.flac> and C<cellule.ogg>), they will be treated
+as two versions of the same file, so a row will be created with two download
+links, one for each format.
 
 =head1 OPTIONS
 
@@ -40,7 +45,7 @@ where the title is a download link.
 
 =item B<--template> I<template>
 
-Path to the HTML::Template::Compiled template used for generating the music table. Defaults to 'index.tmpl'.
+Path to the HTML::Template::Compiled template used for generating the music table. If '' (empty), uses the default format. Is empty by default.
 
 =item B<--prefix> I<prefix>
 
@@ -48,11 +53,7 @@ Prefix for download links. Defaults to '/music/'.
 
 =item B<--cache> I<filename>
 
-Path to the cache file. Created if it does not exist. Defaults to 'cache.db'
-
-=item B<--caching>, B<--no-caching>
-
-Enables or disables caching. Defaults to B<--caching>
+Path to the cache file. Created if it does not exist. If '' (empty), disables caching. Is empty by default.
 
 =back
 
@@ -67,4 +68,3 @@ Copyright (C) 2013 by Marius Gavrilescu
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself, either Perl version 5.14.2 or,
 at your option, any later version of Perl 5 you may have available.
-
This page took 0.010342 seconds and 4 git commands to generate.