From f321af08411110c755286747c81a3bc719d0b181 Mon Sep 17 00:00:00 2001 From: dhilvert Date: Sun, 8 Oct 2006 10:36:00 +0000 Subject: [PATCH] README: migrate to the documentation subdirectory. darcs-hash:20061008103612-789c2-34c56ee8652ddca9ec154a11c90bbbfd45d6ac32.gz --- README | 232 ------------------------------------ doc/Makefile | 5 +- doc/ale-doc.xsl | 54 ++++++++- doc/package/index.xml | 6 +- doc/package/readme/index.xml | 274 +++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 329 insertions(+), 242 deletions(-) delete mode 100644 README create mode 100644 doc/package/readme/index.xml diff --git a/README b/README deleted file mode 100644 index 918c69d..0000000 --- a/README +++ /dev/null @@ -1,232 +0,0 @@ -======================== -ALE version 0.8.4 README -======================== - -This file includes download, build, and installation instructions specific to -this software package. For additional instructions on using 'autotools' build -and installation scripts, see the 'INSTALL' file. Documentation regarding use -of the software is provided in the 'doc' directory of this package, and may -also be available from the project web site. See the end of this file for -relevant URLs. - -Subsections: - - + Package URLs - + Build prerequisites - - GCC C++ compiler - - Prerequisites for native Windows builds - - Cross compilation - + Extraction - + Running configure - + Configuration options - - ImageMagick Support - - Color Data Precision - - Coordinate Data Precision - - FFTW Support - - Enable --wmx - - Getsize - - Assertions - + Further Documentation - + URLs - + Mailing List - - -Package URLs -============ - -http://auricle.dyndns.org/ALE/download/ale-0.8.4.tar.gz - - -Build prerequisites -=================== - - -GCC C++ compiler ----------------- - -GCC version 3.2.3 with C++ support is known to build ALE successfully. Older -versions of GCC may fail to compile some versions of ALE. - - -Prerequisites for native Windows builds ---------------------------------------- - -Successfully running the configuration script on Windows (e.g., for native -builds) may require installation of Cygwin. For more information on Cygwin, -see: - -http://www.cygwin.com/ - -Alternatively, this package can be cross-compiled for Windows on a non-Windows -architecture, provided that the appropriate cross-compilers and libraries are -available. - - -Cross-compilation ------------------ - -For cross-compilation, it may be necessary to specify both host and build -machine types, using the configure --host and --build options. For more -information on these options, see the 'INSTALL' file. - - -Extraction -========== - -Download the source archive file from the URL indicated in the section 'Package -URLs', and invoke: - - tar xzf ale-0.8.4.tar.gz - cd ale-0.8.4 - -Invoking 'ls configure' afterward should reveal an executable script -'configure'. This script is used to determine the capabilities of the system -that will run the software. - - -Running configure -================= - -This package uses a configuration script, 'configure', generated by the GNU -project build tools ("autotools"). For most cases, it should be sufficient to -invoke: - - ./configure - make - make install - -Configuration options specific to this software package are described in the -following section. General operation of the script is described in more detail -in the INSTALL file. - - -Configuration options -===================== - -Configuration options should be passed to the 'configure' script prior to build -and installation, as: - - ./configure --config-option1 --config-option2 ... - make - make install - -Options specific to this package are described in the following subsections. -General configuration options are described in the INSTALL file. - - -ImageMagick Support -------------------- - -Enabling ImageMagick support allows ALE to make use of the file-handling -capabilities of ImageMagick ( http://imagemagick.org/ ). This includes reading -and writing a variety of file formats, including, among many others, PNG and -JPEG (two formats commonly used in web publishing) as well as common -interchange formats such as PPM and TIFF. ImageMagick 6.0.6 is known to work -with this version of ALE; certain older versions of ImageMagick may cause -compile, link, or runtime errors. By default, support is automatically -detected. - ---with-imagemagick=auto Auto-detect ImageMagick support [default] ---with-imagemagick=yes Enable ImageMagick support ---with-imagemagick=no Disable ImageMagick support - - -Color Data Precision --------------------- - -ALE's internal data structures store each color channel within a pixel as -floating-point data; similarly, arithmetic operations on color channels are -performed in floating point. The available data-type configurations are -listed below, with typical data sizes indicated in parentheses. - ---with-colors=single Use C++ 'float' data type (32-bit) [default] ---with-colors=double Use C++ 'double' data type (64-bit) - - -Coordinate Data Precision -------------------------- - -In general, coordinate transformations used by ALE produce results outside of -the set of integers; hence, coordinates are treated as floating-point data. -The two available data-type configurations are listed below, with typical data -sizes indicated in parentheses. - ---with-coords=single Use C++ 'float' data type (32-bit) [default] ---with-coords=double Use C++ 'double' data type (64-bit) - - -FFTW Support ------------- - -This feature is required in order to use the --fl option; it also determines -the approach to calculation of discrete Fourier transforms used by the -Irani-Peleg renderer. For more information on FFTW, see http://fftw.org/. - ---with-fftw3=auto Auto-detect FFTW3. [default] ---with-fftw3=yes Use FFTW3 discrete Fourier transform. ---with-fftw3=no Use built-in discrete Fourier transform. - - -Enable --wmx ------------- - -This build option is required in order to use the --wmx option. If ---enable-wmx is specified, it is expected that fork() and execlp() calls -are available. - ---enable-wmx=auto Automatically detect whether to enable --wmx ---enable-wmx=yes Enable --wmx ---enable-wmx=no Do not enable --wmx - - -Getsize -------- - -This build option is required to obtain additional output from --ui=tty. If -TIOCGWINSZ is not defined in , however, additional output will not -be provided even if --enable-getsize is specified at build time. - ---enable-getsize=auto Check for TIOCGWINSZ at build time. [default] ---enable-getsize=yes Configure to attempt to use TIOCGWINSZ ---enable-getsize=no Do not attempt to use TIOCGWINSZ - - -Assertions ----------- - -Finding bugs within ALE, or within custom modifications to ALE, can be -simplified by enabling run-time assertions. These checks enforce conditions -believed to be necessary or desirable for correct program operation. If a -condition is not satisfied, ALE will abort and display a message indicating the -failed assertion. - ---enable-assertions Enable assertions. [default] ---disable-assertions Disable assertions. - - -Further Documentation -===================== - -For information about command-line usage, program options, and program -operation, see the manual included with this package. The manual may also be -available on-line at the URL listed in the following section. - - -URLs -==== - -Home Page http://auricle.dyndns.org/ALE/ -Manuals http://auricle.dyndns.org/ALE/manuals/ -Mailing list archive http://ventricle.dyndns.org/pipermail/ale/ - - -Mailing List -============ - -Bug reports, feature requests, patch and release announcements, and related -discussion can be sent to ale@ventricle.dyndns.org. Archives of past postings -and subscription information are available at the URLs indicated below. - -Posting address ale@ventricle.dyndns.org -Subscription info http://ventricle.dyndns.org/cgi-bin/mailman/listinfo/ale -Archives http://ventricle.dyndns.org/pipermail/ale/ diff --git a/doc/Makefile b/doc/Makefile index 50b40d3..6e01edc 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -449,7 +449,7 @@ MAN_CUSTOM := - + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -728,5 +764,11 @@ + + + + + + diff --git a/doc/package/index.xml b/doc/package/index.xml index c92b6be..92a8a4f 100644 --- a/doc/package/index.xml +++ b/doc/package/index.xml @@ -9,12 +9,12 @@ Package Manual - + - diff --git a/doc/package/readme/index.xml b/doc/package/readme/index.xml new file mode 100644 index 0000000..7ee2439 --- /dev/null +++ b/doc/package/readme/index.xml @@ -0,0 +1,274 @@ + + + + +
+ + + + Installation Guide + This article includes download, build, and installation instructions specific + to this software package. + + + + + + + + +Windows Binaries + +URLs + +
  • +
+ + +Extraction and Use + +

The zip file available at the above URL is an archive containing the ALE +executable; a zip archival utility can be used to extract the executable from +the archive.

+ +

Once extracted, since ALE is a command-line program, it may be necessary to +open a command prompt window to use ALE successfully. For more information +about command-line usage and options, see the User Manual.

+ + + + +Compiling from source + +URLs + +
  • +
+ + + +Build prerequisites + +GCC C++ compiler + +

GCC version 3.2.3 with C++ support is known to build ALE successfully. Older +versions of GCC may fail to compile some versions of ALE.

+ + + +Prerequisites for building on Windows + +

Successfully running the configuration script on Windows (e.g., for native +builds) may require installation of Cygwin. For more information on Cygwin, +see:

+ +
  • +
+ +

Alternatively, this package can be cross-compiled for Windows on a non-Windows +architecture, provided that the appropriate cross-compilers and libraries are +available.

+ + + + + +Extraction + +

Download the source archive file from the URL indicated in the section +'URLs', and invoke:

+ +tar xzf +cd + + +

Invoking 'ls configure' afterward should reveal an executable script +'configure'. This script is used to determine the capabilities of the system +that will run the software.

+ + + +Running configure + +

This package uses a configuration script, 'configure', generated by the GNU +project build tools ("autotools"). For most cases, it should be sufficient to +invoke:

+ +./configure +make +make install + + +

In cases where the defaults are not adequate, configuration options can be +passed to the configuration script.

+ + +Configuration options + +

Configuration options can be passed to the 'configure' script prior to build +and installation, as:

+ +./configure --config-option1 --config-option2 ... +make +make install + + +

Options specific to this package are described in the following subsections. +General configuration options are described in the file 'INSTALL' included in +the source package.

+ +ImageMagick Support + +

Enabling ImageMagick support allows ALE to make use of the file-handling +capabilities of ImageMagick ( ). This +includes reading and writing a variety of file formats, including, among many +others, PNG and JPEG (two formats commonly used in web publishing) as well as +common interchange formats such as PPM and TIFF. ImageMagick 6.0.6 is known to +work with this version of ALE; certain older versions of ImageMagick may cause +compile, link, or runtime errors. By default, support is automatically +detected.

+ +--with-imagemagick=auto Auto-detect ImageMagick support [default] +--with-imagemagick=yes Enable ImageMagick support +--with-imagemagick=no Disable ImageMagick support + + + +Color Data Precision + +

ALE's internal data structures store each color channel within a pixel as +floating-point data; similarly, arithmetic operations on color channels are +performed in floating point. The available data-type configurations are +listed below, with typical data sizes indicated in parentheses.

+ +--with-colors=single Use C++ 'float' data type (32-bit) [default] +--with-colors=double Use C++ 'double' data type (64-bit) + + + + +Coordinate Data Precision + + +

In general, coordinate transformations used by ALE produce results outside of +the set of integers; hence, coordinates are treated as floating-point data. +The two available data-type configurations are listed below, with typical data +sizes indicated in parentheses.

+ +--with-coords=single Use C++ 'float' data type (32-bit) [default] +--with-coords=double Use C++ 'double' data type (64-bit) + + + + +FFTW Support + + +

+This feature is required in order to use the --fl option; it also determines +the approach to calculation of discrete Fourier transforms used by the +Irani-Peleg renderer. For more information on FFTW, see http://fftw.org/. +

+ +--with-fftw3=auto Auto-detect FFTW3. [default] +--with-fftw3=yes Use FFTW3 discrete Fourier transform. +--with-fftw3=no Use built-in discrete Fourier transform. + + + + + +Enable --wmx + + +

+This build option is required in order to use the --wmx option. If +--enable-wmx is specified, it is expected that fork() and execlp() calls +are available. +

+ +--enable-wmx=auto Automatically detect whether to enable --wmx +--enable-wmx=yes Enable --wmx +--enable-wmx=no Do not enable --wmx + + + + +Getsize + +

This build option is required to obtain additional output from --ui=tty. If +TIOCGWINSZ is not defined in <sys/ioctl.h>, however, additional output will not +be provided even if --enable-getsize is specified at build time. +

+ +--enable-getsize=auto Check for TIOCGWINSZ at build time. [default] +--enable-getsize=yes Configure to attempt to use TIOCGWINSZ +--enable-getsize=no Do not attempt to use TIOCGWINSZ + + + + + +Assertions + + +

+Finding bugs within ALE, or within custom modifications to ALE, can be +simplified by enabling run-time assertions. These checks enforce conditions +believed to be necessary or desirable for correct program operation. If a +condition is not satisfied, ALE will abort and display a message indicating the +failed assertion. +

+ +--enable-assertions Enable assertions. [default] +--disable-assertions Disable assertions. + + + + + +Cross-compilation + +

For cross-compilation, it may be necessary to specify both host and build +machine types, using the configure --host and --build options. For more +information on these options, see the file 'INSTALL' in the source package.

+ + +Further details + +

General operation of the configure script is described in more detail in the +file 'INSTALL' in the source package.

+ + + + +Further Documentation + +

For information about command-line usage, program options, and program +operation, see the manuals included with the source package. Manuals may +also be available on-line at the URL listed in the following section.

+ + + +On-line resources + +Home Page http://auricle.dyndns.org/ALE/ +Manuals http://auricle.dyndns.org/ALE/manuals/ +Mailing list archive http://ventricle.dyndns.org/pipermail/ale/ + + +Mailing list + +

Bug reports, feature requests, patch and release announcements, and related +discussion can be sent to ale@ventricle.dyndns.org. Archives of past postings +and subscription information are available at the URLs indicated below.

+ +Posting address ale@ventricle.dyndns.org +Subscription info http://ventricle.dyndns.org/cgi-bin/mailman/listinfo/ale +Archives http://ventricle.dyndns.org/pipermail/ale/ + + + + +
-- 2.11.4.GIT