.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH IGAL 1 "AUGUST 2000" "Version 1.2" "Version 1.2"

.SH NAME
igal \- online Image GALlery generator
.SH SYNOPSIS
.B igal 
.I [-option1 -option2 ...]
.SH DESCRIPTION
.B igal
is a quick, easy and flexible program meant to help you place your
digital images online.  It generates a pretty good-looking set of HTML
slides even with its default settings.  To try it out just run 
.B igal 
in a directory with
.IR png ", " jpg " or " gif
files and check the output in a web 
browser.  You can further tweak the appearance of your slides with
the options listed below or (if you know a bit of HTML) by modifying
the
.IR ".indextemplate.html " and " .slidetemplate.html"
files that appeared in your image directory.

.SH OPTIONS
.TP
.BI -h
Display brief help, same as
.BR "--help" .
.TP
.BI -d " <dir>"
Operate on image files in directory
.IR <dir> ,
which is also where the HTML and thumbnail files will be generated.
The default is the current directory.
.TP
.BI -y " <n>"
Scale all thumbnails to the same height
.IR <n> .
The default is 75 pixels.
.TP
.BI -w " <n>"
Set the thumbnail rows to be
.I <n>
images wide in the main index file.  Default is 5.
.TP
.BI -b " <n>"
The 6-digit hexadecimal color code of the thumbnail table background
in the main index page.  Default is 000000 (black).
.TP
.BI -p " <n>"
The cellpadding value of the thumbnail index tables.
The default is 3.
.TP
.BI -t " <n>"
Height (in pixels) of the tiled image used to simulate the top
and bottom "film reel" effect on the thumbnail index page.  This
is 28 for the default
.I .tile.gif
image used, but you should set it otherwise if you replace that
file with your own design.
.TP
.BI -i " <file>"
Name of the main thumbnail index file.  The default is
.IR index.html ,
as desirable for most web servers.
.TP
.BI -e " <ext>"
Operate only on image files with extension 
.IR <ext> .
If this isn't specified
.B igal
loads all
.IR png ", " jpg " and " gif
files it finds in the specified directory.
Note that 
.IR jpg " and " jpeg " are equivalent and the"
file extension is also case-insensitive.
.TP
.BI -c
First generate and then publish image slide captions. The first invocation of
.B igal -c
generates a
.I .captions
file that you may edit.  The format of this file is very simple.
You should only have to enter your captions after the
.I ----
separator.  You may rearrange the image order at this point and 
also leave out some pictures by simply placing a pound
.RI ( # )
sign at the beginning of their respective lines.  A second invocation of
.B igal -c
will read your
.I .captions
file, include your captions in the slides and rearrange them if necessary.
.TP
.BI -C
.RI Like " -c"
but preserve file names as captions when generating the
.IR .captions " file."
.TP
.BI -f
Force thumbnail regeneration.
.TP
.BI -n
Use the image file names for the HTML slide files.  Otherwise
the default behavior is to simply name your slides
.IR 1.html ", " 2.html ", "
and so on.
.TP
.BI -k
Use the image captions for the HTML slide titles.
The default behavior is to use the image names.
.TP
.BI -x
Omit the image count from the captions.
.TP
.BI -r
Omit the film reel effect altogether.  For a simple look you
may also want to try setting the thumbnail background to be the
same as the main index page background with the
.B -b
switch.
.TP
.B -s
For the simplest setup, omit all HTML slides.  Clicking the thumbnails on 
the main page will just take users to the plain image files.
.TP
.BI -q " <n>"
Set the percentage quality used when resizing JPG or PNG images to
create thumbnails and slides.  The default is 60.
.TP
.B -a
Write image dimensions and sizes (in kbytes) under each thumbnail
on the index page.
.TP
.B --ad
Like
.I -a
but write only the image dimensions.
.TP
.B --as
Like
.I -a
but write only the image sizes (in kbytes).
.TP
.BI --bigy " <n>"
Like
.B -y
but shrink image slides on the fly (useful if your digital camera
spews out large image files).  Scaled copies of your images are stored
with the 
.I ".slide"
prefix and thumbnails link to these copies.  Clicking on the scaled
copies in the HTML slides lets users see the full unscaled images.
.TP
.BI --xy " <n>"
Scale thumbnails to
.I <n>
pixels along their longest dimension.  This value is passed to
.B "pnmscale -xysize"
and only works properly for
.I jpg
images.
.TP
.BI --www
Make all
.B igal
files world-readable.
.TP
.BI --help
Display brief help, same as
.BR "-h" .
.SH FILES
.I /usr/local/lib/igal/indextemplate.html
.RS
The default index template file.
.RE
.I /usr/local/lib/igal/slidetemplate.html
.RS
The default file used to generate slides.
.RE
.I /usr/local/lib/igal/tile.gif
.RS
The tiled image used for the "film reel" effect.
.RE
All three files are copied to your image directory as dotfiles the
first time you run
.BR igal .
Modify the local copies (but keep their names) if you need to further 
alter the appearance of your slide show (also see
.BR "-t" ")."
.RE
As of version 1.2
.B igal
also checks for the existence of a
.I "$HOME/.igal"
directory where users can store their own templates, overriding
the site-wide 
.IR "/usr/local/lib/igal" .
.SH EXAMPLES
Run
.B igal
in a directory with 
.IR png ", " jpg " or " gif
images to see what it does.  Then
play with the options described above and use
.B -h
if you need a quick listing.  Also see
.I http://www.stanford.edu/~epop/igal
for online examples.
.SH BUGS
None that I know of.
.RE
But if you find some please send me email.
.SH AUTHOR
Eric Pop <epop@stanford.edu>
.SH "SEE ALSO"
.BR cjpeg (1),
.BR djpeg (1),
.BR pnmscale (1),
.BR identify (1),
.BR mogrify (1)
.RE
If they didn't come standard with your Linux distribution
you can find them at
.I rpmfind.net
(inside libjpeg and libgr-progs) and at 
.IR "imagemagick.org" ,
respectively.  Also try
.I www.ijg.org
and
.IR "netpbm.sourceforge.net" .