ALE 0.6.0 User Manual

Purpose

This page summarizes ALE program operation and command-line usage.

Manual pages linked from this section describe file output, rendering and alignment.

For more information on ALE, see the ALE Home Page.

Parameter Meta-syntax

`<foo>`	A required parameter called foo.
`[<foo>]`	An optional parameter called foo.
`[<foo>]*`	Zero or more parameters foo.

Command-line syntax for Image Processing

The following command-line invocation can be used to process a series of frames into an output file:

ale [<option>]* <original-frame> [<supplemental-frame>]* <output-file>

Option Arguments

Options are outlined in the manual pages describing file output, rendering and alignment.

Image Files

ALE can be configured at compile time to use one of two different file handlers. Execute 'ale --version' to determine which file handler is being used. The table below outlines the supported formats for each file handler.

Version Message	File Types Supported
File handler: ImageMagick	Input and output files can be any of the formats supported by ImageMagick.
File handler: PPM	Input files must be PPM, and output files are written as PPM.

Note that many external programs, including ImageMagick's command line utilities, can be used to convert between PPM and other formats.

See the README included in the source distribution for more information about compile-time configuration of file handlers.

Command-line syntax for Version Information

The following command-line invocation can be used to print version information and build options:

ale --version

The following is sample output from this invocation:

ALE Version:      0.6.0
File handler:     ImageMagick
Color data:       SINGLE
Coordinate data:  SINGLE
DFT:              Built-in
Assertions:       Disabled

The first line of output indicates the version of ALE source code being used, while the remaining lines reflect the build options selected at compile time.

For more information about build options, see the README file included in the source distribution.

Command-line syntax for Help Output

When invoked with no options, or options detected as incorrect, ALE outputs a help message specifying command-line usage and available options. The following is a sample invocation:

ale

Related Manual Pages

Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved.