Improve musicexpo POD
[app-musicexpo.git] / musicexpo
1 #!/usr/bin/perl -wT -CSDA
2 use v5.14;
3
4 use App::MusicExpo;
5
6 App::MusicExpo->run;
7
8 __END__
9
10 =head1 NAME
11
12 musicexpo - script which generates a HTML table of music tags
13
14 =head1 SYNOPSIS
15
16 # 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
17 musicexpo a.mp3 b.flac
18
19 # Caches to 'cache.db', and the download links point to /download/a.flac, /download/b.flac, /download/c.flac
20 musicexpo --cache 'cache.db' --prefix /download/ my/music/a.flac my/music/b.flac othermusic/c.flac
21
22 # Caches into /tmp/musicexpocache and uses directory/file.tmpl as template
23 musicexpo --cache /tmp/musicexpocache --template directory/file.tmpl my-music/*.mp3
24
25 =head1 DESCRIPTION
26
27 musicexpo creates a HTML table from a list of songs.
28
29 The default template looks like:
30
31 | Title | Artist | Album | Genre | Track | Year | Type |
32 |---------+---------+-----------------+---------+-------+------+------|
33 | Cellule | Silence | L'autre endroit | Electro | 01/09 | 2005 | FLAC |
34
35 where the title is a download link. If you have multiple files with the same
36 basename (such as C<cellule.flac> and C<cellule.ogg>), they will be treated
37 as two versions of the same file, so a row will be created with two download
38 links, one for each format.
39
40 =head1 OPTIONS
41
42 =over
43
44 =item B<--template> I<template>
45
46 Path to the HTML::Template::Compiled template used for generating the music table. If '' (empty), uses the default format. Is empty by default.
47
48 =item B<--prefix> I<prefix>
49
50 Prefix for download links. Defaults to '/music/'.
51
52 =item B<--cache> I<filename>
53
54 Path to the cache file. Created if it does not exist. If '' (empty), disables caching. Is empty by default.
55
56 =back
57
58 =head1 AUTHOR
59
60 Marius Gavrilescu, E<lt>marius@ieval.roE<gt>
61
62 =head1 COPYRIGHT AND LICENSE
63
64 Copyright (C) 2013 by Marius Gavrilescu
65
66 This library is free software; you can redistribute it and/or modify
67 it under the same terms as Perl itself, either Perl version 5.14.2 or,
68 at your option, any later version of Perl 5 you may have available.
This page took 0.024401 seconds and 4 git commands to generate.