[gnue] r6984 - in trunk: gnue-appserver gnue-appserver/doc gnue-appserver/samples gnue-common gnue-dbtools gnue-designer gnue-forms gnue-navigator gnue-reports

[reinhard]

Author: reinhard
Date: 2005-02-10 08:13:42 -0600 (Thu, 10 Feb 2005)
New Revision: 6984

Added:
   trunk/gnue-appserver/README.cvs
   trunk/gnue-common/README.cvs
   trunk/gnue-designer/README.cvs
   trunk/gnue-forms/README.cvs
   trunk/gnue-navigator/README.cvs
   trunk/gnue-reports/README.cvs
Removed:
   trunk/gnue-appserver/INSTALL.cvs
Modified:
   trunk/gnue-appserver/doc/configuration.txt
   trunk/gnue-appserver/samples/README
   trunk/gnue-appserver/samples/README.cvs
   trunk/gnue-dbtools/MANIFEST.in
   trunk/gnue-forms/MANIFEST.in
Log:
Even more work on installation and configuration docs.


Deleted: trunk/gnue-appserver/INSTALL.cvs
===================================================================
--- trunk/gnue-appserver/INSTALL.cvs    2005-02-10 13:28:28 UTC (rev 6983)
+++ trunk/gnue-appserver/INSTALL.cvs    2005-02-10 14:13:42 UTC (rev 6984)
@@ -1,101 +0,0 @@
-Developer Installation and Testing Instructions
-================================================
-
-You just have to run ./setup-cvs.py in the gnue-common cvs directory to set 
-up a GNUe including a full GNUe Appserver test installation. It will create
-a 'gacvs' (for the appserver) and a gcvs (for testing purposes) script for you.
-
-
-Setting up the database and class repository
---------------------------------------------
-
-Before you can start gacvs, you have to create a database and populate it with
-the class repository.
-
-For PostgreSQL, Interbase/Firebird or SQLite:
-* execute the script 'gsetupdbcvs'
-
-All other backends:
-* create your database as described in your database documentation
-* make sure you have access to this database and it fits your settings in the
-  connections.conf
-* in the directory '/usr/local/gnue/share/gnue/appserver' 
-  (or ~/gnue/share/gnue/appserver for a user installation) run the command
-  "gsscvs --connection=gnue gnue.gsd"
-  this will create and populate all tables needed for the classrepository
-
-
-Populate the database with sample classes and data
---------------------------------------------------
-
-To set up the database for the samples, make sure that you have created and
-populated the database as described above, and run setup-db-cvs.sh from the
-samples directory.
-
-
-Based on a simple example, there are three programs you can test.
-
-
-a. test.py
-----------
-
-A simple test of the application server. 
-
-1. Change to the directory gnue-appserver/src.
-
-2. type "gcvs test.py"
-
-requires: * a connection.conf with a [gnue] entry
-          * database tables created with "setup-db.sh" from the samples
-            directory
-
-
-b. RPC demo client
--------------------
-
-The same example, just executed on the real appserver using GNURPC. 
-
-1. Change to the directory gnue-appserver/src.
-
-2. Startup GNUe Appserver by executing "gacvs -Z"
-
-3. do the test example by calling "gcvs testRPC.py"
-
-requires: * a connection.conf with a [gnue] entry
-          * database tables created with "setup-db.sh" from the samples
-            directory
-         * a least one working GNURPC protocol (for the default GNURPC
-            protocol ("xmlrpc") with Python 2.1, you have to install py-xmlrpc.
-            If you use debian woody, just call 'apt-get install python-xmlrpc';
-            if you use Python 2.2 or later, you don't have to install something
-            special)
-
-
-c. GNUe Forms using sample.gfd
-------------------------------
-
-Accessing the sample data with GNUe Forms. 
-
-1. Change to the directory gnue-appserver/src.
-
-2. Startup GNUe Appserver by executing "gacvs -Z"
-
-3. Change to the directory gnue-appserver/samples.
-
-4. Startup GNUe Forms by executing "gfcvs sample.gfd"
-
-5. A login screen will pop up.
-   Enter the username "hacker" and the password "secret".
-
-6. Now you can change the sample data with GNUe Forms
-
-requires: * a connection.conf with a [gnue] entry
-          * database tables created with "setup-db.sh" from the samples
-            directory
-         * a least one working GNURPC protocol (for the default GNURPC
-            protocol ("xmlrpc") with Python 2.1, you have to install py-xmlrpc.
-            If you use debian woody, just call 'apt-get install python-xmlrpc';
-            if you use Python 2.2 or later, you don't have to install something
-            special)
-         * a [appserver] entry in your connections.conf file. For a sample
-            entry have a look at sample.connection.conf

Copied: trunk/gnue-appserver/README.cvs (from rev 6982, 
trunk/gnue-appserver/INSTALL.cvs)
===================================================================
--- trunk/gnue-appserver/INSTALL.cvs    2005-02-09 19:34:27 UTC (rev 6982)
+++ trunk/gnue-appserver/README.cvs     2005-02-10 14:13:42 UTC (rev 6984)
@@ -0,0 +1,30 @@
+Developer Installation Instructions
+===================================
+
+If you have downloaded gnue-appserver from the subversion repository (which you
+most probably have, because you wouldn't see this file otherwise), you can
+install and configure everything like described in the files "INSTALL" and
+"doc/configuration.txt".
+
+However, GNU Enterprise supports parallel use of an "installed" version and one
+or several "development" versions by providing a "developer install" script
+that uses different names for the programs.
+
+After downloading all the tools you want to have from the subversion
+repository, you just to run ./setup-cvs.py in the gnue-common directory.
+
+With the developer installation, you have to substitute the commands of the
+gnue-appserver package as follows:
+
+gnue-appserver -> gacvs
+gnue-readgcd   -> gcdcvs
+gnue-reagdld   -> gldcvs
+gnue-setupdb   -> gsetupdbcvs
+setup-db.sh    -> setup-cvs-db.sh     ("samples/" directory)
+
+Also, you will all relevant files and directories in ~/gnue instead of
+/usr/local/gnue.
+
+While the developer install script substitutes the steps given in the file
+"INSTALL", you still have to follow the steps given in doc/configuration.txt
+(with the above substitutions applied).

Modified: trunk/gnue-appserver/doc/configuration.txt
===================================================================
--- trunk/gnue-appserver/doc/configuration.txt  2005-02-10 13:28:28 UTC (rev 
6983)
+++ trunk/gnue-appserver/doc/configuration.txt  2005-02-10 14:13:42 UTC (rev 
6984)
@@ -20,7 +20,7 @@
 C. If you *really* want to follow the bleeding edge of development, you can
    access our SVN repository by following the instructions given at
    http://www.gnuenterprise.org/developers/svn.php. Please make sure your read
-   the files "INSTALL.cvs" and "README.cvs" in every package, if available.
+   the file "README.cvs" in every package, if available.
 
 Once you have installed the gnue-common and gnue-appserver packages, you have
 to do several configuration steps:
@@ -140,6 +140,10 @@
 installs, and to "/usr/local/gnue/share/gnue/appserver" for standard installs
 from the source packages.
 
+Whenever you change a file in the module path, you can send the running
+gnue-appserver process a SIGHUP signal, this will make all changes become
+effective.
+
 Some applications also provide files with an extension of ".gsd" that contain
 default or sample data.  You can read in those files with the command
 "gnue-schema --connection=gnue <filename>".

Modified: trunk/gnue-appserver/samples/README
===================================================================
--- trunk/gnue-appserver/samples/README 2005-02-10 13:28:28 UTC (rev 6983)
+++ trunk/gnue-appserver/samples/README 2005-02-10 14:13:42 UTC (rev 6984)
@@ -5,6 +5,13 @@
 installation instructions you can find in the file "INSTALL".
 
 
+Installing the sample application
+---------------------------------
+
+To install the sample application and fill the database with some sample data,
+you can simply call the "setup-db.sh" script given in this directory.
+
+
 Running the Application Server
 ------------------------------
 
@@ -16,9 +23,9 @@
 
 As soon as gnue-appserver runs, you can try to connect to it.  If you have
 gnue-forms installed, you can try running the "sample.gfd" form.  Basically,
-you can do this by changing into the "samples" directory and typing
-"gnue-forms sample.gfd".  Please refer to gnue-forms's documentation for more
-details.
+you can do this by changing into this directory (where you found this file)
+and typing "gnue-forms sample.gfd".  Please refer to gnue-forms's documentation
+for more details.
 
 Alternatively, you can let AppServer generate the form dynamically by calling
 "gnue-forms appserver://appserver/form/address_person".

Modified: trunk/gnue-appserver/samples/README.cvs
===================================================================
--- trunk/gnue-appserver/samples/README.cvs     2005-02-10 13:28:28 UTC (rev 
6983)
+++ trunk/gnue-appserver/samples/README.cvs     2005-02-10 14:13:42 UTC (rev 
6984)
@@ -1,8 +1,6 @@
 To try GNUe-AppServer, please follow the procedure given in the README file,
-but note that the cvs versions of the commands have different names:
+but note that the developer versions of the commands have different names:
 
 setup-db.sh    --> setup-cvs-db.sh
-gnue-schema    --> gsscvs
-gnue-readgcd   --> gcdcvs
-gnue-readgld   --> gldcvs
 gnue-appserver --> gacvs
+gnue-forms     --> gfcvs

Added: trunk/gnue-common/README.cvs
===================================================================
--- trunk/gnue-common/README.cvs        2005-02-10 13:28:28 UTC (rev 6983)
+++ trunk/gnue-common/README.cvs        2005-02-10 14:13:42 UTC (rev 6984)
@@ -0,0 +1,21 @@
+Developer Installation Instructions
+===================================
+
+If you have downloaded gnue-common from the subversion repository (which you
+most probably have, because you wouldn't see this file otherwise), you can
+install and configure everything like described in the file "INSTALL".
+
+However, GNU Enterprise supports parallel use of an "installed" version and one
+or several "development" versions by providing a "developer install" script
+that uses different names for the programs.
+
+After downloading all the tools you want to have from the subversion
+repository, you just to run ./setup-cvs.py in the gnue-common directory.
+
+With the developer installation, you have to substitute the commands of the
+gnue-common package as follows:
+
+gnue-schema  -> gsscvs
+
+Also, you will all relevant files and directories in ~/gnue instead of
+/usr/local/gnue.

Modified: trunk/gnue-dbtools/MANIFEST.in
===================================================================
--- trunk/gnue-dbtools/MANIFEST.in      2005-02-10 13:28:28 UTC (rev 6983)
+++ trunk/gnue-dbtools/MANIFEST.in      2005-02-10 14:13:42 UTC (rev 6984)
@@ -3,7 +3,7 @@
 include ChangeLog
 include INSTALL
 include NEWS
-include README*
+include README
 include THANKS
 include TODO
 

Added: trunk/gnue-designer/README.cvs
===================================================================
--- trunk/gnue-designer/README.cvs      2005-02-10 13:28:28 UTC (rev 6983)
+++ trunk/gnue-designer/README.cvs      2005-02-10 14:13:42 UTC (rev 6984)
@@ -0,0 +1,21 @@
+Developer Installation Instructions
+===================================
+
+If you have downloaded gnue-designer from the subversion repository (which you
+most probably have, because you wouldn't see this file otherwise), you can
+install and configure everything like described in the file "INSTALL".
+
+However, GNU Enterprise supports parallel use of an "installed" version and one
+or several "development" versions by providing a "developer install" script
+that uses different names for the programs.
+
+After downloading all the tools you want to have from the subversion
+repository, you just to run ./setup-cvs.py in the gnue-common directory.
+
+With the developer installation, you have to substitute the commands of the
+gnue-designer package as follows:
+
+gnue-designer -> gdes
+
+Also, you will all relevant files and directories in ~/gnue instead of
+/usr/local/gnue.

Modified: trunk/gnue-forms/MANIFEST.in
===================================================================
--- trunk/gnue-forms/MANIFEST.in        2005-02-10 13:28:28 UTC (rev 6983)
+++ trunk/gnue-forms/MANIFEST.in        2005-02-10 14:13:42 UTC (rev 6984)
@@ -3,9 +3,9 @@
 include ChangeLog
 include COPYING
 include FAQ
-include INSTALL*
+include INSTALL
 include NEWS
-include README*
+include README
 include TODO
 
 include doc/*

Added: trunk/gnue-forms/README.cvs
===================================================================
--- trunk/gnue-forms/README.cvs 2005-02-10 13:28:28 UTC (rev 6983)
+++ trunk/gnue-forms/README.cvs 2005-02-10 14:13:42 UTC (rev 6984)
@@ -0,0 +1,21 @@
+Developer Installation Instructions
+===================================
+
+If you have downloaded gnue-forms from the subversion repository (which you
+most probably have, because you wouldn't see this file otherwise), you can
+install and configure everything like described in the file "INSTALL".
+
+However, GNU Enterprise supports parallel use of an "installed" version and one
+or several "development" versions by providing a "developer install" script
+that uses different names for the programs.
+
+After downloading all the tools you want to have from the subversion
+repository, you just to run ./setup-cvs.py in the gnue-common directory.
+
+With the developer installation, you have to substitute the commands of the
+gnue-forms package as follows:
+
+gnue-forms -> gfcvs
+
+Also, you will all relevant files and directories in ~/gnue instead of
+/usr/local/gnue.

Added: trunk/gnue-navigator/README.cvs
===================================================================
--- trunk/gnue-navigator/README.cvs     2005-02-10 13:28:28 UTC (rev 6983)
+++ trunk/gnue-navigator/README.cvs     2005-02-10 14:13:42 UTC (rev 6984)
@@ -0,0 +1,21 @@
+Developer Installation Instructions
+===================================
+
+If you have downloaded gnue-navigator from the subversion repository (which you
+most probably have, because you wouldn't see this file otherwise), you can
+install and configure everything like described in the file "INSTALL".
+
+However, GNU Enterprise supports parallel use of an "installed" version and one
+or several "development" versions by providing a "developer install" script
+that uses different names for the programs.
+
+After downloading all the tools you want to have from the subversion
+repository, you just to run ./setup-cvs.py in the gnue-common directory.
+
+With the developer installation, you have to substitute the commands of the
+gnue-navigator package as follows:
+
+gnue-navigator -> gncvs
+
+Also, you will all relevant files and directories in ~/gnue instead of
+/usr/local/gnue.

Added: trunk/gnue-reports/README.cvs
===================================================================
--- trunk/gnue-reports/README.cvs       2005-02-10 13:28:28 UTC (rev 6983)
+++ trunk/gnue-reports/README.cvs       2005-02-10 14:13:42 UTC (rev 6984)
@@ -0,0 +1,24 @@
+Developer Installation Instructions
+===================================
+
+If you have downloaded gnue-reports from the subversion repository (which you
+most probably have, because you wouldn't see this file otherwise), you can
+install and configure everything like described in the files INSTALL and
+doc/configuration.txt.
+
+However, GNU Enterprise supports parallel use of an "installed" version and one
+or several "development" versions by providing a "developer install" script
+that uses different names for the programs.
+
+After downloading all the tools you want to have from the subversion
+repository, you just to run ./setup-cvs.py in the gnue-common directory.
+
+With the developer installation, you have to substitute the commands of the
+gnue-reports package as follows:
+
+gnue-reports        -> grcvs
+gnue-reports-server -> grdcvs
+gnue-reports-filter -> grfcvs
+
+Also, you will all relevant files and directories in ~/gnue instead of
+/usr/local/gnue.