Go to the first, previous, next, last section, table of contents.

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 --option=arg to avoid any confusion caused by a space.

The default configuration file name is `.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 (`/etc/webmagickrc' and `$HOME/.webmagickrc' by default). When a directory is processed, WebMagick will process any `.webmagickrc' files found in the path from the server's root directory (specified by $opt_rootpath (see section Specify Server Root Path)) to the directory being processed. All configuration options are additive.

Evaluation order (inverse of precedence) is as follows :

1. Files listed in @global_option_files (default `/etc/webmagickrc' and `$HOME/.webmagickrc')
2. Command line options
3. 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.

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

In general, WebMagick's defaults produce nice output. However, the options $opt_prefixpath (see section Specifying Root Prefix), $opt_rootpath (see section Specify Server Root Path), $opt_iconpath (see section Specifying WebMagick Icon Location), $opt_htimage (see section Imagemap Program), and $opt_maptype (see section 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.):

index.html

Main (default server index) HTML index file.

indexjs.html

Javascript master index file (name currently hard-coded).

.cache

Thumbnail cache directory

.indexdir.html

HTML page that displays directory frame

.indexjs.html

HTML file to load JavaScript source into browser.

.index.pl

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

.index.js

JavaScript variables file (similar to status file but in JavaScript).

.index1.html

HTML page that displays thumbnail frame

.index1.gif

Montaged images (thumbnails) in GIF format

.index1.jpg

Montaged images (thumbnails) in JPEG format

.index1.map

Server-side imagemap (clickable map) file

Go to the first, previous, next, last section, table of contents.