gnue forms/INSTALL forms/README reports/INSTALL...

[Jason Cater]

CVSROOT:        /cvsroot/gnue
Module name:    gnue
Changes by:     Jason Cater <address@hidden>    02/04/15 13:43:05

Modified files:
        forms          : INSTALL README 
        reports        : INSTALL README 

Log message:
        yet more documentation updates

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/forms/INSTALL.diff?tr1=1.19&tr2=1.20&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/forms/README.diff?tr1=1.20&tr2=1.21&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/reports/INSTALL.diff?tr1=1.6&tr2=1.7&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/reports/README.diff?tr1=1.5&tr2=1.6&r1=text&r2=text

Patches:
Index: gnue/forms/INSTALL
diff -c gnue/forms/INSTALL:1.19 gnue/forms/INSTALL:1.20
*** gnue/forms/INSTALL:1.19     Sun Jan 13 07:00:39 2002
--- gnue/forms/INSTALL  Mon Apr 15 13:43:04 2002
***************
*** 4,14 ****
  =====================================
  First intall the common package.
  
! Make sure that you've have a valid /usr/local/gnue/etc/gnue.conf
! This is installed by gnue-common package as a sample.gnue.conf
! you have to edit and move rename the file
  
! ./setup.py install
  
  
  General information:
--- 4,16 ----
  =====================================
  First intall the common package.
  
! Make sure that you have a valid /usr/local/gnue/etc/gnue.conf.
! This is installed by gnue-common package as a sample.gnue.conf.
! You will have to copy sample.gnue.conf to gnue.conf and edit
! gnue.conf to suit your needs.  Then, run:
  
!  $ python2 setup.py install  (depending on your OS, this could
!                               also be python2.1 or python2.2)
  
  
  General information:
***************
*** 16,22 ****
  
  GNUe-Forms needs some prerequisites to work. You need a database
  managment system, a user-interface library, python as programming
! language and a xml-handling library.  As of this writting GNUe Forms 
  allows you to use geas, postgresql, mysql, db2, oracle, or odbc.
  
  Later there will be available interoperability for a variety of
--- 18,24 ----
  
  GNUe-Forms needs some prerequisites to work. You need a database
  managment system, a user-interface library, python as programming
! language and a xml-handling library.  As of this writting GNUe Forms
  allows you to use geas, postgresql, mysql, db2, oracle, or odbc.
  
  Later there will be available interoperability for a variety of
***************
*** 34,49 ****
  
  Debian packages to be installed:
  ================================
  
! python-dev          The python interpreter and environment (1.5.2).
! libgtk1.2.7-devel Development files for the GIMP Toolkit needed for
!                   wxGTK. 
! cvs               Required for gnuef-"download".
! postgresql-dev    Required if using PostgreSQL        
! python-mysqldb    Required if using MySQL
  
! There will eventually be a bunch of dependend packages that will
! be installed automatically too.
  
  
  Other software to be installed:
--- 36,51 ----
  
  Debian packages to be installed:
  ================================
+ You should apt-get install the following packages:
  
!   python2.1-dev
!   python2.1-egenix-mxdatetime
!   libwxgtk2.2-python
!   python2.1-psycopg  (if needed -- for PostgreSQL support)
!   python2.1-mysqldb  (if needed -- for MySQL support)
  
! This will also install other packages, such as libgtk, libwxgtk,
! postgresql-client, et al.
  
  
  Other software to be installed:
***************
*** 67,73 ****
          place then debian installs them. One workaround is
          "ln -s /usr/include/postgresql /usr/include/pgsql".
          As root issue finally "./setup.py install".
!         
      Note: if you are on the bleeding edge PyGreSQL
         is also included in postgreSQL cvs tree at
         pgsql/src/interfaces/python/.  If you build
--- 69,75 ----
          place then debian installs them. One workaround is
          "ln -s /usr/include/postgresql /usr/include/pgsql".
          As root issue finally "./setup.py install".
! 
      Note: if you are on the bleeding edge PyGreSQL
         is also included in postgreSQL cvs tree at
         pgsql/src/interfaces/python/.  If you build
***************
*** 83,97 ****
          "python setup.py build" and as root "python setup.py install".
  
  mxDateTime-2.x  http://www.lemburg.com/file/python/mxDateTime.html
!         Needed by several of the database drivers (including the 
!         PostgreSQL drivers). Untar in some place, enter the directory, 
!         and issue "python setup.py build" and as root "python setup.py 
!         install"  
! 
! PyXML-0.6.x.tar.gz:     pyxml.sourceforge.net/topics/download.html
!   ->sourceforge.net/project/showfiles.php?group_id=6473&release_id=13315
!       Untar in some place. Enter in the directory PyXML-0.6.1, issue
!       "python setup.py build" and as root "python setup.py install".
  
  wxGTK-2.2.2.tar.gz:    www.wxwindows.org
          Untar in some place. Enter in the directory wxGTK, issue
--- 85,94 ----
          "python setup.py build" and as root "python setup.py install".
  
  mxDateTime-2.x  http://www.lemburg.com/file/python/mxDateTime.html
!         Needed by several of the database drivers (including the
!         PostgreSQL drivers). Untar in some place, enter the directory,
!         and issue "python setup.py build" and as root "python setup.py
!         install"
  
  wxGTK-2.2.2.tar.gz:    www.wxwindows.org
          Untar in some place. Enter in the directory wxGTK, issue
***************
*** 115,133 ****
          Untar in some place. Enter in the directory pyncurses-0.3,
          issue "debian/apply-patch.sh", "python setup.py build" and as
          root "python setup.py install".
!         
          Pyncurses 0.3 does not currently build on Mac OS X.
  
  
  Download table:
  ===============
  
! Distutils-1.0.1.tar.gz:         www.python.org 
! PyGreSQL.tgz:           www.druid.net/pygresql                
! PyXML-0.6.1.tar.gz:     pyxml.sourceforge.net/topics/download.html
!                         ->sourceforge.net/project/showfiles.php\
!                           ?group_id=6473&release_id=13315
! wxGTK-2.2.2.tar.gz:     www.freiburg.linux.de/~wxxt/download.htm 
  wxPython-2.2.2.tar.gz:          www.wxpython.org/download.php
  mxDateTime                www.lemburg.com/files/python/mxDateTime.html
                          (this link is gone as of 12 Jan 2002)
--- 112,127 ----
          Untar in some place. Enter in the directory pyncurses-0.3,
          issue "debian/apply-patch.sh", "python setup.py build" and as
          root "python setup.py install".
! 
          Pyncurses 0.3 does not currently build on Mac OS X.
  
  
  Download table:
  ===============
  
! Distutils-1.0.1.tar.gz:         www.python.org
! PyGreSQL.tgz:           www.druid.net/pygresql
! wxGTK-2.2.2.tar.gz:     www.freiburg.linux.de/~wxxt/download.htm
  wxPython-2.2.2.tar.gz:          www.wxpython.org/download.php
  mxDateTime                www.lemburg.com/files/python/mxDateTime.html
                          (this link is gone as of 12 Jan 2002)
Index: gnue/forms/README
diff -c gnue/forms/README:1.20 gnue/forms/README:1.21
*** gnue/forms/README:1.20      Sat Nov 10 19:54:30 2001
--- gnue/forms/README   Mon Apr 15 13:43:04 2002
***************
*** 1,8 ****
  GNUe Forms: A tool of the GNUe Project (www.gnue.org)
!                       
                  Congratulations! You have purchased an extremely fine
!         device that would give you thousands of years of trouble-free 
!         service, except that you undoubtably will destroy it via some 
          typical bonehead consumer maneuver. Which is why we ask you
          to PLEASE FOR GOD'S SAKE READ THIS OWNER'S MANUAL CAREFULLY
          BEFORE YOU UNPACK THE DEVICE. YOU ALREADY UNPACKED IT, DIDN'T
--- 1,8 ----
  GNUe Forms: A tool of the GNUe Project (www.gnue.org)
! 
                  Congratulations! You have purchased an extremely fine
!         device that would give you thousands of years of trouble-free
!         service, except that you undoubtably will destroy it via some
          typical bonehead consumer maneuver. Which is why we ask you
          to PLEASE FOR GOD'S SAKE READ THIS OWNER'S MANUAL CAREFULLY
          BEFORE YOU UNPACK THE DEVICE. YOU ALREADY UNPACKED IT, DIDN'T
***************
*** 10,24 ****
          FIDDLED WITH THE KNOBS, AND NOW YOUR CHILD, THE SAME CHILD WHO
          ONCE SHOVED A POLISH SAUSAGE INTO YOUR VIDEOCASSETTE RECORDER
          AND SET IT ON "FAST FORWARD", THIS CHILD ALSO IS FIDDLING
!         WITH THE KNOBS, RIGHT?  AND YOU'RE JUST NOW STARTING TO READ 
!         THE INSTRUCTIONS, RIGHT???  WE MIGHT AS WELL JUST BREAK THESE 
          DEVICES RIGHT AT THE FACTORY BEFORE WE SHIP THEM OUT, YOU
!         KNOW THAT? 
                                  -- Dave Barry, "Read This First!"
!                               -- Shamelessly ripped off from the
                                     Window Maker (www.windowmaker.org)
                                     README file, but I really like it :)
!                                    
  
  Compatibility:
    GNUe Forms has been successfully used on
--- 10,24 ----
          FIDDLED WITH THE KNOBS, AND NOW YOUR CHILD, THE SAME CHILD WHO
          ONCE SHOVED A POLISH SAUSAGE INTO YOUR VIDEOCASSETTE RECORDER
          AND SET IT ON "FAST FORWARD", THIS CHILD ALSO IS FIDDLING
!         WITH THE KNOBS, RIGHT?  AND YOU'RE JUST NOW STARTING TO READ
!         THE INSTRUCTIONS, RIGHT???  WE MIGHT AS WELL JUST BREAK THESE
          DEVICES RIGHT AT THE FACTORY BEFORE WE SHIP THEM OUT, YOU
!         KNOW THAT?
                                  -- Dave Barry, "Read This First!"
!                                 -- Shamelessly ripped off from the
                                     Window Maker (www.windowmaker.org)
                                     README file, but I really like it :)
! 
  
  Compatibility:
    GNUe Forms has been successfully used on
***************
*** 26,36 ****
      FreeBSD 4.2-Stable
      RedHat GNU/Linux
      S.u.S.E. Linux 6.4
!     Slackware 8 
      Solaris 2.5.1
      Windows 98
!     
!   People wanting to use curses mode should read the 
      notes at end of this file.
  
  To install:
--- 26,36 ----
      FreeBSD 4.2-Stable
      RedHat GNU/Linux
      S.u.S.E. Linux 6.4
!     Slackware 8
      Solaris 2.5.1
      Windows 98
! 
!   People wanting to use curses mode should read the
      notes at end of this file.
  
  To install:
Index: gnue/reports/INSTALL
diff -c gnue/reports/INSTALL:1.6 gnue/reports/INSTALL:1.7
*** gnue/reports/INSTALL:1.6    Mon Apr 15 00:36:43 2002
--- gnue/reports/INSTALL        Mon Apr 15 13:43:05 2002
***************
*** 1,8 ****
--- 1,12 ----
  Installation instructions for GNUe Reports
  
+ Note: Instructions for Debian are at the end of this document.
+ 
  Short Version
  =============
  
+ For the impatient...
+ 
  Install the following prerequisites:
  
   * Python 2.0 or later    http://www.python.org/
***************
*** 12,18 ****
  
  Then, as root:
  
!  $ python2 ./setup.py install  (may be python2.1 or python2.2)
   $ cd /usr/local/gnue/etc
   $ cp sample.gnue.conf gnue.conf
   $ cp sample.report-filters.conf report-filters.conf
--- 16,22 ----
  
  Then, as root:
  
!  $ python2 ./setup.py install  (may also be python2.1 or python2.2)
   $ cd /usr/local/gnue/etc
   $ cp sample.gnue.conf gnue.conf
   $ cp sample.report-filters.conf report-filters.conf
***************
*** 21,30 ****
  Introduction
  ============
  
! Currently, only a non-server report engine will run (i.e., the
! background server implementation of Reports is not complete).
! This means Reports is currently useful for evaluation or for
! small, centralized (2-tier) sites.
  
  
  Prerequisites
--- 25,38 ----
  Introduction
  ============
  
! GNUe Reports is the primary reporting engine for GNU Enterprise.
! It requires a few prerequisite packages to be installed prior to
! installing reports.
! 
! Currently, reports will only run in a command-line mode -- the
! "server" implementation of GNUe Reports is still underway. This
! means Reports is currently useful for evaluation or for small,
! centralized (2-tier) sites.
  
  
  Prerequisites
***************
*** 37,45 ****
  The following minimum programs are required for running GNUe-Reports:
  
   Python 2.0 or later    http://www.python.org/
-  GNUe-Common            http://www.gnuenterprise.org/downloads/common
   Sablotron              http://www.gingerall.com/charlie/ga/xml/p_sab.xml
   PySablot               http://sourceforge.net/projects/pysablot/
  
  
  Configuration
--- 45,66 ----
  The following minimum programs are required for running GNUe-Reports:
  
   Python 2.0 or later    http://www.python.org/
   Sablotron              http://www.gingerall.com/charlie/ga/xml/p_sab.xml
   PySablot               http://sourceforge.net/projects/pysablot/
+  GNUe-Common            http://www.gnuenterprise.org/downloads/common
+ 
+ 
+ Installation
+ ============
+ 
+ Run the following command:
+ 
+   python2 setup.py install
+ 
+ If python2 is not found, try one of these alternates:
+ 
+   python2.1 setup.py install
+   python2.2 setup.py install
  
  
  Configuration
***************
*** 55,61 ****
  (printers, email, file, and fax.)
  
  
- 
  Support for the "printer" destination
  =====================================
  Currently, the only "printer" adapter available is the "bsd" adapter. This
--- 76,81 ----
***************
*** 103,111 ****
  In other words, -d -  will output the report to the console (or through a
  unix pipe.)  When using -d -, it is best to also specify the --quiet option.
  
! Example grrun:
  
!   $ grrun -D file -d- --filter html | enscript -P lp
  
  
  
--- 123,131 ----
  In other words, -d -  will output the report to the console (or through a
  unix pipe.)  When using -d -, it is best to also specify the --quiet option.
  
! Example grrun using Unix pipes:
  
!   $ grrun --quiet -D file -d- --filter html | enscript -P lp
  
  
  
***************
*** 170,175 ****
--- 190,222 ----
  Reports, "--filter postscript" will be the logical choice. Until then,
  unless you've manually configured sendfax to convert html documents,
  "--filter text" is the only choice.
+ 
+ 
+ Debian Installation
+ ===================
+ 
+ To install on a Debian system, you need to apt-get the following packages
+ (these exist in Woody; I'm not sure about Potato):
+ 
+   python2.1
+   python2.1-dev
+   python2.1-egenix-mxdatetime
+   sablotron
+   libexpat1
+   python2.1-psycopg  (if needed -- for PostgreSQL support)
+   python2.1-mysqldb  (if needed -- for MySQL support)
+   hylafax-client     (if needed -- for Fax support)
+ 
+ Also, grab the debs for PySablot from:
+   http://www.gnuenterprise.org/~jcater/debian/pysablot2.1_0.1-1_i386.deb
+ 
+ and install as:
+   dpkg --install pysablot2.1_0.1-1_i386.deb
+ 
+ You should now have all the prerequisites installed and can install
+ GNUe Common and GNUe Reports using:
+ 
+   python2.1 setup.py install
  
  
  
Index: gnue/reports/README
diff -c gnue/reports/README:1.5 gnue/reports/README:1.6
*** gnue/reports/README:1.5     Wed Oct 24 14:37:59 2001
--- gnue/reports/README Mon Apr 15 13:43:05 2002
***************
*** 1,7 ****
- GNUe-Reports requires gnue-common to be installed, including the setup
- of the connections file (see gnue-common README for details). 
  
! For questions, use the reports mailing list at http://lists.gnue.org/ 
  or visit us in IRC at irc.openprojects.net, channel #gnuenterprise
  
! -- Jason Cater (jcater) 
--- 1,19 ----
  
! For installation instructions, please read the file INSTALL.
! 
! GNUe Reports is known to work on the following platforms:
!   * Debian GNU/Linux 2.x/3.x
!   * RedHat Linux 7.x
! 
! GNUe Reports should work without issue on any Unix-compatable system
! for which Python is available.  This applies to most modern (and some
! not-so-modern) distributions.  It should also work on ANY platform for
! which Python is available, but the gnue.conf may need to be tweaked for
! these platforms (i.e., MacOS, MS-Windows, et al.) -- especially the
! LprCommand and similar options.
! 
! 
! For questions, use the reports mailing list at http://lists.gnue.org/
  or visit us in IRC at irc.openprojects.net, channel #gnuenterprise
  
! -- Jason Cater (jcater)