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

General

Display Help

Variable:

$opt_help=1

Argument:

--help

Display usage message.

Specify Source Directory

Variable:

$opt_srcdir=path

Argument:

--srcdir path

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.

Enable Verbose Output

Variable:

$opt_verbose=1

Argument:

--verbose

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.

Enable Debug Output

Variable:

$opt_debug=1

Argument:

--debug

Print debugging messages.

Sub-Directory Processing

Recurse Sub-Directories

Variable:

$opt_recurse=1

Argument:

--recurse

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.

Prune Directory

Variable:

$opt_prune=1

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

Ignore Directory

Variable:

$opt_ignore=1

If $opt_ignore is set in a directory's `.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 $opt_indexname.

Ignore FrontPage

Variable:

$opt_ignorefp=1

Argument:

--ignorefp

If $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]).

Forcing Output To Be Generated

WebMagick uses algorithms similar in concept to those used by 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.

Force Generation Of Thumbnail Cache

Variable:

$opt_forcecache=1

Argument:

--forcecache

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 $opt_cache must be set to a non-zero value. The --forcemontage option be used to force montages.

Force Generation Of HTML Files

Variable:

$opt_forcehtml=1

Argument:

--forcehtml

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

Force Generation Of Montage

Variable:

$opt_forcemontage=1

Argument:

--forcemontage

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