summaryrefslogtreecommitdiff
path: root/bin/dthumb
blob: f3eb2cd6b2f367b3f11552a4c0c361d692ebc094 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
#!/usr/bin/perl
# Copyright © 2009,2010 by Daniel Friesel <derf@derf.homelinux.org>
# License: WTFPL <http://sam.zoy.org/wtfpl>
use strict;
use warnings;
use autodie;

use App::Dthumb;
use Getopt::Long qw(:config no_ignore_case);

my $opt = {};

GetOptions(
	$opt,
	qw{
		help|h
		size|d=i
		spacing|s=f
		no-lightbox|L
		no-names|n
		quality|q=i
		version|v
	},
) or die("Please see perldoc -F $0\n");

my $dthumb = App::Dthumb->new($opt);

$dthumb->run();

__END__

=head1 NAME

dthumb - Generate Thumbnails + Index for a set of images

=head1 SYNOPSIS

B<dthumb> [I<options>]

=head1 DESCRIPTION

dthumb will create an F<index.xhtml> with a list (thumbnails) of
all images found in the current directory; the thumbnails will link to the
images.

Note that recursion is not yet supported.

During operation, B<dthumb> will show its progress on STDERR.

=head1 OPTIONS

=over

=item B<-L>, B<--no-lightbox>

Disable Javascript lightbox.  Note that in the current implementations, this
simple skips installation of the data files.  The lightbox link in the HTML
will still be written, leading to 404s on the server.  This will be fixed.

=item B<-n>, B<--no-names>

Do not show image names below thumbnails

=item B<-d>, B<--size> I<pixels>

Maximum thumbnail size (either width or height).  Defaults to 200

=item B<-s>, B<--spacing> I<float>

Use I<float> as spacing factor.
The size of each image element (image + possible border around it) is the
number of pixels (see --size) times I<float>.
So for B<1.1> you have a small border around each image, for B<1.0> you have
no border at all, etc.

=item B<-q>, B<--quality> I<int>

Set thumbnail quality.
Accepts values between 0 and 100, where 100 is the highest possible quality

=back

=head1 EXIT STATUS

Zero upon success, non-zero otherwise.

=head1 CONFIGURATION

None.

=head1 FILES

B<dthumb> always works in the current working directory.  It will create the
file F<index.xhtml>, in which the HTML code for the thumbnail list is saved.

It also creates two directories: F<.thumbs> for the thumbnail images, and
F<.dthumb>, which contains various data (so far icons and javascript code).

=head1 DEPENDENCIES

=over

=item * autodie (Included in core as of perl 5.10.1)

=item * Data::Section

=item * Image::Imlib2

=item * Time::Progress

=back

=head1 BUGS AND LIMITATIONS

Thumbnails of changed images are not yet recreated.

=head1 AUTHOR

Copyright (C) 2009, 2010 by Daniel Friesel E<lt>derf@chaosdorf.deE<gt>

The lightbox code is (C) by Lokesh Dhakar
E<lt>http://huddletogether.com/projects/lightbox/E<gt>, licensed under
CC-BY-2.5

=head1 LICENSE

    0. You just DO WHAT THE FUCK YOU WANT TO