This is webmagick.info, produced by makeinfo version 4.0 from
webmagick.texinfo.

INFO-DIR-SECTION WebMagick Image Web Generator
START-INFO-DIR-ENTRY
* WebMagick: (webmagick.info).          WebMagick Image Web Generator
END-INFO-DIR-ENTRY

   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 `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 (C) 1997-2001 Bob Friesenhahn
(bfriesen@simple.dallas.tx.us)


File: webmagick.info,  Node: Thumbnail Title Xref,  Next: Thumb Label Format,  Prev: Thumbnail Label Options,  Up: Thumbnail Label Options

Thumbnail Labels
----------------

`Variable:'
     $opt_imgindexname=filename

`Argument:'
     -imgindexname filename

   Specify the filename for the image name to thumbnail-title
cross-reference for images (default `.imgindex'). If this file exists,
then _labelformat_ will replace _imagename_ if _imagename_ is found in
the file. This provides the ability to use user-specified label text
rather than the default provided by `$opt_thumblabel'. See the
description of `$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:

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


File: webmagick.info,  Node: Thumb Label Format,  Next: Thumb Label Width,  Prev: Thumbnail Title Xref,  Up: Thumbnail Label Options

Thumbnail Label Format
----------------------

`Variable:'
     $opt_thumblabel=format

`Argument:'
     -thumblabel format

   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,

         -label "%m:%f %wx%h"

   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 _"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 `$opt_imgindexname' option for a description of a more
powerful per-image labeling mechanism.

   When `$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:

`%b'
     (file size)

`%f'
     (full filename)

`%h'
     (height)

`%m'
     (magick)

`%n'
     (filename minus extension)

`%w'
     (width)


File: webmagick.info,  Node: Thumb Label Width,  Next: Thumb Label Font,  Prev: Thumb Label Format,  Up: Thumbnail Label Options

Thumbnail Label Width
---------------------

`Variable:'
     $opt_thumblabelwidth=labelwidth

`Argument:'
     -thumblabelwidth labelwidth

   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.


File: webmagick.info,  Node: Thumb Label Font,  Prev: Thumb Label Width,  Up: Thumbnail Label Options

Thumbnail Label Font
--------------------

`Variable:'
     $opt_thumbfont=fontspec

`Argument:'
     -thumbfont fontspec

   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 `--thumbfont=fontspec' and you
should have better luck.


File: webmagick.info,  Node: Thumbnail Hooks,  Prev: Thumbnail Label Options,  Up: Montage Options

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


File: webmagick.info,  Node: Read Fail Hook,  Next: Thumb Post Hook,  Prev: Thumbnail Hooks,  Up: Thumbnail Hooks

Read Failure Hook
-----------------

`Variable:'
     $opt_readfailhook=string

   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:

      $opt_thumbreadfailhook='unlink($imagename)';

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


File: webmagick.info,  Node: Thumb Post Hook,  Next: Thumb Pre Hook,  Prev: Read Fail Hook,  Up: Thumbnail Hooks

Thumbnail Post-processing Hook
------------------------------

`Variable:'
     $opt_thumbposthook=string

   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:

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

   applies the PerlMagick Sharpen operation on the thumbnail,

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

   displays thumbnails in grayscale, and

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

   displays embossed thumbnails.

   See the PerlMagick documentation
(http://www.wizards.dupont.com/cristy/www/perl.html) for the many other
operations which may be applied to an image.


File: webmagick.info,  Node: Thumb Pre Hook,  Prev: Thumb Post Hook,  Up: Thumbnail Hooks

Thumbnail Pre-Processing Hook
-----------------------------

`Variable:'
     $opt_thumbprehook=string

   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:

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

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


File: webmagick.info,  Node: HTML Options,  Next: String Customization,  Prev: Montage Options,  Up: Top

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


File: webmagick.info,  Node: HTML Content,  Next: Text Colors,  Prev: HTML Options,  Up: HTML Options

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::


File: webmagick.info,  Node: Allow Configuration,  Next: JavaScript Mode,  Prev: HTML Content,  Up: HTML Content

Allow Configuration
-------------------

`Variable:'
     $opt_allowconfig=1

`Argument:'
     -allowconfig

   Available only when also using `$opt_javascript' and `$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 `$opt_prefixpath'. For example, if $opt_prefixpath is empty
(the default), the configuration will apply to all directories on the
site.


File: webmagick.info,  Node: JavaScript Mode,  Next: Table Mode,  Prev: Allow Configuration,  Up: HTML Content

JavaScript Mode
---------------

`Variable:'
     $opt_javascript=1

`Argument:'
     -javascript

   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
`$opt_iconpath' (*note 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

     application/x-javascript        js

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

     AddType .js application/x-javascript 8bit

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

             .js             application/x-javascript


File: webmagick.info,  Node: Table Mode,  Next: README File Treatment,  Prev: JavaScript Mode,  Up: HTML Content

Table Mode
----------

`Variable:'
     $opt_tables=1

`Argument:'
     -tables

   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.


File: webmagick.info,  Node: README File Treatment,  Next: Address Info,  Prev: Table Mode,  Up: HTML Content

README File Treatment
---------------------

`Variable:'
     $opt_readmevisible=1

`Argument:'
     -readmevisible

   Specify the handling of a README file. If the file designated by
`$opt_readme' exists (default `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.


File: webmagick.info,  Node: Address Info,  Next: Anonymize,  Prev: README File Treatment,  Up: HTML Content

Address Information
-------------------

`Variable:'
     $opt_address=string

`Argument:'
     -address string

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


File: webmagick.info,  Node: Anonymize,  Next: Page Header,  Prev: Address Info,  Up: HTML Content

Anonymize
---------

`Variable:'
     $opt_anonymous

`Argument:'
     -anonymous

   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.


File: webmagick.info,  Node: Page Header,  Next: Page Title,  Prev: Anonymize,  Up: HTML Content

Page Header
-----------

`Variable:'
     $opt_header=string

`Argument:'
     -header string

   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.


File: webmagick.info,  Node: Page Title,  Next: Stylesheet,  Prev: Page Header,  Up: HTML Content

Page Title
----------

`Variable:'
     $opt_title=string

`Argument:'
     -title string

   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"'.


File: webmagick.info,  Node: Stylesheet,  Next: Dir Page Fmt (No Frames),  Prev: Page Title,  Up: HTML Content

Stylesheet
----------

`Variable:'
     $opt_stylesheet=URL

`Argument:'
     -stylesheet URL

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

   * `$opt_colorfore' (*note Thumb Foreground::)

   * `$opt_colorback' (*note Thumb Background::)

   * `$opt_dircolorfore' (*note Dir Foreground Color::)

   * `$opt_dircolorback' (*note Dir Background Color::)

   * `$opt_coloralink' (*note Thumb Active Link Color::)

   * `$opt_colorlink' (*note Thumb Un-visited Color::)

   * `$opt_colorvlink' (*note Thumb Visited Color::)

   * `$opt_dircoloralink' (*note Dir Active Color::)

   * `$opt_dircolorlink' (*note Dir Un-Visited Color::)

   * `$opt_dircolorvlink' (*note Dir Visited Color::)



File: webmagick.info,  Node: Dir Page Fmt (No Frames),  Next: Dir Page Fmt (Framed),  Prev: Stylesheet,  Up: HTML Content

Directory Page Template (No Frames)
-----------------------------------

`Variable:'
     $opt_dirfmt=string

   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.


File: webmagick.info,  Node: Dir Page Fmt (Framed),  Next: Per-Image HTML,  Prev: Dir Page Fmt (No Frames),  Up: HTML Content

Directory Page Template (Framed)
--------------------------------

`Variable:'
     $opt_frameddirfmt=string

   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.


File: webmagick.info,  Node: Per-Image HTML,  Prev: Dir Page Fmt (Framed),  Up: HTML Content

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::


File: webmagick.info,  Node: Enable Per-image HTML,  Next: Per-image HTML extension,  Prev: Per-Image HTML,  Up: Per-Image HTML

Enable Per-image HTML
.....................

`Variable:'
     $opt_pichtml=1

`Argument:'
     -pichtml

   Enable per-image HTML file generation.


File: webmagick.info,  Node: Per-image HTML extension,  Next: Per-image HTML Nav Buttons,  Prev: Enable Per-image HTML,  Up: Per-Image HTML

Per-image HTML extension
........................

`Variable:'
     $opt_pichtmlext='.ext'.

`Argument:'
     -pichtmlext extention

   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'.


File: webmagick.info,  Node: Per-image HTML Nav Buttons,  Next: Per-image Picture Title,  Prev: Per-image HTML extension,  Up: Per-Image HTML

Per-image HTML Nav Buttons
..........................

`Variable:'
     $opt_pichtmlnav

`Argument:'
     -pichtmlnav

   Enable image navigation buttons (up, previous, next) on per-image
HTML files.


File: webmagick.info,  Node: Per-image Picture Title,  Next: Per-image Picture Title Start HTML,  Prev: Per-image HTML Nav Buttons,  Up: Per-Image HTML

Per-image Picture Title
.......................

`Variable:'
     $opt_pichtmlputtitle

`Argument:'
     -pichtmlputtitle

   Enable per-image HTML picture titles. Default is on.


File: webmagick.info,  Node: Per-image Picture Title Start HTML,  Next: Per-image Picture Title End HTML,  Prev: Per-image Picture Title,  Up: Per-Image HTML

Per-image Picture Title Start HTML
..................................

`Variable:'
     $opt_pichtmltitlestart

`Argument:'
     -pichtmltitlestart

   HTML to add before picture title (default is <P>)


File: webmagick.info,  Node: Per-image Picture Title End HTML,  Next: Default Frame Target,  Prev: Per-image Picture Title Start HTML,  Up: Per-Image HTML

Per-image Picture Title End HTML
................................

`Variable:'
     $opt_pichtmltitleend

`Argument:'
     -pichtmltitleend

   HTML to add after picture title (default is </P>)


File: webmagick.info,  Node: Default Frame Target,  Next: Extra Top HTML,  Prev: Per-image Picture Title End HTML,  Up: Per-Image HTML

Default Frame Target
....................

`Variable:'
     $opt_pichtmltarget='targetname';

`Argument:'
     -pichtmltarget target_name

   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.


File: webmagick.info,  Node: Extra Top HTML,  Next: Extra Bottom HTML,  Prev: Default Frame Target,  Up: Per-Image HTML

Extra Top HTML
..............

`Variable:'
     $opt_pichtmltop='html_source';

`Argument:'
     -pichtmltop 'html_source'

   Extra HTML to insert above the image.


File: webmagick.info,  Node: Extra Bottom HTML,  Prev: Extra Top HTML,  Up: Per-Image HTML

Extra Bottom HTML
.................

`Variable:'
     $opt_pichtmlbottom='html_source';

`Argument:'
     -pichtmlbottom 'html_source'

   Extra HTML to insert below the image.


File: webmagick.info,  Node: Text Colors,  Next: HTML Link Colors,  Prev: HTML Content,  Up: HTML Options

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


File: webmagick.info,  Node: Thumb Background,  Next: Thumb Foreground,  Prev: Text Colors,  Up: Text Colors

Thumbnail Frame Background Color
--------------------------------

`Variable:'
     $opt_colorback=colorspec

`Argument:'
     -colorback colorspec

   Specify the background color for thumbnail frame.


File: webmagick.info,  Node: Thumb Foreground,  Next: Dir Foreground Color,  Prev: Thumb Background,  Up: Text Colors

Thumbnail Frame Text Foreground Color
-------------------------------------

`Variable:'
     $opt_colorfore=colorspec

`Argument:'
     -colorfore colorspec

   Specify the toreground color for text in thumbnail frame.


File: webmagick.info,  Node: Dir Foreground Color,  Next: Dir Background Color,  Prev: Thumb Foreground,  Up: Text Colors

Directory Frame Text Color
--------------------------

`Variable:'
     $opt_dircolorfore=colorspec

`Argument:'
     -dircolorfore colorspec

   Specify the foreground text color of the directory frame. Defaults to
the value of `$opt_colorfore' (*note Thumb Foreground::) if not
explicitly set.


File: webmagick.info,  Node: Dir Background Color,  Prev: Dir Foreground Color,  Up: Text Colors

Directory Frame Background Color
--------------------------------

`Variable:'
     $opt_dircolorback=colorspec

`Argument:'
     -dircolorback colorspec

   Specify the background color of the directory frame. Defaults to the
value of `$opt_colorback' (*note Thumb Background::) if not explicitly
set.


File: webmagick.info,  Node: HTML Link Colors,  Next: Frame Options,  Prev: Text Colors,  Up: HTML Options

HTML Link Colors
================

* 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


File: webmagick.info,  Node: Thumb Active Link Color,  Next: Thumb Un-visited Color,  Prev: HTML Link Colors,  Up: HTML Link Colors

Thumbnail Frame Active Link Color
---------------------------------

`Variable:'
     $opt_coloralink=colorspec

`Argument:'
     -coloralink colorspec

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


File: webmagick.info,  Node: Thumb Un-visited Color,  Next: Thumb Visited Color,  Prev: Thumb Active Link Color,  Up: HTML Link Colors

Thumbnail Frame Un-visited Link Color
-------------------------------------

`Variable:'
     $opt_colorlink=colorspec

`Argument:'
     -colorlink colorspec

   Specify link (unvisited) color for the thumbnail frame.


File: webmagick.info,  Node: Thumb Visited Color,  Next: Dir Active Color,  Prev: Thumb Un-visited Color,  Up: HTML Link Colors

Thumbnail Frame Visited Link Color
----------------------------------

`Variable:'
     $opt_colorvlink=colorspec

`Argument:'
     -colorvlink colorspec

   Specify link (visited) color for the thumbnail frame.


File: webmagick.info,  Node: Dir Active Color,  Next: Dir Un-Visited Color,  Prev: Thumb Visited Color,  Up: HTML Link Colors

Directory Frame Active Link Color
---------------------------------

`Variable:'
     $opt_dircoloralink=colorspec

`Argument:'
     -dircoloralink colorspec

   Specify link (active) color for the directory frame. Defaults to
value of `$opt_coloralink' (*note Thumb Active Link Color::)if not
explicitly set.


File: webmagick.info,  Node: Dir Un-Visited Color,  Next: Dir Visited Color,  Prev: Dir Active Color,  Up: HTML Link Colors

Directory Frame Un-Visited Color
--------------------------------

`Variable:'
     $opt_dircolorlink=colorspec

`Argument:'
     -dircolorlink colorspec

   Specify link (unvisited) color for the directory frame. Defaults to
the value of `$opt_colorlink' (*note Thumb Un-visited Color::) if not
explicitly set.


File: webmagick.info,  Node: Dir Visited Color,  Prev: Dir Un-Visited Color,  Up: HTML Link Colors

Directory Frame Visited Color
-----------------------------

`Variable:'
     $opt_dircolorvlink=colorspec

`Argument:'
     -dircolorvlink colorspec

   Specify link (visited) color for the directory frame. Defaults to
value of `$opt_colorvlink' (*note Thumb Visited Color::) if not
explicitly set.


File: webmagick.info,  Node: Frame Options,  Next: Meta Tags,  Prev: HTML Link Colors,  Up: HTML Options

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)


File: webmagick.info,  Node: Frames,  Next: Frame Borders,  Prev: Frame Options,  Up: Frame Options

Enable Frames
-------------

`Variable:'
     $opt_frames=1

`Argument:'
     -[no]frames

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


File: webmagick.info,  Node: Frame Borders,  Next: Frame Border Thickness,  Prev: Frames,  Up: Frame Options

Enable Frame Borders
--------------------

`Variable:'
     $opt_frameborder=borderenable

`Argument:'
     -frameborder borderenable

   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.


File: webmagick.info,  Node: Frame Border Thickness,  Next: Frame Margin Height,  Prev: Frame Borders,  Up: Frame Options

Frame Border Thickness
----------------------

`Variable:'
     $opt_framebordersize=bordersize

`Argument:'
     -framebordersize bordersize

   Specifies the number of pixels allocated to the frame border.


File: webmagick.info,  Node: Frame Margin Height,  Next: Frame Margin Width,  Prev: Frame Border Thickness,  Up: Frame Options

Frame Margin Height
-------------------

`Variable:'
     $opt_framemarginheight=marginheight

`Argument:'
     -framemarginheight marginheight

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


File: webmagick.info,  Node: Frame Margin Width,  Next: Frame Style,  Prev: Frame Margin Height,  Up: Frame Options

Frame Margin Width
------------------

`Variable:'
     $opt_framemarginwidth=marginwidth

`Argument:'
     -framemarginwidth marginwidth

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


File: webmagick.info,  Node: Frame Style,  Prev: Frame Margin Width,  Up: Frame Options

Frame Style
-----------

`Variable:'
     $opt_framestyle=framestyle

`Argument:'
     -framestyle framestyle

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

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

     	 -------------
     	|  |          |
     	|  |          |
     	|  |          |
     	|  |          |
     	|  |          |
     	|  |          |
     	 -------------


  2.  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.

     	 -------------
     	|  |          |
     	|  |          |
     	|--|          |
     	|  |          |
     	|  |          |
     	|  |          |
     	 -------------


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

     	 -------------
     	|  |          |
     	|  |----------|
     	|  |          |
     	|  |          |
     	|  |          |
     	|  |          |
     	 -------------


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

     	 -------------
     	|             |
     	|-- ----------|
     	|  |          |
     	|  |          |
     	|  |          |
     	|  |          |
     	 -------------



File: webmagick.info,  Node: Meta Tags,  Prev: Frame Options,  Up: HTML Options

HTML Meta Tags
==============

* 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


File: webmagick.info,  Node: Meta Author,  Next: Meta Charset,  Prev: Meta Tags,  Up: Meta Tags

Meta-Tag Author
---------------

`Variable:'
     $opt_metaauthor=string

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


File: webmagick.info,  Node: Meta Charset,  Next: Meta Classification,  Prev: Meta Author,  Up: Meta Tags

Meta-Tag Charset
----------------

`Variable:'
     $opt_metacharset=string

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


File: webmagick.info,  Node: Meta Classification,  Next: Meta Description,  Prev: Meta Charset,  Up: Meta Tags

Meta-Tag Classification
-----------------------

`Variable:'
     $opt_metaclassification=string

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


File: webmagick.info,  Node: Meta Description,  Next: Meta Expires,  Prev: Meta Classification,  Up: Meta Tags

Meta-Tag Description
--------------------

`Variable:'
     $opt_metadescription=string

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


File: webmagick.info,  Node: Meta Expires,  Next: Meta Key-Words,  Prev: Meta Description,  Up: Meta Tags

Meta-Tag Expires
----------------

`Variable:'
     $opt_metaexpires=string

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

     	"Tue, 20 Aug 1996 14:25:27 GMT"

   Since the specified expiration time is absolute, use of this option
implies a commitment to execute WebMagick with option `--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.


File: webmagick.info,  Node: Meta Key-Words,  Prev: Meta Expires,  Up: Meta Tags

Meta-Tag Key-Words
------------------

`Variable:'
     $opt_metakeywords=string

   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.


File: webmagick.info,  Node: String Customization,  Next: Authors,  Prev: HTML Options,  Up: Top

String Customization
********************

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

`Variable:'
     $opt_msg_copyright = "Copyright "

`Variable:'
     $opt_date_format = "%B %e, %Y" (see strftime(3))

`Variable:'
     $opt_msg_directories = "Directories"

`Variable:'
     $opt_msg_directory_navigator = "Directory Navigator"

`Variable:'
     $opt_msg_images = "Images"

`Variable:'
     $opt_msg_index_of_directory = "Index of directory"

`Variable:'
     $opt_msg_index_of_files = "Index of files "

`Variable:'
     $opt_msg_index_through = "through"

`Variable:'
     $opt_msg_next = "Next"

`Variable:'
     $opt_msg_page_navigator = "Page Navigator"

`Variable:'
     $opt_msg_page_updated_on = "Page update on"

`Variable:'
     $opt_msg_prev = "Prev"

`Variable:'
     $opt_msg_produced_by = "Produced by"

`Variable:'
     $opt_msg_readme = "ReadMe"

`Variable:'
     $opt_msg_up = "Up"


File: webmagick.info,  Node: Authors,  Next: Obtaining WebMagick,  Prev: String Customization,  Up: Top

Authors
*******

   WebMagick is currently maintained by Chris Lindell
<clindell@users.sourceforge.net>.  It was written by Bob Friesenhahn
<bfriesen@simple.dallas.tx.us> with copious input from Anthony Thyssen
<anthony@cit.gu.edu.au>. 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 Andrey
A. Chernov <ache@nagual.pp.ru>.

   ImageMagick and PerlMagick are written by John Cristy
<cristy@dupont.com>. 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.


File: webmagick.info,  Node: Obtaining WebMagick,  Next: Installation,  Prev: Authors,  Up: Top

Obtaining WebMagick
*******************

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

  1. PERL version 5 (http://www.perl.com/perl/index.html)

  2. ImageMagick (http://www.wizards.dupont.com/cristy/ImageMagick.html)

  3. PerlMagick (http://www.wizards.dupont.com/cristy/www/perl.html)

  4. WebMagick (http://webmagick.sourceforge.net)

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


File: webmagick.info,  Node: Installation,  Next: Option Index,  Prev: Obtaining WebMagick,  Up: Top

Installing WebMagick
********************

* Menu:

* Basic Installation::
* Installation Names::


File: webmagick.info,  Node: Basic Installation,  Next: Installation Names,  Prev: Installation,  Up: Installation

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
`$opt_prefixpath', `$opt_rootpath', `$opt_iconpath', `$opt_htimage',
and `$opt_maptype' in the `webmagick' script and the sample
`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
`webmagick.js' must be installed in the location specified by
`$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.


File: webmagick.info,  Node: Installation Names,  Prev: Basic Installation,  Up: Installation

Installation Names
==================

   By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.

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


File: webmagick.info,  Node: Option Index,  Next: Argument Index,  Prev: Installation,  Up: Top

Option Index
************

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

* Menu:

* $opt_address:                          Address Info.
* $opt_allowconfig:                      Allow Configuration.
* $opt_anonymous:                        Anonymize.
* $opt_cache:                            Caching.
* $opt_cachedir:                         Cache Directory.
* $opt_cacheformat:                      Cache Thumbnail Format.
* $opt_cachegeom:                        Cache Thumnail Geometry.
* $opt_cachemin:                         Cache Minimum Image Size.
* $opt_coloralink:                       Thumb Active Link Color.
* $opt_colorback:                        Thumb Background.
* $opt_colorfore:                        Thumb Foreground.
* $opt_colorlink:                        Thumb Un-visited Color.
* $opt_colorvlink:                       Thumb Visited Color.
* $opt_columns:                          Columns.
* $opt_date_format:                      String Customization.
* $opt_debug:                            Debug Output.
* $opt_dircoloralink:                    Dir Active Color.
* $opt_dircolorback:                     Dir Background Color.
* $opt_dircolorfore:                     Dir Foreground Color.
* $opt_dircolorlink:                     Dir Un-Visited Color.
* $opt_dircolorvlink:                    Dir Visited Color.
* $opt_dirfmt:                           Dir Page Fmt (No Frames).
* $opt_dirindexname:                     Directory Title Xref.
* $opt_forcecache:                       Force Cache.
* $opt_forcegif:                         Force GIF Format.
* $opt_forcehtml:                        Force HTML.
* $opt_forcemontage:                     Force Montage.
* $opt_frameborder:                      Frame Borders.
* $opt_framebordersize:                  Frame Border Thickness.
* $opt_frameddirfmt:                     Dir Page Fmt (Framed).
* $opt_framemarginheight:                Frame Margin Height.
* $opt_framemarginwidth:                 Frame Margin Width.
* $opt_frames:                           Frames.
* $opt_framestyle:                       Frame Style.
* $opt_header:                           Page Header.
* $opt_help:                             Display Help.
* $opt_htimage:                          Imagemap Program.
* $opt_iconpath:                         Icon Location.
* $opt_ignorefp:                         Ignore FrontPage.
* $opt_imgindexname:                     Thumbnail Title Xref.
* $opt_indexname:                        Index File Base Name.
* $opt_javascript:                       JavaScript Mode.
* $opt_mapnetscape:                      Netscape Color Cube.
* $opt_maptype:                          Imagemap Type.
* $opt_maxgif:                           GIF/JPEG Transition Point.
* $opt_metaauthor:                       Meta Author.
* $opt_metacharset:                      Meta Charset.
* $opt_metaclassification:               Meta Classification.
* $opt_metadescription:                  Meta Description.
* $opt_metaexpires:                      Meta Expires.
* $opt_metakeywords:                     Meta Key-Words.
* $opt_msg_copyright:                    String Customization.
* $opt_msg_directories:                  String Customization.
* $opt_msg_directory_navigator:          String Customization.
* $opt_msg_images:                       String Customization.
* $opt_msg_index_of_directory:           String Customization.
* $opt_msg_index_of_files:               String Customization.
* $opt_msg_index_through:                String Customization.
* $opt_msg_next:                         String Customization.
* $opt_msg_page_navigator:               String Customization.
* $opt_msg_page_updated_on:              String Customization.
* $opt_msg_prev:                         String Customization.
* $opt_msg_produced_by:                  String Customization.
* $opt_msg_readme:                       String Customization.
* $opt_msg_up:                           String Customization.
* $opt_pageindexname:                    Page Index File Name.
* $opt_pichtml:                          Enable Per-image HTML.
* $opt_pichtmlbottom:                    Extra Bottom HTML.
* $opt_pichtmlext:                       Per-image HTML extension.
* $opt_pichtmlnav:                       Per-image HTML Nav Buttons.
* $opt_pichtmlputtitle:                  Per-image Picture Title.
* $opt_pichtmltarget:                    Default Frame Target.
* $opt_pichtmltitleend:                  Per-image Picture Title End HTML.
* $opt_pichtmltitlestart:                Per-image Picture Title Start HTML.
* $opt_pichtmltop:                       Extra Top HTML.
* $opt_prefixpath:                       Root Prefix.
* $opt_prune:                            Prune Directory.
* $opt_readfailhook:                     Read Fail Hook.
* $opt_readme:                           README File Name.
* $opt_readmevisible:                    README File Treatment.
* $opt_recurse:                          Recursion.
* $opt_rootpath:                         Server Root Path.
* $opt_rows:                             Rows.
* $opt_srcdir:                           Source Directory.
* $opt_stylesheet:                       Stylesheet.
* $opt_tables:                           Table Mode.
* $opt_thumbbackground:                  Thumb Background Color.
* $opt_thumbborderwidth:                 Border Width.
* $opt_thumbcompose:                     Composition Algorithm.
* $opt_thumbfont:                        Thumb Label Font.
* $opt_thumbforeground:                  Thumb Foreground Color.
* $opt_thumbframe:                       Thumb Frame.
* $opt_thumbframebgcolor:                Border Color.
* $opt_thumbframecolor:                  Thumb Frame Color.
* $opt_thumbgeometry:                    Thumb Geometry.
* $opt_thumbgravity:                     Thumb Gravity.
* $opt_thumblabel:                       Thumb Label Format.
* $opt_thumblabelwidth:                  Thumb Label Width.
* $opt_thumbposthook:                    Thumb Post Hook.
* $opt_thumbprehook:                     Thumb Pre Hook.
* $opt_thumbshadow:                      Thumb Shadows.
* $opt_thumbtexture:                     Thumb Background Texture.
* $opt_thumbtransparent:                 Thumb Trans Color.
* $opt_title:                            Page Title.
* $opt_verbose:                          Verbose Output.
* $opt_zoomfilter:                       Zoom Filter.
* %opt_icons:                            Icon File Names.


File: webmagick.info,  Node: Argument Index,  Next: Concept Index,  Prev: Option Index,  Up: Top

Argument Index
**************

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

* Menu:

* --address:                             Address Info.
* --allowconfig:                         Allow Configuration.
* --anonymous:                           Anonymize.
* --cache:                               Caching.
* --cachedir:                            Cache Directory.
* --cacheformat:                         Cache Thumbnail Format.
* --cachegeom:                           Cache Thumnail Geometry.
* --cachemin:                            Cache Minimum Image Size.
* --coloralink:                          Thumb Active Link Color.
* --colorback:                           Thumb Background.
* --colorfore:                           Thumb Foreground.
* --colorlink:                           Thumb Un-visited Color.
* --colorvlink:                          Thumb Visited Color.
* --columns:                             Columns.
* --debug:                               Debug Output.
* --dircoloralink:                       Dir Active Color.
* --dircolorback:                        Dir Background Color.
* --dircolorfore:                        Dir Foreground Color.
* --dircolorlink:                        Dir Un-Visited Color.
* --dircolorvlink:                       Dir Visited Color.
* --dirindexname:                        Directory Title Xref.
* --forcecache:                          Force Cache.
* --forcegif:                            Force GIF Format.
* --forcehtml:                           Force HTML.
* --forcemontage:                        Force Montage.
* --frameborder:                         Frame Borders.
* --framebordersize:                     Frame Border Thickness.
* --framemarginheight:                   Frame Margin Height.
* --framemarginwidth:                    Frame Margin Width.
* --frames:                              Frames.
* --framestyle:                          Frame Style.
* --header:                              Page Header.
* --help:                                Display Help.
* --htimage:                             Imagemap Program.
* --iconpath:                            Icon Location.
* --ignorefp:                            Ignore FrontPage.
* --imgindexname:                        Thumbnail Title Xref.
* --indexname:                           Index File Base Name.
* --javascript:                          JavaScript Mode.
* --mapnetscape:                         Netscape Color Cube.
* --maptype:                             Imagemap Type.
* --maxgif:                              GIF/JPEG Transition Point.
* --pageindexname:                       Page Index File Name.
* --pichtml:                             Enable Per-image HTML.
* --pichtmlbottom:                       Extra Bottom HTML.
* --pichtmlext:                          Per-image HTML extension.
* --pichtmlnav:                          Per-image HTML Nav Buttons.
* --pichtmlputtitle:                     Per-image Picture Title.
* --pichtmltarget:                       Default Frame Target.
* --pichtmltitleend:                     Per-image Picture Title End HTML.
* --pichtmltitlestart:                   Per-image Picture Title Start HTML.
* --pichtmltop:                          Extra Top HTML.
* --prefixpath:                          Root Prefix.
* --readme:                              README File Name.
* --readmevisible:                       README File Treatment.
* --recurse:                             Recursion.
* --rootpath:                            Server Root Path.
* --rows:                                Rows.
* --srcdir:                              Source Directory.
* --stylesheet:                          Stylesheet.
* --tables:                              Table Mode.
* --thumbbackground:                     Thumb Background Color.
* --thumbcompose:                        Composition Algorithm.
* --thumbfont:                           Thumb Label Font.
* --thumbforeground:                     Thumb Foreground Color.
* --thumbframe:                          Thumb Frame.
* --thumbframebgcolor:                   Border Color.
* --thumbframecolor:                     Thumb Frame Color.
* --thumbgeometry:                       Thumb Geometry.
* --thumbgravity:                        Thumb Gravity.
* --thumblabel:                          Thumb Label Format.
* --thumblabelwidth:                     Thumb Label Width.
* --thumbshadow:                         Thumb Shadows.
* --thumbtexture:                        Thumb Background Texture.
* --thumbtransparent:                    Thumb Trans Color.
* --title:                               Page Title.
* --verbose:                             Verbose Output.
* --zoomfilter:                          Zoom Filter.

