docsite - Document Site Generator
Author: Tomas Teubner

##### docsite

- Overview
- Description File
- Download

##### Project Documentation

- Project Information

## Abstract

docsite is a Document Site Generator.

Its main purpose is to simply generate an entire tree of directories and documents for a web server from a set of preformatted documents in a source folder tree and a file describing the folder structure, document titles and some additional text.

## Usage

On a Windows operating system the GUI version of the generator is started by

    docsite-<version>

where `version` is the docsite version number $currentVersion.

In a Unix/Linux environment the call is simply

    docsite

When at least three additional arguments are passed on the command line, the batch version of the generator is used automatically.

So under Windows the call would be

    docsite <desc-file> <source-dir> <target-dir>

and under Unix/Linux

    docsite.sh <desc-file> <source-dir> <target-dir>

The arguments are

desc-file
  is the description file for the site. Either a local file or a URL may be used here.
source-dir
  is the source directory for files to be placed in the site. This may either be a local directory or an FTP URL.
target-dir
  is the target directory for the site. This may either be a local directory or an FTP URL.

## FTP-URLs

An FTP URL has the following general format:

    ftp://username:password@hostname:port/directory?locale=us_en

The `:password` part may be omitted if the password is empty.

If the `:port` part is left out, the FTP standard port 21 is used.

username
  the login name of the FTP user.
password
  the password used for login.
hostname
  the host name or IP address of the FTP server.
port
  the port number of the FTP command server.
directory
  base directory
locale=xx_yy
  locale used on the FTP server. This is mainly used to parse date information from FTP file listings.