add --help option
[mkgallery.git] / README
1   $Id$
2
3   README document for mkgallery script
4
5   Copyright (c) 2006 Eugene G. Crosser
6
7   This software is provided 'as-is', without any express or implied
8   warranty.  In no event will the authors be held liable for any damages
9   arising from the use of this software.
10
11   Permission is granted to anyone to use this software for any purpose,
12   including commercial applications, and to alter it and redistribute it
13   freely, subject to the following restrictions:
14
15   1. The origin of this software must not be misrepresented; you must not
16      claim that you wrote the original software. If you use this software
17      in a product, an acknowledgment in the product documentation would be
18      appreciated but is not required.
19   2. Altered source versions must be plainly marked as such, and must not be
20      misrepresented as being the original software.
21   3. This notice may not be removed or altered from any source distribution.
22
23 mkgallery.pl traverses directory tree starting from current directory
24 downwards, and in each directory creates an index.html file with the
25 list of subdirectories and the list of image files in the directory.
26 Fielsystem objects starting with '.' are not processed.  For every
27 directory, a file ".title" is checked, and created if absent, with the
28 title for this album.  Two subdirectories are created with scaled down
29 versions of the images: ".640" and ".160", and a direcotory named ".html"
30 containging slideshow pages (and info pages for non-javascript clients).
31
32 For the thing to work, you must create a subdirectory named ".include"
33 at the root of your image gallery, or somewhere upstairs in the
34 document tree, and put there files from the subdirectory "include"
35 of this distribution.  Then, chdir to the root of your gallery and run
36 "mkgallery.pl" script.  First time, you will be asked to enter titles
37 for all subdirectories ("Albums"); if you wish to recreate the titles,
38 remove ".title" files or specify "--asktitles".  If you *don't* want
39 "index.html" to be generated in some directory, create a file ".noindex"
40 there.  This way you can preserve index created by hand or by some other
41 script like "mkindex.pl".
42
43 command-line options:
44  --help:        print help message and exit
45  --incpath:     do not try to find .include diretory upstream, use
46                 specified path (absolute or relavive).  Use with causion.
47  --debug:       print a lot of debugging info to stdout as you run
48  --asktitle:    ask to edit album titles even if there are ".title" files
49  --noasktitle:  don't ask to enter album titles even where ".title"
50                 files are absent.  Use partial directory names as titles.
51
52 The only way to specify titles for individual pictures is to write
53 comments into the image files.
54
55 "mkindex.pl" is a simple script that is completely unrelated to the
56 gallery (theoretically).  If your tree starts with YYYY/DD (four
57 digit year and two-digit month), this script will create a compact
58 table with references to individual months, and then a separate list
59 of subdirectories that are not four-digit.
60
61 Requirements:
62 Image::Info
63 Image::Magick (optional. If not present, will run djeg|pnmscale|cjpeg pipe)
64 Term::ReadLine
65
66 Homepage:
67 http://www.average.org/mkgallery/
68
69 TODO:
70 - make index.html depend of .title and directory timestamps
71 - any ideas?
72
73 Eugene Crosser <crosser at average dot org>