diff options
| -rw-r--r-- | INSTALL | 234 | ||||
| -rw-r--r-- | README | 94 | ||||
| -rw-r--r-- | configure.ac | 2 |
3 files changed, 306 insertions, 24 deletions
@@ -0,0 +1,234 @@ +Installation Instructions +************************* + +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, +2006 Free Software Foundation, Inc. + +This file is free documentation; the Free Software Foundation gives +unlimited permission to copy, distribute and modify it. + +Basic Installation +================== + +Briefly, the shell commands `./configure; make; make install' should +configure, build, and install this package. The following +more-detailed instructions are generic; see the `README' file for +instructions specific to this package. + + The `configure' shell script attempts to guess correct values for +various system-dependent variables used during compilation. It uses +those values to create a `Makefile' in each directory of the package. +It may also create one or more `.h' files containing system-dependent +definitions. Finally, it creates a shell script `config.status' that +you can run in the future to recreate the current configuration, and a +file `config.log' containing compiler output (useful mainly for +debugging `configure'). + + It can also use an optional file (typically called `config.cache' +and enabled with `--cache-file=config.cache' or simply `-C') that saves +the results of its tests to speed up reconfiguring. Caching is +disabled by default to prevent problems with accidental use of stale +cache files. + + If you need to do unusual things to compile the package, please try +to figure out how `configure' could check whether to do them, and mail +diffs or instructions to the address given in the `README' so they can +be considered for the next release. If you are using the cache, and at +some point `config.cache' contains results you don't want to keep, you +may remove or edit it. + + The file `configure.ac' (or `configure.in') is used to create +`configure' by a program called `autoconf'. You need `configure.ac' if +you want to change it or regenerate `configure' using a newer version +of `autoconf'. + +The simplest way to compile this package is: + + 1. `cd' to the directory containing the package's source code and type + `./configure' to configure the package for your system. + + Running `configure' might take a while. While running, it prints + some messages telling which features it is checking for. + + 2. Type `make' to compile the package. + + 3. Optionally, type `make check' to run any self-tests that come with + the package. + + 4. Type `make install' to install the programs and any data files and + documentation. + + 5. You can remove the program binaries and object files from the + source code directory by typing `make clean'. To also remove the + files that `configure' created (so you can compile the package for + a different kind of computer), type `make distclean'. There is + also a `make maintainer-clean' target, but that is intended mainly + for the package's developers. If you use it, you may have to get + all sorts of other programs in order to regenerate files that came + with the distribution. + +Compilers and Options +===================== + +Some systems require unusual options for compilation or linking that the +`configure' script does not know about. Run `./configure --help' for +details on some of the pertinent environment variables. + + You can give `configure' initial values for configuration parameters +by setting variables in the command line or in the environment. Here +is an example: + + ./configure CC=c99 CFLAGS=-g LIBS=-lposix + + *Note Defining Variables::, for more details. + +Compiling For Multiple Architectures +==================================== + +You can compile the package for more than one kind of computer at the +same time, by placing the object files for each architecture in their +own directory. To do this, you can use GNU `make'. `cd' to the +directory where you want the object files and executables to go and run +the `configure' script. `configure' automatically checks for the +source code in the directory that `configure' is in and in `..'. + + With a non-GNU `make', it is safer to compile the package for one +architecture at a time in the source code directory. After you have +installed the package for one architecture, use `make distclean' before +reconfiguring for another architecture. + +Installation Names +================== + +By default, `make install' installs the package's commands under +`/usr/local/bin', include files under `/usr/local/include', etc. You +can specify an installation prefix other than `/usr/local' by giving +`configure' the option `--prefix=PREFIX'. + + You can specify separate installation prefixes for +architecture-specific files and architecture-independent files. If you +pass the option `--exec-prefix=PREFIX' to `configure', the package uses +PREFIX as the prefix for installing programs and libraries. +Documentation and other data files still use the regular prefix. + + In addition, if you use an unusual directory layout you can give +options like `--bindir=DIR' 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. + + If the package supports it, you can cause programs to be installed +with an extra prefix or suffix on their names by giving `configure' the +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. + +Optional Features +================= + +Some packages pay attention to `--enable-FEATURE' options to +`configure', where FEATURE indicates an optional part of the package. +They may also pay attention to `--with-PACKAGE' options, where PACKAGE +is something like `gnu-as' or `x' (for the X Window System). The +`README' should mention any `--enable-' and `--with-' options that the +package recognizes. + + For packages that use the X Window System, `configure' can usually +find the X include and library files automatically, but if it doesn't, +you can use the `configure' options `--x-includes=DIR' and +`--x-libraries=DIR' to specify their locations. + +Specifying the System Type +========================== + +There may be some features `configure' cannot figure out automatically, +but needs to determine by the type of machine the package will run on. +Usually, assuming the package is built to be run on the _same_ +architectures, `configure' can figure that out, but if it prints a +message saying it cannot guess the machine type, give it the +`--build=TYPE' option. TYPE can either be a short name for the system +type, such as `sun4', or a canonical name which has the form: + + CPU-COMPANY-SYSTEM + +where SYSTEM can have one of these forms: + + OS KERNEL-OS + + See the file `config.sub' for the possible values of each field. If +`config.sub' isn't included in this package, then this package doesn't +need to know the machine type. + + If you are _building_ compiler tools for cross-compiling, you should +use the option `--target=TYPE' to select the type of system they will +produce code for. + + If you want to _use_ a cross compiler, that generates code for a +platform different from the build platform, you should specify the +"host" platform (i.e., that on which the generated programs will +eventually be run) with `--host=TYPE'. + +Sharing Defaults +================ + +If you want to set default values for `configure' scripts to share, you +can create a site shell script called `config.site' that gives default +values for variables like `CC', `cache_file', and `prefix'. +`configure' looks for `PREFIX/share/config.site' if it exists, then +`PREFIX/etc/config.site' if it exists. Or, you can set the +`CONFIG_SITE' environment variable to the location of the site script. +A warning: not all `configure' scripts look for a site script. + +Defining Variables +================== + +Variables not defined in a site shell script can be set in the +environment passed to `configure'. However, some packages may run +configure again during the build, and the customized values of these +variables may be lost. In order to avoid this problem, you should set +them in the `configure' command line, using `VAR=value'. For example: + + ./configure CC=/usr/local2/bin/gcc + +causes the specified `gcc' to be used as the C compiler (unless it is +overridden in the site shell script). + +Unfortunately, this technique does not work for `CONFIG_SHELL' due to +an Autoconf bug. Until the bug is fixed you can use this workaround: + + CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash + +`configure' Invocation +====================== + +`configure' recognizes the following options to control how it operates. + +`--help' +`-h' + Print a summary of the options to `configure', and exit. + +`--version' +`-V' + Print the version of Autoconf used to generate the `configure' + script, and exit. + +`--cache-file=FILE' + Enable the cache: use and save the results of the tests in FILE, + traditionally `config.cache'. FILE defaults to `/dev/null' to + disable caching. + +`--config-cache' +`-C' + Alias for `--cache-file=config.cache'. + +`--quiet' +`--silent' +`-q' + Do not print messages saying which checks are being made. To + suppress all normal output, redirect it to `/dev/null' (any error + messages will still be shown). + +`--srcdir=DIR' + Look for the package's source code in directory DIR. Usually + `configure' can determine that directory automatically. + +`configure' also accepts some other, not widely useful, options. Run +`configure --help' for more details. + @@ -2,7 +2,7 @@ CATARACT Static web photo gallery generator http://cgg.bzatek.net/ -version 0.99.2 [2009-02-26] +version 0.99.2 [2009-03-28] Copyright (C) 2008-2009 Tomas Bzatek <tbzatek@users.sourceforge.net> @@ -14,36 +14,38 @@ gallery, designed to be clean and easily usable. Due to the static design, there's no way to comment pictures on the web. Feature highlights: - * static HTML gallery, no extra requirements on server - * fast, easy to cache/mirror - * XML-based description files - * modern design, valid XHTML 1.0 and CSS 2 - * EXIF & IPTC support - * console application, allowing easy scripting - (e.g. auto-refresh after new images are uploaded via FTP) + * static HTML gallery, no extra requirements on the server + * fast, easy to cache/mirror + * XML-based description files + * modern design, valid XHTML 1.0 and CSS 2 + * EXIF & IPTC support + * console application, allowing easy scripting + (e.g. auto-refresh after new images are uploaded via FTP) + * licensed under GNU GPLv2 license Planned features: - * autotoolize - * optional pushing comments and captions to images - * switchable flat album view - * slideshow mode - * switchable styles - * jBrout db support? - * stars rating system (iframed php script?) + * GraphicsMagick port + * job parallelization + * optional pushing comments and captions to images + * switchable flat album view + * slideshow mode + * switchable styles + * jBrout db support? + * stars rating system (iframed php script?) DOCUMENTATION ------------- -CGG creates a set of HTML files and images from the source structure. -Input files are structured in subdirectories, each directory may contain +CGG creates a set of HTML files and images from the source structure. +Input files are structured in subdirectories, each directory may contain only one index XML file and the generated directory tree copies the source -structure. All links to sub-galleries, items, descriptions and individual -settings are specified in XML files. No more files other than global setup +structure. All links to sub-galleries, items, descriptions and individual +settings are specified in XML files. No more files other than global setup XML file are needed. -For convenience, sources contain the cgg-dirgen.sh script, which creates -an index XML template from images in current directory. That can be used +For convenience, sources contain the cgg-dirgen script, which creates +an index XML template from images in current directory. That can be used as a skeleton of new album, writing down title, description and comments. For detailed syntax of input XML files please check the sample gallery included @@ -51,16 +53,62 @@ in the source tree. It demonstrates basic features and contains detailed tag description inside the XML files. +ENTITIES +-------- + + * As a general rule, all nested tags have to be surrounded by the CDATA block, + e.g. <![CDATA[<b>text</b>]]> + * It's strongly discouraged to use named entities like < or > outside + the CDATA block as the XML parser will unescape them to < and > automatically + which might lead to validation troubles. Some other commonly-used + HTML entities like © are unknown to the XML parser and will throw an error. + * Lonely ampersands (forgotten or inside a URL) get escaped automatically + for the safety. Opening ampersands in entities are left untouched of course. + + +VALIDATION +---------- + +For easy validation of single files you can use well-known W3C Markup Validator. +For automated validation of series of files it's better to use command-line tools +like xmllint, which is a part of the libxml2 suite, also heavily used in cataract. + +Using xmllint we can easily validate all html files in the current +directory structure: + +for i in `find -regex '.*html$'`; do (echo "=================== $i"; xmllint --valid --noout $i); done + +This will automatically download linked DTD schema (XHTML 1.0 Strict in this case) +as defined in the XML header. Processing large number of files might be inconvenient +and you may want to use locally cached schemes. Running + +XML_DEBUG_CATALOG="1" xmllint --valid --noout <file.html> + +will tell you which schema files are needed. Then just create local catalog file, +as described on the Wikipedia XML Catalog page: + +<?xml version="1.0"?> +<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" + "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"> +<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog" prefer="public"> + <public publicId="-//W3C//DTD XHTML 1.0 Strict//EN" uri="xhtml1-strict.dtd"/> +</catalog> + +and pass it as XML_CATALOG_FILES variable: + +XML_CATALOG_FILES="catalog.xml" xmllint --valid --noout <file.html> + + BUILDING -------- First make sure you have met the following requirements: libxml-2.0 (tested with 2.7.2) - glib-2.0 (2.12.0 recommented, tested with 2.18.3) + glib-2.0 (2.16.0 recommented, tested with 2.18.3) exiv2 (tested with 0.17.1) ImageMagick (tested with 6.4.5.7) -To compile cgg, type 'make' +Please refer to standard instructions in the INSTALL file. DEVELOPMENT diff --git a/configure.ac b/configure.ac index 945f6d5..02d1492 100644 --- a/configure.ac +++ b/configure.ac @@ -2,7 +2,7 @@ AC_INIT PACKAGE=cataract VERSION=0.99.2 -APP_BUILD_DATE=2009-02-26 +APP_BUILD_DATE=2009-03-28 APP_COPYRIGHT_STRING="Copyright (c) 2008-2009 Tomas Bzatek" AC_SUBST(PACKAGE) |