ALICE TRD fxsproxy README
		=========================

fxsproxy is a tool for the retrieval of all TRD FEE configuration 
information via DIM acknowledge channel, triggered by a DIM command 
including the run number. This command can be launched from everywhere, 
preferably from within the PVSS SOR script.
In case of any problems, please contact: Frederick.Kramer@cern.ch


REQUIREMENTS
------------

The Library libdim is necessary for this package, the dim headers and a dim_dns has to be running.


INSTALLATION
------------

There are two possible ways for the installation:
A: install from rpm
B: install from source


A) 

rpm -U fxsproxy-X.X-X.i386.rpm

Files that are installed are:
/usr/bin/fxsproxy_server              the command line proxy
/usr/bin/fxsproxy_testclient          a client to send a command
/usr/bin/fxsproxyd                    the daemon version of the server (not ready yet)
/etc/rc.d/init.d/fxsproxyd            the service script for the daemon
/etc/trd/fxsproxy.conf                the file including all config information of the proxy
/etc/trd/fxsproxy_xml_displayer.xsl   the style sheet for viewing the xml output in a browser


B)

The installation procedure from source makes use of the GNU quasi-standard 
autoreconfigure, which is creating a configure script which then provides 
the actual makefiles.
The standard installation procedure comprises the following steps:
1. unpack & enter the package:
	tar zxfv fxsproxy.tar.gz
	cd fxsproxy
2. create the makefiles with the prefix /
	./configure --prefix=/
3. compile the code and test the output
	make
4. install the fxsproxy (you need to be root for this)
	(su)
	make install
	(exit)

Like this, the files will be installed to the directories:
/bin
/etc/rc.d/init.d
/etc/trd
If you don't give the prefix, the above three directories will be preceeded by /usr/local


INSTALLATION/DE-INSTALLATION OPTIONS
-----------------------------------

A) 
rpm -e fxsproxy


B)
- remove the installed files
	make uninstall
- erase what has been built
	make clean 
- additionally erase anything './configure' has created
	make distclean


OPERATION
---------

This package comes with 2 binary programs:
1. the main program fxsproxyd, which can be started normally or as a 
   background process.

A)
   Starting it in the latter way can be achieved by entering
   $> /etc/rc.d/init.d/fxsproxyd start

   Stopping:
   $> /etc/rc.d/init.d/fxsproxyd stop

   Restarting:
   $> /etc/rc.d/init.d/fxsproxyd restart

   Checking the status:
   $> /etc/rc.d/init.d/fxsproxyd status

   After killing the program or after a crash (what of course shouldn't happen) the 
   lock file (that prevents from multiple startups) is not removed. To get the program
   starting delete it before or do:   
   $> /etc/rc.d/init.d/fxsproxyd force-start

   Unless there is an error the daemon should always be running without
   any need of intervention.

B)
   Using the proxy from command line:
   Starting does not require any argument:
   $> fxsproxyd
   but one can pass the full path and name of a configuration file if a different
   one than the standard confugration file /etc/trd/fxsproxyd.conf is to be
   used, e.g.:
   $> fxsproxyd /the/location/and/the/fi.le

   The output will be sent to /var/log/messages in any case.

2. a test-client: fxsproxy_testclient, which takes the run number as first 
   argument (use 1 for testing purposes) and, if needed, either SOR or EOR as second.



RELEASES
--------

1.0  Running the proxy as a background process is now possible. Since now all primary
     features are in place and stable this is the first version with a 1 in the front.
     Some other new features are:
     a) protection against multiple startup
     b) protection against multiple triggering with the same run number
     c) protection against triggering while still processing the previous command
     d) revised XSL file. Now direct visualisation of the output is quite convenient.
     Anyhow there are some remaining issues:
     a) ask for the FEE states in parallel,
     b) full daemon functionality via /sbin/service not yet in place
     c) GTU/PreTrigger
0.13 All main functionalities are done, except that of the daemon. The dcsFXSPutData 
     section needs to be revised for the next release. Also still missing is the part for 
     GTU and pretrigger.
0.12 --
0.11 --
0.10 --
0.9  The command line server is mostly ready, the main missing functionality is sending
     tags, this will hopefully be solved in the next release.
     The second main open issue is the daemon. This is in principle ready but there are 
     still quite problems with dim.
0.8  --
0.7  --
0.6  first release, many open issues