mkthumbs

Index


NAME

Top

mkthumbs - Automatic Thumbnails Generator

VERSION

Top

This document describes mkthumbs version 0.1.4

SYNOPSIS

Top

 mkthumbs [options] [start folder]

 # Make 800x600 versions (using profile):
 ./mkthumbs -P 800 /path/to/photo/albums

 # Create thumbnails with the same name as their parent,
 # but in a thumbs folder:
 ./mkthumbs -p thumbs/ /path/to/photo/albums

 # Save all thumbnails outside the original structure,
 # in a structure under /tmp/thumbnails:
 ./mkthumbs -o /tmp/thumbnails /path/to/photo/albums

 # Same as above but cut off /path/to from thumbnails directories:
 ./mkthumbs -c 2 -o /tmp/thumbnails /path/to/photo/albums

 # Make 800x600 versions of some pictures albums:
 ./mkthumbs -d 16 -q 80 -w 800 -h 600 /path/to/photo/albums

DESCRIPTION

Top

mkthumbs tries to create a resized version of all image files found under the requested base folder.

REQUIRED ARGUMENTS

Top

At least one of: suffix, prefix, output. Note that profile may aleviate the call of either of these.

OPTIONS

Top

--help

Display usage information

--profiles

Lists profiles names.

--defaults

Display default values for every option available. This becomes "computed options values" when extra arguments are provided.

-P, --profile profile name

Loads requested profile. Note that the "default" profile is always loaded.

-b, --blur factor

Blur (or sharpen) factor for generated thumbnails. Specify a factor > 1 for blurry or < 1 for sharp

-c, --cut number

Ignore number directory components. This is useful for getting a fine-grained control over the directory where the recursive thumbnails will be saved.

-d, --depth integer

Image depth.

-f, --format format

Desired image format for the generated thumbnails. Use anything Image::Magick can handle.

-h, --height pixels

Maximum height for generated thumbnails.

-l, --filter resize_filter

Image resize filter. Check Image::Magick for more info. Here are the current documented values:

 Point, Box, Triangle, Hermite, Hanning, Hamming,
 Blackman, Gaussian, Quadratic, Cubic, Catrom, Mitchell,
 Lanczos, Bessel, Sinc

--last boolean

Keep last frame from a montage/animation (keeps first frame if false).

-o, --output directory

Put all thumbnails in a directory structure under directory.

-p, --prefix string

Prefix all thumnails names with string

-q, --quality percent

Thumbnails quality, an integer between 0 and 100.

-s, --suffix string

Suffix all thumnails names with string

-t, --type image_type

Image Type. Check Image::Magick for more info. Here are the current documented values:

 Bilevel, Grayscale, GrayscaleMatte, Palette, PaletteMatte,
 TrueColor, TrueColorMatte, ColorSeparation, Optimize
 ColorSeparationMatte

-v, --verbose

Increment verbosity level by providing more -v.

-x, --force

Increment “brute” level by providing more -x.

-w, --width pixels

Maximum width for generated thumbnails.

EXIT STATUS

Top

0

Success. :)

DIAGNOSTICS

Top

TBD

TBD.

CONFIGURATION

Top

mkthumbs requires no configuration files or environment variables.

DEPENDENCIES

Top

File::Find::Rule, File::Find::Rule::MMagic, File::MMagic, Image::Magick

INCOMPATIBILITIES

Top

None reported.

BUGS AND LIMITATIONS

Top

No bugs have been reported.

Please report any bugs or feature requests to <altblue@n0i.net>.

AUTHOR

Top

Marius Feraru <altblue@n0i.net>.

LICENSE AND COPYRIGHT

Top

Copyright (c) 2006, Marius Feraru <altblue@n0i.net>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

Top

Because this software is licensed free of charge, there is no warranty for the software, to the extent permitted by applicable law. Except when otherwise stated in writing the copyright holders and/or other parties provide the software "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the software is with you. should the software prove defective, you assume the cost of all necessary servicing, repair, or correction.

In no event unless required by applicable law or agreed to in writing will any copyright holder, or any other party who may modify and/or redistribute the software as permitted by the above license, be liable to you for damages, including any general, special, incidental, or consequential damages arising out of the use or inability to use the software (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the software to operate with any other software), even if such holder or other party has been advised of the possibility of such damages.