From 7e123702db976d0423c0134fa0fc6467606df96e Mon Sep 17 00:00:00 2001
From: hades <hades>
Date: Sat, 9 Sep 2000 18:24:46 +0000
Subject: [PATCH] *** empty log message ***

---
 allParam/README | 81 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 allParam/README

diff --git a/allParam/README b/allParam/README
new file mode 100644
index 0000000..3567fd8
--- /dev/null
+++ b/allParam/README
@@ -0,0 +1,81 @@
+Author:  Benjamin Sailer
+         TUM/E12
+         Benjamin.Sailer@ph.tum.de
+Version: 0.1
+Date:    2000-09-09
+
+Param libraries
+===============
+
+Content
+-------
+
+1. The scope of the README files
+2. How to install the param libraries
+3. How to use the param libraries
+4. Known bugs and further developement perspectives
+
+1. The scope of the README files
+--------------------------------
+
+  Each subdirecory has it's own README file, containing the prerequesites of
+the special param library build there. The test directory contains a litte test
+suite to check if the explicit defined behaviour of the libraries is fulfilled
+within the concrete enviroment. Unfortunately this testing suite cannot check
+if the parameter sources needed for a correct work are available. In case of
+files this is not that big problem because if you set the enviroment variable
+DAQSLOW_PARAM_FILE to the file param.tcl in the test directory, it should
+work out fine. If the parameter source is a database, of course the situation
+is bad because you need connection to the explicit database containing exactly
+the data tested within the test suite (for liboraParam.a you even need
+connection to the database at compiletime). With libcaParam.a there can only
+be tested a complete setup of a EPICS parameter server, which is contained in
+the HADES DAQ runctrl package, together with the param library.
+
+2. How to install the param libraries
+-------------------------------------
+
+  Retrieve the libraries via ftp from
+ftp://ftp.e12.physik.tu-muenchen.de/pub/bsailer/param/param.0.1.tar.Z
+and extract them to a directory of your own choice (which is only needed for
+building, testing and installing the libraries).
+  Go into the extracted directory param and type
+$ make <lib>_all
+where <lib> is one of 'ca', 'file', 'ora', 'psql' or 'tcl', or simply 
+$ make
+if you want to make them all. '_all' includes installation to your home
+directory respectively the subdirectories lib/$SYSTYPE and include/<lib> as
+well as compiling and running a test suite in the subdirectory param/test.
+A protocol named <lib>_test_protocol.txt is created there but take care of the
+fact, that failures may come due to missing parameter sources - as mentioned
+above.
+  The usage of the enviroment variable $SYSTYPE applies to the fact that your
+home directory may be available from different os' with different binary file
+formats, which you should be able to use simultaneously. If you don't have this
+envviroment variable available, you can make good this placing the lines
+SYSTYPE=$(echo "$(uname -m)_$(uname -s)_$(uname -r)" |
+    tr -d [:cntrl:] |
+    tr [:lower:] [:upper:] |
+    tr -c [:alnum:] _)
+export SYSTYPE
+into your ~/.profile.
+  If you want to install the libraries to another path (e.g. /usr/local/lib is
+foreseen, if you want to make the libraries available systemwide as root),
+the change of LIBPATH and INCPATH in the Makefiles is straight forward.
+
+3. How to use the param libraries
+---------------------------------
+
+
+
+4. Known bugs and further developement perspectives
+---------------------------------------------------
+
+- The treatment of values out of bounds (e.g. strings longer than the foreseen
+  PARAM_MAX_NAME_LEN and PARAM_MAX_VALUE_LEN) is not checked in the testsuite
+  yet.
+
+Please send bug reports to
+
+Benjamin.Sailer@ph.tum.de
+
-- 
2.43.0