DOMESDAY - Automatically generate website navigation pages such as hierarchical site maps and A-Z indices by extracting meta data from the files which make up the site.

domesday [options] <projectfile>

domesday --help|-h|--version

This manual page documents the Domesday program.

Domesday is a program that generates site navigation pages. It is designed so that it may be run autonomously - The main program requires no user input. To make this possible, each index must be first defined in a project file which must be passed as an argument to Domesday. These project files can be created either with the Domesdaygui program which gives a user friendly way of generating the settings and also running the Domesday program; or the settings files may be edited by hand. Full details of the settings file format (and hence the features of the program) can be found in the Domesday.project(5) manual page.

-h, --help

Show summary of options.

-v, --version

Show version of program.

--quiet

Supresses all ouput apart from summary line which is printed at the end indication the location of the log file and the number of files included in the output.

--no-interaction

Ocassionally, Domesday may ask the user questions, such as confirming the overwrite of the output file. This option answers yes to all of those questions. It is useful when running Domesday automatically, from a cron job for example.

The following numbers will be printed at the beginning of an error string.

The file you chose for the output file already existed. A backup of it has been created with the given name. If you didn't want to overwrite the file, you must retrieve the backup and save it under a different name, otherwise Domesday will overwrite it on the next run.

This is produced if something went wrong when trying to create a backup file. The index generation will not continue, so your original file will be safe.

These are errors relating to the project settings file.

This error occurs when an attempt is made to access a variable using the wrong type. This error is caused by a mistake in the program. Please report this error to the Domesday team.

The warning occurs when the settings file is parsed and no locale is given. The application will assume the settings file is in English and continue processing.

This error occurs when an attempt is made to run Domesday with an out of date settings file. Setting names or syntax may have changed and an updated settings file is needed for reliable operation.

This warning occurs when an attempt is made to save the settings file without first specifying a file name.

This error occurs when the project file contains illegal setting values.

This warning occurs when the project file contains a variable which is not recognized by the application.

This warning occurs when the project file contains poorly formatted HTTP headers. This warning is only relevant to the server method for file inspection.

These are errors relating to placeholders

A replacement could not be found for the stated placeholder in the stated project setting. This is usually due to a typing error - please see the Domesday.project manual page and confirm the spelling of the placeholder. If it is correct, then it is possibly that the placeholder you gave is invalid in that section. Some placeholders are only valid in certain sections of the settings. See the Domesday.project manual page for full details of all valid placeholders in each section.

This error is produced if the stated placeholder in the stated setting has too many attributes. The attributes will be ignored. See the Domesday.project manual page for details of placeholders and their attributes.

An attribute has been given twice in the given placeholder of the given setting. Attributes must only appear once. In this event, the first attribute will probably take precendence, although you should really fix the problem in the setting

The attribute you gave is unknown. This is often due to a typing mistake. Note that attributes must be in the same language as the settings file Locale.

Some attributes can only take a fixed number of responses. This is one of those attributes and the value you gave to it is not one of the fixed responses. Please see the Domesday.project manual page for details of placeholders and their attributes.

These errors should never occur. If they do, please send a bug report to us, including the full error message

In order to extract information from Debian Packages, the dpkg-deb program needs to be installed in /usr/bin/dpkg-deb. The file will be included in the index, but will not include any detail.

These warnings/errors map to File has no head-, body- or neither of h1-, h2-, h3-, h4-, h5-, h6- nor p-elements inside a body-element respectively. These warnings/errors should occur, depending on the quality of the source files only. If they do occur, please check if the indexed HTML source file contains the specified elements, before sending a bug report to us, including the full error message

This error occurs if the type of the file couldn't be determined. The main reason this will occur is if the file type is not supported by the program. We do put a lot of work into ensuring that all popular file types for web documents are supported, so...

This warning occurs when the application encounters a dead hyperlink.

This warning is to let you know that there are going to be no files in the index. This usually means that either the filters have excluded everything or the root files/directories were misunderstood. Please look through the log file for more information.

If the filesystem and dirScanner methods have been chosen, the scanRoot setting should contain a list of directories. This error is reported if one of those directories does not exist.

If the filesystem and dirScanner methods have been chosen, the scanRoot setting should contain a list of directories. This error is reported if one of those entries is not a directory.

This indicates that an internal error occured. In all likelyhood, nobody will ever see this error. Please submit a bug report including the full text of the error message and the full log file.

indexgen.project(5) indexgengui(1),

This manual page was written by Mark Howard <mh@tildemh.com>