\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename webmagick.info
@settitle WebMagick Image Web Generator
@c Define a new index for options.
@defcodeindex op
@c Define a new index for command-line arguments
@defcodeindex sw
@c Indicate ready for use (no ugly markings)
@finalout
@c %**end of header

@c Before release, run C-u C-c C-u C-a (texinfo-all-menus-update with a
@c prefix arg).  This updates the node pointers, which texinfmt.el needs.

@dircategory WebMagick Image Web Generator
@direntry
* WebMagick: (webmagick.info).          WebMagick Image Web Generator
@end direntry


@ifinfo
This file documents WebMagick, a package which supports making image
collections available on the Web. It recurses through directory trees,
building HTML pages, imagemap files, and client-side/server-side maps to
allow the user to navigate through collections of thumbnail images
(somewhat similar to @code{xv}'s Visual Schnauzer) and select the image to view
with a mouse click.

This work may be used for any purpose, public or private, provided that
this work or derivations thereof are attributed to its original authors.

Copyright @copyright{} 1997-2001 Bob Friesenhahn (bfriesen@@simple.dallas.tx.us)
@end ifinfo

@c Start chapers on new pages
@setchapternewpage on

@titlepage
@c use the new format for titles
@title WebMagick
@subtitle Image Web Generator
@subtitle December 2001 (Version 2.02)

@author by Bob Friesenhahn
@author now maintained by Chris Lindell

@c The following two commands start the copyright page.
@page
@vskip 0pt plus 1filll
Copyright @copyright{} 1997-2001 Bob Friesenhahn (bfriesen@@simple.dallas.tx.us)

@sp 2

This work may be used for any purpose, public or private, provided that
this work or derivations thereof are attributed to its original authors.

@end titlepage

@ifinfo
@node Top, Introduction, (dir), (dir)
@comment node-name,     next,   previous,       up
@top WebMagick

WebMagick is a package which supports making image collections available
on the Web. It recurses through directory trees, building HTML pages,
imagemap files, and client-side/server-side maps to allow the user to
navigate through collections of thumbnail images and select the image to
view with a mouse click.

@end ifinfo

@menu
* Introduction::                WebMagick basics
* General::                     Options that control basic processing
* Directory Paths::             Directory path options
* File Names::                  File name options
* Server-Side Imagemaps::       Server-side imagemap options
* Thumbnail Caching::           Thumbnail caching options
* Montage Options::             Montage (thumbnail page) options
* HTML Options::                HTML generation options
* String Customization::		Customizing (localizing) displayed strings
* Authors::                     WebMagick maintainer and friends
* Obtaining WebMagick::         Where to obtain WebMagick and the
                                packages it requires
* Installation::                Installing WebMagick
* Option Index::                Option variable index
* Argument Index::              Command-line argument index
* Concept Index::               Concept index

 --- The Detailed Node Listing ---

General

* Display Help::                List options
* Source Directory::            Specify source directory
* Verbose Output::              Display progress verbosely
* Debug Output::                Display debug messages
* Sub-Directory Processing::    Control sub-directory processing
* Forcing Output::              Override WebMagick's work avoidance
                                algorithms

Sub-Directory Processing

* Recursion::                   Control recursion into sub-directories
* Prune Directory::             Skip sub-directory and its children
* Ignore Directory::            Skip generating output for directory
* Ignore FrontPage::            Ignore FrontPage directories

Forcing Output To Be Generated

* Force Cache::                 Force cached thumbnails to be updated
* Force HTML::                  Force generated HTML to be updated
* Force Montage::               Force thumbnail montages to be updated

Paths

* URL Computation::             Define how URLs are generated

URL Computation

* Server Root Path::            Location of server's root
* Root Prefix::                 URL prefix to server's root
* Icon Location::               Specify offset to WebMagick icons

File Names

* Icon File Names::             Specify icon and background file names
* Index File Base Name::        Specify base name for visible HTML index
* README File Name::            Specify filename for directory README
* Page Index File Name::        Specify base name for per-page HTML
* Directory Title Xref::        Specify filename that contains directory
                                titles

Server-Side Imagemaps

* Imagemap Program::            Specify URL to server-side imagemap program
* Imagemap Type::               Specify server-side imagemap type

Thumbnail Caching

* Caching::                     Enable thumbnail caching
* Cache Directory::             Specify thumbnail cache directory name
* Cache Thumbnail Format::      Specify thumbnail image format
* Cache Thumnail Geometry::     Specify thumbnail image geometry
* Cache Minimum Image Size::    Specify cross-over point before trying JPEG

Montage Options

* Montage Anatomy::             The Anatomy of a montage
* Montage Geometry::            Specify montage geometry
* Montage Format::              Specify montage format
* Montage Colors::              Specify montage colors
* Thumbnail Imaging::           Specify montage thumbnail imaging options
* Thumbnail Label Options::     Specify montage thumbnail label options
* Thumbnail Hooks::             Specify pre/postprocessing options for
                                thumbnails

Montage Geometry

* Columns::                     Specify montage columns          
* Rows::                        Specify montage rows

Montage Image Format

* GIF/JPEG Transition Point::   Specify GIF/JPEG size transition point
* Force GIF Format::            Always use GIF format for montages

Montage Colors

* Thumb Foreground Color::      Specify thumbnail foreground color
* Thumb Background Color::      Specify thumbnail background color
* Thumb Trans Color::           Specify thumbnail transparent color
* Thumb Frame Color::           Specify thumbnail frame color
* Border Color::                Specify thumbnail border color
* Netscape Color Cube::         Quantize montage to Netscape 216 color cube

Thumbnail Imaging

* Thumb Frame::                 Enable decorative frames around thumbnails
* Thumb Shadows::               Enable decorative shadows under thumbnails
* Border Width::                Specify thumbnail border width
* Thumb Background Texture::    Specify montage background image
* Thumb Geometry::              Specify thumbnail geometry
* Thumb Gravity::               Specify thumbnail placement
* Composition Algorithm::       Specify thumbnail imaging algorithm
* Zoom Filter::                 Specify zoom filter to use for reductions

Thumbnail Label Options

* Thumbnail Title Xref::        Specify thumbnail titles
* Thumb Label Format::          Specify thumbnail label format
* Thumb Label Width::           Specify thumbnail label truncation width
* Thumb Label Font::            Specify thumbnail label font

Thumbnail Processing Hooks

* Read Fail Hook::              Specify image read-failure hook
* Thumb Post Hook::             Specify thumbnail pre-processing hook
* Thumb Pre Hook::              Specify thumbnail post-processing hook

HTML Options

* HTML Content::                Specify HTML page contents
* Text Colors::                 Specify HTML text colors
* HTML Link Colors::            Specify HTML link colors
* Frame Options::               Specify frame options
* Meta Tags::                   Specify HTML meta tags

HTML Content

* Allow Configuration::         Allow user configuration
* JavaScript Mode::             Enable JavaScript output
* Table Mode::                  Use tables instead of imagemaps
* README File Treatment::       Control README file visibility
* Address Info::                Specify an address field
* Anonymize::                   Protect the author's reputation
* Page Header::                 Specify HTML page header
* Page Title::                  Specify HTML page title
* Stylesheet::                  Specify a URL to a Cascading Style Sheet
* Dir Page Fmt (No Frames)::    Directory page template (unframed)
* Dir Page Fmt (Framed)::       Directory page template (framed)
* Per-Image HTML::              

Per-Image HTML

* Enable Per-image HTML::       
* Per-image HTML extension::    
* Per-image HTML Nav Buttons::
* Per-image Picture Title::   
* Per-image Picture Title Start HTML::
* Per-image Picture Title End HTML::   
* Default Frame Target::        
* Extra Top HTML::              
* Extra Bottom HTML::           

Text Colors

* Thumb Background::            Specify thumbnail page background color
* Thumb Foreground::            Specify thumbnail page foreground color
* Dir Foreground Color::        Specify directory page foreground color
* Dir Background Color::        Specify directory page background color

HTML Link Colors

* Thumb Active Link Color::     Specify thumbnail page active link color
* Thumb Un-visited Color::      Specify thumbnail page un-visited link color
* Thumb Visited Color::         Specify thumbnail page visited link color
* Dir Active Color::            Specify directory page active link color
* Dir Un-Visited Color::        Specify directory page un-visited link color
* Dir Visited Color::           Specify directory page visited link color

Frame Options

* Frames::                      Enable frames
* Frame Borders::               Enable frame borders
* Frame Border Thickness::      Specify frame border thickness
* Frame Margin Height::         Specify frame margin height
* Frame Margin Width::          Specify frame margin width
* Frame Style::                 Specify frame style (layout)

HTML Meta Tags

* Meta Author::                 Specify AUTHOR meta-tag
* Meta Charset::                Specify CHARSET meta-tag
* Meta Classification::         Specify CLASSIFICATION meta-tag
* Meta Description::            Specify DESCRIPTION meta-tag
* Meta Expires::                Specify EXPIRES meta-tag
* Meta Key-Words::              Specify KEYWORDS meta-tag


Installing WebMagick

* Basic Installation::          
* Installation Names::          
@end menu

@node Introduction, General, Top, Top
@comment node-name,     next,   previous,       up
@chapter Introduction

WebMagick creates HTML index files and imagemaps corresponding
to a directory of image files. WebMagick is ideal for making
large image collections available on the net or for just using your Web
browser for browsing images.

Configuration options are derived from either the command line (options
prefixed with '-', '--', or '+'), configuration file ($opt_ options), or
internal defaults ($opt_ options). Some arguments (like X11 font
specifications) seem to confuse PERL's getopt function. When this
happens, try using the syntax @code{--option=arg} to avoid any confusion
caused by a space.

The default configuration file name is @file{.webmagickrc}.
Configuration files are written in PERL syntax and are sourced via
PERL's eval statement. When WebMagick is executed, it first
reads files listed in the @@global_option_files array
(@file{/etc/webmagickrc} and @file{$HOME/.webmagickrc} by default). When
a directory is processed, WebMagick will process any
@file{.webmagickrc} files found in the path from the server's root
directory (specified by @code{$opt_rootpath} (@pxref{Server Root Path})) to the
directory being processed. All configuration options are additive.

@sp 1
@noindent
Evaluation order (inverse of precedence) is as follows :
@cindex .webmagickrc evaluation order

@enumerate
@item
Files listed in @@global_option_files

(default @file{/etc/webmagickrc} and @file{$HOME/.webmagickrc})

@item
Command line options

@item
Per directory .webmagickrc files.

Webmagickrc files are evaluated in path order from server root to
current directory. This allows sub-directories to "inherit" the
configuration of parent directories.
@end enumerate

@noindent
Each directory is processed with items 1 & 2 already complete.
@sp 1

In general, WebMagick's defaults produce nice output. However,
the options @code{$opt_prefixpath} (@pxref{Root Prefix}), @code{$opt_rootpath}
(@pxref{Server Root Path}), @code{$opt_iconpath} (@pxref{Icon Location}),
@code{$opt_htimage} (@pxref{Imagemap Program}), and @code{$opt_maptype}
(@pxref{Imagemap Type}) must be configured on a per-site basis so please
read the documentation on these options and perform the required
configuration before executing the program.

A key configuration/installation issue is that WebMagick depends on the
image files being on the same filesystem as the icons. The reason for
this limitation is that this allows WebMagick to determine the
mapping between the physical disk and the server's URLs. If someone
knows a better algorithm than this one, please let the author know.

By default the output files of WebMagick for the first page are
as follows (second page replace '1' with '2', etc.):

@table @code
@item index.html
Main (default server index) HTML index file.

@item indexjs.html
Javascript master index file (name currently hard-coded).

@item .cache
Thumbnail cache directory

@item .indexdir.html
HTML page that displays directory frame

@item .indexjs.html
HTML file to load JavaScript source into browser.

@item .index.pl
WebMagick status file (in PERL format). Re-generated per run. May be
used by other programs to produce additional HTML output.

@item .index.js
JavaScript variables file (similar to status file but in JavaScript).

@item .index1.html
HTML page that displays thumbnail frame

@item .index1.gif
Montaged images (thumbnails) in GIF format

@item .index1.jpg
Montaged images (thumbnails) in JPEG format

@item .index1.map
Server-side imagemap (clickable map) file

@end table

@node General, Directory Paths, Introduction, Top
@chapter General

@menu
* Display Help::                List options
* Source Directory::            Specify source directory
* Verbose Output::              Display progress verbosely
* Debug Output::                Display debug messages
* Sub-Directory Processing::    Control sub-directory processing
* Forcing Output::              Override WebMagick's work avoidance
                                algorithms
@end menu

@node Display Help, Source Directory, General, General
@section Display Help
@cindex help
@opindex $opt_help
@swindex --help

@table @code
@item Variable:
@code{$opt_help=1}
@item Argument:
@code{--help}
@end table

Display usage message.

@node Source Directory, Verbose Output, Display Help, General
@section Specify Source Directory
@cindex directory, specification
@opindex $opt_srcdir
@swindex --srcdir

@table @code
@item Variable:
$opt_srcdir=path
@item Argument:
--srcdir path
@end table

Image directory to process or start recursion at (default current
directory). Specify this option (usually on the command line) if the
directory you want to process is not the current directory.  This simply
causes WebMagick to change directories before starting
processing.

@node Verbose Output, Debug Output, Source Directory, General
@section Enable Verbose Output
@cindex verbose
@opindex $opt_verbose
@swindex --verbose

@table @code
@item Variable:
$opt_verbose=1
@item Argument:
--verbose
@end table

Normally WebMagick prints only the directory names for
directories it processes. Selecting the verbose option displays the
number of images and sub-directories in the directory as well as the
number of pages to be generated, and the current page number.  It will
also show the current image index WebMagick is currently
creating as a progress report.

@node Debug Output, Sub-Directory Processing, Verbose Output, General
@section Enable Debug Output
@cindex debugging
@opindex $opt_debug
@swindex --debug

@table @code
@item Variable:
$opt_debug=1
@item Argument:
--debug
@end table
 
Print debugging messages.

@node Sub-Directory Processing, Forcing Output, Debug Output, General
@section Sub-Directory Processing

@menu
* Recursion::                   Control recursion into sub-directories
* Prune Directory::             Skip sub-directory and its children
* Ignore Directory::            Skip generating output for directory
* Ignore FrontPage::            Ignore FrontPage directories
@end menu

@node Recursion, Prune Directory, Sub-Directory Processing, Sub-Directory Processing
@subsection Recurse Sub-Directories
@cindex recurse
@opindex $opt_recurse
@swindex --recurse

@table @code
@item Variable:
$opt_recurse=1
@item Argument:
--recurse
@end table

Recurse directory tree (default off). The default is to only process the
current directory, generating appropriate links for sub-directories and
the parent directory. Selecting this option causes WebMagick to
recurse through sub-directories as well.

@node Prune Directory, Ignore Directory, Recursion, Sub-Directory Processing
@subsection Prune Directory
@cindex directory, prune
@opindex $opt_prune

@table @code
@item Variable:
$opt_prune=1
@end table

If @code{$opt_prune} is set in a directory's @file{.webmagickrc} file (default
off), then sub-directories below that directory will not be processed by
WebMagick when operating in the recursive mode.
@xref{Ignore Directory,$opt_ignore}, for details on how to skip a
directory rather than prune it.


@node Ignore Directory,Ignore FrontPage, Prune Directory, Sub-Directory Processing
@subsection Ignore Directory
@cindex directory, skip

@table @code
@item Variable:
$opt_ignore=1
@end table

If @code{$opt_ignore} is set in a directory's @file{.webmagickrc} file (default
off), then that directory will not be processed (but will still be
linked to). If recursion is enabled, then recursion will continue into
any sub-directories. This provides support for subdirectories with HTML
files which are generated by other means.  also @code{$opt_indexname}.

@node Ignore FrontPage,  , Ignore Directory, Sub-Directory Processing
@subsection Ignore FrontPage
@cindex directory, skip
@opindex $opt_ignorefp
@swindex --ignorefp


@table @code
@item Variable:
$opt_ignorefp=1
@item Argument:
--ignorefp
@end table

If @code{$opt_ignorefp} is used, sub-directories with names like _vti_bin
will be ignored. MS FrontPage creates these directories which begin with 
an underscore followed by a lowercased letter (_[a-z]).


@node Forcing Output,  , Sub-Directory Processing, General
@section Forcing Output To Be Generated
@cindex force
@cindex override

WebMagick uses algorithms similar in concept to those used by
@code{make} to try to only do required processing.  Occasionally due to
modification of a parameter that WebMagick doesn't track or due
to external modification of file modification times, WebMagick will skip
doing an update that it should have done. In these cases, options are
provided to force WebMagick to perform a task.

@menu
* Force Cache::                 Force cached thumbnails to be updated
* Force HTML::                  Force generated HTML to be updated
* Force Montage::               Force thumbnail montages to be updated
@end menu

@node Force Cache, Force HTML, Forcing Output, Forcing Output
@subsection Force Generation Of Thumbnail Cache
@cindex cache, force generation of
@opindex $opt_forcecache
@swindex --forcecache

@table @code
@item Variable:
$opt_forcecache=1
@item Argument:
--forcecache
@end table

Force cache files to be generated (default off).  Without this option,
WebMagick will only re-generate cache files if the source file
is newer.  In order for this option to take effect, a montage must be
generated and @code{$opt_cache} must be set to a non-zero value.  The
--forcemontage option be used to force montages.

@node Force HTML, Force Montage, Force Cache, Forcing Output
@subsection Force Generation Of HTML Files
@cindex HTML, force generation of
@opindex $opt_forcehtml
@swindex --forcehtml

@table @code
@item Variable:
$opt_forcehtml=1
@item Argument:
--forcehtml
@end table

Force HTML files to be generated (default off).  Without this option,
WebMagick will only re-generate HTML files as required.

@node Force Montage,  , Force HTML, Forcing Output
@subsection Force Generation Of Montage
@cindex montage, force generation of
@opindex $opt_forcemontage
@swindex --forcemontage

@table @code
@item Variable:
$opt_forcemontage=1
@item Argument:
--forcemontage
@end table

Force montage (default false).  Without this option, WebMagick
will only re-generate montages as required.


@node Directory Paths, File Names, General, Top
@chapter Paths

@menu
* URL Computation::             Define how URLs are generated
@end menu

@node URL Computation,  , Directory Paths, Directory Paths
@section URL Computation

@menu
* Server Root Path::            Location of server's root
* Root Prefix::                 URL prefix to server's root
* Icon Location::               Specify offset to WebMagick icons
@end menu

@node Server Root Path, Root Prefix, URL Computation, URL Computation
@subsection Specify Server Root Path
@cindex URL, root path
@opindex $opt_rootpath
@swindex --rootpath

@table @code
@item Variable:
$opt_rootpath=path
@item Argument:
--rootpath path
@end table

Absolute path to server root directory (NCSA/Apache DocumentRoot) or the
users Home page directory. This must be an absolute path (starting with
@file{/}) to the top of the WWW directory tree WebMagick will be
processing in.  If this value is specified incorrectly,
WebMagick will generate incorrect URLs.

@node Root Prefix, Icon Location, Server Root Path, URL Computation
@subsection Specifying Root Prefix
@cindex URL, prefix
@cindex home directory
@opindex $opt_prefixpath
@swindex --prefixpath

@table @code
@item Variable:
$opt_prefixpath=path
@item Argument:
--prefixpath path
@end table

The prefix to prepend to all URLs to specify the WWW location of
@code{$opt_rootpath} (@pxref{Server Root Path}).  For directories under the WWW
server's root directory (@file{/}) this is a empty string (""). For a
user's personal pages this is the URL path to their home pages (usually
@file{/~username} equating to @file{~/public_html}, but may be
configured differently on your server).

If a relative URL can be computed then this option is not actually
used. It however must be used if the WebMagick icon images are
not in the same logical WWW directory tree as the directories
WebMagick is processing. (See the next option).

@node Icon Location,  , Root Prefix, URL Computation
@subsection Specifying WebMagick Icon Location
@cindex icon, location
@opindex $opt_iconpath
@swindex --iconpath

@table @code
@item Variable:
$opt_iconpath=path
@item Argument:
--iconpath path
@end table

This is the relative path from the top of the WWW directory tree
specified in @code{$opt_rootpath} (@pxref{Server Root Path}). If this value is
specified incorrectly then WebMagick will generate incorrect
URLs for its icons.

@node File Names, Server-Side Imagemaps, Directory Paths, Top
@chapter File Names

@menu
* Icon File Names::             Specify icon and background file names
* Index File Base Name::        Specify base name for visible HTML index
* README File Name::            Specify filename for directory README
* Page Index File Name::        Specify base name for per-page HTML
* Directory Title Xref::        Specify filename that contains directory
                                titles
@end menu

@node Icon File Names, Index File Base Name, File Names, File Names
@section Specifying Icon File Names
@cindex icons, hash table
@opindex %opt_icons

@table @code
@item Variable:
%opt_icons=(  'id', 'filename', .... ;
@end table

This is a hash table of all the images used directly by
WebMagick and located in the @code{$opt_iconpath} (@pxref{Icon
Location}) directory. The elments are pairs of icon @file{id}s and the
filename of the image. The @file{id}s currently used internally by
@file{WebMagick} are :- @file{background}, @file{dirbackground},
@file{prev}, @file{next}, @file{next_grey}, @file{up}, @file{help}, and
@file{ball}.  These IDs are used as follows:

@table @code
@item background
@cindex background image, thumbnail frame
@cindex thumbnail frame background image
thumbnail frame background image

@item dirbackground
@cindex background image, directory frame
@cindex directory frame background image
directory frame background image

@item prev
link to previous page

@item next
link to next page

@item next_gray
link to next page (when there isn't one)

@item up
link to parent directory up

@item help
link to help Readme File (if it exists)

@item ball
a decorative ball.  If no definition exists (array element is left
undefined) then the ball is not displayed in preference to unadorned
text.
@end table

By default the @code{background} and @code{dirbackground} options are
undefined which results in no background images being defined.

Other images can also be defined in the hash table and
WebMagick will automatically process those images along with
the images it uses, to generate the icon URL and size infomation. This
information can then be used in the various special formating options to
add extra, or special purpose links.

An alternative way to define entries (particularly useful in directory
.webmagickrc files) is to define (or undefine) individual hash table
entries.

Use syntax similar to

@example
$opt_icons@{'background'@} = 'background.gif';
@end example

to add a background image to the thumbnail page or override an existing
definition.

Use syntax similar to

@example
undef $opt_icons@{'background'@};
@end example

to undefine an existing definition for the image corresponding to
@file{background}.  This can be useful if the default is to display a
background image but you want to turn off the background image for a
particular sub-directory tree.


@node Index File Base Name, README File Name, Icon File Names, File Names
@section Index File Base Name
@cindex file name, master index
@opindex $opt_indexname
@swindex --indexname

@table @code
@item Variable:
$opt_indexname=filename
@item Argument:
--indexname filename
@end table

Base name of the master index files (default server index), usually set
to @file{index.html}. This is also the filename WebMagick
will look for in sub-directories and parent directory
@file{.webmagickrc} files as the document to make links to.

EG: If a directory is not processed by WebMagick, by either never
running WebMagick on that directory, or the option
@code{$opt_ignore} has been set, then setting @code{$opt_indexname} will
specify the document WebMagick created index files of OTHER
directories should link to.

If you do not want WebMagick to ever link to this directory then setting
the option, @code{$opt_indexname}, to "NOLINK" will will prevent
WebMagick index files in other directories from linking to this
directory.

If you want WebMagick to entirely ignore a particular directory tree,
even during recursion of the surrounding directories, then you can use
the following options in its "@file{.webmagickrc}" file:

@example
@group
#
# .webmagickrc -- WebMagick is not to process or even link
# to this directory tree
#
$opt_indexname = 'NOLINK'; # Do not link to this directory
$opt_ignore    = 1;        # Do not generate WebMagick image indexes
$opt_prune     = 1;        # Don't recurse into sub-directories
@end group
@end example

@node README File Name, Page Index File Name, Index File Base Name, File Names
@section Specifying README File Name
@cindex file name, README
@opindex $opt_readme
@swindex --readme

@table @code
@item Variable:
$opt_readme=filename
@item Argument:
--readme filename
@end table

Name of directory information file (default @file{README.html}). If
this file exists in the directory, then it will be displayed in
preference to the first page of images and a link will appear in the
directory frame which links to the image index. Typically the contents
of this file describe the images to be viewed.

@node Page Index File Name, Directory Title Xref, README File Name, File Names
@section Page Index File Name
@cindex file name, per-page
@opindex $opt_pageindexname
@swindex --pageindexname

@table @code
@item Variable:
$opt_pageindexname=string
@item Argument:
--pageindexname string
@end table

Base name of page-related index files (default @file{.index}). This
name is used as the prefix for all generated files except for the main
index file. The default naming creates these as hidden files (UNIX
convention).

@node Directory Title Xref,  , Page Index File Name, File Names
@section Specifying Sub-Directory Titles
@cindex file name, directory index
@opindex $opt_dirindexname
@swindex --dirindexname

@table @code
@item Variable:
$opt_dirindexname=filename
@item Argument:
--dirindexname filename
@end table

Specify the file name to contain the directory-name to title
cross-reference for naming sub-directories (default file name
@file{.dirindex}). If this file exists, then @emph{dirtext} will replace
@file{dirname} if @file{dirname} is found in the file. This provides the
ability to use user-specified text rather than actual sub-directory
names. The order specified by this file is used to sort directory names.
If an entry for a directory is not in this file, then that directory name
is sorted alphbetically with relation to the other directory names.

The format of the file is:

@example
dirname  dirtext
@end example

With @emph{dirname} representing the directory name and @emph{dirtext}
representing the replacement link text.

It is wise to limit the length of @emph{dirtext} to fit within the
limitations of the directory frame.

@node Server-Side Imagemaps, Thumbnail Caching, File Names, Top
@chapter Server-Side Imagemaps

@menu
* Imagemap Program::            Specify URL to server-side imagemap program
* Imagemap Type::               Specify server-side imagemap type
@end menu

@node Imagemap Program, Imagemap Type, Server-Side Imagemaps, Server-Side Imagemaps
@section Imagemap Program
@cindex server, imagemap program
@opindex $opt_htimage
@swindex --htimage

@table @code
@item Variable:
$opt_htimage=path
@item Argument:
--htimage path
@end table

Specify imagemap CGI program URL (set to '' for none). Older servers
(e.g. CERN and old NCSA) require an external program to handle
server-side imagemaps. These programs are usually supplied with a full
URL to the referenced file. Newer servers have server-side imagemap
support built-in and can accept URLs relative to the current
directory. If you have a modern server, then specify this value as a
null string (just hit @key{RETURN} when running the configure script).

@node Imagemap Type,  , Imagemap Program, Server-Side Imagemaps
@section Imagemap Type
@cindex server, imagemap type
@opindex $opt_maptype
@swindex --maptype

@table @code
@item Variable:
$opt_maptype=maptype
@item Argument:
--maptype maptype
@end table

Specify server-side map type (set to "ncsa" or "cern"). NCSA and Apache
servers require "ncsa". CERN requires "cern".  Phttpd can use either
format.

NCSA format looks similar to:

@example
@group
default .index1.html
rect scooby1.gif 440,0 549,128
@end group
@end example

while CERN format looks similar to:

@example
@group
default .index1.html
rect (440,0) (549,128) scooby1.gif
@end group
@end example

@node Thumbnail Caching, Montage Options, Server-Side Imagemaps, Top
@chapter Thumbnail Caching
@cindex caching, thumbnail

@menu
* Caching::                     Enable thumbnail caching
* Cache Directory::             Specify thumbnail cache directory name
* Cache Thumbnail Format::      Specify thumbnail image format
* Cache Thumnail Geometry::     Specify thumbnail image geometry
* Cache Minimum Image Size::    Specify cross-over point before trying JPEG
@end menu

@node Caching, Cache Directory, Thumbnail Caching, Thumbnail Caching
@section Enable Caching
@cindex flag, cache
@opindex $opt_cache
@swindex --cache

@table @code
@item Variable:
$opt_cache
@item Argument:
--cache
@end table

Enable thumbnail caching. This is good for a 5X reduction in processing
time when a single image is added or removed from a directory since
thumbnails are cached in reduced form.

As an added benefit, WebMagick can share its cache with John
Bradley's @code{xv} image manipulation program (Visual Schnauzer
feature) if configuration values are set as follows:

@example
@group
$opt_cacheformat= 'P7';
$opt_cachegeom  = 80x60;
$opt_cachedir   = '.xvpics';
@end group
@end example

Sharing the cache with @code{xv} is only feasable if all of the
images being cached are compatable with @code{xv} (ImageMagick
supports many more formats than @code{xv}). A further drawback of
sharing the cache with @code{xv} is that @code{xv} is limited to
thumbnails with a geometry of 80x60 which may be small for your tastes
(I prefer larger).

@node Cache Directory, Cache Thumbnail Format, Caching, Thumbnail Caching
@section Cache Directory
@cindex directory, cache name
@cindex cache, directory
@opindex $opt_cachedir
@swindex --cachedir

@table @code
@item Variable:
$opt_cachedir=dirspec
@item Argument:
--cachedir dirspec
@end table

Specify subdirectory name to cache thumbnails in (default
@file{.cache}).

@node Cache Thumbnail Format, Cache Thumnail Geometry, Cache Directory, Thumbnail Caching
@section Cache Thumbnail Format
@cindex cache, format
@cindex thumbnail, format
@opindex $opt_cacheformat
@swindex --cacheformat

@table @code
@item Variable:
$opt_cacheformat=imageformat
@item Argument:
--cacheformat imageformat
@end table

Specify the format that cached thumbnails are saved in. Can be any format that
ImageMagick knows how to read and write. The default is 'JPEG' which
works well for photorealistic images.

@node Cache Thumnail Geometry, Cache Minimum Image Size, Cache Thumbnail Format, Thumbnail Caching
@section Cache Thumbnail Geometry
@cindex cache, thumbnail geometry
@cindex geometry, cached thumbnail
@opindex $opt_cachegeom
@swindex --cachegeom

@table @code
@item Variable:
$opt_cachegeom=geometry
@item Argument:
--cachegeom geometry
@end table

Specifies the geometry specification for cached thumbnails.  The default
is to use the value specified by @code{$opt_thumbgeometry} (@pxref{Thumb
Geometry}).  If a smaller value is used, there will be more unused space
around the montaged thumbnails. Use of a larger value than the thubnail
geometry is to be avoided because the cached thumbnail will still have
to be reduced for the montage, costing both time and thumbnail quality.

@node Cache Minimum Image Size,  , Cache Thumnail Geometry, Thumbnail Caching
@section Cache Minimum Image Size
@cindex cache, minimum size
@opindex $opt_cachemin
@swindex --cachemin

@table @code
@item Variable:
$opt_cachemin=minsize
@item Argument:
--cachemin minsize
@end table

Specifies the original Image size (in total pixels) over which caching
will be used. For images smaller than this size, WebMagick will
use the original image in the Montage and no thumbnail will be
cached. The default value is 60,000 which is equivalent to a
@c This is an experiment with math output
@tex
$300\times200$
@end tex
@ifinfo
300 x 200
@end ifinfo
@ifhtml
300 x 200
@end ifhtml
image.

Selecting a value for this option is a judgement call based on space vs
time.  If a small value is selected, the initial run will be slower and
more disk space will be consumed by thumbnails.  However, subsequent
updates should be faster since more thumbnails are already reduced.  If
a large value is selected, then less disk space will be consumed, the
first pass will be faster, and subsequent passes will be slower.

@node Montage Options, HTML Options, Thumbnail Caching, Top
@chapter Montage Options
@cindex montage

@menu
* Montage Anatomy::             The Anatomy of a montage
* Montage Geometry::            Specify montage geometry
* Montage Format::              Specify montage format
* Montage Colors::              Specify montage colors
* Thumbnail Imaging::           Specify montage thumbnail imaging options
* Thumbnail Label Options::     Specify montage thumbnail label options
* Thumbnail Hooks::             Specify pre/postprocessing options for
                                thumbnails
@end menu

@node Montage Anatomy, Montage Geometry, Montage Options, Montage Options
@section The Anatomy Of A Montage

@subsection Montage Layout
@cindex montage layout
@cindex layout, montage

A montage is a single image which is composed of thumbnail images layed
out in a grid.  The size of the montage image is determined by the size
of the individual thumbnails and the number of rows and columns in the
grid.

The following figure shows a montage consisting of three columns and two
rows of thumbnails:

@image{fig/montage-sample-framed,,}

@subsection The Anatomy Of A Thumbnail
@cindex thumbnail anatomy
@cindex anatomy, thumbnail
@cindex thumbnail, layout


@subsubsection Un-Framed Thumbnails

Un-framed thumbnails consist of four components: the thumbnail image,
the thumbnail border, an optional thumbnail shadow, and an optional
thumbnail label area.

@image{fig/thumbnail-anatomy-plain,,}

@subsubsection Framed Thumbnails

Framed thumbnails consist of four components: the thumbnail image, the
thumbnail frame, the thumbnail border, an optional thumbnail shadow, and
an optional thumbnail label area.

@image{fig/thumbnail-anatomy-framed,,}

@node Montage Geometry, Montage Format, Montage Anatomy, Montage Options
@section Montage Geometry

The montage geometry specifies the size in rows and columns of the
generated thumbnail grid. Since a single montage is displayed per HTML
page, after the montage grid is full, a new page is started.  The
montage geometry combined with the thumbnail geometry determines the
total size of the montage image and therefore the size that the user's
web browser must be set to in order to view the entire montage.

Setting the rows to a very large value (large enough that rows x columns
exceeds the number of images) results in a single HTML page being
generated.  The user can then use the browser's vertical scroll bar to
peruse the thumbnails.

@menu
* Columns::                     Specify montage columns          
* Rows::                        Specify montage rows
@end menu

@node Columns, Rows, Montage Geometry, Montage Geometry
@subsection Columns
@cindex columns, montage
@cindex montage, columns
@opindex $opt_columns
@swindex --columns

@table @code
@item Variable:
$opt_columns=number
@item Argument:
--columns number
@end table

Specify the montage columns (max). This is the maximum number of
thumbnail columns allowed per thumbnail row.

@node Rows,  , Columns, Montage Geometry
@subsection Rows
@cindex rows
@opindex $opt_rows
@swindex --rows

@table @code
@item Variable:
$opt_rows=number
@item Argument:
--rows number
@end table

Specify the montage rows (max). This is the maximum number of thumbnail
rows allowed per page.

@node Montage Format, Montage Colors, Montage Geometry, Montage Options
@section Montage Image Format

@menu
* GIF/JPEG Transition Point::   Specify GIF/JPEG size transition point
* Force GIF Format::            Always use GIF format for montages
@end menu

@node GIF/JPEG Transition Point, Force GIF Format, Montage Format, Montage Format
@subsection GIF/JPEG Transition Point
@cindex imagemap selection
@cindex selection, imagemap
@cindex tuning, GIF vs JPEG
@opindex $opt_maxgif
@swindex --maxgif

@table @code
@item Variable:
$opt_maxgif=number
@item Argument:
--maxgif number
@end table

Specify the maximum size of GIF imagemap before trying JPEG (default
30000).  This is an optimization which tries to avoid the JPEG
conversion step. When indexing true or deep-color images, JPEG usually
leads to a smaller montage imagemap file.

Even if a JPEG image is generated, the smaller of the two images is
selected for use and the larger one is deleted to save disk space.

@node Force GIF Format,  , GIF/JPEG Transition Point, Montage Format
@subsection Force GIF Format
@cindex force, GIF
@cindex GIF, force
@opindex $opt_forcegif
@swindex --forcegif

@table @code
@item Variable:
$opt_forcegif=1
@item Argument:
--forcegif
@end table

Force GIF imagemaps to be generated (default off). This avoids the
possible generation of JPEG format imagemaps when the GIF file is large
(over 30K). The primary reason for using this option is because GIF
supports image transparancy while JPEG does not, leading to a possibly
more attractive display when using GIF format imagmaps. The drawbacks of
forcing GIF format are larger imagemap files (often two or three times
the size of JPEG when montaging true or deep-color images) and the
limited color depth (256 colors) of the GIF format.

@node Montage Colors, Thumbnail Imaging, Montage Format, Montage Options
@section Montage Colors

@menu
* Thumb Foreground Color::      Specify thumbnail foreground color
* Thumb Background Color::      Specify thumbnail background color
* Thumb Trans Color::           Specify thumbnail transparent color
* Thumb Frame Color::           Specify thumbnail frame color
* Border Color::                Specify thumbnail border color
* Netscape Color Cube::         Quantize montage to Netscape 216 color cube
@end menu

@node Thumb Foreground Color, Thumb Background Color, Montage Colors, Montage Colors
@subsection Thumbnail Foreground Color
@cindex color, thumbnail foreground
@cindex thumbnail, foreground color
@opindex $opt_thumbforeground
@swindex --thumbforeground

@table @code
@item Variable:
$opt_thumbforeground=colorspec
@item Argument:
--thumbforeground colorspec
@end table

Specify the montage foreground color.  This color is used as the color
for thumbnail label text.

@node Thumb Background Color, Thumb Trans Color, Thumb Foreground Color, Montage Colors
@subsection Thumbnail Background Color
@cindex color, thumbnail background
@cindex thumbnail background, color
@opindex $opt_thumbbackground
@swindex --thumbbackground

@table @code
@item Variable:
$opt_thumbbackground=colorspec
@item Argument:
--thumbbackground colorspec
@end table

Specifies the background color that thumbnails are imaged upon.

@node Thumb Trans Color, Thumb Frame Color, Thumb Background Color, Montage Colors
@subsection Thumbnail Transparent Color
@cindex color, thumbnail transparency
@cindex transparent, background
@cindex background, transparent color
@cindex thumbnail, transparent color
@opindex $opt_thumbtransparent
@swindex --thumbtransparent

@table @code
@item Variable:
$opt_thumbtransparent=colorspec
@item Argument:
--thumbtransparent colorspec
@end table

Specify a montage color to set transparent. Usually should be set the
same as the background color @code{$opt_colorback} (@pxref{Thumb Background
Color}) of the imagemap page. GIF format imagemaps use the transparent
color directly while JPEG format imagemaps may approximate
"transparency" by setting the imagemap background color to the same
color used as the background for HTML pages. This approximation becomes
less useful for clients with shallow colormaps.


@node Thumb Frame Color, Border Color, Thumb Trans Color, Montage Colors
@subsection Thumbnail Frame Color
@cindex matte, color
@cindex thumbnail, matte, color
@cindex color, color frame
@cindex thumbnail, color matte
@opindex $opt_thumbframecolor
@swindex --thumbframecolor

@table @code
@item Variable:
$opt_thumbframecolor=colorspec
@item Argument:
--thumbframecolor colorspec
@end table

Specify the thumbnail frame color (only applicable if frames are
enabled).

@node Border Color, Netscape Color Cube, Thumb Frame Color, Montage Colors
@subsection Thumbnail Frame Border Color
@cindex color, thumbnail border
@cindex thumbnail border, color
@opindex $opt_thumbframebgcolor
@swindex --thumbframebgcolor

@table @code
@item Variable:
$opt_thumbframebgcolor=colorspec
@item Argument:
--thumbframebgcolor colorspec
@end table

Specifies the background color within the thumbnail frame.  Ignored if
there is no frame.

@node Netscape Color Cube,  , Border Color, Montage Colors
@subsection Quantize To Netscape Color Cube
@cindex Netscape, color map
@cindex color map, Netscape
@cindex color cube
@cindex cube, color
@opindex $opt_mapnetscape
@swindex --mapnetscape

@table @code
@item Variable:
$opt_mapnetscape
@item Argument:
--mapnetscape
@end table

Re-map the montage colors to the Netscape 216-color cube. Netscape maps
colors to a fixed 216-color cube on PseudoColor color displays. Using
this option allows you to ensure that Netscape doesn't dither or re-map
your colors when used with common PseudoColor displays and the images
may be smaller. The drawback to using this option is that the color
quality will be significantly decreased on True and DirectColor displays
or when using browsers that don't use the 216-color cube technique.

When using image transparency, make sure that the transparent color is
selected from one of the 216 "standard" colors or transparency won't
work.

@node Thumbnail Imaging, Thumbnail Label Options, Montage Colors, Montage Options
@section Thumbnail Imaging

@menu
* Thumb Frame::                 Enable decorative frames around thumbnails
* Thumb Shadows::               Enable decorative shadows under thumbnails
* Border Width::                Specify thumbnail border width
* Thumb Background Texture::    Specify montage background image
* Thumb Geometry::              Specify thumbnail geometry
* Thumb Gravity::               Specify thumbnail placement
* Composition Algorithm::       Specify thumbnail imaging algorithm
* Zoom Filter::                 Specify zoom filter to use for reductions
@end menu



@node Thumb Frame, Thumb Shadows, Thumbnail Imaging, Thumbnail Imaging
@subsection Enable Thumbnail Frame
@cindex frame, thumbnail enable
@cindex thumbnail, enable frame
@opindex $opt_thumbframe
@swindex --thumbframe

@table @code
@item Variable:
$opt_thumbframe=geometry
@item Argument:
--thumbframe geometry
@end table

Specify the geometry specification for frame to place around
thumbnail. If no frame is desired then the string "false" should be
specified. The specified geometry values are in @emph{addition} to the
thumbnail geometry. For example, a frame geometry of '8x8' places an 8
pixel frame around the image.

@node Thumb Shadows, Border Width, Thumb Frame, Thumbnail Imaging
@subsection Enable Thumbnail Shadows
@cindex shadow, thumbnail
@cindex thumbnail, enable shadows
@opindex $opt_thumbshadow
@swindex --thumbshadow

@table @code
@item Variable:
$opt_thumbshadow=boolean
@item Argument:
--thumbshadow boolean
@end table

Set to string "true" or "false" to control the use of
decorative shadows around image thumbnails (or frames if enabled). The
default is "false".

@node Border Width, Thumb Background Texture, Thumb Shadows, Thumbnail Imaging
@subsection Thumbnail Frame Border Width
@cindex width, thumbnail border
@cindex thumbnail border, width
@opindex $opt_thumbborderwidth

@table @code
@item Variable:
$opt_thumbborderwidth=borderwidth
@end table

Specify the border (in pixels) to place between a thumbnail and its
surrounding frame.  This option only takes effect if thumbnail frames
are enabled and the thumbnail geometry specification doesn't also
specify the thumbnail border width.

@node Thumb Background Texture, Thumb Geometry, Border Width, Thumbnail Imaging
@subsection Thumbnail Background Texture
@cindex texture, thumbnail background
@cindex background, thumbnail
@cindex thumbnail, background texture
@opindex $opt_thumbtexture
@swindex --thumbtexture

@table @code
@item Variable:
$opt_thumbtexture=texturespec
@item Argument:
--thumbtexture texturespec
@end table

Specify a texture to use as montage background.  The built-in textures
"granite:" and "plasma:" are available.  A texture is the same
aas a background image. For example:

Granite texture:

@example
$opt_thumbtexture='granite:';
@end example

Plasma texture:

@example
$opt_thumbtexture='plasma:blue-yellow';
@end example

Image file texture:

@example
$opt_thumbtexture='vibrant.gif';
@end example

@node Thumb Geometry, Thumb Gravity, Thumb Background Texture, Thumbnail Imaging
@subsection Thumbnail Geometry
@cindex geometry, thumbnail
@cindex thumbnail, geometry
@opindex $opt_thumbgeometry
@swindex --thumbgeometry

@table @code
@item Variable:
$opt_thumbgeometry=geometry
@item Argument:
--thumbgeometry geometry
@end table

Specify image thumbnail geometry. Thumbnail geometry is specifed in the
form:

@example
 <width>x<height>+<borderwidth>+<borderheight>@{!@}@{<@}@{>@}
@end example

Specify the size and scaling options for thumbnail images (default
'106x80+2+2>').

The following description is extracted verbatim from the montage manual
page regarding the treatment of this option:

By default, the width and height are maximum values.  That is, the image
is expanded or contracted to fit the width and height value while
maintaining the aspect ratio of the image.  Append an exclamation point
to the geometry to force the image size to exactly the size you specify.
For example, if you specify 640x480! the image width is set to 640
pixels and height to 480.  If only one factor is specified, both the
width and height assume the value.
 
Use > to change the dimensions of the image only if its size exceeds the
geometry specification.  Use < to resize the image only if its dimensions is
less than the geometry specification.  For example, if you specify
640x480> and the image size is 512x512, the image size does not change.
However, if the image is 1024x1024, it is resized to 640x480.
 
Each image is surrounded by a border whose size in pixels is specified
as <border width> and <border height> and whose color is the background
color.


@node Thumb Gravity, Composition Algorithm, Thumb Geometry, Thumbnail Imaging
@subsection Thumbnail Gravity
@cindex gravity, thumbnail
@cindex thumbnail, gravity
@opindex $opt_thumbgravity
@swindex --thumbgravity

@table @code
@item Variable:
$opt_thumbgravity=direction
@item Argument:
--thumbgravity direction
@end table

Specify the thumbnail positioning within the specified geometry
(@code{$opt_thumbgeometry} area. If the thumbnail is smaller in any
dimension than the geometry, then it will be placed according to this
specification. Available options are @code{NorthWest}, @code{North},
@code{NorthEast}, @code{West}, @code{Center}, @code{East}
@code{SouthWest}, @code{South}, and @code{SouthEast}. Just as with a map
(at least those in the northern hemisphere) @code{North} is up and @code{West} is
left. The default is @code{Center} so that thumbnails are centered in
their grid.

@node Composition Algorithm, Zoom Filter, Thumb Gravity, Thumbnail Imaging
@subsection Thumbnail Composition Algorithm
@cindex thumbnail composition
@cindex composition, thumbnail
@opindex $opt_thumbcompose
@swindex --thumbcompose

@table @code
@item Variable:
$opt_thumbcompose=operation
@item Argument:
--thumbcompose operation
@end table

Specify the image composition algorithm for thumbnails. This controls
the algorithm by which the thumbnail image is placed on the
background. Available options are (default @code{Replace}): @code{Over},
@code{In}, @code{Out}, @code{Atop}, @code{Xor}, @code{Plus},
@code{Minus}, @code{Add}, @code{Subtract}, @code{Difference},
@code{Bumpmap}, @code{Replace}, @code{MatteReplace}, @code{Mask},
@code{Blend}, and @code{Displace}. Use of @code{Over} is recommended for
use with images that have transparency. This option may have negative
side-effects for images without transparency.

@node Zoom Filter,  , Composition Algorithm, Thumbnail Imaging
@subsection Thumbnail Zoom Filter
@cindex zoom, filter
@cindex filter, zoom
@cindex reduction, filter
@opindex $opt_zoomfilter
@swindex --zoomfilter

@table @code
@item Variable:
$opt_zoomfilter=filtertype
@item Argument:
--zoomfilter filtertype
@end table

Select the filter algorithm to use for image zooms (reductions &
enlargements). The available values are @code{Box}, @code{Triangle}, and
@code{Mitchell}. The algorithms have a significant effect on processing
time and may have a perceptible effect on image quality. Images zoomed
via the @code{Box} algorithm will have the lowest quality (unsuitable
for further processing) and will zoom the fastest.  Images zoomed via
the @code{Triangle} algorithm usually have sufficient quality that it
takes careful inspection to detect differences from the best algorithm.

The @code{Triangle} algorithm is almost as fast as the @code{Box}
algorithm so there is little need to use the @code{Box} algorithm. The
@code{Mitchell} algorithm produces the best possible results (preserving
fine details) but with a 40% (or so) speed penalty overall as compared
with the @code{Triangle} algorithm. If speed is not important for your
application, and end-users are likely to be using deep-color displays,
then by all means choose the @code{Mitchell} algorithm because if you
choose a lesser agorithm, you will never know what you are missing.

@node Thumbnail Label Options, Thumbnail Hooks, Thumbnail Imaging, Montage Options
@section Thumbnail Label Options

@menu
* Thumbnail Title Xref::        Specify thumbnail titles
* Thumb Label Format::          Specify thumbnail label format
* Thumb Label Width::           Specify thumbnail label truncation width
* Thumb Label Font::            Specify thumbnail label font
@end menu

@node Thumbnail Title Xref, Thumb Label Format, Thumbnail Label Options, Thumbnail Label Options
@subsection Thumbnail Labels
@cindex file name, image index
@opindex $opt_imgindexname
@swindex --imgindexname

@table @code
@item Variable:
$opt_imgindexname=filename
@item Argument:
--imgindexname filename
@end table

Specify the filename for the image name to thumbnail-title
cross-reference for images (default @file{.imgindex}). If this file
exists, then @emph{labelformat} will replace @emph{imagename} if
@emph{imagename} is found in the file. This provides the ability to use
user-specified label text rather than the default provided by
@code{$opt_thumblabel}. See the description of @code{$opt_thumblabel} or the
montage(1) manual page for information on the label format. The order
specified by this file is used to sort image names.  If an entry for an
image is not in this file, then that image name is sorted alphbetically
with relation to the other image names.

The format of the image index file consists of an image name followed by
an image label.  The image name and the image label are delimited by
white space which may be one or more space or tab characters as shown in
the following example:

@example
mr2-91ev.jpg	'91 Front
mr2-91re.jpg	'91 Back
mr2-91si.jpg	'91 Side
@end example

@node Thumb Label Format, Thumb Label Width, Thumbnail Title Xref, Thumbnail Label Options
@subsection Thumbnail Label Format
@cindex label, thumbnail
@cindex thumbnail, label format
@opindex $opt_thumblabel
@swindex --thumblabel

@table @code
@item Variable:
$opt_thumblabel=format
@item Argument:
--thumblabel format
@end table

Specifies the default format of thumbnail labels. The image filename,
type, width, height, or scene number in the label by embedding special
format characters. Embed %f for filename, %d for directory, %e for
filename extention, %t for top of filename, %m for magick, %w for width,
%h for height, %s for scene number, %b for file size, or \n for
newline. For example,

@example
    -label "%m:%f %wx%h"
@end example

produces an image label of MIFF:bird.miff 512x480 for an image titled
bird.miff and whose width is 512 and height is 480. (This explanation
borrowed from montage manual page). If a label is not desired, then use
the argument @emph{"label"} to turn off this feature.

The default format is '%f\n%wx%h %b' which displays the filename over
the image geometry followed by image size.

See the @code{$opt_imgindexname} option for a description of a more
powerful per-image labeling mechanism.

When @code{$opt_cache} is enabled, a number of labeling features will not
work correctly since they may refer to characteristics of the cached
thumbnail rather than the original image.

The labels which are supported when caching
is enabled are:

@table @code
@item %b
(file size)
@item %f
(full filename)
@item %h
(height)
@item %m
(magick)
@item %n
(filename minus extension)
@item %w
(width)
@end table

@node Thumb Label Width, Thumb Label Font, Thumb Label Format, Thumbnail Label Options
@subsection Thumbnail Label Width
@cindex label, width
@cindex thumbnail, label width
@opindex $opt_thumblabelwidth
@swindex --thumblabelwidth

@table @code
@item Variable:
$opt_thumblabelwidth=labelwidth
@item Argument:
--thumblabelwidth labelwidth
@end table

Specify the maximum column width (in characters) of label text.  Label
text longer than this is truncated to the specified width.  The purpose
of this is to ensure that the label is not munged due to excessive
length.

@node Thumb Label Font,  , Thumb Label Width, Thumbnail Label Options
@subsection Thumbnail Label Font
@cindex font, thumbnail label
@cindex thumbnail, label font
@opindex $opt_thumbfont
@swindex --thumbfont

@table @code
@item Variable:
$opt_thumbfont=fontspec
@item Argument:
--thumbfont fontspec
@end table

Specify the thumbnail title font. This is the X11 font used to title thumbnails
(default 5x8). PERL's newgetopt module seems to have difficulties with
the dashes in most X11 font specifications. If 'getopt' prints
the usage message rather than doing what you want to, then try using the
command line syntax @code{--thumbfont=fontspec} and you should have
better luck.

@node Thumbnail Hooks,  , Thumbnail Label Options, Montage Options
@section Thumbnail Processing Hooks

WebMagick provides EMACS-like hooks that can be used to insert
additional processing code fragments into the thumbnail generation code.

@menu
* Read Fail Hook::              Specify image read-failure hook
* Thumb Post Hook::             Specify thumbnail pre-processing hook
* Thumb Pre Hook::              Specify thumbnail post-processing hook
@end menu

@node Read Fail Hook, Thumb Post Hook, Thumbnail Hooks, Thumbnail Hooks
@subsection Read Failure Hook
@cindex hook, read failure
@cindex read, failure hook
@opindex $opt_readfailhook

@table @code
@item Variable:
$opt_readfailhook=string
@end table

PERL code fragment to evaluate if an original image fails to read during
the process of building a thumbnail. Usually this is due to the original
image being corrupted.  Your mileage may vary.

When the code fragment is executed, the name of the current image is in
the variable '$imagename'.  For example:

@example
@group
 $opt_thumbreadfailhook='unlink($imagename)';
@end group
@end example

removes the image, assuming that it is defective.  In the case of images
retrieved from the binaries newsgroups this is not a bad assumption.

@node Thumb Post Hook, Thumb Pre Hook, Read Fail Hook, Thumbnail Hooks
@subsection Thumbnail Post-processing Hook
@cindex hook, thumbnail post-processing
@cindex thumbnail, post-processing
@opindex $opt_thumbposthook

@table @code
@item Variable:
$opt_thumbposthook=string
@end table

PERL code fragment to evaluate on the reduced thumbnail before saving it
to cache or using it in the montage.  The thumbnail image is available
via the variable $image.  For example:

@example
@group
 $opt_thumbposthook='$status=$image->Sharpen(factor=>40);
   warn $status if "$status"';
@end group
@end example

applies the PerlMagick Sharpen operation on the thumbnail,

@example
@group
 $opt_thumbposthook='$image->Set(colorspace=>"Gray");
   $status=$image->Quantize();
   warn $status if "$status"';
@end group
@end example

displays thumbnails in grayscale, and

@example
@group
 $opt_thumbposthook='$image->Set(colorspace=>"Gray");
   $status=$image->Quantize();
   warn $status if "$status";
   $status=$image->Emboss();
   warn $status if "$status"';
@end group
@end example

displays embossed thumbnails.

See the
@uref{http://www.wizards.dupont.com/cristy/www/perl.html,PerlMagick
documentation} for the many other operations which may be applied to an
image.

@node Thumb Pre Hook,  , Thumb Post Hook, Thumbnail Hooks
@subsection Thumbnail Pre-Processing Hook
@cindex hook, thumbnail pre-processing
@cindex thumbnail, pre-processing hook
@opindex $opt_thumbprehook

@table @code
@item Variable:
$opt_thumbprehook=string
@end table

PERL code fragment to evaluate on the original image in memory prior to
reducing it into a thumbnail.  The image is available via the variable
$image.  For example:

@example
@group
 $opt_thumbprehook='$status=$image->Blur(factor=>80);
 warn $status if "$status"';
@end group
@end example

applies the PerlMagick Blur operation on the image. See the
@uref{http://www.wizards.dupont.com/cristy/www/perl.html,PerlMagick
documentation} for the many operations which may be applied to an image.

@node HTML Options, String Customization, Montage Options, Top
@chapter HTML Options

@menu
* HTML Content::                Specify HTML page contents
* Text Colors::                 Specify HTML text colors
* HTML Link Colors::            Specify HTML link colors
* Frame Options::               Specify frame options
* Meta Tags::                   Specify HTML meta tags
@end menu

@node HTML Content, Text Colors, HTML Options, HTML Options
@section HTML Content

@menu
* Allow Configuration::         Allow user configuration
* JavaScript Mode::             Enable JavaScript output
* Table Mode::                  Use tables instead of imagemaps
* README File Treatment::       Control README file visibility
* Address Info::                Specify an address field
* Anonymize::                   Protect the author's reputation
* Page Header::                 Specify HTML page header
* Page Title::                  Specify HTML page title
* Stylesheet::                  Specify a URL to a Cascading Style Sheet
* Dir Page Fmt (No Frames)::    Directory page template (unframed)
* Dir Page Fmt (Framed)::       Directory page template (framed)
* Per-Image HTML::              
@end menu

@node Allow Configuration, JavaScript Mode, HTML Content, HTML Content
@subsection Allow Configuration
@cindex configuration
@opindex $opt_allowconfig
@swindex --allowconfig

@table @code
@item Variable:
$opt_allowconfig=1
@item Argument:
--allowconfig
@end table

Available only when also using @code{$opt_javascript} and @code{$opt_tables}, Allow 
Configuration gives the user the option to select their own frame style
and number of rows and columns for the table. There will be an icon in 
the directory frame that will pop-up a new window which includes
pictures of the available frame styles. 

This configuration is accomplished with cookies. If the user has cookies
disabled in their browser, their configuration will not be saved. 

When a configuration is saved, it will be applied to all directories
at or below @code{$opt_prefixpath}. For example, if $opt_prefixpath is 
empty (the default), the configuration will apply to all directories
on the site. 



@node JavaScript Mode, Table Mode, Allow Configuration, HTML Content
@subsection JavaScript Mode
@cindex javascript
@opindex $opt_javascript
@swindex --javascript

@table @code
@item Variable:
$opt_javascript=1
@item Argument:
--javascript
@end table

When JavaScript mode is enabled, JavaScript code is added to the main
index file (default index.html) to re-set the location to the JavaScript
index file (currently hard-coded as "indexjs.html").  This results in
JavaScript being loaded into the browser automatically if JavaScript is
supported by the browser and the browser is one that WebMagick supports
(currently Netscape 3.0X, Netscape 4.0X, and Internet Explorer 4.0X).
Browsers that do not support JavaScript, have JavaScript disabled, or
are not recognized by WebMagick safely ignore the JavaScript and operate
directly from WebMagick's usual HTML files.

The advantage of JavaScript mode is that other than retrieving a few
intial files and the images to be viewed, all HTML is generated directly
within the user's browser, minimizing server accesses.  In addition,
navigation and presentation are dramatically improved since there is no
need to pre-compute every possible viewing option and JavaScript has
better control and knowledge of the browser than HTML does.

In order for JavaScript mode to operate correctly, the file
'webmagick.js' must be installed in the location specified by
@code{$opt_iconpath} (@pxref{Icon Location}) and the server must be updated to
associate MIME type "application/x-javascript" with the extension ".js".
Read your web server's documentation to see what is required in order
to add new MIME types (if the type is not already supported).

Apache server: Update conf/mime.types and add the line

@example
application/x-javascript        js
@end example

CERN or W3 server: Update config/httpd.conf and add the line

@example
AddType .js application/x-javascript 8bit
@end example

Phttpd: Update modules/file.conf and add the following to the
content-types list

@example
        .js             application/x-javascript
@end example

@node Table Mode, README File Treatment, JavaScript Mode, HTML Content
@subsection Table Mode
@cindex tables
@opindex $opt_tables
@swindex --tables

@table @code
@item Variable:
$opt_tables=1
@item Argument:
--tables
@end table

Use HTML tables instead of imagemaps for displaying thumbnails. This
results in quicker navigation because smaller images are downloaded, and
quicker directory processing, since no montages are created. 

This option is available with or without JavaScript mode enabled. 



@node README File Treatment, Address Info, Table Mode, HTML Content
@subsection README File Treatment
@cindex flag, README visible
@opindex $opt_readmevisible
@swindex --readmevisible

@table @code
@item Variable:
$opt_readmevisible=1
@item Argument:
--readmevisible
@end table

Specify the handling of a README file. If the file designated by
@code{$opt_readme} exists (default @file{README.html}) then make it the first
page seen when the user enters a directory.  Regardless of this option,
the help icon will appear if the README file exists which is a link to
the file.

@node Address Info, Anonymize, README File Treatment, HTML Content
@subsection Address Information
@cindex tag, address
@opindex $opt_address
@swindex --address

@table @code
@item Variable:
$opt_address=string
@item Argument:
--address string
@end table

Specify additional information to place in <ADDRESS></ADDRESS> tags in
page frame.  WebMagick copyright and support information is
placed on all generated pages.

@node Anonymize, Page Header, Address Info, HTML Content
@subsection Anonymize
@cindex anonymous
@cindex author, protect
@cindex protect, author
@opindex $opt_anonymous
@swindex --anonymous

@table @code
@item Variable:
$opt_anonymous
@item Argument:
--anonymous
@end table

Turn off the WebMagick copyright info and author's address on all
generated pages.  If you are operating a site that my mother wouldn't
approve of, please use this option.

@node Page Header, Page Title, Anonymize, HTML Content
@subsection Page Header
@cindex page, header
@cindex header, page
@opindex $opt_header
@swindex --header

@table @code
@item Variable:
$opt_header=string
@item Argument:
--header string
@end table

Specify text to add to the page header in the thumbnail frame (a short
term hack). This option is subject to change and will be eliminated if
the thumbnail frame is templatized.

@node Page Title, Stylesheet, Page Header, HTML Content
@subsection Page Title
@cindex title, page
@cindex page, title
@opindex $opt_title
@swindex --title

@table @code
@item Variable:
$opt_title=string
@item Argument:
--title string
@end table

Specify the page title. If this option is not specified, then
WebMagick will generate its own title in the form 'Index of
directory "subdirectory name"'.

@node Stylesheet, Dir Page Fmt (No Frames), Page Title, HTML Content
@subsection Stylesheet
@cindex stylesheet
@opindex $opt_stylesheet
@swindex --stylesheet

@table @code
@item Variable:
$opt_stylesheet=URL
@item Argument:
--stylesheet URL
@end table

Specify a style sheet to use for all generated pages. This will override
the following options:

@itemize
@item @code{$opt_colorfore} (@pxref{Thumb Foreground})
@item @code{$opt_colorback} (@pxref{Thumb Background})
@item @code{$opt_dircolorfore} (@pxref{Dir Foreground Color})
@item @code{$opt_dircolorback} (@pxref{Dir Background Color})
@item @code{$opt_coloralink} (@pxref{Thumb Active Link Color})
@item @code{$opt_colorlink} (@pxref{Thumb Un-visited Color})
@item @code{$opt_colorvlink} (@pxref{Thumb Visited Color})
@item @code{$opt_dircoloralink} (@pxref{Dir Active Color})
@item @code{$opt_dircolorlink} (@pxref{Dir Un-Visited Color})
@item @code{$opt_dircolorvlink} (@pxref{Dir Visited Color})

@end itemize



@node Dir Page Fmt (No Frames), Dir Page Fmt (Framed), Stylesheet, HTML Content
@subsection Directory Page Template (No Frames)
@cindex template, directory page (frameless)
@cindex directory page, template (frameless)
@opindex $opt_dirfmt

@table @code
@item Variable:
$opt_dirfmt=string
@end table

Specify a template (written in PERL) that represents the format used to
generate the frame-less directory navigation page. This format will be
seen by browsers that do not support frames. This is a guru-level option
that may require reading WebMagick code.

@node Dir Page Fmt (Framed), Per-Image HTML, Dir Page Fmt (No Frames), HTML Content
@subsection Directory Page Template (Framed)
@cindex template, directory page (framed)
@cindex directory page, template (framed)
@opindex $opt_frameddirfmt

@table @code
@item Variable:
$opt_frameddirfmt=string
@end table

Specify a template (written in PERL) that represents the format used to
generate the framed (left frame) directory navigation page. This format
will be seen by browsers that support frames. This is a guru-level
option that may require reading WebMagick code.

@node Per-Image HTML,  , Dir Page Fmt (Framed), HTML Content
@subsection Per-Image HTML

When per-image HTML mode is enabled, an HTML file is generated
corresponding to each image.  The HTML file is named based on the image
file name with an HTML extension.

@menu
* Enable Per-image HTML::       
* Per-image HTML extension::    
* Per-image HTML Nav Buttons::
* Per-image Picture Title::   
* Per-image Picture Title Start HTML::
* Per-image Picture Title End HTML::   
* Default Frame Target::        
* Extra Top HTML::              
* Extra Bottom HTML::           
@end menu

@node Enable Per-image HTML, Per-image HTML extension, Per-Image HTML, Per-Image HTML
@subsubsection Enable Per-image HTML
@cindex enable, per-image html
@cindex per-image html, enable
@opindex $opt_pichtml
@swindex --pichtml

@table @code
@item Variable:
$opt_pichtml=1
@item Argument:
--pichtml
@end table

Enable per-image HTML file generation.

@node Per-image HTML extension, Per-image HTML Nav Buttons, Enable Per-image HTML, Per-Image HTML
@subsubsection Per-image HTML extension
@cindex extension, per-image html
@cindex per-image html, extension
@opindex $opt_pichtmlext
@swindex --pichtmlext

@table @code
@item Variable:
$opt_pichtmlext='.ext'.
@item Argument:
--pichtmlext extention
@end table

Set the file extension to use for per-image HTML files.  The final name
is the image file name appended with this file extension.  The default extension
is '.html'.

@node Per-image HTML Nav Buttons, Per-image Picture Title, Per-image HTML extension, Per-Image HTML
@subsubsection Per-image HTML Nav Buttons 
@cindex per-image html, nav buttons
@cindex nav buttons, per-image html
@opindex $opt_pichtmlnav
@swindex --pichtmlnav
 
@table @code
@item Variable:
$opt_pichtmlnav
@item Argument:
--pichtmlnav
@end table
 
Enable image navigation buttons (up, previous, next) on per-image HTML files. 

@node Per-image Picture Title, Per-image Picture Title Start HTML, Per-image HTML Nav Buttons, Per-Image HTML
@subsubsection Per-image Picture Title 
@cindex per-image html, picture title
@cindex picture title, per-image html
@opindex $opt_pichtmlputtitle
@swindex --pichtmlputtitle
 
@table @code
@item Variable:
$opt_pichtmlputtitle
@item Argument:
--pichtmlputtitle
@end table
 
Enable per-image HTML picture titles. Default is on.  

@node Per-image Picture Title Start HTML, Per-image Picture Title End HTML, Per-image Picture Title, Per-Image HTML
@subsubsection Per-image Picture Title Start HTML 
@cindex per-image html, picture title
@cindex picture title, per-image html
@opindex $opt_pichtmltitlestart
@swindex --pichtmltitlestart
 
@table @code
@item Variable:
$opt_pichtmltitlestart
@item Argument:
--pichtmltitlestart
@end table
 
HTML to add before picture title (default is <P>)

@node Per-image Picture Title End HTML, Default Frame Target, Per-image Picture Title Start HTML, Per-Image HTML
@subsubsection Per-image Picture Title End HTML 
@cindex per-image html, picture title
@cindex picture title, per-image html
@opindex $opt_pichtmltitleend
@swindex --pichtmltitleend
 
@table @code
@item Variable:
$opt_pichtmltitleend
@item Argument:
--pichtmltitleend
@end table
 
HTML to add after picture title (default is </P>)

@node Default Frame Target, Extra Top HTML, Per-image Picture Title End HTML, Per-Image HTML
@subsubsection Default Frame Target
@cindex frame target, per-image html
@cindex per-image html, frame target
@cindex default, frame target
@cindex frame target, default
@opindex $opt_pichtmltarget
@swindex --pichtmltarget

@table @code
@item Variable:
$opt_pichtmltarget='targetname';
@item Argument:
--pichtmltarget target_name
@end table

Set the default URL target name for links in per-image HTML files.
There is normally no need to set this target because HTML is normally
displayed in the current frame and there are no links by default,
however, sometimes it is desirable for links to display in a different
(or new) window.

@node Extra Top HTML, Extra Bottom HTML, Default Frame Target, Per-Image HTML
@subsubsection Extra Top HTML
@cindex html, top
@cindex top, html
@opindex $opt_pichtmltop
@swindex --pichtmltop

@table @code
@item Variable:
$opt_pichtmltop='html_source';
@item Argument:
--pichtmltop 'html_source'
@end table

Extra HTML to insert above the image.

@node Extra Bottom HTML,  , Extra Top HTML, Per-Image HTML
@subsubsection Extra Bottom HTML
@cindex html, bottom
@cindex bottom, html
@opindex $opt_pichtmlbottom
@swindex --pichtmlbottom

@table @code
@item Variable:
$opt_pichtmlbottom='html_source';
@item Argument:
--pichtmlbottom 'html_source'
@end table

Extra HTML to insert below the image.

@node Text Colors, HTML Link Colors, HTML Content, HTML Options
@section Text Colors

@menu
* Thumb Background::            Specify thumbnail page background color
* Thumb Foreground::            Specify thumbnail page foreground color
* Dir Foreground Color::        Specify directory page foreground color
* Dir Background Color::        Specify directory page background color
@end menu

@node Thumb Background, Thumb Foreground, Text Colors, Text Colors
@subsection Thumbnail Frame Background Color
@cindex color, background (thumbnail frame)
@cindex background color (thumbnail frame)
@cindex frame, color (thumbnail frame)
@opindex $opt_colorback
@swindex --colorback

@table @code
@item Variable:
$opt_colorback=colorspec
@item Argument:
--colorback colorspec
@end table

Specify the background color for thumbnail frame.

@node Thumb Foreground, Dir Foreground Color, Thumb Background, Text Colors
@subsection Thumbnail Frame Text Foreground Color
@cindex text, foreground color (thumbnail frame)
@cindex foreground color, text (thumbnail frame)
@cindex color, foreground text (thumbnail frame)
@opindex $opt_colorfore
@swindex --colorfore

@table @code
@item Variable:
$opt_colorfore=colorspec
@item Argument:
--colorfore colorspec
@end table

Specify the toreground color for text in thumbnail frame.

@node Dir Foreground Color, Dir Background Color, Thumb Foreground, Text Colors
@subsection Directory Frame Text Color
@cindex color, text (directory frame)
@cindex text, color (directory frame)
@opindex $opt_dircolorfore
@swindex --dircolorfore

@table @code
@item Variable:
$opt_dircolorfore=colorspec
@item Argument:
--dircolorfore colorspec
@end table

Specify the foreground text color of the directory frame. Defaults to
the value of @code{$opt_colorfore} (@pxref{Thumb Foreground}) if not explicitly
set.

@node Dir Background Color,  , Dir Foreground Color, Text Colors
@subsection Directory Frame Background Color
@cindex color, background  (directory frame)
@cindex frame, background color  (directory frame)
@opindex $opt_dircolorback
@swindex --dircolorback

@table @code
@item Variable:
$opt_dircolorback=colorspec
@item Argument:
--dircolorback colorspec
@end table

Specify the background color of the directory frame. Defaults to the
value of @code{$opt_colorback} (@pxref{Thumb Background}) if not explicitly
set.

@node HTML Link Colors, Frame Options, Text Colors, HTML Options
@section HTML Link Colors
@cindex link, colors
@cindex colors, link

@menu
* Thumb Active Link Color::     Specify thumbnail page active link color
* Thumb Un-visited Color::      Specify thumbnail page un-visited link color
* Thumb Visited Color::         Specify thumbnail page visited link color
* Dir Active Color::            Specify directory page active link color
* Dir Un-Visited Color::        Specify directory page un-visited link color
* Dir Visited Color::           Specify directory page visited link color
@end menu

@node Thumb Active Link Color, Thumb Un-visited Color, HTML Link Colors, HTML Link Colors
@subsection Thumbnail Frame Active Link Color
@cindex color, active link (thumbnail frame)
@cindex html, active link color (thumbnail frame)
@cindex link, active (thumbnail frame)
@opindex $opt_coloralink
@swindex --coloralink

@table @code
@item Variable:
$opt_coloralink=colorspec
@item Argument:
--coloralink colorspec
@end table

Specify the link (active) color for the thumbnail frame.


@node Thumb Un-visited Color, Thumb Visited Color, Thumb Active Link Color, HTML Link Colors
@subsection Thumbnail Frame Un-visited Link Color
@cindex color, un-visited link (thumbnail frame)
@cindex link, un-visited color (thumbnail frame)
@cindex un-visited link, color (thumbnail frame)
@opindex $opt_colorlink
@swindex --colorlink

@table @code
@item Variable:
$opt_colorlink=colorspec
@item Argument:
--colorlink colorspec
@end table

Specify link (unvisited) color for the thumbnail frame.

@node Thumb Visited Color, Dir Active Color, Thumb Un-visited Color, HTML Link Colors
@subsection Thumbnail Frame Visited Link Color
@cindex color, visited link (thumbnail frame)
@cindex link, visited color (thumbnail frame)
@cindex visited link color (thumbnail frame)
@opindex $opt_colorvlink
@swindex --colorvlink

@table @code
@item Variable:
$opt_colorvlink=colorspec
@item Argument:
--colorvlink colorspec
@end table

Specify link (visited) color for the thumbnail frame.

@node Dir Active Color, Dir Un-Visited Color, Thumb Visited Color, HTML Link Colors
@subsection Directory Frame Active Link Color
@cindex color, active link (directory frame)
@cindex link, active color (directory frame)
@cindex active link color (directory frame)
@opindex $opt_dircoloralink
@swindex --dircoloralink

@table @code
@item Variable:
$opt_dircoloralink=colorspec
@item Argument:
--dircoloralink colorspec
@end table

Specify link (active) color for the directory frame. Defaults to value of
@code{$opt_coloralink} (@pxref{Thumb Active Link Color})if not explicitly set.


@node Dir Un-Visited Color, Dir Visited Color, Dir Active Color, HTML Link Colors
@subsection Directory Frame Un-Visited Color
@cindex color, unvisited link (directory frame)
@cindex unvisited link, color(directory frame)
@opindex $opt_dircolorlink
@swindex --dircolorlink

@table @code
@item Variable:
$opt_dircolorlink=colorspec
@item Argument:
--dircolorlink colorspec
@end table

Specify link (unvisited) color for the directory frame. Defaults to the
value of @code{$opt_colorlink} (@pxref{Thumb Un-visited Color}) if not
explicitly set.

@node Dir Visited Color,  , Dir Un-Visited Color, HTML Link Colors
@subsection Directory Frame Visited Color
@cindex color, visited link (directory frame)
@cindex visited link, color(directory frame)
@opindex $opt_dircolorvlink
@swindex --dircolorvlink

@table @code
@item Variable:
$opt_dircolorvlink=colorspec
@item Argument:
--dircolorvlink colorspec
@end table

Specify link (visited) color for the directory frame. Defaults to value
of @code{$opt_colorvlink} (@pxref{Thumb Visited Color}) if not explicitly set.


@node Frame Options, Meta Tags, HTML Link Colors, HTML Options
@section Frame Options

@menu
* Frames::                      Enable frames
* Frame Borders::               Enable frame borders
* Frame Border Thickness::      Specify frame border thickness
* Frame Margin Height::         Specify frame margin height
* Frame Margin Width::          Specify frame margin width
* Frame Style::                 Specify frame style (layout)
@end menu

@node Frames, Frame Borders, Frame Options, Frame Options
@subsection Enable Frames
@cindex frame, enable
@opindex $opt_frames
@swindex --frames

@table @code
@item Variable:
$opt_frames=1
@item Argument:
--[no]frames
@end table

Enable frames. This defaults to on, but is useful to turn off if you have a single directory
collection. 


@node Frame Borders, Frame Border Thickness, Frames, Frame Options
@subsection Enable Frame Borders
@cindex frame, borders enable
@cindex borders, frame enable
@opindex $opt_frameborder
@swindex --frameborder

@table @code
@item Variable:
$opt_frameborder=borderenable
@item Argument:
--frameborder borderenable
@end table

Enable decorative frame borders with the value 'YES' or disable
decorative frame borders by specifying the value 'NO'.  These options
are passed directly to the HTML's FRAMESET 'FRAMEBORDER' option in the
generated pages.

@node Frame Border Thickness, Frame Margin Height, Frame Borders, Frame Options
@subsection Frame Border Thickness
@cindex frame, border thickness
@cindex border thickness, frame
@opindex $opt_framebordersize
@swindex --framebordersize

@table @code
@item Variable:
$opt_framebordersize=bordersize
@item Argument:
--framebordersize bordersize
@end table

Specifies the number of pixels allocated to the frame border.

@node Frame Margin Height, Frame Margin Width, Frame Border Thickness, Frame Options
@subsection Frame Margin Height
@cindex frame, margin height
@cindex margin height, frame
@opindex $opt_framemarginheight
@swindex --framemarginheight

@table @code
@item Variable:
$opt_framemarginheight=marginheight
@item Argument:
--framemarginheight marginheight
@end table

Specifies the number of pixels allocated to the frame margin in the
vertical direction.

@node Frame Margin Width, Frame Style, Frame Margin Height, Frame Options
@subsection Frame Margin Width
@cindex frame, margin width
@cindex margin width, frame
@opindex $opt_framemarginwidth
@swindex --framemarginwidth

@table @code
@item Variable:
$opt_framemarginwidth=marginwidth
@item Argument:
--framemarginwidth marginwidth
@end table

Specifies the number of pixels allocated to the frame margin in the
horizontal direction.

@node Frame Style,  , Frame Margin Width, Frame Options
@subsection Frame Style
@cindex frame, style
@cindex style, frame
@cindex frame, template selection
@opindex $opt_framestyle
@swindex --framestyle

@table @code
@item Variable:
$opt_framestyle=framestyle
@item Argument:
--framestyle framestyle
@end table

Specifies the frame template to use.  Templates are currently specified
for the range of 1-4 with the following effect:

@need 2500
@enumerate
@c ============
@c Style 1
@c ============
@item

Simple two frame screen with directories listed in the left frame and
imagemap or README displayed in the right frame.

@image{fig/frame-style-1,,}

@sp 1

@c ============
@c Style 2
@c ============
@need 2500
@item

Three frame screen with directories listed in top-left frame,
imagemap displayed in bottom-left frame, and README/Images
displayed in full-height right-hand frame.

@image{fig/frame-style-2,,}

@sp 1

@c ============
@c Style 3
@c ============
@need 2500
@item

Three frame screen with directories listed in left frame,
imagemap displayed in top-right frame, and README/Images
displayed in lower-right frame.

@image{fig/frame-style-3,,}

@sp 1

@c ============
@c Style 4
@c ============
@need 2500
@item

Three frame screen with directories listed in lower-left frame,
imagemap displayed in top frame, and README/Images displayed in
lower-right frame.

@image{fig/frame-style-4,,}

@sp 1

@end enumerate

@node Meta Tags,  , Frame Options, HTML Options
@section HTML Meta Tags
@cindex meta tags
@cindex tags, meta

@menu
* Meta Author::                 Specify AUTHOR meta-tag
* Meta Charset::                Specify CHARSET meta-tag
* Meta Classification::         Specify CLASSIFICATION meta-tag
* Meta Description::            Specify DESCRIPTION meta-tag
* Meta Expires::                Specify EXPIRES meta-tag
* Meta Key-Words::              Specify KEYWORDS meta-tag
@end menu

@node Meta Author, Meta Charset, Meta Tags, Meta Tags
@subsection Meta-Tag Author
@cindex meta, author
@cindex tag, author
@cindex author, meta tag
@opindex $opt_metaauthor

@table @code
@item Variable:
$opt_metaauthor=string
@end table

Specify author name to add to the HTML meta tags in generated HTML
files.

@node Meta Charset, Meta Classification, Meta Author, Meta Tags
@subsection Meta-Tag Charset
@cindex meta, charset
@cindex tag, charset
@cindex charset, meta tag
@opindex $opt_metacharset

@table @code
@item Variable:
$opt_metacharset=string
@end table

Specify HTML documents character set in case HTTPD can't provide it.


@node Meta Classification, Meta Description, Meta Charset, Meta Tags
@subsection Meta-Tag Classification
@cindex meta, classification
@cindex tag, classification
@cindex classification, meta tag
@opindex $opt_metaclassification

@table @code
@item Variable:
$opt_metaclassification=string
@end table

Specify any classification information to add to the HTML meta tags in
generated HTML files.  This may be used by indexing robots.

@node Meta Description, Meta Expires, Meta Classification, Meta Tags
@subsection Meta-Tag Description
@cindex meta, description
@cindex tag, description
@cindex description, meta tag
@opindex $opt_metadescription

@table @code
@item Variable:
$opt_metadescription=string
@end table

Specify page description text to add to the HTML meta tags in generated
HTML files. This information may used by indexing robots.

@node Meta Expires, Meta Key-Words, Meta Description, Meta Tags
@subsection Meta-Tag Expires
@cindex meta, expires
@cindex tag, expires
@cindex expires, meta tag
@opindex $opt_metaexpires

@table @code
@item Variable:
$opt_metaexpires=string
@end table

Page expiration date to add to the HTML meta tags in generated HTML
files. Should be specified in the form:

@example
	"Tue, 20 Aug 1996 14:25:27 GMT"
@end example

Since the specified expiration time is absolute, use of this option
implies a commitment to execute WebMagick with option
@code{--forcehtml} as least as often as the specified expiration period.

This information is used by browsers and caching servers to
determine when cached data becomes stale.

@node Meta Key-Words,  , Meta Expires, Meta Tags
@subsection Meta-Tag Key-Words
@cindex meta, key-words
@cindex tag, key-words
@cindex key-words, meta tag
@opindex $opt_metakeywords

@table @code
@item Variable:
$opt_metakeywords=string
@end table

Specify keywords to add to the HTML meta tags in generated HTML files.
Should be specified as a string with keywords delimited by a comma
(e.g. "key1,key2,key3"). This information may used by indexing
robots.

@node String Customization, Authors, HTML Options, Top
@chapter String Customization

@cindex localization
@opindex $opt_msg_copyright
@opindex $opt_date_format
@opindex $opt_msg_directories
@opindex $opt_msg_directory_navigator
@opindex $opt_msg_images
@opindex $opt_msg_index_of_directory
@opindex $opt_msg_index_of_files
@opindex $opt_msg_index_through
@opindex $opt_msg_next
@opindex $opt_msg_page_navigator
@opindex $opt_msg_page_updated_on
@opindex $opt_msg_prev
@opindex $opt_msg_produced_by
@opindex $opt_msg_readme
@opindex $opt_msg_up

Use the following variables to override the strings that WebMagick displays.

@table @code
@item Variable:
$opt_msg_copyright = "Copyright "
@item Variable:
$opt_date_format = "%B %e, %Y" (see strftime(3))
@item Variable:
$opt_msg_directories = "Directories"
@item Variable:
$opt_msg_directory_navigator = "Directory Navigator"
@item Variable:
$opt_msg_images = "Images"
@item Variable:
$opt_msg_index_of_directory = "Index of directory"
@item Variable:
$opt_msg_index_of_files = "Index of files "
@item Variable:
$opt_msg_index_through = "through"
@item Variable:
$opt_msg_next = "Next"
@item Variable:
$opt_msg_page_navigator = "Page Navigator"
@item Variable:
$opt_msg_page_updated_on = "Page update on"
@item Variable:
$opt_msg_prev = "Prev"
@item Variable:
$opt_msg_produced_by = "Produced by"
@item Variable:
$opt_msg_readme = "ReadMe"
@item Variable:
$opt_msg_up = "Up"
@end table



@node Authors, Obtaining WebMagick, String Customization, Top
@chapter Authors

WebMagick is currently maintained by @email{clindell@@users.sourceforge.net,Chris Lindell}.
It was written by @email{bfriesen@@simple.dallas.tx.us,Bob Friesenhahn} with copious input
from @email{anthony@@cit.gu.edu.au,Anthony Thyssen}. Anthony's diligent
assistance as the first alpha tester is very much appreciated. Patches
to support per-image HTML files and other usability enhancements were
contributed by @email{ache@@nagual.pp.ru,Andrey A. Chernov}.

ImageMagick and PerlMagick are written by
@email{cristy@@dupont.com, John Cristy}. WebMagick would not be possible
without his wonderful software. The author greatly appreciates Cristy's
assistance with ironing out PerlMagick's (or WebMagick's) bugs and
feature set during the development of WebMagick.

@node Obtaining WebMagick, Installation, Authors, Top
@chapter Obtaining WebMagick

@noindent
The following packages are required in order to install WebMagick.
Retrieve each package and install according to the following order:

@enumerate
@item @uref{http://www.perl.com/perl/index.html,PERL version 5}

@item @uref{http://www.wizards.dupont.com/cristy/ImageMagick.html,ImageMagick}

@item @uref{http://www.wizards.dupont.com/cristy/www/perl.html,PerlMagick}

@item @uref{http://webmagick.sourceforge.net,WebMagick}
@end enumerate

Each package provides its own installation instructions.  Please follow
them carefully.

@node Installation, Option Index, Obtaining WebMagick, Top
@chapter Installing WebMagick
@cindex install


@menu
* Basic Installation::          
* Installation Names::          
@end menu

@node Basic Installation, Installation Names, Installation, Installation
@section Basic Installation

Execute the provided configure script specifying a --prefix option for a
GNU-style directory heriarchy you would like to install in (e.g.
"./configure --prefix=/opt/tools"). This will generate a base copy of
WebMagick that has been edited to reflect the location of your PERL
interpreter and the X11 RGB database.
 
The configure script will ask you questions to provide definitions of
@code{$opt_prefixpath}, @code{$opt_rootpath}, @code{$opt_iconpath},
@code{$opt_htimage}, and @code{$opt_maptype} in the @file{webmagick}
script and the sample @file{webmagickrc} file.  Read the Introduction
section of this manual to learn the details. A few examples are provided
below. The script provides a running narrative with examples so it
should not be necessary to read much documentation before running it.
 
Then "make install". This will install WebMagick, sample icons, the
WebMagick JavaScript interface, and TexInfo documentation.  The
WebMagick icons must be installed in a directory somewhere under the
same server "root" as the images you want to catalogue.  This root does
not neccessarily have to be the actual server root.  The "root" may be
established via a server path mapping (rather than symbolic link) that
offsets onto another filesystem.
 
In order for JavaScript mode to operate correctly, the file
@file{webmagick.js} must be installed in the location specified by
@code{$opt_iconpath} and the server must be updated to associate MIME type
"application/x-javascript" with the extension ".js".  This file contains
the various JavaScript routines that define WebMagick's JavaScript
interface.  See the formal documentation for more on JavaScript.


@node Installation Names,  , Basic Installation, Installation
@section Installation Names

By default, @samp{make install} will install the package's files in
@file{/usr/local/bin}, @file{/usr/local/man}, etc.  You can specify an
installation prefix other than @file{/usr/local} by giving
@code{configure} the option @samp{--prefix=@var{path}}.

In addition, if you use an unusual directory layout you can give options
like @samp{--bindir=@var{path}} to specify different values for
particular kinds of files.  Run @samp{configure --help} for a list of
the directories you can set and what kinds of files go in them.


@node  Option Index, Argument Index, Installation, Top
@unnumbered Option Index

Summary index of available WebMagick option variables.  Many of these
options have command-line equivalents.

@printindex op

@node Argument Index, Concept Index, Option Index, Top
@unnumbered Argument Index

Summary index of available WebMagick command-line arguments.  All of
these arguments have equivalent option variables.

@printindex sw

@node   Concept Index,  , Argument Index, Top
@comment        node-name,      next,   previous,       up
@unnumbered Concept Index

@printindex cp

@contents
@bye
