This is an implementation of the INDEX format as discussed
in de-mirror@informatik.tu-muenchen.de in July 1992.

genindex creates a recursive directory index, human-readable diffs
(containing new non-index files/directories) to yesterday, last week,
and last month, and machine-readable diffs to the last few days
(containing all changes, so a new version can be constructed from an
old one).

genindex has been tested on several platforms (Sun, Ultrix, Irix,
Interactive).  Please report bugs to ftpadm@cs.tu-berlin.de.

PACKLIST:
    README		this file
    genindex		INDEX generating script, needs config.sh
    config.sh		local configuration
    draft-index-format	de-mirror format definition
    index-mon2num	month name converter for INDEX files
    index-to-ls		converter from INDEX to ls-lR
    testawk		awk tester, tests for long strings
			    (necessary for index-to-ls, which is
			     itself unnecessary :-))

INSTALLATION:
    o If GNU find > 3.5 is not installed on the index-generating
      machine yet, get it (*), cd to its source directory and type
      `configure'.
		    (*) Many FTP sites provide GNU utilities,
			e.g. ftp.cs.tu-berlin.de:/pub/gnu/find.

    o edit config.sh thoroughly.

    o test genindex by running "genindex `pwd`" manually.
      If that succeeds, run "genindex" without arguments, if you
      hardwired the FTP root directory in config.sh, or give the
      FTP root directory as an argument.
      A directory prefix added to all files in INDEX can be given
      as second argument. That prefix should always be "/" (default)
      for full archive listings.
      The INDEX destination directory is the third optional argument
      (default: FTP root directory).

      Example:
	"genindex /home/ftp/pub/amiga  /pub/amiga /index/amiga/"
      generates a partial listing of the amiga archive section
      which will be put to /index/amiga/INDEX{,.Z}.

    o copy genindex and config.sh to some location (both to the
      same directory).

    o (optionally:) generate a file containing ignored names
      (as described in config.sh).

    o Add an entry
    
	    17 23 * * *		<full path>/genindex [rootdir] [prefix]

      to the archive owner's crontab (using "crontab -e" on most
      architectures).  rootdir and prefix are optional, as said above.

      Please generate the INDEX daily before midnight.  This is a
      convention helping archie and INDEX mirror sites.

It is vital that you don't change the format definition (e.g. remove
the permissions field), because your INDEX will no longer conform to
the de-mirror INDEX format standard ("draft-index-format" in this
directory) and will thus become useless.
You may, however, remove some info lines (see "draft-index-format"
for mandatory information).

Finally: PLEASE!! don't change the location in your archive where
you put INDEX.Z without prior notice to the mirror sites (mail to
on of the addresses below suffices).
Because `mirror', the automatic file duplication software used by
many sites, cannot cope with symbolic links, replacing the INDEX
by a symlink to a new location is destructive in the same way.

It is strongly recommended that you put the index to ftp's root
directory "/", NOT /pub and NOT .disk1/hebauf/myINDEX. :-)

Many thanks to Heiner Marxen, Vera Heinau, Heiko Schlichting,
Bodo Bock and Kai 'Oswald' Seidler for their help!

Good luck && have fun,
    Carsten Rossenhoevel <cross@cs.tu-berlin.de>

......................................................................
Berliner FTP-Server-Verbund                     ftpadm@cs.tu-berlin.de
TU Berlin && FU Berlin && other sites in Berlin, Germany
