$Id: INSTALL,v 1.34 2000/12/14 12:31:00 loic Exp $

The Catalog home page is http://www.senga.org/

Quick start (assuming you have installed MySQL and Perl):
---------------------------------------------------------

          perl -MCPAN -e 'install Bundle::Catalog'
          #
          # Read the Setup chapter in the documentation. It will 
          # teach you how to configure catalog and create your first catalog.
          #
          netscape http://www.mymachine.org/Catalog/catalog_toc.html
          #
          # Go to URL http://www.mymachine.org/cgi-bin/Catalog?context=ccontrol_panel
          # to get the Catalog Control Panel.
          #
          netscape http://www.mymachine.org/cgi-bin/Catalog?context=ccontrol_panel

Re-run perl Makefile.PL: 
------------------------

	  If you already went thru all the questions of perl Makefile.PL
	  and just want to re-use an existing configuration do the following:

	  USE_CONFIG=/home/httpd/cgi-bin perl Makefile.PL

	  where /home/httpd/cgi-bin is the directory containing all the *.conf
	  files.

Requires: 
---------

	  MySQL-3.23.24 or higher  (http://www.mysql.com/)
          perl5.005_03 or higher (http://www.perl.org/)

	  Some perl modules need patches to work properly. Look for
	  *.patch in the Catalog directory.

Configuration:
--------------

          tar -zxvf Catalog-*.tar.gz

          cd Catalog-*

          perl Makefile.PL

              At this point you can either answer the questions or
                pre-define the answers using the following environment 
                variables:

	      USE_CONFIG if you already have a working configuration installed
		         specify the directory containing the install.conf and
	                 mysql.conf files in this variable. USE_DEFAULTS=1 is
			 set if USE_CONFIG is set.
              CGIDIR for the path of the directory where the cgi-bin 
                     programs will be installed.
	      CGIPATH for the location of the cgi-bin scripts when browsing
	              from a navgigator. Typically if you've set CGIDIR to
	              /home/httpd/cgi-bin this will be /cgi-bin.
              CONFIG_DIR If not specified it will default to CGIDIR. 
                     CONFIG_DIR is the path of the directory where the default 
                     configuration files will be installed. Existing
                     configuration files, if any, will be preserved. 
                     The cgi-bin programs will only be able to find the
                     configuration files if they have the CONFIG_DIR variable
                     properly set in their environment.
              HTMLDIR for the path of the HTML directory where the
                      HTML material (doc, images...) will be installed. Note 
		      that images in the documentation will only be included if
	              you have texi2html version 1.51a (by default on GNU
	              Linux RedHat 5.2, if you installed everything from 
	              the distribution).
	      HTMLPATH for the location of the Catalog material when browsing
	               from a navgigator. Typically if you've set HTMLDIR to
	               /home/httpd/html/Catalog this will be /Catalog.
              INFODIR for the path of the info directory where the
                      documentation will be installed.
              USERID The user id of the HTTP daemon. The configuration files
                     must have the same owner because the HTML interface
                     must be able to modify them.
	      MYSQL_HOME Directory in which MySQL is installed. For instance
			 if you have /usr/local/bin/mysqldump then the directory
			 is /usr/local. If you have /opt/mysql-3.21/bin/mysqldump
			 then use /opt/mysql-3.21 as the directory.
	      MYSQL_BASE name of the MySQL database that will be used.
	      MYSQL_USER name of the user for authentification when connecting
		     to the MySQL server (--user option).
	      MYSQL_PASSWORD password of the user for authentification when
		     connecting to the MySQL server (--password option).
	      MYSQL_HOST host name of the machine where the MySQL server is
		     located (--host option).
              MYSQL_PORT TCP/IP port to use to connect to the server, if not
		     the default (--port option).
	      MYSQL_UNIX_PORT file name of the socket file to use when 
	             connecting to a server on the local 
	             machine (--socket option).
	      DOC_HTML if set to 'yes' format documenation in HTML, if set to
		     'no' do not format. If conversion utility is missing, skip
		     formating anyway. Default is yes.
	      DOC_PS if set to 'yes' format documenation in Postscript, if set 
		     to 'no' do not format. If conversion utility is missing, 
		     skip formating anyway. Default is no.
	      DOC_INFO if set to 'yes' format documenation in Emacs info, if
		     set to 'no' do not format. If conversion utility is 
		     missing, skip formating anyway. Default is no.

	      Alternatively you can hand edit the conf/install.conf and
	      conf/mysql.conf files. The mysql.conf file contains the values
	      associated to the environment variables starting with MYSQL_
	      and the install.conf file contains all the others.

	      When the Makefile.PL is executed, it reads the conf/install.conf
	      and conf/mysql.conf files and re-use existing values as 
	      defaults. An environment variable will override the corresponding
	      value found in the files. If a value is specified using an
	      environment variable, the interactive mode is disabled for
	      this value. At completion the the conf/install.conf and 
	      conf/mysql.conf files are updated with the new values.

	      If the configuration contained in the conf/install.conf and 
	      conf/mysql.conf files is correct and you simply want to
	      execute Makefile.PL again (after a make clean, for instance)
	      you can completely skip user interaction using the following

			USE_DEFAULTS=1 perl Makefile.PL

	  make 

	  make test

          make install

Loic Dachary
loic@senga.org
http://www.senga.org/
